ABLATE Source Documentation  0.12.34
Public Member Functions | List of all members
ablate::mathFunctions::Peak Class Reference

#include <peak.hpp>

+ Inheritance diagram for ablate::mathFunctions::Peak:

Public Member Functions

 Peak (const Peak &)=delete
 
void operator= (const Peak &)=delete
 
 Peak (std::vector< double > startValue, std::vector< double > peakValue, std::vector< double > endValue, double start, double peak, double end, int dir)
 
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::MathFunction
virtual ~MathFunction ()=default
 

Detailed Description

Peak functions in x, y, or z

Constructor & Destructor Documentation

◆ Peak()

ablate::mathFunctions::Peak::Peak ( std::vector< double >  startValue,
std::vector< double >  peakValue,
std::vector< double >  endValue,
double  start,
double  peak,
double  end,
int  dir 
)
explicit

Peak function from start to end with the specified start and end values

Parameters
startValue
endValue
start
end
dir0, 1, 2

Member Function Documentation

◆ Eval() [1/4]

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

Return a context for petsc style functions

Returns

Implements ablate::mathFunctions::MathFunction.

◆ GetPetscFunction()

PetscFunction ablate::mathFunctions::Peak::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: