mfem::FunctionCoefficient Class Reference

A general function coefficient. More...

#include <coefficient.hpp>

Inheritance diagram for mfem::FunctionCoefficient:

Collaboration diagram for mfem::FunctionCoefficient:

Public Member Functions
	FunctionCoefficient (std::function< double(const Vector &)> F)
	Define a time-independent coefficient from a std function. More...
	FunctionCoefficient (std::function< double(const Vector &, double)> TDF)
	Define a time-dependent coefficient from a std function. More...
MFEM_DEPRECATED	FunctionCoefficient (double(*f)(Vector &))
	(DEPRECATED) Define a time-independent coefficient from a C-function More...
MFEM_DEPRECATED	FunctionCoefficient (double(*tdf)(Vector &, double))
	(DEPRECATED) Define a time-dependent coefficient from a C-function More...
virtual double	Eval (ElementTransformation &T, const IntegrationPoint &ip)
	Evaluate the coefficient at ip. More...
Public Member Functions inherited from mfem::Coefficient
	Coefficient ()
virtual void	SetTime (double t)
	Set the time for time dependent coefficients. More...
double	GetTime ()
	Get the time for time dependent coefficients. More...
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 void	Project (QuadratureFunction &qf)
	Fill the QuadratureFunction qf by evaluating the coefficient at the quadrature points. More...
virtual	~Coefficient ()

Protected Attributes
std::function< double(const Vector &)>	Function
std::function< double(const Vector &, double)>	TDFunction
Protected Attributes inherited from mfem::Coefficient
double	time

Detailed Description

A general function coefficient.

Definition at line 219 of file coefficient.hpp.

Constructor & Destructor Documentation

FunctionCoefficient() [1/4]

mfem::FunctionCoefficient::FunctionCoefficient ( std::function< double(const Vector &)>  F )

inline

Define a time-independent coefficient from a std function.

Parameters

F	time-independent std::function

Definition at line 228 of file coefficient.hpp.

FunctionCoefficient() [2/4]

mfem::FunctionCoefficient::FunctionCoefficient ( std::function< double(const Vector &, double)>  TDF )

inline

Define a time-dependent coefficient from a std function.

Parameters

TDF	time-dependent function

Definition at line 234 of file coefficient.hpp.

FunctionCoefficient() [3/4]

MFEM_DEPRECATED mfem::FunctionCoefficient::FunctionCoefficient ( double(*)(Vector &)  f )

inline

(DEPRECATED) Define a time-independent coefficient from a C-function

Deprecated:

Use the method where the C-function, f, uses a const Vector argument instead of Vector.

Definition at line 241 of file coefficient.hpp.

FunctionCoefficient() [4/4]

MFEM_DEPRECATED mfem::FunctionCoefficient::FunctionCoefficient ( double(*)(Vector &, double)  tdf )

inline

(DEPRECATED) Define a time-dependent coefficient from a C-function

Deprecated:

Use the method where the C-function, tdf, uses a const Vector argument instead of Vector.

Definition at line 250 of file coefficient.hpp.

Member Function Documentation

Eval()

double mfem::FunctionCoefficient::Eval ( ElementTransformation &  T, const IntegrationPoint &  ip  )

virtual

Evaluate the coefficient at ip.

Implements mfem::Coefficient.

Definition at line 129 of file coefficient.cpp.

Member Data Documentation

Function

std::function<double(const Vector &)> mfem::FunctionCoefficient::Function

protected

Definition at line 222 of file coefficient.hpp.

TDFunction

std::function<double(const Vector &, double)> mfem::FunctionCoefficient::TDFunction

protected

Definition at line 223 of file coefficient.hpp.

---

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

• fem/coefficient.hpp
• fem/coefficient.cpp