ABLATE Source Documentation  0.12.36
Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
ablate::mathFunctions::geom::Geometry Class Referenceabstract
+ Inheritance diagram for ablate::mathFunctions::geom::Geometry:

Public Member Functions

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
 
virtual bool InsideGeometry (const double *xyz, const int &ndims, const double &time) const =0
 
const std::shared_ptr< mathFunctions::MathFunction > & InsideValues () const
 
const std::shared_ptr< mathFunctions::MathFunction > OutsideValues () const
 
- Public Member Functions inherited from ablate::mathFunctions::MathFunction
virtual ~MathFunction ()=default
 

Protected Member Functions

 Geometry (const std::shared_ptr< mathFunctions::MathFunction > &insideValues, const std::shared_ptr< mathFunctions::MathFunction > &outsideValues)
 

Static Protected Member Functions

static PetscErrorCode GeometryPetscFunction (PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar *u, void *ctx)
 

Member Function Documentation

◆ Eval() [1/4]

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

Return a context for petsc style functions

Returns

Implements ablate::mathFunctions::MathFunction.

◆ GetPetscFunction()

PetscFunction ablate::mathFunctions::geom::Geometry::GetPetscFunction ( )
inlineoverridevirtual

Return a raw petsc style function to evaluate this math function

Returns

Implements ablate::mathFunctions::MathFunction.

◆ InsideGeometry()

virtual bool ablate::mathFunctions::geom::Geometry::InsideGeometry ( const double *  xyz,
const int &  ndims,
const double &  time 
) const
pure virtual

determines if inside geometry

Parameters
xyz
ndims
time
Returns

Implemented in ablate::mathFunctions::geom::Union, ablate::mathFunctions::geom::Triangle, ablate::mathFunctions::geom::Surface, ablate::mathFunctions::geom::Sphere, ablate::mathFunctions::geom::Inverse, ablate::mathFunctions::geom::Difference, ablate::mathFunctions::geom::CylinderShell, ablate::mathFunctions::geom::ConvexPolygon, and ablate::mathFunctions::geom::Box.

◆ InsideValues()

const std::shared_ptr<mathFunctions::MathFunction>& ablate::mathFunctions::geom::Geometry::InsideValues ( ) const
inline

Returns the inside values function

◆ OutsideValues()

const std::shared_ptr<mathFunctions::MathFunction> ablate::mathFunctions::geom::Geometry::OutsideValues ( ) const
inline

Returns the outside values function

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