MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
mfem::ScalarMatrixProductCoefficient Class Reference

Matrix coefficient defined as a product of a scalar coefficient and a matrix coefficient. More...

#include <coefficient.hpp>

Inheritance diagram for mfem::ScalarMatrixProductCoefficient:
[legend]
Collaboration diagram for mfem::ScalarMatrixProductCoefficient:
[legend]

Public Member Functions

 ScalarMatrixProductCoefficient (real_t A, MatrixCoefficient &B)
 Constructor with one coefficient. Result is A*B.
 
 ScalarMatrixProductCoefficient (Coefficient &A, MatrixCoefficient &B)
 Constructor with two coefficients. Result is A*B.
 
void SetTime (real_t t)
 Set the time for internally stored coefficients.
 
void SetAConst (real_t A)
 Reset the scalar factor as a constant.
 
real_t GetAConst () const
 Return the scalar factor.
 
void SetACoef (Coefficient &A)
 Reset the scalar factor.
 
CoefficientGetACoef () const
 Return the scalar factor.
 
void SetBCoef (MatrixCoefficient &B)
 Reset the matrix factor.
 
MatrixCoefficientGetBCoef () const
 Return the matrix factor.
 
virtual void Eval (DenseMatrix &M, ElementTransformation &T, const IntegrationPoint &ip)
 Evaluate the matrix coefficient at ip.
 
- 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::MatrixCoefficient
int height
 
int width
 
real_t time
 
bool symmetric
 

Detailed Description

Matrix coefficient defined as a product of a scalar coefficient and a matrix coefficient.

Definition at line 2078 of file coefficient.hpp.

Constructor & Destructor Documentation

◆ ScalarMatrixProductCoefficient() [1/2]

mfem::ScalarMatrixProductCoefficient::ScalarMatrixProductCoefficient ( real_t A,
MatrixCoefficient & B )

Constructor with one coefficient. Result is A*B.

Definition at line 1261 of file coefficient.cpp.

◆ ScalarMatrixProductCoefficient() [2/2]

mfem::ScalarMatrixProductCoefficient::ScalarMatrixProductCoefficient ( Coefficient & A,
MatrixCoefficient & B )

Constructor with two coefficients. Result is A*B.

Definition at line 1267 of file coefficient.cpp.

Member Function Documentation

◆ Eval()

void mfem::ScalarMatrixProductCoefficient::Eval ( DenseMatrix & M,
ElementTransformation & T,
const IntegrationPoint & ip )
virtual

Evaluate the matrix coefficient at ip.

Implements mfem::MatrixCoefficient.

Definition at line 1280 of file coefficient.cpp.

◆ GetACoef()

Coefficient * mfem::ScalarMatrixProductCoefficient::GetACoef ( ) const
inline

Return the scalar factor.

Definition at line 2103 of file coefficient.hpp.

◆ GetAConst()

real_t mfem::ScalarMatrixProductCoefficient::GetAConst ( ) const
inline

Return the scalar factor.

Definition at line 2098 of file coefficient.hpp.

◆ GetBCoef()

MatrixCoefficient * mfem::ScalarMatrixProductCoefficient::GetBCoef ( ) const
inline

Return the matrix factor.

Definition at line 2108 of file coefficient.hpp.

◆ SetACoef()

void mfem::ScalarMatrixProductCoefficient::SetACoef ( Coefficient & A)
inline

Reset the scalar factor.

Definition at line 2101 of file coefficient.hpp.

◆ SetAConst()

void mfem::ScalarMatrixProductCoefficient::SetAConst ( real_t A)
inline

Reset the scalar factor as a constant.

Definition at line 2096 of file coefficient.hpp.

◆ SetBCoef()

void mfem::ScalarMatrixProductCoefficient::SetBCoef ( MatrixCoefficient & B)
inline

Reset the matrix factor.

Definition at line 2106 of file coefficient.hpp.

◆ SetTime()

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

Set the time for internally stored coefficients.

Reimplemented from mfem::MatrixCoefficient.

Definition at line 1273 of file coefficient.cpp.


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