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 (real_t A, VectorCoefficient &B)
	Constructor with constant and vector coefficient. Result is A * B.
	ScalarVectorProductCoefficient (Coefficient &A, VectorCoefficient &B)
	Constructor with two coefficients. Result is A * B.
void	SetTime (real_t t) override
	Set the time for internally stored coefficients.
void	SetAConst (real_t A)
	Reset the scalar factor as a constant.
real_t	GetAConst () const
	Return the scalar factor.
void	SetACoef (Coefficient &A)
	Reset the scalar factor.
Coefficient *	GetACoef () const
	Return the scalar factor.
void	SetBCoef (VectorCoefficient &B)
	Reset the vector factor.
VectorCoefficient *	GetBCoef () const
	Return the vector factor.
void	Eval (Vector &V, ElementTransformation &T, const IntegrationPoint &ip) override
	Evaluate the coefficient at ip.
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.
Public Member Functions inherited from mfem::VectorCoefficient
	VectorCoefficient (int vd)
	Initialize the VectorCoefficient with vector dimension vd.
real_t	GetTime ()
	Get the time for time dependent coefficients.
int	GetVDim ()
	Returns dimension of the vector.
virtual void	Project (QuadratureFunction &qf)
	Fill the QuadratureFunction qf by evaluating the coefficient at the quadrature points.
virtual	~VectorCoefficient ()

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

Detailed Description

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

Definition at line 1936 of file coefficient.hpp.

Constructor & Destructor Documentation

ScalarVectorProductCoefficient() [1/2]

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

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

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

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 from mfem::VectorCoefficient.

Definition at line 605 of file coefficient.cpp.

Eval() [2/2]

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

overridevirtual

Evaluate the coefficient at ip.

Implements mfem::VectorCoefficient.

Definition at line 1214 of file coefficient.cpp.

GetACoef()

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

inline

Return the scalar factor.

Definition at line 1961 of file coefficient.hpp.

GetAConst()

real_t mfem::ScalarVectorProductCoefficient::GetAConst ( ) const

inline

Return the scalar factor.

Definition at line 1956 of file coefficient.hpp.

GetBCoef()

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

inline

Return the vector factor.

Definition at line 1966 of file coefficient.hpp.

SetACoef()

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

inline

Reset the scalar factor.

Definition at line 1959 of file coefficient.hpp.

SetAConst()

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

inline

Reset the scalar factor as a constant.

Definition at line 1954 of file coefficient.hpp.

SetBCoef()

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

inline

Reset the vector factor.

Definition at line 1964 of file coefficient.hpp.

SetTime()

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

overridevirtual

Set the time for internally stored coefficients.

Reimplemented from mfem::VectorCoefficient.

Definition at line 1207 of file coefficient.cpp.

---

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

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