jet::CustomScalarField3::Builder Class Reference

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

#include <jet/custom_scalar_field3.h>

Public Member Functions
Builder &	withFunction (const std::function< double(const Vector3D &)> &func)
	Returns builder with field function. More...
Builder &	withGradientFunction (const std::function< Vector3D(const Vector3D &)> &func)
	Returns builder with divergence function. More...
Builder &	withLaplacianFunction (const std::function< double(const Vector3D &)> &func)
	Returns builder with curl function. More...
Builder &	withDerivativeResolution (double resolution)
	Returns builder with derivative resolution. More...
CustomScalarField3	build () const
	Builds CustomScalarField3. More...
CustomScalarField3Ptr	makeShared () const
	Builds shared pointer of CustomScalarField3 instance. More...

Detailed Description

Front-end to create CustomScalarField3 objects step by step.

Member Function Documentation

build()

CustomScalarField3 jet::CustomScalarField3::Builder::build

(

)

const

Builds CustomScalarField3.

makeShared()

CustomScalarField3Ptr jet::CustomScalarField3::Builder::makeShared

(

)

const

Builds shared pointer of CustomScalarField3 instance.

withDerivativeResolution()

Builder& jet::CustomScalarField3::Builder::withDerivativeResolution

(

double

resolution

)

Returns builder with derivative resolution.

withFunction()

Builder& jet::CustomScalarField3::Builder::withFunction

(

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

func

)

Returns builder with field function.

withGradientFunction()

Builder& jet::CustomScalarField3::Builder::withGradientFunction

(

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

func

)

Returns builder with divergence function.

withLaplacianFunction()

Builder& jet::CustomScalarField3::Builder::withLaplacianFunction

(

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

func

)

Returns builder with curl function.

---

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

• jet/custom_scalar_field3.h