MFEM  v4.4.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
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 ()
 
- Public Member Functions inherited from mfem::SymmetricMatrixCoefficient
 SymmetricMatrixCoefficient (int dimension)
 Construct a dim x dim matrix coefficient. More...
 
double GetTime ()
 Get the time for time dependent coefficients. More...
 
int GetSize () const
 Get the size of the matrix. More...
 
virtual ~SymmetricMatrixCoefficient ()
 

Additional Inherited Members

- Protected Attributes inherited from mfem::SymmetricMatrixCoefficient
int dim
 
double time
 

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

Constructor & Destructor Documentation

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

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

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

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

Definition at line 1347 of file coefficient.hpp.

Member Function Documentation

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

Evaluate the matrix coefficient at ip.

Implements mfem::SymmetricMatrixCoefficient.

Definition at line 678 of file coefficient.cpp.

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

Set the time for internally stored coefficients.

Reimplemented from mfem::SymmetricMatrixCoefficient.

Definition at line 672 of file coefficient.cpp.


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