A general vector function coefficient. More...

#include <coefficient.hpp>

Inheritance diagram for mfem::VectorFunctionCoefficient:

Collaboration diagram for mfem::VectorFunctionCoefficient:

Public Member Functions
	VectorFunctionCoefficient (int dim, std::function< void(const Vector &, Vector &)> F, Coefficient *q=nullptr)
	Define a time-independent vector coefficient from a std function. More...

	VectorFunctionCoefficient (int dim, std::function< void(const Vector &, double, Vector &)> TDF, Coefficient *q=nullptr)
	Define a time-dependent vector coefficient from a std function. More...

virtual void	Eval (Vector &V, ElementTransformation &T, const IntegrationPoint &ip)
	Evaluate the vector coefficient at ip. More...

virtual	~VectorFunctionCoefficient ()

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

Additional Inherited Members
Protected Attributes inherited from mfem::VectorCoefficient
int	vdim

double	time

Detailed Description

A general vector function coefficient.

Definition at line 604 of file coefficient.hpp.

Constructor & Destructor Documentation

◆ VectorFunctionCoefficient() [1/2]

mfem::VectorFunctionCoefficient::VectorFunctionCoefficient	(	int	dim,
		std::function< void(const Vector &, Vector &)>	F,
		Coefficient *	q = `nullptr`
	)

inline

Define a time-independent vector coefficient from a std function.

Parameters

dim	- the size of the vector
F	- time-independent function
q	- optional scalar Coefficient to scale the vector coefficient

Definition at line 616 of file coefficient.hpp.

◆ VectorFunctionCoefficient() [2/2]

mfem::VectorFunctionCoefficient::VectorFunctionCoefficient	(	int	dim,
		std::function< void(const Vector &, double, Vector &)>	TDF,
		Coefficient *	q = `nullptr`
	)

inline

Define a time-dependent vector coefficient from a std function.

Parameters

dim	- the size of the vector
TDF	- time-dependent function
q	- optional scalar Coefficient to scale the vector coefficient

Definition at line 626 of file coefficient.hpp.

◆ ~VectorFunctionCoefficient()

virtual mfem::VectorFunctionCoefficient::~VectorFunctionCoefficient ( )

inlinevirtual

Definition at line 637 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::VectorFunctionCoefficient::Eval	(	Vector &	V,
		ElementTransformation &	T,
		const IntegrationPoint &	ip
	)

virtual

Evaluate the vector coefficient at ip.

Implements mfem::VectorCoefficient.

Definition at line 316 of file coefficient.cpp.

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

fem/coefficient.hpp
fem/coefficient.cpp

Public Member Functions

Additional Inherited Members