MFEM  v4.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
mfem::GridFunctionCoefficient Class Reference

Coefficient defined by a GridFunction. This coefficient is mesh dependent. More...

#include <coefficient.hpp>

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

Public Member Functions

 GridFunctionCoefficient ()
 
 GridFunctionCoefficient (GridFunction *gf, int comp=1)
 
void SetGridFunction (GridFunction *gf)
 
GridFunctionGetGridFunction () const
 
virtual double Eval (ElementTransformation &T, const IntegrationPoint &ip)
 Evaluate the coefficient in the element described by T at the point ip. More...
 
- Public Member Functions inherited from mfem::Coefficient
 Coefficient ()
 
void SetTime (double t)
 
double GetTime ()
 
double Eval (ElementTransformation &T, const IntegrationPoint &ip, double t)
 Evaluate the coefficient in the element described by T at the point ip at time t. More...
 
virtual ~Coefficient ()
 

Additional Inherited Members

- Protected Attributes inherited from mfem::Coefficient
double time
 

Detailed Description

Coefficient defined by a GridFunction. This coefficient is mesh dependent.

Definition at line 164 of file coefficient.hpp.

Constructor & Destructor Documentation

mfem::GridFunctionCoefficient::GridFunctionCoefficient ( )
inline

Definition at line 171 of file coefficient.hpp.

mfem::GridFunctionCoefficient::GridFunctionCoefficient ( GridFunction gf,
int  comp = 1 
)
inline

Construct GridFunctionCoefficient from a given GridFunction, and optionally specify a component to use if it is a vector GridFunction.

Definition at line 174 of file coefficient.hpp.

Member Function Documentation

double mfem::GridFunctionCoefficient::Eval ( ElementTransformation T,
const IntegrationPoint ip 
)
virtual

Evaluate the coefficient in the element described by T at the point ip.

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

Implements mfem::Coefficient.

Reimplemented in mfem::electromagnetics::ScaledGFCoefficient.

Definition at line 49 of file coefficient.cpp.

GridFunction* mfem::GridFunctionCoefficient::GetGridFunction ( ) const
inline

Definition at line 178 of file coefficient.hpp.

void mfem::GridFunctionCoefficient::SetGridFunction ( GridFunction gf)
inline

Definition at line 177 of file coefficient.hpp.


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