Vector coefficient defined as a normalized vector field (returns v/|v|) More...

#include <coefficient.hpp>

Inheritance diagram for mfem::NormalizedVectorCoefficient:

Collaboration diagram for mfem::NormalizedVectorCoefficient:

Public Member Functions
	NormalizedVectorCoefficient (VectorCoefficient &A, real_t tol=1e-6)
	Return a vector normalized to a length of one.

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

void	SetACoef (VectorCoefficient &A)
	Reset the vector coefficient.

VectorCoefficient *	GetACoef () const
	Return the 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 a normalized vector field (returns v/|v|)

Definition at line 1975 of file coefficient.hpp.

Constructor & Destructor Documentation

◆ NormalizedVectorCoefficient()

mfem::NormalizedVectorCoefficient::NormalizedVectorCoefficient	(	VectorCoefficient &	A,
		real_t	tol = 1e-6 )

Return a vector normalized to a length of one.

This class evaluates the vector coefficient A and, if |A| > tol, returns the normalized vector A / |A|. If |A| <= tol, the zero vector is returned.

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

overridevirtual

Evaluate the coefficient at ip.

Implements mfem::VectorCoefficient.

Definition at line 1233 of file coefficient.cpp.

◆ GetACoef()

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

inline

Return the vector coefficient.

Definition at line 1997 of file coefficient.hpp.

◆ SetACoef()

void mfem::NormalizedVectorCoefficient::SetACoef ( VectorCoefficient & A )

inline

Reset the vector coefficient.

Definition at line 1995 of file coefficient.hpp.

◆ SetTime()

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

overridevirtual

Set the time for internally stored coefficients.