Jet  v1.3.3
Classes | Public Member Functions | Static Public Member Functions | List of all members
jet::CustomScalarField3 Class Referencefinal

3-D scalar field with custom field function. More...

#include <jet/custom_scalar_field3.h>

Inheritance diagram for jet::CustomScalarField3:
jet::ScalarField3 jet::Field3

Classes

class  Builder
 Front-end to create CustomScalarField3 objects step by step. More...
 

Public Member Functions

 CustomScalarField3 (const std::function< double(const Vector3D &)> &customFunction, double derivativeResolution=1e-3)
 Constructs a field with given function. More...
 
 CustomScalarField3 (const std::function< double(const Vector3D &)> &customFunction, const std::function< Vector3D(const Vector3D &)> &customGradientFunction, double derivativeResolution=1e-3)
 Constructs a field with given field and gradient function. More...
 
 CustomScalarField3 (const std::function< double(const Vector3D &)> &customFunction, const std::function< Vector3D(const Vector3D &)> &customGradientFunction, const std::function< double(const Vector3D &)> &customLaplacianFunction)
 Constructs a field with given field, gradient, and Laplacian function. More...
 
double sample (const Vector3D &x) const override
 Returns the sampled value at given position x. More...
 
std::function< double(const Vector3D &)> sampler () const override
 Returns the sampler function. More...
 
Vector3D gradient (const Vector3D &x) const override
 Returns the gradient vector at given position x. More...
 
double laplacian (const Vector3D &x) const override
 Returns the Laplacian at given position x. More...
 
- Public Member Functions inherited from jet::ScalarField3
 ScalarField3 ()
 Default constructor. More...
 
virtual ~ScalarField3 ()
 Default destructor. More...
 
- Public Member Functions inherited from jet::Field3
 Field3 ()
 
virtual ~Field3 ()
 

Static Public Member Functions

static Builder builder ()
 Returns builder fox CustomScalarField3. More...
 

Detailed Description

3-D scalar field with custom field function.

Constructor & Destructor Documentation

◆ CustomScalarField3() [1/3]

jet::CustomScalarField3::CustomScalarField3 ( const std::function< double(const Vector3D &)> &  customFunction,
double  derivativeResolution = 1e-3 
)

Constructs a field with given function.

This constructor creates a field with user-provided function object. To compute derivatives, such as gradient and Laplacian, finite differencing is used. Thus, the differencing resolution also can be provided as the last parameter.

◆ CustomScalarField3() [2/3]

jet::CustomScalarField3::CustomScalarField3 ( const std::function< double(const Vector3D &)> &  customFunction,
const std::function< Vector3D(const Vector3D &)> &  customGradientFunction,
double  derivativeResolution = 1e-3 
)

Constructs a field with given field and gradient function.

This constructor creates a field with user-provided field and gradient function objects. To compute Laplacian, finite differencing is used. Thus, the differencing resolution also can be provided as the last parameter.

◆ CustomScalarField3() [3/3]

jet::CustomScalarField3::CustomScalarField3 ( const std::function< double(const Vector3D &)> &  customFunction,
const std::function< Vector3D(const Vector3D &)> &  customGradientFunction,
const std::function< double(const Vector3D &)> &  customLaplacianFunction 
)

Constructs a field with given field, gradient, and Laplacian function.

Member Function Documentation

◆ builder()

static Builder jet::CustomScalarField3::builder ( )
static

Returns builder fox CustomScalarField3.

◆ gradient()

Vector3D jet::CustomScalarField3::gradient ( const Vector3D x) const
overridevirtual

Returns the gradient vector at given position x.

Reimplemented from jet::ScalarField3.

◆ laplacian()

double jet::CustomScalarField3::laplacian ( const Vector3D x) const
overridevirtual

Returns the Laplacian at given position x.

Reimplemented from jet::ScalarField3.

◆ sample()

double jet::CustomScalarField3::sample ( const Vector3D x) const
overridevirtual

Returns the sampled value at given position x.

Implements jet::ScalarField3.

◆ sampler()

std::function<double(const Vector3D&)> jet::CustomScalarField3::sampler ( ) const
overridevirtual

Returns the sampler function.

Reimplemented from jet::ScalarField3.


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