Jet
v1.3.3
|
2-D vector field with custom field function. More...
#include <jet/custom_vector_field2.h>
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... | |
![]() | |
VectorField2 () | |
Default constructor. More... | |
virtual | ~VectorField2 () |
Default destructor. More... | |
![]() | |
Field2 () | |
virtual | ~Field2 () |
Static Public Member Functions | |
static Builder | builder () |
Returns builder fox CustomVectorField2. More... | |
2-D vector field with custom field function.
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.
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.
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.
|
static |
Returns builder fox CustomVectorField2.
|
overridevirtual |
Returns the curl at given position x
.
Reimplemented from jet::VectorField2.
|
overridevirtual |
Returns the divergence at given position x
.
Reimplemented from jet::VectorField2.
Returns the sampled value at given position x
.
Implements jet::VectorField2.
Returns the sampler function.
Reimplemented from jet::VectorField2.