ablate::mathFunctions::FunctionPointer Class Reference

Inheritance diagram for ablate::mathFunctions::FunctionPointer:

Public Member Functions
	FunctionPointer (ablate::mathFunctions::PetscFunction function, void *context=nullptr)
double	Eval (const double &x, const double &y, const double &z, const double &t) const override
double	Eval (const double *xyz, const int &ndims, const double &t) const override
void	Eval (const double &x, const double &y, const double &z, const double &t, std::vector< double > &result) const override
void	Eval (const double *xyz, const int &ndims, const double &t, std::vector< double > &result) const override
ablate::mathFunctions::PetscFunction	GetPetscFunction () override
void *	GetContext () override
Public Member Functions inherited from ablate::mathFunctions::MathFunction
virtual	~MathFunction ()=default

Member Function Documentation

Eval() [1/4]

double ablate::mathFunctions::FunctionPointer::Eval ( const double &  x, const double &  y, const double &  z, const double &  t  ) const

overridevirtual

Return a single double value

Parameters

x
y
z
t

Returns

Implements ablate::mathFunctions::MathFunction.

Eval() [2/4]

void ablate::mathFunctions::FunctionPointer::Eval ( const double &  x, const double &  y, const double &  z, const double &  t, std::vector< double > &  result  ) const

overridevirtual

Populate a result array

Parameters

x
y
z
t
result

Implements ablate::mathFunctions::MathFunction.

Eval() [3/4]

double ablate::mathFunctions::FunctionPointer::Eval ( const double *  xyz, const int &  ndims, const double &  t  ) const

overridevirtual

Return a single double value based upon an xyz array

Parameters

xyz
ndims
t

Returns

Implements ablate::mathFunctions::MathFunction.

Eval() [4/4]

void ablate::mathFunctions::FunctionPointer::Eval ( const double *  xyz, const int &  ndims, const double &  t, std::vector< double > &  result  ) const

overridevirtual

Populate a result array based upon an xyz array

Parameters

xyz
ndims
t
result

Implements ablate::mathFunctions::MathFunction.

GetContext()

void* ablate::mathFunctions::FunctionPointer::GetContext ( )

inlineoverridevirtual

Return a context for petsc style functions

Returns

Implements ablate::mathFunctions::MathFunction.

GetPetscFunction()

ablate::mathFunctions::PetscFunction ablate::mathFunctions::FunctionPointer::GetPetscFunction ( )

inlineoverridevirtual

Return a raw petsc style function to evaluate this math function

Returns

Implements ablate::mathFunctions::MathFunction.

---

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

• src/mathFunctions/functionPointer.hpp
• src/mathFunctions/functionPointer.cpp