MFEM  v4.5.2 Finite element discretization library
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:
[legend]
Collaboration diagram for mfem::SymmetricMatrixFunctionCoefficient:
[legend]

## 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. More...

SymmetricMatrixFunctionCoefficient (const DenseSymmetricMatrix &m, Coefficient &q)
Define a constant matrix coefficient times a scalar Coefficient. More...

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

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

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

virtual ~SymmetricMatrixFunctionCoefficient ()

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

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

Public Member Functions inherited from mfem::SymmetricMatrixCoefficient
SymmetricMatrixCoefficient (int dimension)
Construct a dim x dim matrix coefficient. More...

int GetSize () const
Get the size of the matrix. More...

Fill the QuadratureFunction qf by evaluating the coefficient at the quadrature points. More...

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

const DenseSymmetricMatrixGetMatrix ()
Return a reference to the constant matrix. More...

virtual ~SymmetricMatrixCoefficient ()

Public Member Functions inherited from mfem::MatrixCoefficient
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...

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

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

virtual ~MatrixCoefficient ()

Protected Attributes inherited from mfem::SymmetricMatrixCoefficient
DenseSymmetricMatrix mat
Internal matrix used when evaluating this coefficient as a DenseMatrix. More...

Protected Attributes inherited from mfem::MatrixCoefficient
int height

int width

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

## ◆ 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 1374 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 1383 of file coefficient.hpp.

## ◆ SymmetricMatrixFunctionCoefficient() [3/3]

 mfem::SymmetricMatrixFunctionCoefficient::SymmetricMatrixFunctionCoefficient ( int dim, std::function< void(const Vector &, double, 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 1392 of file coefficient.hpp.

## ◆ ~SymmetricMatrixFunctionCoefficient()

 virtual mfem::SymmetricMatrixFunctionCoefficient::~SymmetricMatrixFunctionCoefficient ( )
inlinevirtual

Definition at line 1406 of file coefficient.hpp.

## ◆ Eval() [1/3]

 virtual void mfem::SymmetricMatrixCoefficient::Eval

Evaluate the matrix coefficient in the element described by T at the point ip, storing the result as a symmetric matrix 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).

## ◆ Eval() [2/3]

 void mfem::SymmetricMatrixCoefficient::Eval

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

Definition at line 778 of file coefficient.cpp.

## ◆ Eval() [3/3]

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

Evaluate the matrix coefficient at ip.

Implements mfem::SymmetricMatrixCoefficient.

Definition at line 798 of file coefficient.cpp.

## ◆ SetTime()

 void mfem::SymmetricMatrixFunctionCoefficient::SetTime ( double t )
virtual

Set the time for internally stored coefficients.

Reimplemented from mfem::MatrixCoefficient.

Definition at line 792 of file coefficient.cpp.

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