Vector coefficient defined by a scalar DeltaCoefficient and a constant vector direction. More...

#include <coefficient.hpp>

Inheritance diagram for mfem::VectorDeltaCoefficient:

Collaboration diagram for mfem::VectorDeltaCoefficient:

Public Member Functions
	VectorDeltaCoefficient (int vdim_)
	Construct with a vector of dimension vdim_.

	VectorDeltaCoefficient (const Vector &dir_)
	Construct with a Vector object representing the direction and a unit delta function centered at (0.0,0.0,0.0)

	VectorDeltaCoefficient (const Vector &dir_, real_t x, real_t s)
	Construct with a Vector object representing the direction and a delta function scaled by s and centered at (x,0.0,0.0)

	VectorDeltaCoefficient (const Vector &dir_, real_t x, real_t y, real_t s)
	Construct with a Vector object representing the direction and a delta function scaled by s and centered at (x,y,0.0)

	VectorDeltaCoefficient (const Vector &dir_, real_t x, real_t y, real_t z, real_t s)
	Construct with a Vector object representing the direction and a delta function scaled by s and centered at (x,y,z)

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

void	SetDeltaCoefficient (const DeltaCoefficient &d_)
	Replace the associated DeltaCoefficient with a new DeltaCoefficient.

DeltaCoefficient &	GetDeltaCoefficient ()
	Return the associated scalar DeltaCoefficient.

void	SetScale (real_t s)

void	SetDirection (const Vector &d_)

void	SetDeltaCenter (const Vector &center)

void	GetDeltaCenter (Vector &center)

virtual void	EvalDelta (Vector &V, ElementTransformation &T, const IntegrationPoint &ip)
	Return the specified direction vector multiplied by the value returned by DeltaCoefficient::EvalDelta() of the associated scalar DeltaCoefficient.

virtual void	Eval (Vector &V, ElementTransformation &T, const IntegrationPoint &ip)
	A VectorDeltaFunction cannot be evaluated. Calling this method will cause an MFEM error, terminating the application.

virtual	~VectorDeltaCoefficient ()

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

Protected Attributes
Vector	dir

DeltaCoefficient	d

Protected Attributes inherited from mfem::VectorCoefficient
int	vdim

real_t	time

Detailed Description

Vector coefficient defined by a scalar DeltaCoefficient and a constant vector direction.

WARNING this cannot be used as a normal coefficient. The usual Eval method is disabled.

Definition at line 943 of file coefficient.hpp.

Constructor & Destructor Documentation

◆ VectorDeltaCoefficient() [1/5]

mfem::VectorDeltaCoefficient::VectorDeltaCoefficient ( int vdim_ )

inline

Construct with a vector of dimension vdim_.

Definition at line 951 of file coefficient.hpp.

◆ VectorDeltaCoefficient() [2/5]

mfem::VectorDeltaCoefficient::VectorDeltaCoefficient ( const Vector & dir_ )

inline

Construct with a Vector object representing the direction and a unit delta function centered at (0.0,0.0,0.0)

Definition at line 956 of file coefficient.hpp.

◆ VectorDeltaCoefficient() [3/5]

mfem::VectorDeltaCoefficient::VectorDeltaCoefficient	(	const Vector &	dir_,
		real_t	x,
		real_t	s )

inline

Construct with a Vector object representing the direction and a delta function scaled by s and centered at (x,0.0,0.0)

Definition at line 961 of file coefficient.hpp.

◆ VectorDeltaCoefficient() [4/5]

mfem::VectorDeltaCoefficient::VectorDeltaCoefficient	(	const Vector &	dir_,
		real_t	x,
		real_t	y,
		real_t	s )

inline

Construct with a Vector object representing the direction and a delta function scaled by s and centered at (x,y,0.0)

Definition at line 966 of file coefficient.hpp.

◆ VectorDeltaCoefficient() [5/5]

mfem::VectorDeltaCoefficient::VectorDeltaCoefficient	(	const Vector &	dir_,
		real_t	x,
		real_t	y,
		real_t	z,
		real_t	s )

inline

Construct with a Vector object representing the direction and a delta function scaled by s and centered at (x,y,z)

Definition at line 971 of file coefficient.hpp.

◆ ~VectorDeltaCoefficient()

virtual mfem::VectorDeltaCoefficient::~VectorDeltaCoefficient ( )

inlinevirtual

Definition at line 1004 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 from mfem::VectorCoefficient.

Definition at line 605 of file coefficient.cpp.

◆ Eval() [2/2]

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

inlinevirtual

A VectorDeltaFunction cannot be evaluated. Calling this method will cause an MFEM error, terminating the application.

Implements mfem::VectorCoefficient.

Definition at line 1001 of file coefficient.hpp.

◆ EvalDelta()

void mfem::VectorDeltaCoefficient::EvalDelta	(	Vector &	V,
		ElementTransformation &	T,
		const IntegrationPoint &	ip )

virtual

Return the specified direction vector multiplied by the value returned by DeltaCoefficient::EvalDelta() of the associated scalar DeltaCoefficient.

Definition at line 584 of file coefficient.cpp.

◆ GetDeltaCenter()

void mfem::VectorDeltaCoefficient::GetDeltaCenter ( Vector & center )

inline

Definition at line 990 of file coefficient.hpp.

◆ GetDeltaCoefficient()

DeltaCoefficient & mfem::VectorDeltaCoefficient::GetDeltaCoefficient ( )

inline

Return the associated scalar DeltaCoefficient.

Definition at line 984 of file coefficient.hpp.

◆ SetDeltaCenter()

void mfem::VectorDeltaCoefficient::SetDeltaCenter ( const Vector & center )

inline

Definition at line 989 of file coefficient.hpp.

◆ SetDeltaCoefficient()

void mfem::VectorDeltaCoefficient::SetDeltaCoefficient ( const DeltaCoefficient & d_ )

inline

Replace the associated DeltaCoefficient with a new DeltaCoefficient.

The new DeltaCoefficient cannot have a specified weight Coefficient, i.e. DeltaCoefficient::Weight() should return NULL.

Definition at line 981 of file coefficient.hpp.

◆ SetDirection()

void mfem::VectorDeltaCoefficient::SetDirection ( const Vector & d_ )

Definition at line 578 of file coefficient.cpp.

◆ SetScale()

void mfem::VectorDeltaCoefficient::SetScale ( real_t s )

inline

Definition at line 986 of file coefficient.hpp.

◆ SetTime()

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

virtual

Set the time for internally stored coefficients.

Reimplemented from mfem::VectorCoefficient.

Definition at line 572 of file coefficient.cpp.

Member Data Documentation

◆ d

DeltaCoefficient mfem::VectorDeltaCoefficient::d

protected

Definition at line 947 of file coefficient.hpp.

◆ dir

Vector mfem::VectorDeltaCoefficient::dir

protected

Definition at line 946 of file coefficient.hpp.

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

fem/coefficient.hpp
fem/coefficient.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VectorDeltaCoefficient() [1/5]

◆ VectorDeltaCoefficient() [2/5]

◆ VectorDeltaCoefficient() [3/5]

◆ VectorDeltaCoefficient() [4/5]

◆ VectorDeltaCoefficient() [5/5]

◆ ~VectorDeltaCoefficient()

Member Function Documentation

◆ Eval() [1/2]

◆ Eval() [2/2]

◆ EvalDelta()

◆ GetDeltaCenter()

◆ GetDeltaCoefficient()

◆ SetDeltaCenter()

◆ SetDeltaCoefficient()

◆ SetDirection()

◆ SetScale()

◆ SetTime()

Member Data Documentation

◆ d

◆ dir