mfem::ScalarVectorProductCoefficient Class Reference

Vector coefficient defined as a product of scalar and vector coefficients. More...

#include <coefficient.hpp>

Inheritance diagram for mfem::ScalarVectorProductCoefficient:

Collaboration diagram for mfem::ScalarVectorProductCoefficient:

Public Member Functions
	ScalarVectorProductCoefficient (double A, VectorCoefficient &B)
	Constructor with constant and vector coefficient. Result is A * B. More...
	ScalarVectorProductCoefficient (Coefficient &A, VectorCoefficient &B)
	Constructor with two coefficients. Result is A * B. More...
void	SetTime (double t)
	Set the time for internally stored coefficients. More...
void	SetAConst (double A)
	Reset the scalar factor as a constant. More...
double	GetAConst () const
	Return the scalar factor. More...
void	SetACoef (Coefficient &A)
	Reset the scalar factor. More...
Coefficient *	GetACoef () const
	Return the scalar factor. More...
void	SetBCoef (VectorCoefficient &B)
	Reset the vector factor. More...
VectorCoefficient *	GetBCoef () const
	Return the vector factor. More...
virtual void	Eval (Vector &V, ElementTransformation &T, const IntegrationPoint &ip)
	Evaluate the coefficient at ip. 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...
Public Member Functions inherited from mfem::VectorCoefficient
	VectorCoefficient (int vd)
	Initialize the VectorCoefficient with vector dimension vd. 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

Vector coefficient defined as a product of scalar and vector coefficients.

Definition at line 1713 of file coefficient.hpp.

Constructor & Destructor Documentation

ScalarVectorProductCoefficient() [1/2]

mfem::ScalarVectorProductCoefficient::ScalarVectorProductCoefficient	(	double	A,
		VectorCoefficient &	B
	)

Constructor with constant and vector coefficient. Result is A * B.

Definition at line 1055 of file coefficient.cpp.

ScalarVectorProductCoefficient() [2/2]

mfem::ScalarVectorProductCoefficient::ScalarVectorProductCoefficient	(	Coefficient &	A,
		VectorCoefficient &	B
	)

Constructor with two coefficients. Result is A * B.

Definition at line 1061 of file coefficient.cpp.

Member Function Documentation

Eval() [1/3]

void mfem::ScalarVectorProductCoefficient::Eval ( Vector &  V, ElementTransformation &  T, const IntegrationPoint &  ip  )

virtual

Evaluate the coefficient at ip.

Implements mfem::VectorCoefficient.

Definition at line 1074 of file coefficient.cpp.

Eval() [2/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() [3/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.

GetACoef()

Coefficient* mfem::ScalarVectorProductCoefficient::GetACoef ( ) const

inline

Return the scalar factor.

Definition at line 1738 of file coefficient.hpp.

GetAConst()

double mfem::ScalarVectorProductCoefficient::GetAConst ( ) const

inline

Return the scalar factor.

Definition at line 1733 of file coefficient.hpp.

GetBCoef()

VectorCoefficient* mfem::ScalarVectorProductCoefficient::GetBCoef ( ) const

inline

Return the vector factor.

Definition at line 1743 of file coefficient.hpp.

SetACoef()

void mfem::ScalarVectorProductCoefficient::SetACoef ( Coefficient &  A )

inline

Reset the scalar factor.

Definition at line 1736 of file coefficient.hpp.

SetAConst()

void mfem::ScalarVectorProductCoefficient::SetAConst ( double  A )

inline

Reset the scalar factor as a constant.

Definition at line 1731 of file coefficient.hpp.

SetBCoef()

void mfem::ScalarVectorProductCoefficient::SetBCoef ( VectorCoefficient &  B )

inline

Reset the vector factor.

Definition at line 1741 of file coefficient.hpp.

SetTime()

void mfem::ScalarVectorProductCoefficient::SetTime ( double  t )

virtual

Set the time for internally stored coefficients.

Reimplemented from mfem::VectorCoefficient.

Definition at line 1067 of file coefficient.cpp.

---

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

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