CubbyFlow::CustomVectorField3::Builder Class Reference

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

#include <Core/Field/CustomVectorField3.h>

Public Member Functions
Builder &	WithFunction (const std::function< Vector3D(const Vector3D &)> &func)
	Returns builder with field function. More...
Builder &	WithDivergenceFunction (const std::function< double(const Vector3D &)> &func)
	Returns builder with divergence function. More...
Builder &	WithCurlFunction (const std::function< Vector3D(const Vector3D &)> &func)
	Returns builder with curl function. More...
Builder &	WithDerivativeResolution (double resolution)
	Returns builder with derivative resolution. More...
CustomVectorField3	Build () const
	Builds CustomVectorField3. More...
CustomVectorField3Ptr	MakeShared () const
	Builds shared pointer of CustomVectorField3 instance. More...

Detailed Description

Front-end to create CustomVectorField3 objects step by step.

Member Function Documentation

Build()

CustomVectorField3 CubbyFlow::CustomVectorField3::Builder::Build

(

)

const

Builds CustomVectorField3.

MakeShared()

CustomVectorField3Ptr CubbyFlow::CustomVectorField3::Builder::MakeShared

(

)

const

Builds shared pointer of CustomVectorField3 instance.

WithCurlFunction()

Builder& CubbyFlow::CustomVectorField3::Builder::WithCurlFunction

(

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

func

)

Returns builder with curl function.

WithDerivativeResolution()

Builder& CubbyFlow::CustomVectorField3::Builder::WithDerivativeResolution

(

double

resolution

)

Returns builder with derivative resolution.

WithDivergenceFunction()

Builder& CubbyFlow::CustomVectorField3::Builder::WithDivergenceFunction

(

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

func

)

Returns builder with divergence function.

WithFunction()

Builder& CubbyFlow::CustomVectorField3::Builder::WithFunction

(

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

func

)

Returns builder with field function.

---

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

• Core/Field/CustomVectorField3.h