MFEM  v4.2.0 Finite element discretization library
mfem::MatrixCoefficient Class Referenceabstract

Base class for Matrix Coefficients that optionally depend on time and space. More...

#include <coefficient.hpp>

Inheritance diagram for mfem::MatrixCoefficient:
[legend]

## Public Member Functions

MatrixCoefficient (int dim, bool symm=false)
Construct a dim x dim matrix coefficient. More...

MatrixCoefficient (int h, int w, bool symm=false)
Construct a h x w matrix coefficient. More...

void SetTime (double t)
Set the time for time dependent coefficients. More...

double GetTime ()
Get the time for time dependent coefficients. More...

int GetHeight () const
Get the height of the matrix. More...

int GetWidth () const
Get the width of the matrix. More...

int GetVDim () const
For backward compatibility get the width of the matrix. More...

bool IsSymmetric () const

virtual void Eval (DenseMatrix &K, ElementTransformation &T, const IntegrationPoint &ip)=0
Evaluate the matrix coefficient in the element described by T at the point ip, storing the result in K. More...

virtual void EvalSymmetric (Vector &K, ElementTransformation &T, const IntegrationPoint &ip)
Evaluate the upper triangular entries of the matrix coefficient in the symmetric case, similarly to Eval. Matrix entry (i,j) is stored in K[j - i + os_i] for 0 <= i <= j < width, os_0 = 0, os_{i+1} = os_i + width - i. That is, K = {M(0,0), ..., M(0,w-1), M(1,1), ..., M(1,w-1), ..., M(w-1,w-1) with w = width. More...

virtual ~MatrixCoefficient ()

int height

int width

double time

bool symmetric

## Detailed Description

Base class for Matrix Coefficients that optionally depend on time and space.

Definition at line 693 of file coefficient.hpp.

## Constructor & Destructor Documentation

 mfem::MatrixCoefficient::MatrixCoefficient ( int dim, bool symm = false )
inlineexplicit

Construct a dim x dim matrix coefficient.

Definition at line 702 of file coefficient.hpp.

 mfem::MatrixCoefficient::MatrixCoefficient ( int h, int w, bool symm = false )
inline

Construct a h x w matrix coefficient.

Definition at line 706 of file coefficient.hpp.

 virtual mfem::MatrixCoefficient::~MatrixCoefficient ( )
inlinevirtual

Definition at line 743 of file coefficient.hpp.

## Member Function Documentation

 virtual void mfem::MatrixCoefficient::Eval ( DenseMatrix & K, ElementTransformation & T, const IntegrationPoint & ip )
pure virtual

Evaluate the matrix coefficient in the element described by T at the point ip, storing the result in K.

Note
When this method is called, the caller must make sure that the IntegrationPoint associated with T is the same as ip. This can be achieved by calling T.SetIntPoint(&ip).
 virtual void mfem::MatrixCoefficient::EvalSymmetric ( Vector & K, ElementTransformation & T, const IntegrationPoint & ip )
inlinevirtual

Evaluate the upper triangular entries of the matrix coefficient in the symmetric case, similarly to Eval. Matrix entry (i,j) is stored in K[j - i + os_i] for 0 <= i <= j < width, os_0 = 0, os_{i+1} = os_i + width - i. That is, K = {M(0,0), ..., M(0,w-1), M(1,1), ..., M(1,w-1), ..., M(w-1,w-1) with w = width.

Reimplemented in mfem::MatrixFunctionCoefficient.

Definition at line 739 of file coefficient.hpp.

 int mfem::MatrixCoefficient::GetHeight ( ) const
inline

Get the height of the matrix.

Definition at line 716 of file coefficient.hpp.

 double mfem::MatrixCoefficient::GetTime ( )
inline

Get the time for time dependent coefficients.

Definition at line 713 of file coefficient.hpp.

 int mfem::MatrixCoefficient::GetVDim ( ) const
inline

For backward compatibility get the width of the matrix.

Definition at line 722 of file coefficient.hpp.

 int mfem::MatrixCoefficient::GetWidth ( ) const
inline

Get the width of the matrix.

Definition at line 719 of file coefficient.hpp.

 bool mfem::MatrixCoefficient::IsSymmetric ( ) const
inline

Definition at line 724 of file coefficient.hpp.

 void mfem::MatrixCoefficient::SetTime ( double t )
inline

Set the time for time dependent coefficients.

Definition at line 710 of file coefficient.hpp.

## Member Data Documentation

 int mfem::MatrixCoefficient::height
protected

Definition at line 696 of file coefficient.hpp.

 bool mfem::MatrixCoefficient::symmetric
protected

Definition at line 698 of file coefficient.hpp.

 double mfem::MatrixCoefficient::time
protected

Definition at line 697 of file coefficient.hpp.

 int mfem::MatrixCoefficient::width
protected

Definition at line 696 of file coefficient.hpp.

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