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

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

#include <jet/custom_scalar_field2.h>

Inheritance diagram for jet::CustomScalarField2:
jet::ScalarField2 jet::Field2

Classes

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

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

2-D scalar field with custom field function.

Constructor & Destructor Documentation

◆ CustomScalarField2() [1/3]

jet::CustomScalarField2::CustomScalarField2 ( const std::function< double(const Vector2D &)> &  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.

◆ CustomScalarField2() [2/3]

jet::CustomScalarField2::CustomScalarField2 ( const std::function< double(const Vector2D &)> &  customFunction,
const std::function< Vector2D(const Vector2D &)> &  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.

◆ CustomScalarField2() [3/3]

jet::CustomScalarField2::CustomScalarField2 ( const std::function< double(const Vector2D &)> &  customFunction,
const std::function< Vector2D(const Vector2D &)> &  customGradientFunction,
const std::function< double(const Vector2D &)> &  customLaplacianFunction 
)

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

Member Function Documentation

◆ builder()

static Builder jet::CustomScalarField2::builder ( )
static

Returns builder fox CustomScalarField2.

◆ gradient()

Vector2D jet::CustomScalarField2::gradient ( const Vector2D x) const
overridevirtual

Returns the gradient vector at given position x.

Reimplemented from jet::ScalarField2.

◆ laplacian()

double jet::CustomScalarField2::laplacian ( const Vector2D x) const
overridevirtual

Returns the Laplacian at given position x.

Reimplemented from jet::ScalarField2.

◆ sample()

double jet::CustomScalarField2::sample ( const Vector2D x) const
overridevirtual

Returns the sampled value at given position x.

Implements jet::ScalarField2.

◆ sampler()

std::function<double(const Vector2D&)> jet::CustomScalarField2::sampler ( ) const
overridevirtual

Returns the sampler function.

Reimplemented from jet::ScalarField2.


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