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

Vector coefficient defined as the Curl of a vector GridFunction. More...

#include <coefficient.hpp>

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

Public Member Functions

 CurlGridFunctionCoefficient (const GridFunction *gf)
 Construct the coefficient with a vector grid function gf. The grid function is not owned by the coefficient. More...
 
void SetGridFunction (const GridFunction *gf)
 Set the vector grid function. More...
 
const GridFunctionGetGridFunction () const
 Get the vector grid function. More...
 
virtual void Eval (Vector &V, ElementTransformation &T, const IntegrationPoint &ip)
 Evaluate the vector curl coefficient at ip. More...
 
virtual ~CurlGridFunctionCoefficient ()
 
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 void Project (QuadratureFunction &qf)
 Fill the QuadratureFunction qf by evaluating the coefficient at the quadrature points. More...
 
virtual ~VectorCoefficient ()
 

Protected Attributes

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

Detailed Description

Vector coefficient defined as the Curl of a vector GridFunction.

Definition at line 756 of file coefficient.hpp.

Constructor & Destructor Documentation

◆ CurlGridFunctionCoefficient()

mfem::CurlGridFunctionCoefficient::CurlGridFunctionCoefficient ( const GridFunction gf)

Construct the coefficient with a vector grid function gf. The grid function is not owned by the coefficient.

Definition at line 472 of file coefficient.cpp.

◆ ~CurlGridFunctionCoefficient()

virtual mfem::CurlGridFunctionCoefficient::~CurlGridFunctionCoefficient ( )
inlinevirtual

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

◆ Eval() [3/3]

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

Evaluate the vector curl coefficient at ip.

Implements mfem::VectorCoefficient.

Definition at line 484 of file coefficient.cpp.

◆ GetGridFunction()

const GridFunction* mfem::CurlGridFunctionCoefficient::GetGridFunction ( ) const
inline

Get the vector grid function.

Definition at line 770 of file coefficient.hpp.

◆ SetGridFunction()

void mfem::CurlGridFunctionCoefficient::SetGridFunction ( const GridFunction gf)

Set the vector grid function.

Definition at line 479 of file coefficient.cpp.

Member Data Documentation

◆ GridFunc

const GridFunction* mfem::CurlGridFunctionCoefficient::GridFunc
protected

Definition at line 759 of file coefficient.hpp.


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