OGS 6.2.2-87-g988ee9c30.dirty.20200123122242
NumLib::MatrixProvider Class Referenceabstract

Detailed Description

Manages storage for matrices.

This the matrix-analog of VectorProvider. The same notes apply to this class.

Definition at line 89 of file MatrixProviderUser.h.

#include <MatrixProviderUser.h>

Inheritance diagram for NumLib::MatrixProvider:

Public Member Functions

virtual GlobalMatrix & getMatrix ()=0
 Get an uninitialized matrix. More...
 
virtual GlobalMatrix & getMatrix (std::size_t &id)=0
 Get an uninitialized matrix with the given id. More...
 
virtual GlobalMatrix & getMatrix (GlobalMatrix const &A)=0
 Get a copy of A. More...
 
virtual GlobalMatrix & getMatrix (GlobalMatrix const &A, std::size_t &id)=0
 Get a copy of A in the storage of the matrix with the given id. More...
 
virtual GlobalMatrix & getMatrix (MathLib::MatrixSpecifications const &ms)=0
 Get a matrix according to the given specifications. More...
 
virtual GlobalMatrix & getMatrix (MathLib::MatrixSpecifications const &ms, std::size_t &id)=0
 
virtual void releaseMatrix (GlobalMatrix const &A)=0
 
virtual ~MatrixProvider ()=default
 

Constructor & Destructor Documentation

◆ ~MatrixProvider()

virtual NumLib::MatrixProvider::~MatrixProvider ( )
virtualdefault

Member Function Documentation

◆ getMatrix() [1/6]

◆ getMatrix() [2/6]

virtual GlobalMatrix& NumLib::MatrixProvider::getMatrix ( std::size_t &  id)
pure virtual

Get an uninitialized matrix with the given id.

Implemented in NumLib::SimpleMatrixVectorProvider.

◆ getMatrix() [3/6]

virtual GlobalMatrix& NumLib::MatrixProvider::getMatrix ( GlobalMatrix const &  A)
pure virtual

Get a copy of A.

Implemented in NumLib::SimpleMatrixVectorProvider.

◆ getMatrix() [4/6]

virtual GlobalMatrix& NumLib::MatrixProvider::getMatrix ( GlobalMatrix const &  A,
std::size_t &  id 
)
pure virtual

Get a copy of A in the storage of the matrix with the given id.

Implemented in NumLib::SimpleMatrixVectorProvider.

◆ getMatrix() [5/6]

virtual GlobalMatrix& NumLib::MatrixProvider::getMatrix ( MathLib::MatrixSpecifications const &  ms)
pure virtual

Get a matrix according to the given specifications.

Implemented in NumLib::SimpleMatrixVectorProvider.

◆ getMatrix() [6/6]

virtual GlobalMatrix& NumLib::MatrixProvider::getMatrix ( MathLib::MatrixSpecifications const &  ms,
std::size_t &  id 
)
pure virtual

Get a matrix according to the given specifications in the storage of the matrix with the given id.

Implemented in NumLib::SimpleMatrixVectorProvider.

◆ releaseMatrix()


The documentation for this class was generated from the following file: