MFEM  v4.6.0
Finite element discretization library
Public Member Functions | List of all members
mfem::NormalizedVectorCoefficient Class Reference

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

#include <coefficient.hpp>

Inheritance diagram for mfem::NormalizedVectorCoefficient:
[legend]
Collaboration diagram for mfem::NormalizedVectorCoefficient:
[legend]

Public Member Functions

 NormalizedVectorCoefficient (VectorCoefficient &A, double tol=1e-6)
 Return a vector normalized to a length of one. More...
 
void SetTime (double t)
 Set the time for internally stored coefficients. More...
 
void SetACoef (VectorCoefficient &A)
 Reset the vector coefficient. More...
 
VectorCoefficientGetACoef () const
 Return the vector coefficient. 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 normalized vector field (returns v/|v|)

Definition at line 1886 of file coefficient.hpp.

Constructor & Destructor Documentation

◆ NormalizedVectorCoefficient()

mfem::NormalizedVectorCoefficient::NormalizedVectorCoefficient ( VectorCoefficient A,
double  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 1132 of file coefficient.cpp.

Member Function Documentation

◆ Eval() [1/3]

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

Evaluate the coefficient at ip.

Implements mfem::VectorCoefficient.

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

◆ GetACoef()

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

Return the vector coefficient.

Definition at line 1908 of file coefficient.hpp.

◆ SetACoef()

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

Reset the vector coefficient.

Definition at line 1906 of file coefficient.hpp.

◆ SetTime()

void mfem::NormalizedVectorCoefficient::SetTime ( double  t)
virtual

Set the time for internally stored coefficients.

Reimplemented from mfem::VectorCoefficient.

Definition at line 1137 of file coefficient.cpp.


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