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

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

#include <jet/custom_vector_field2.h>

Inheritance diagram for jet::CustomVectorField2:
jet::VectorField2 jet::Field2

Classes

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

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

2-D vector field with custom field function.

Constructor & Destructor Documentation

◆ CustomVectorField2() [1/3]

jet::CustomVectorField2::CustomVectorField2 ( const std::function< Vector2D(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.

◆ CustomVectorField2() [2/3]

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

◆ CustomVectorField2() [3/3]

jet::CustomVectorField2::CustomVectorField2 ( const std::function< Vector2D(const Vector2D &)> &  customFunction,
const std::function< double(const Vector2D &)> &  customDivergenceFunction,
const std::function< double(const Vector2D &)> &  customCurlFunction 
)

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

Member Function Documentation

◆ builder()

static Builder jet::CustomVectorField2::builder ( )
static

Returns builder fox CustomVectorField2.

◆ curl()

double jet::CustomVectorField2::curl ( const Vector2D x) const
overridevirtual

Returns the curl at given position x.

Reimplemented from jet::VectorField2.

◆ divergence()

double jet::CustomVectorField2::divergence ( const Vector2D x) const
overridevirtual

Returns the divergence at given position x.

Reimplemented from jet::VectorField2.

◆ sample()

Vector2D jet::CustomVectorField2::sample ( const Vector2D x) const
overridevirtual

Returns the sampled value at given position x.

Implements jet::VectorField2.

◆ sampler()

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

Returns the sampler function.

Reimplemented from jet::VectorField2.


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