MFEM  v4.1.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Attributes | List of all members
mfem::VectorCoefficient Class Referenceabstract

#include <coefficient.hpp>

Inherited by Deformation, mfem::CurlGridFunctionCoefficient, mfem::GradientGridFunctionCoefficient, mfem::internal::ShapeCoefficient, mfem::internal::VDotVShapeCoefficient, mfem::MatVecCoefficient, mfem::NodeExtrudeCoefficient, mfem::ScalarVectorProductCoefficient, mfem::VectorArrayCoefficient, mfem::VectorConstantCoefficient, mfem::VectorCrossProductCoefficient, mfem::VectorDeltaCoefficient, mfem::VectorFunctionCoefficient, mfem::VectorGridFunctionCoefficient, mfem::VectorRestrictedCoefficient, and mfem::VectorSumCoefficient.

Public Member Functions

 VectorCoefficient (int vd)
 
void SetTime (double t)
 
double GetTime ()
 
int GetVDim ()
 Returns dimension of the vector. More...
 
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...
 
virtual ~VectorCoefficient ()
 

Protected Attributes

int vdim
 
double time
 

Detailed Description

Definition at line 280 of file coefficient.hpp.

Constructor & Destructor Documentation

mfem::VectorCoefficient::VectorCoefficient ( int  vd)
inline

Definition at line 287 of file coefficient.hpp.

virtual mfem::VectorCoefficient::~VectorCoefficient ( )
inlinevirtual

Definition at line 318 of file coefficient.hpp.

Member Function Documentation

virtual void mfem::VectorCoefficient::Eval ( Vector V,
ElementTransformation T,
const IntegrationPoint ip 
)
pure 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).

Implemented in mfem::NodeExtrudeCoefficient, mfem::MatVecCoefficient, mfem::VectorCrossProductCoefficient, mfem::ScalarVectorProductCoefficient, mfem::VectorSumCoefficient, mfem::VectorRestrictedCoefficient, mfem::VectorDeltaCoefficient, mfem::CurlGridFunctionCoefficient, mfem::GradientGridFunctionCoefficient, mfem::VectorGridFunctionCoefficient, mfem::VectorArrayCoefficient, mfem::VectorFunctionCoefficient, and mfem::VectorConstantCoefficient.

void mfem::VectorCoefficient::Eval ( DenseMatrix M,
ElementTransformation T,
const IntegrationRule ir 
)
virtual

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.

Reimplemented in mfem::VectorRestrictedCoefficient, mfem::GradientGridFunctionCoefficient, and mfem::VectorGridFunctionCoefficient.

Definition at line 90 of file coefficient.cpp.

double mfem::VectorCoefficient::GetTime ( )
inline

Definition at line 290 of file coefficient.hpp.

int mfem::VectorCoefficient::GetVDim ( )
inline

Returns dimension of the vector.

Definition at line 293 of file coefficient.hpp.

void mfem::VectorCoefficient::SetTime ( double  t)
inline

Definition at line 289 of file coefficient.hpp.

Member Data Documentation

double mfem::VectorCoefficient::time
protected

Definition at line 284 of file coefficient.hpp.

int mfem::VectorCoefficient::vdim
protected

Definition at line 283 of file coefficient.hpp.


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