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

Vector quadrature function coefficient which requires that the quadrature rules used for this vector coefficient be the same as those that live within the supplied QuadratureFunction. More...

#include <coefficient.hpp>

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

Public Member Functions

 VectorQuadratureFunctionCoefficient (QuadratureFunction &qf)
 Constructor with a quadrature function as input. More...
 
void SetComponent (int index_, int length_)
 
const QuadratureFunctionGetQuadFunction () const
 
virtual void Eval (Vector &V, ElementTransformation &T, const IntegrationPoint &ip)
 Evaluate the vector coefficient in the element described by T at the point ip, storing the result in V. More...
 
virtual void Project (QuadratureFunction &qf)
 Fill the QuadratureFunction qf by evaluating the coefficient at the quadrature points. More...
 
virtual ~VectorQuadratureFunctionCoefficient ()
 
virtual void Eval (Vector &V, ElementTransformation &T, const IntegrationPoint &ip)=0
 Evaluate the vector coefficient in the element described by T at the point ip, storing the result in V. More...
 
virtual void Eval (DenseMatrix &M, ElementTransformation &T, const IntegrationRule &ir)
 Evaluate the vector coefficient in the element described by T at all points of ir, storing the result in M. More...
 
- Public Member Functions inherited from mfem::VectorCoefficient
 VectorCoefficient (int vd)
 Initialize the VectorCoefficient with vector dimension vd. More...
 
virtual void SetTime (double t)
 Set the time for time dependent coefficients. More...
 
double GetTime ()
 Get the time for time dependent coefficients. More...
 
int GetVDim ()
 Returns dimension of the vector. More...
 
virtual void Eval (DenseMatrix &M, ElementTransformation &T, const IntegrationRule &ir)
 Evaluate the vector coefficient in the element described by T at all points of ir, storing the result in M. More...
 
virtual ~VectorCoefficient ()
 

Additional Inherited Members

- Protected Attributes inherited from mfem::VectorCoefficient
int vdim
 
double time
 

Detailed Description

Vector quadrature function coefficient which requires that the quadrature rules used for this vector coefficient be the same as those that live within the supplied QuadratureFunction.

Definition at line 2240 of file coefficient.hpp.

Constructor & Destructor Documentation

◆ VectorQuadratureFunctionCoefficient()

mfem::VectorQuadratureFunctionCoefficient::VectorQuadratureFunctionCoefficient ( QuadratureFunction qf)

Constructor with a quadrature function as input.

Definition at line 1570 of file coefficient.cpp.

◆ ~VectorQuadratureFunctionCoefficient()

virtual mfem::VectorQuadratureFunctionCoefficient::~VectorQuadratureFunctionCoefficient ( )
inlinevirtual

Definition at line 2263 of file coefficient.hpp.

Member Function Documentation

◆ Eval() [1/3]

virtual void mfem::VectorCoefficient::Eval

Evaluate the vector coefficient in the element described by T at the point ip, storing the result in V.

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::VectorCoefficient::Eval

Evaluate the vector coefficient in the element described by T at all points of ir, storing the result in M.

The dimensions of M are GetVDim() by ir.GetNPoints() and they must be set by the implementation of this method.

The general implementation provided by the base class (using the Eval method for one IntegrationPoint at a time) can be overloaded for more efficient implementation.

Note
The IntegrationPoint associated with T is not used, and this method will generally modify this IntegrationPoint associated with T.

Definition at line 265 of file coefficient.cpp.

◆ Eval() [3/3]

void mfem::VectorQuadratureFunctionCoefficient::Eval ( Vector V,
ElementTransformation T,
const IntegrationPoint ip 
)
virtual

Evaluate the vector coefficient in the element described by T at the point ip, storing the result in V.

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

Implements mfem::VectorCoefficient.

Definition at line 1588 of file coefficient.cpp.

◆ GetQuadFunction()

const QuadratureFunction& mfem::VectorQuadratureFunctionCoefficient::GetQuadFunction ( ) const
inline

Definition at line 2255 of file coefficient.hpp.

◆ Project()

void mfem::VectorQuadratureFunctionCoefficient::Project ( QuadratureFunction qf)
virtual

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

The vdim of the VectorCoefficient should be equal to the vdim of the QuadratureFunction.

Reimplemented from mfem::VectorCoefficient.

Definition at line 1615 of file coefficient.cpp.

◆ SetComponent()

void mfem::VectorQuadratureFunctionCoefficient::SetComponent ( int  index_,
int  length_ 
)

Set the starting index within the QuadFunc that'll be used to project outwards as well as the corresponding length. The projected length should have the bounds of 1 <= length <= (length QuadFunc - index).

Definition at line 1574 of file coefficient.cpp.


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