ABLATE Source Documentation  0.12.36
Public Member Functions | List of all members
ablate::mathFunctions::MathFunction Class Referenceabstract

#include <mathFunction.hpp>

+ Inheritance diagram for ablate::mathFunctions::MathFunction:

Public Member Functions

virtual double Eval (const double &x, const double &y, const double &z, const double &t) const =0
 
virtual double Eval (const double *xyz, const int &ndims, const double &t) const =0
 
virtual void Eval (const double &x, const double &y, const double &z, const double &t, std::vector< double > &result) const =0
 
virtual void Eval (const double *xyz, const int &ndims, const double &t, std::vector< double > &result) const =0
 
virtual PetscFunction GetPetscFunction ()=0
 
virtual void * GetContext ()=0
 
virtual ~MathFunction ()=default
 

Detailed Description

Shared interface for all "math" style functions

Constructor & Destructor Documentation

◆ ~MathFunction()

virtual ablate::mathFunctions::MathFunction::~MathFunction ( )
virtualdefault

provide hook to allow math functions to cleanup

Member Function Documentation

◆ Eval() [1/4]

virtual double ablate::mathFunctions::MathFunction::Eval ( const double &  x,
const double &  y,
const double &  z,
const double &  t 
) const
pure virtual

Return a single double value

Parameters
x
y
z
t
Returns

Implemented in ablate::mathFunctions::SimpleFormula, ablate::mathFunctions::Peak, ablate::mathFunctions::ParsedSeries, ablate::mathFunctions::NearestPoint, ablate::mathFunctions::LinearTable, ablate::mathFunctions::LinearFunction, ablate::mathFunctions::Linear, ablate::mathFunctions::geom::Geometry, ablate::mathFunctions::FunctionWrapper, ablate::mathFunctions::FunctionPointer, ablate::mathFunctions::Formula, ablate::mathFunctions::ConstantValue, and ablate::domain::Hdf5Initializer::Hdf5MathFunction.

◆ Eval() [2/4]

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

Populate a result array

Parameters
x
y
z
t
result

Implemented in ablate::mathFunctions::SimpleFormula, ablate::mathFunctions::Peak, ablate::mathFunctions::ParsedSeries, ablate::mathFunctions::NearestPoint, ablate::mathFunctions::LinearTable, ablate::mathFunctions::LinearFunction, ablate::mathFunctions::Linear, ablate::mathFunctions::geom::Geometry, ablate::mathFunctions::FunctionWrapper, ablate::mathFunctions::FunctionPointer, ablate::mathFunctions::Formula, ablate::mathFunctions::ConstantValue, and ablate::domain::Hdf5Initializer::Hdf5MathFunction.

◆ Eval() [3/4]

virtual double ablate::mathFunctions::MathFunction::Eval ( const double *  xyz,
const int &  ndims,
const double &  t 
) const
pure virtual

Return a single double value based upon an xyz array

Parameters
xyz
ndims
t
Returns

Implemented in ablate::mathFunctions::SimpleFormula, ablate::mathFunctions::Peak, ablate::mathFunctions::ParsedSeries, ablate::mathFunctions::NearestPoint, ablate::mathFunctions::LinearTable, ablate::mathFunctions::LinearFunction, ablate::mathFunctions::Linear, ablate::mathFunctions::geom::Geometry, ablate::mathFunctions::FunctionWrapper, ablate::mathFunctions::FunctionPointer, ablate::mathFunctions::Formula, ablate::mathFunctions::ConstantValue, and ablate::domain::Hdf5Initializer::Hdf5MathFunction.

◆ Eval() [4/4]

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

Populate a result array based upon an xyz array

Parameters
xyz
ndims
t
result

Implemented in ablate::mathFunctions::SimpleFormula, ablate::mathFunctions::Peak, ablate::mathFunctions::ParsedSeries, ablate::mathFunctions::NearestPoint, ablate::mathFunctions::LinearTable, ablate::mathFunctions::LinearFunction, ablate::mathFunctions::Linear, ablate::mathFunctions::geom::Geometry, ablate::mathFunctions::FunctionWrapper, ablate::mathFunctions::FunctionPointer, ablate::mathFunctions::Formula, ablate::mathFunctions::ConstantValue, and ablate::domain::Hdf5Initializer::Hdf5MathFunction.

◆ GetContext()

virtual void* ablate::mathFunctions::MathFunction::GetContext ( )
pure virtual

Return a context for petsc style functions

Returns

Implemented in ablate::mathFunctions::SimpleFormula, ablate::mathFunctions::Peak, ablate::mathFunctions::ParsedSeries, ablate::mathFunctions::NearestPoint, ablate::mathFunctions::LinearTable, ablate::mathFunctions::LinearFunction, ablate::mathFunctions::Linear, ablate::mathFunctions::geom::Geometry, ablate::mathFunctions::FunctionWrapper, ablate::mathFunctions::FunctionPointer, ablate::mathFunctions::Formula, ablate::mathFunctions::ConstantValue, and ablate::domain::Hdf5Initializer::Hdf5MathFunction.

◆ GetPetscFunction()

virtual PetscFunction ablate::mathFunctions::MathFunction::GetPetscFunction ( )
pure virtual

Return a raw petsc style function to evaluate this math function

Returns

Implemented in ablate::mathFunctions::SimpleFormula, ablate::mathFunctions::Peak, ablate::mathFunctions::ParsedSeries, ablate::mathFunctions::NearestPoint, ablate::mathFunctions::LinearTable, ablate::mathFunctions::LinearFunction, ablate::mathFunctions::Linear, ablate::mathFunctions::geom::Geometry, ablate::mathFunctions::FunctionWrapper, ablate::mathFunctions::FunctionPointer, ablate::mathFunctions::Formula, ablate::mathFunctions::ConstantValue, and ablate::domain::Hdf5Initializer::Hdf5MathFunction.

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