ablate::mathFunctions::ParsedSeries Class Reference

#include <parsedSeries.hpp>

Inheritance diagram for ablate::mathFunctions::ParsedSeries:

Public Member Functions
	ParsedSeries (const ParsedSeries &)=delete
void	operator= (const ParsedSeries &)=delete
	ParsedSeries (std::string functionString, int lowerBound=1, int upperBound=1000, const std::shared_ptr< ablate::parameters::Parameters > &constants={})
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
void *	GetContext () override
PetscFunction	GetPetscFunction () override
Public Member Functions inherited from ablate::mathFunctions::FormulaBase
	FormulaBase (const FormulaBase &)=delete
	prevent copy of this object
void	operator= (const FormulaBase &)=delete
	prevent copy of this object
Public Member Functions inherited from ablate::mathFunctions::MathFunction
virtual	~MathFunction ()=default

Additional Inherited Members
Protected Member Functions inherited from ablate::mathFunctions::FormulaBase
	FormulaBase (std::string functionString, const std::shared_ptr< ablate::parameters::Parameters > &constants)
Static Protected Member Functions inherited from ablate::mathFunctions::FormulaBase
static std::invalid_argument	ConvertToException (mu::Parser::exception_type &exception)
Protected Attributes inherited from ablate::mathFunctions::FormulaBase
double	coordinate [3] = {0, 0, 0}
	The coordinate linked to the parser.
double	time = 0.0
	the time linked to the parser
mu::Parser	parser
	The parser object library for this formula.
const std::string	formula
	the formula output for debugging

Detailed Description

computes a series result from a string function with variables x, y, z, t, and n where i index of summation. See the ParsedFunction for details on the string formatting. Note that the lower and upper bound are inclusive.

Constructor & Destructor Documentation

ParsedSeries()

ablate::mathFunctions::ParsedSeries::ParsedSeries ( std::string  functionString, int  lowerBound = 1, int  upperBound = 1000, const std::shared_ptr< ablate::parameters::Parameters > &  constants = {}  )

explicit

A formula that can be used with to compute a series

Parameters

functionString	see ParsedFunction for details on the string formatting
lowerBound	the inclusive lower bound of summation (m)
upperBound	the inclusive upper bound of summation (n)
constants

Member Function Documentation

Eval() [1/4]

double ablate::mathFunctions::ParsedSeries::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::ParsedSeries::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::ParsedSeries::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::ParsedSeries::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::ParsedSeries::GetContext ( )

inlineoverridevirtual

Return a context for petsc style functions

Returns

Implements ablate::mathFunctions::MathFunction.

GetPetscFunction()

PetscFunction ablate::mathFunctions::ParsedSeries::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/parsedSeries.hpp
• src/mathFunctions/parsedSeries.cpp