MFEM v4.7.0 Finite element discretization library
Searching...
No Matches
mfem::MatrixFunctionCoefficient 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::MatrixFunctionCoefficient:
[legend]
Collaboration diagram for mfem::MatrixFunctionCoefficient:
[legend]

## Public Member Functions

MatrixFunctionCoefficient (int dim, std::function< void(const Vector &, DenseMatrix &)> F, Coefficient *q=nullptr)
Define a time-independent square matrix coefficient from a std function.

MatrixFunctionCoefficient (const DenseMatrix &m, Coefficient &q)
Define a constant matrix coefficient times a scalar Coefficient.

MatrixFunctionCoefficient (int dim, std::function< void(const Vector &, Vector &)> SymmF, Coefficient *q=NULL)
Define a time-independent symmetric square matrix coefficient from a std function.

MatrixFunctionCoefficient (int dim, std::function< void(const Vector &, real_t, DenseMatrix &)> TDF, Coefficient *q=nullptr)
Define a time-dependent square matrix coefficient from a std function.

void SetTime (real_t t)
Set the time for internally stored coefficients.

virtual void Eval (DenseMatrix &K, ElementTransformation &T, const IntegrationPoint &ip)
Evaluate the matrix coefficient at ip.

virtual void EvalSymmetric (Vector &K, ElementTransformation &T, const IntegrationPoint &ip)
(DEPRECATED) Evaluate the symmetric matrix coefficient at ip.

virtual ~MatrixFunctionCoefficient ()

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 ~MatrixCoefficient ()

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 1232 of file coefficient.hpp.

## ◆ MatrixFunctionCoefficient() [1/4]

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

Define a time-independent square 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 1247 of file coefficient.hpp.

## ◆ MatrixFunctionCoefficient() [2/4]

 mfem::MatrixFunctionCoefficient::MatrixFunctionCoefficient ( const DenseMatrix & 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 1256 of file coefficient.hpp.

## ◆ MatrixFunctionCoefficient() [3/4]

 mfem::MatrixFunctionCoefficient::MatrixFunctionCoefficient ( int dim, std::function< void(const Vector &, Vector &)> SymmF, Coefficient * q = NULL )
inline

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

Parameters
 dim - the size of the matrix SymmF - function used in EvalSymmetric q - optional scalar Coefficient to scale the matrix coefficient
Deprecated
Use another constructor without setting SymmFunction.

Definition at line 1266 of file coefficient.hpp.

## ◆ MatrixFunctionCoefficient() [4/4]

 mfem::MatrixFunctionCoefficient::MatrixFunctionCoefficient ( int dim, std::function< void(const Vector &, real_t, DenseMatrix &)> 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 1276 of file coefficient.hpp.

## ◆ ~MatrixFunctionCoefficient()

 virtual mfem::MatrixFunctionCoefficient::~MatrixFunctionCoefficient ( )
inlinevirtual

Definition at line 1294 of file coefficient.hpp.

## ◆ Eval()

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

Evaluate the matrix coefficient at ip.

Implements mfem::MatrixCoefficient.

Definition at line 723 of file coefficient.cpp.

## ◆ EvalSymmetric()

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

(DEPRECATED) Evaluate the symmetric matrix coefficient at ip.

Deprecated

Reimplemented from mfem::MatrixCoefficient.

Definition at line 778 of file coefficient.cpp.

## ◆ SetTime()

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

Set the time for internally stored coefficients.

Reimplemented from mfem::MatrixCoefficient.

Definition at line 717 of file coefficient.cpp.

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