mfem::VectorCoefficient Class Reference

Base class for vector Coefficients that optionally depend on time and space. More...

#include <coefficient.hpp>

Inheritance diagram for mfem::VectorCoefficient:

Public Member Functions
	VectorCoefficient (int vd)
	Initialize the VectorCoefficient with vector dimension vd.
virtual void	SetTime (real_t t)
	Set the time for time dependent coefficients.
real_t	GetTime ()
	Get the time for time dependent coefficients.
int	GetVDim ()
	Returns dimension of the vector.
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.
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.
virtual void	Project (QuadratureFunction &qf)
	Fill the QuadratureFunction qf by evaluating the coefficient at the quadrature points.
virtual	~VectorCoefficient ()

Protected Attributes
int	vdim
real_t	time

Detailed Description

Base class for vector Coefficients that optionally depend on time and space.

Definition at line 566 of file coefficient.hpp.

Constructor & Destructor Documentation

VectorCoefficient()

mfem::VectorCoefficient::VectorCoefficient ( int vd )

inline

Initialize the VectorCoefficient with vector dimension vd.

Definition at line 574 of file coefficient.hpp.

~VectorCoefficient()

virtual mfem::VectorCoefficient::~VectorCoefficient ( )

inlinevirtual

Definition at line 615 of file coefficient.hpp.

Member Function Documentation

Eval() [1/2]

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 Dist_Vector_Coefficient, mfem::common::KershawTransformation, mfem::common::NormalizedGradCoefficient, mfem::common::SpiralTransformation, mfem::CurlGridFunctionCoefficient, mfem::GradientGridFunctionCoefficient, mfem::LevelSetNormalGradCoeff, mfem::MatrixVectorProductCoefficient, mfem::NodeExtrudeCoefficient, mfem::NormalizedVectorCoefficient, mfem::PositionVectorCoefficient, mfem::PWVectorCoefficient, mfem::ScalarVectorProductCoefficient, mfem::ShiftedVectorFunctionCoefficient, mfem::VectorArrayCoefficient, mfem::VectorConstantCoefficient, mfem::VectorCrossProductCoefficient, mfem::VectorDeltaCoefficient, mfem::VectorFunctionCoefficient, mfem::VectorGridFunctionCoefficient, mfem::VectorQuadratureFunctionCoefficient, mfem::VectorRestrictedCoefficient, mfem::VectorSumCoefficient, and mfem::VolumeForceCoefficient.

Definition at line 265 of file coefficient.cpp.

Eval() [2/2]

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 Dist_Vector_Coefficient, mfem::common::KershawTransformation, mfem::common::NormalizedGradCoefficient, mfem::common::SpiralTransformation, mfem::CurlGridFunctionCoefficient, mfem::GradientGridFunctionCoefficient, mfem::LevelSetNormalGradCoeff, mfem::MatrixVectorProductCoefficient, mfem::NodeExtrudeCoefficient, mfem::NormalizedVectorCoefficient, mfem::PositionVectorCoefficient, mfem::PWVectorCoefficient, mfem::ScalarVectorProductCoefficient, mfem::ShiftedVectorFunctionCoefficient, mfem::VectorArrayCoefficient, mfem::VectorConstantCoefficient, mfem::VectorCrossProductCoefficient, mfem::VectorDeltaCoefficient, mfem::VectorFunctionCoefficient, mfem::VectorGridFunctionCoefficient, mfem::VectorQuadratureFunctionCoefficient, mfem::VectorRestrictedCoefficient, mfem::VectorSumCoefficient, and mfem::VolumeForceCoefficient.

GetTime()

real_t mfem::VectorCoefficient::GetTime ( )

inline

Get the time for time dependent coefficients.

Definition at line 580 of file coefficient.hpp.

GetVDim()

int mfem::VectorCoefficient::GetVDim ( )

inline

Returns dimension of the vector.

Definition at line 583 of file coefficient.hpp.

Project()

void mfem::VectorCoefficient::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 in mfem::VectorGridFunctionCoefficient, and mfem::VectorQuadratureFunctionCoefficient.

Definition at line 279 of file coefficient.cpp.

SetTime()

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

inlinevirtual

Set the time for time dependent coefficients.

Reimplemented in mfem::MatrixVectorProductCoefficient, mfem::NormalizedVectorCoefficient, mfem::PWVectorCoefficient, mfem::ScalarVectorProductCoefficient, mfem::VectorArrayCoefficient, mfem::VectorCrossProductCoefficient, mfem::VectorDeltaCoefficient, mfem::VectorRestrictedCoefficient, and mfem::VectorSumCoefficient.

Definition at line 577 of file coefficient.hpp.

Member Data Documentation

time

real_t mfem::VectorCoefficient::time

protected

Definition at line 570 of file coefficient.hpp.

vdim

int mfem::VectorCoefficient::vdim

protected

Definition at line 569 of file coefficient.hpp.

---

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

• fem/coefficient.hpp
• fem/coefficient.cpp