Vector coefficient defined as the linear combination of two vectors. More...

#include <coefficient.hpp>

Inheritance diagram for mfem::VectorSumCoefficient:

Collaboration diagram for mfem::VectorSumCoefficient:

Public Member Functions
	VectorSumCoefficient (int dim)

	VectorSumCoefficient (VectorCoefficient &A, VectorCoefficient &B, real_t alpha_=1.0, real_t beta_=1.0)

	VectorSumCoefficient (VectorCoefficient &A_, VectorCoefficient &B_, Coefficient &alpha_, Coefficient &beta_)

void	SetTime (real_t t) override
	Set the time for internally stored coefficients.

void	SetACoef (VectorCoefficient &A_)
	Reset the first vector coefficient.

VectorCoefficient *	GetACoef () const
	Return the first vector coefficient.

void	SetBCoef (VectorCoefficient &B_)
	Reset the second vector coefficient.

VectorCoefficient *	GetBCoef () const
	Return the second vector coefficient.

void	SetAlphaCoef (Coefficient &A_)
	Reset the factor in front of the first vector coefficient.

Coefficient *	GetAlphaCoef () const
	Return the factor in front of the first vector coefficient.

void	SetBetaCoef (Coefficient &B_)
	Reset the factor in front of the second vector coefficient.

Coefficient *	GetBetaCoef () const
	Return the factor in front of the second vector coefficient.

void	SetA (const Vector &A_)
	Reset the first vector as a constant.

const Vector &	GetA () const
	Return the first vector constant.

void	SetB (const Vector &B_)
	Reset the second vector as a constant.

const Vector &	GetB () const
	Return the second vector constant.

void	SetAlpha (real_t alpha_)
	Reset the factor in front of the first vector coefficient as a constant.

real_t	GetAlpha () const
	Return the factor in front of the first vector coefficient.

void	SetBeta (real_t beta_)
	Reset the factor in front of the second vector coefficient as a constant.

real_t	GetBeta () const
	Return the factor in front of the second vector coefficient.

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 the linear combination of two vectors.

Definition at line 1854 of file coefficient.hpp.

Constructor & Destructor Documentation

◆ VectorSumCoefficient() [1/3]

mfem::VectorSumCoefficient::VectorSumCoefficient ( int dim )

Constructor with no coefficients. To be used with the various "Set" methods

Definition at line 1134 of file coefficient.cpp.

◆ VectorSumCoefficient() [2/3]

mfem::VectorSumCoefficient::VectorSumCoefficient	(	VectorCoefficient &	A,
		VectorCoefficient &	B,
		real_t	alpha_ = 1.0,
		real_t	beta_ = 1.0 )

Constructor with two vector coefficients. Result is alpha_ * A + beta_ * B

Definition at line 1144 of file coefficient.cpp.

◆ VectorSumCoefficient() [3/3]

mfem::VectorSumCoefficient::VectorSumCoefficient	(	VectorCoefficient &	A_,
		VectorCoefficient &	B_,
		Coefficient &	alpha_,
		Coefficient &	beta_ )

Constructor with scalar coefficients. Result is alpha_ * A_ + beta_ * B_

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

overridevirtual

Evaluate the coefficient at ip.

Implements mfem::VectorCoefficient.

Definition at line 1184 of file coefficient.cpp.

◆ GetA()

const Vector & mfem::VectorSumCoefficient::GetA ( ) const

inline

Return the first vector constant.

Definition at line 1912 of file coefficient.hpp.

◆ GetACoef()

VectorCoefficient * mfem::VectorSumCoefficient::GetACoef ( ) const

inline

Return the first vector coefficient.

Definition at line 1892 of file coefficient.hpp.

◆ GetAlpha()

real_t mfem::VectorSumCoefficient::GetAlpha ( ) const

inline

Return the factor in front of the first vector coefficient.

Definition at line 1922 of file coefficient.hpp.

◆ GetAlphaCoef()

Coefficient * mfem::VectorSumCoefficient::GetAlphaCoef ( ) const

inline

Return the factor in front of the first vector coefficient.

Definition at line 1902 of file coefficient.hpp.

◆ GetB()

const Vector & mfem::VectorSumCoefficient::GetB ( ) const

inline

Return the second vector constant.

Definition at line 1917 of file coefficient.hpp.

◆ GetBCoef()

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

inline

Return the second vector coefficient.

Definition at line 1897 of file coefficient.hpp.

◆ GetBeta()

real_t mfem::VectorSumCoefficient::GetBeta ( ) const

inline

Return the factor in front of the second vector coefficient.

Definition at line 1927 of file coefficient.hpp.

◆ GetBetaCoef()

Coefficient * mfem::VectorSumCoefficient::GetBetaCoef ( ) const

inline

Return the factor in front of the second vector coefficient.

Definition at line 1907 of file coefficient.hpp.

◆ SetA()

void mfem::VectorSumCoefficient::SetA ( const Vector & A_ )

inline

Reset the first vector as a constant.

Definition at line 1910 of file coefficient.hpp.

◆ SetACoef()

void mfem::VectorSumCoefficient::SetACoef ( VectorCoefficient & A_ )

inline

Reset the first vector coefficient.

Definition at line 1890 of file coefficient.hpp.

◆ SetAlpha()

void mfem::VectorSumCoefficient::SetAlpha ( real_t alpha_ )

inline

Reset the factor in front of the first vector coefficient as a constant.

Definition at line 1920 of file coefficient.hpp.

◆ SetAlphaCoef()

void mfem::VectorSumCoefficient::SetAlphaCoef ( Coefficient & A_ )

inline

Reset the factor in front of the first vector coefficient.

Definition at line 1900 of file coefficient.hpp.

◆ SetB()

void mfem::VectorSumCoefficient::SetB ( const Vector & B_ )

inline

Reset the second vector as a constant.

Definition at line 1915 of file coefficient.hpp.

◆ SetBCoef()

void mfem::VectorSumCoefficient::SetBCoef ( VectorCoefficient & B_ )

inline

Reset the second vector coefficient.

Definition at line 1895 of file coefficient.hpp.

◆ SetBeta()

void mfem::VectorSumCoefficient::SetBeta ( real_t beta_ )

inline

Reset the factor in front of the second vector coefficient as a constant.

Definition at line 1925 of file coefficient.hpp.

◆ SetBetaCoef()

void mfem::VectorSumCoefficient::SetBetaCoef ( Coefficient & B_ )

inline

Reset the factor in front of the second vector coefficient.

Definition at line 1905 of file coefficient.hpp.

◆ SetTime()

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

overridevirtual

Set the time for internally stored coefficients.

Reimplemented from mfem::VectorCoefficient.

Definition at line 1175 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

Detailed Description

Constructor & Destructor Documentation

◆ VectorSumCoefficient() [1/3]

◆ VectorSumCoefficient() [2/3]

◆ VectorSumCoefficient() [3/3]

Member Function Documentation

◆ Eval() [1/2]

◆ Eval() [2/2]

◆ GetA()

◆ GetACoef()

◆ GetAlpha()

◆ GetAlphaCoef()

◆ GetB()

◆ GetBCoef()

◆ GetBeta()

◆ GetBetaCoef()

◆ SetA()

◆ SetACoef()

◆ SetAlpha()

◆ SetAlphaCoef()

◆ SetB()

◆ SetBCoef()

◆ SetBeta()

◆ SetBetaCoef()

◆ SetTime()