ABLATE Source Documentation  0.12.33
ablate::mathFunctions::NearestPoint Class Reference

#include <nearestPoint.hpp>

+ Inheritance diagram for ablate::mathFunctions::NearestPoint:

Public Member Functions

 NearestPoint (const std::vector< double > &coordinates, const std::vector< double > &values)
 
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

Simple math function that takes a list of a points/values and returns the value associated with the nearest point

Constructor & Destructor Documentation

◆ NearestPoint()

ablate::mathFunctions::NearestPoint::NearestPoint ( const std::vector< double > &  coordinates,
const std::vector< double > &  values 
)

Create a simple math function that initializes based upon the list of points

Parameters
coordinateslist of coordinates (x1, y1, z1, x2, y2, etc.)
valuesList of values

Member Function Documentation

◆ Eval() [1/4]

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

Return a context for petsc style functions

Returns

Implements ablate::mathFunctions::MathFunction.

◆ GetPetscFunction()

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