MFEM  v4.3.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
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 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...
 
- Public Member Functions inherited from mfem::VectorCoefficient
 VectorCoefficient (int vd)
 Initialize the VectorCoefficient with vector dimension vd. More...
 
void SetTime (double t)
 Set the time for time dependent coefficients. 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 ~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 1366 of file coefficient.hpp.

Constructor & Destructor Documentation

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 579 of file coefficient.cpp.

Member Function Documentation

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

Evaluate the coefficient at ip.

Implements mfem::VectorCoefficient.

Definition at line 584 of file coefficient.cpp.

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

Return the vector coefficient.

Definition at line 1385 of file coefficient.hpp.

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

Reset the vector coefficient.

Definition at line 1383 of file coefficient.hpp.


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