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::VectorFunctionCoefficient Class Reference

A general vector function coefficient. More...

#include <coefficient.hpp>

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

Public Member Functions

 VectorFunctionCoefficient (int dim, std::function< void(const Vector &, Vector &)> F, Coefficient *q=nullptr)
 Define a time-independent vector coefficient from a std function. More...
 
 VectorFunctionCoefficient (int dim, std::function< void(const Vector &, double, Vector &)> TDF, Coefficient *q=nullptr)
 Define a time-dependent vector coefficient from a std function. More...
 
virtual void Eval (Vector &V, ElementTransformation &T, const IntegrationPoint &ip)
 Evaluate the vector coefficient at ip. More...
 
virtual ~VectorFunctionCoefficient ()
 
- 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

A general vector function coefficient.

Definition at line 408 of file coefficient.hpp.

Constructor & Destructor Documentation

mfem::VectorFunctionCoefficient::VectorFunctionCoefficient ( int  dim,
std::function< void(const Vector &, Vector &)>  F,
Coefficient q = nullptr 
)
inline

Define a time-independent vector coefficient from a std function.

Parameters
dim- the size of the vector
F- time-independent function
q- optional scalar Coefficient to scale the vector coefficient

Definition at line 420 of file coefficient.hpp.

mfem::VectorFunctionCoefficient::VectorFunctionCoefficient ( int  dim,
std::function< void(const Vector &, double, Vector &)>  TDF,
Coefficient q = nullptr 
)
inline

Define a time-dependent vector coefficient from a std function.

Parameters
dim- the size of the vector
TDF- time-dependent function
q- optional scalar Coefficient to scale the vector coefficient

Definition at line 430 of file coefficient.hpp.

virtual mfem::VectorFunctionCoefficient::~VectorFunctionCoefficient ( )
inlinevirtual

Definition at line 441 of file coefficient.hpp.

Member Function Documentation

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

Evaluate the vector coefficient at ip.

Implements mfem::VectorCoefficient.

Definition at line 104 of file coefficient.cpp.


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