MFEM  v4.5.2
Finite element discretization library
Public Member Functions | List of all members
mfem::CrossCrossCoefficient Class Reference

Matrix coefficient defined as -a k x k x, for a vector k and scalar a. More...

#include <coefficient.hpp>

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

Public Member Functions

 CrossCrossCoefficient (double A, VectorCoefficient &K)
 
 CrossCrossCoefficient (Coefficient &A, VectorCoefficient &K)
 
void SetTime (double t)
 Set the time for internally stored coefficients. More...
 
void SetAConst (double A)
 Reset the scalar factor as a constant. More...
 
double GetAConst () const
 Return the scalar factor. More...
 
void SetACoef (Coefficient &A)
 Reset the scalar factor. More...
 
CoefficientGetACoef () const
 Return the scalar factor. More...
 
void SetKCoef (VectorCoefficient &K)
 Reset the vector factor. More...
 
VectorCoefficientGetKCoef () const
 Return the vector factor. More...
 
virtual void Eval (DenseMatrix &M, ElementTransformation &T, const IntegrationPoint &ip)
 Evaluate the matrix coefficient at ip. More...
 
- 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 ()
 

Additional Inherited Members

- Protected Attributes inherited from mfem::MatrixCoefficient
int height
 
int width
 
double time
 
bool symmetric
 

Detailed Description

Matrix coefficient defined as -a k x k x, for a vector k and scalar a.

This coefficient returns \(a * (|k|^2 I - k \otimes k)\), where I is the identity matrix and \(\otimes\) indicates the outer product. This can be evaluated for vectors of any dimension but in three dimensions it corresponds to computing the cross product with k twice.

Definition at line 2066 of file coefficient.hpp.

Constructor & Destructor Documentation

◆ CrossCrossCoefficient() [1/2]

mfem::CrossCrossCoefficient::CrossCrossCoefficient ( double  A,
VectorCoefficient K 
)

Definition at line 1307 of file coefficient.cpp.

◆ CrossCrossCoefficient() [2/2]

mfem::CrossCrossCoefficient::CrossCrossCoefficient ( Coefficient A,
VectorCoefficient K 
)

Definition at line 1312 of file coefficient.cpp.

Member Function Documentation

◆ Eval()

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

Evaluate the matrix coefficient at ip.

Implements mfem::MatrixCoefficient.

Definition at line 1325 of file coefficient.cpp.

◆ GetACoef()

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

Return the scalar factor.

Definition at line 2090 of file coefficient.hpp.

◆ GetAConst()

double mfem::CrossCrossCoefficient::GetAConst ( ) const
inline

Return the scalar factor.

Definition at line 2085 of file coefficient.hpp.

◆ GetKCoef()

VectorCoefficient* mfem::CrossCrossCoefficient::GetKCoef ( ) const
inline

Return the vector factor.

Definition at line 2095 of file coefficient.hpp.

◆ SetACoef()

void mfem::CrossCrossCoefficient::SetACoef ( Coefficient A)
inline

Reset the scalar factor.

Definition at line 2088 of file coefficient.hpp.

◆ SetAConst()

void mfem::CrossCrossCoefficient::SetAConst ( double  A)
inline

Reset the scalar factor as a constant.

Definition at line 2083 of file coefficient.hpp.

◆ SetKCoef()

void mfem::CrossCrossCoefficient::SetKCoef ( VectorCoefficient K)
inline

Reset the vector factor.

Definition at line 2093 of file coefficient.hpp.

◆ SetTime()

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

Set the time for internally stored coefficients.

Reimplemented from mfem::MatrixCoefficient.

Definition at line 1318 of file coefficient.cpp.


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