MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
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 (real_t A, VectorCoefficient &K)
 
 CrossCrossCoefficient (Coefficient &A, VectorCoefficient &K)
 
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 SetKCoef (VectorCoefficient &K)
 Reset the vector factor.
 
VectorCoefficientGetKCoef () const
 Return the vector 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 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 2200 of file coefficient.hpp.

Constructor & Destructor Documentation

◆ CrossCrossCoefficient() [1/2]

mfem::CrossCrossCoefficient::CrossCrossCoefficient ( real_t A,
VectorCoefficient & K )

Definition at line 1357 of file coefficient.cpp.

◆ CrossCrossCoefficient() [2/2]

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

Definition at line 1362 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 1375 of file coefficient.cpp.

◆ GetACoef()

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

Return the scalar factor.

Definition at line 2224 of file coefficient.hpp.

◆ GetAConst()

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

Return the scalar factor.

Definition at line 2219 of file coefficient.hpp.

◆ GetKCoef()

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

Return the vector factor.

Definition at line 2229 of file coefficient.hpp.

◆ SetACoef()

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

Reset the scalar factor.

Definition at line 2222 of file coefficient.hpp.

◆ SetAConst()

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

Reset the scalar factor as a constant.

Definition at line 2217 of file coefficient.hpp.

◆ SetKCoef()

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

Reset the vector factor.

Definition at line 2227 of file coefficient.hpp.

◆ SetTime()

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

Set the time for internally stored coefficients.

Reimplemented from mfem::MatrixCoefficient.

Definition at line 1368 of file coefficient.cpp.


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