mfem::SymmetricMatrixFunctionCoefficient Class Reference

A matrix coefficient with an optional scalar coefficient multiplier q. The matrix function can either be represented by a std function or a constant matrix provided when constructing this object.
More...

#include <coefficient.hpp>

Inheritance diagram for mfem::SymmetricMatrixFunctionCoefficient:

Collaboration diagram for mfem::SymmetricMatrixFunctionCoefficient:

Public Member Functions
	SymmetricMatrixFunctionCoefficient (int dim, std::function< void(const Vector &, DenseSymmetricMatrix &)> F, Coefficient *q=nullptr)
	Define a time-independent symmetric matrix coefficient from a std function.
	SymmetricMatrixFunctionCoefficient (const DenseSymmetricMatrix &m, Coefficient &q)
	Define a constant matrix coefficient times a scalar Coefficient.
	SymmetricMatrixFunctionCoefficient (int dim, std::function< void(const Vector &, real_t, DenseSymmetricMatrix &)> TDF, Coefficient *q=nullptr)
	Define a time-dependent square matrix coefficient from a std function.
void	SetTime (real_t t) override
	Set the time for internally stored coefficients.
void	Eval (DenseSymmetricMatrix &K, ElementTransformation &T, const IntegrationPoint &ip) override
	Evaluate the matrix coefficient at ip.
virtual	~SymmetricMatrixFunctionCoefficient ()
void	Eval (DenseMatrix &K, ElementTransformation &T, const IntegrationPoint &ip) override
	Evaluate the matrix coefficient in the element described by T at the point ip, storing the result as a dense matrix K.
Public Member Functions inherited from mfem::SymmetricMatrixCoefficient
	SymmetricMatrixCoefficient (int dimension)
	Construct a dim x dim matrix coefficient.
int	GetSize () const
	Get the size of the matrix.
virtual void	ProjectSymmetric (QuadratureFunction &qf)
	Fill the QuadratureFunction qf by evaluating the coefficient at the quadrature points.
MFEM_DEPRECATED const DenseSymmetricMatrix &	GetMatrix ()
virtual	~SymmetricMatrixCoefficient ()
Public Member Functions inherited from mfem::MatrixCoefficient
	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.
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	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 ()

Additional Inherited Members
Protected Attributes inherited from mfem::SymmetricMatrixCoefficient
DenseSymmetricMatrix	mat_aux
	Internal matrix used when evaluating this coefficient as a DenseMatrix.
Protected Attributes inherited from mfem::MatrixCoefficient
int	height
int	width
real_t	time
bool	symmetric

Detailed Description

A matrix coefficient with an optional scalar coefficient multiplier q. The matrix function can either be represented by a std function or a constant matrix provided when constructing this object.

Definition at line 1558 of file coefficient.hpp.

Constructor & Destructor Documentation

SymmetricMatrixFunctionCoefficient() [1/3]

mfem::SymmetricMatrixFunctionCoefficient::SymmetricMatrixFunctionCoefficient ( int dim, std::function< void(const Vector &, DenseSymmetricMatrix &)> F, Coefficient * q = nullptr )

inline

Define a time-independent symmetric matrix coefficient from a std function.

Parameters

dim	- the size of the matrix
F	- time-independent function
q	- optional scalar Coefficient to scale the matrix coefficient

Definition at line 1572 of file coefficient.hpp.

SymmetricMatrixFunctionCoefficient() [2/3]

mfem::SymmetricMatrixFunctionCoefficient::SymmetricMatrixFunctionCoefficient ( const DenseSymmetricMatrix & m, Coefficient & q )

inline

Define a constant matrix coefficient times a scalar Coefficient.

Parameters

m	- constant matrix
q	- optional scalar Coefficient to scale the matrix coefficient

Definition at line 1581 of file coefficient.hpp.

SymmetricMatrixFunctionCoefficient() [3/3]

mfem::SymmetricMatrixFunctionCoefficient::SymmetricMatrixFunctionCoefficient ( int dim, std::function< void(const Vector &, real_t, DenseSymmetricMatrix &)> TDF, Coefficient * q = nullptr )

inline

Define a time-dependent square matrix coefficient from a std function.

Parameters

dim	- the size of the matrix
TDF	- time-dependent function
q	- optional scalar Coefficient to scale the matrix coefficient

Definition at line 1590 of file coefficient.hpp.

~SymmetricMatrixFunctionCoefficient()

virtual mfem::SymmetricMatrixFunctionCoefficient::~SymmetricMatrixFunctionCoefficient ( )

inlinevirtual

Definition at line 1604 of file coefficient.hpp.

Member Function Documentation

Eval() [1/2]

void mfem::SymmetricMatrixCoefficient::Eval ( DenseMatrix & K, ElementTransformation & T, const IntegrationPoint & ip )

overridevirtual

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

This function allows the use of SymmetricMatrixCoefficient in situations where the symmetry is not taken advantage of.

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

Reimplemented from mfem::SymmetricMatrixCoefficient.

Definition at line 1523 of file coefficient.cpp.

Eval() [2/2]

void mfem::SymmetricMatrixFunctionCoefficient::Eval ( DenseSymmetricMatrix & K, ElementTransformation & T, const IntegrationPoint & ip )

overridevirtual

Evaluate the matrix coefficient at ip.

Implements mfem::SymmetricMatrixCoefficient.

Definition at line 848 of file coefficient.cpp.

SetTime()

void mfem::SymmetricMatrixFunctionCoefficient::SetTime ( real_t t )

overridevirtual

Set the time for internally stored coefficients.

Reimplemented from mfem::MatrixCoefficient.

Definition at line 842 of file coefficient.cpp.

---

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

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