mfem::MatrixCoefficient Class Reference

#include <coefficient.hpp>

Inheritance diagram for mfem::MatrixCoefficient:

Public Member Functions
	MatrixCoefficient (int dim, bool symm=false)
	Construct a dim x dim matrix coefficient.
	MatrixCoefficient (int h, int w, bool symm=false)
	Construct a h x w matrix coefficient.
virtual void	SetTime (real_t t)
	Set the time for time dependent coefficients.
real_t	GetTime ()
	Get the time for time dependent coefficients.
int	GetHeight () const
	Get the height of the matrix.
int	GetWidth () const
	Get the width of the matrix.
int	GetVDim () const
	For backward compatibility get the width of the matrix.
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.
virtual void	Project (QuadratureFunction &qf, bool transpose=false)
	Fill the QuadratureFunction qf by evaluating the coefficient at the quadrature points. The matrix will be transposed or not according to the boolean argument transpose.
virtual void	EvalSymmetric (Vector &K, ElementTransformation &T, const IntegrationPoint &ip)
	(DEPRECATED) Evaluate a symmetric matrix coefficient.
virtual	~MatrixCoefficient ()

Protected Attributes
int	height
int	width
real_t	time
bool	symmetric

Detailed Description

Base class for matrix-valued coefficients that optionally depend on time and space.

Definition at line 1060 of file coefficient.hpp.

Constructor & Destructor Documentation

MatrixCoefficient() [1/2]

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

inlineexplicit

Construct a dim x dim matrix coefficient.

Definition at line 1069 of file coefficient.hpp.

MatrixCoefficient() [2/2]

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

inline

Construct a h x w matrix coefficient.

Definition at line 1073 of file coefficient.hpp.

~MatrixCoefficient()

virtual mfem::MatrixCoefficient::~MatrixCoefficient ( )

inlinevirtual

Definition at line 1124 of file coefficient.hpp.

Member Function Documentation

Eval()

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).

Implemented in HessianCoefficient, HRHessianCoefficient, mfem::CrossCrossCoefficient, mfem::ExponentialMatrixCoefficient, mfem::IdentityMatrixCoefficient, mfem::InverseMatrixCoefficient, mfem::MatrixArrayCoefficient, mfem::MatrixArrayVectorCoefficient, mfem::MatrixConstantCoefficient, mfem::MatrixFunctionCoefficient, mfem::MatrixProductCoefficient, mfem::MatrixRestrictedCoefficient, mfem::MatrixSumCoefficient, mfem::OuterProductCoefficient, mfem::PmlMatrixCoefficient, mfem::PWMatrixCoefficient, mfem::ScalarMatrixProductCoefficient, mfem::SymmetricMatrixCoefficient, mfem::SymmetricMatrixConstantCoefficient, mfem::SymmetricMatrixFunctionCoefficient, and mfem::TransposeMatrixCoefficient.

EvalSymmetric()

virtual void mfem::MatrixCoefficient::EvalSymmetric ( Vector & K, ElementTransformation & T, const IntegrationPoint & ip )

inlinevirtual

(DEPRECATED) Evaluate a symmetric matrix coefficient.

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.

Deprecated

Use Eval() instead.

Reimplemented in mfem::MatrixFunctionCoefficient.

Definition at line 1120 of file coefficient.hpp.

GetHeight()

int mfem::MatrixCoefficient::GetHeight ( ) const

inline

Get the height of the matrix.

Definition at line 1083 of file coefficient.hpp.

GetTime()

real_t mfem::MatrixCoefficient::GetTime ( )

inline

Get the time for time dependent coefficients.

Definition at line 1080 of file coefficient.hpp.

GetVDim()

int mfem::MatrixCoefficient::GetVDim ( ) const

inline

For backward compatibility get the width of the matrix.

Definition at line 1089 of file coefficient.hpp.

GetWidth()

int mfem::MatrixCoefficient::GetWidth ( ) const

inline

Get the width of the matrix.

Definition at line 1086 of file coefficient.hpp.

IsSymmetric()

bool mfem::MatrixCoefficient::IsSymmetric ( ) const

inline

Deprecated

Use SymmetricMatrixCoefficient instead

Definition at line 1092 of file coefficient.hpp.

Project()

void mfem::MatrixCoefficient::Project ( QuadratureFunction & qf, bool transpose = false )

virtual

Fill the QuadratureFunction qf by evaluating the coefficient at the quadrature points. The matrix will be transposed or not according to the boolean argument transpose.

The stored entries use the same row/column convention as Eval(), unless transpose == true, in which case K^T is stored instead.

The vdim of the QuadratureFunction should be equal to the height times the width of the matrix.

Definition at line 696 of file coefficient.cpp.

SetTime()

virtual void mfem::MatrixCoefficient::SetTime ( real_t t )

inlinevirtual

Set the time for time dependent coefficients.

Reimplemented in mfem::CrossCrossCoefficient, mfem::ExponentialMatrixCoefficient, mfem::InverseMatrixCoefficient, mfem::MatrixArrayCoefficient, mfem::MatrixArrayVectorCoefficient, mfem::MatrixFunctionCoefficient, mfem::MatrixRestrictedCoefficient, mfem::MatrixSumCoefficient, mfem::OuterProductCoefficient, mfem::PWMatrixCoefficient, mfem::ScalarMatrixProductCoefficient, mfem::SymmetricMatrixFunctionCoefficient, and mfem::TransposeMatrixCoefficient.

Definition at line 1077 of file coefficient.hpp.

Member Data Documentation

height

int mfem::MatrixCoefficient::height

protected

Definition at line 1063 of file coefficient.hpp.

symmetric

bool mfem::MatrixCoefficient::symmetric

protected

Definition at line 1065 of file coefficient.hpp.

time

real_t mfem::MatrixCoefficient::time

protected

Definition at line 1064 of file coefficient.hpp.

width

int mfem::MatrixCoefficient::width

protected

Definition at line 1063 of file coefficient.hpp.

---

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

• fem/coefficient.hpp
• fem/coefficient.cpp