jet::CustomVectorField2::Builder Class Reference

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

#include <jet/custom_vector_field2.h>

Public Member Functions
Builder &	withFunction (const std::function< Vector2D(const Vector2D &)> &func)
	Returns builder with field function. More...
Builder &	withDivergenceFunction (const std::function< double(const Vector2D &)> &func)
	Returns builder with divergence function. More...
Builder &	withCurlFunction (const std::function< double(const Vector2D &)> &func)
	Returns builder with curl function. More...
Builder &	withDerivativeResolution (double resolution)
	Returns builder with derivative resolution. More...
CustomVectorField2	build () const
	Builds CustomVectorField2. More...
CustomVectorField2Ptr	makeShared () const
	Builds shared pointer of CustomVectorField2 instance. More...

Detailed Description

Front-end to create CustomVectorField2 objects step by step.

Member Function Documentation

build()

CustomVectorField2 jet::CustomVectorField2::Builder::build

(

)

const

Builds CustomVectorField2.

makeShared()

CustomVectorField2Ptr jet::CustomVectorField2::Builder::makeShared

(

)

const

Builds shared pointer of CustomVectorField2 instance.

withCurlFunction()

Builder& jet::CustomVectorField2::Builder::withCurlFunction

(

const std::function< double(const Vector2D &)> &

func

)

Returns builder with curl function.

withDerivativeResolution()

Builder& jet::CustomVectorField2::Builder::withDerivativeResolution

(

double

resolution

)

Returns builder with derivative resolution.

withDivergenceFunction()

Builder& jet::CustomVectorField2::Builder::withDivergenceFunction

(

const std::function< double(const Vector2D &)> &

func

)

Returns builder with divergence function.

withFunction()

Builder& jet::CustomVectorField2::Builder::withFunction

(

const std::function< Vector2D(const Vector2D &)> &

func

)

Returns builder with field function.

---

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

• jet/custom_vector_field2.h