Jet  v1.3.3
Public Member Functions | List of all members
jet::CustomVectorField3::Builder Class Referencefinal

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

#include <jet/custom_vector_field3.h>

Public Member Functions

BuilderwithFunction (const std::function< Vector3D(const Vector3D &)> &func)
 Returns builder with field function. More...
 
BuilderwithDivergenceFunction (const std::function< double(const Vector3D &)> &func)
 Returns builder with divergence function. More...
 
BuilderwithCurlFunction (const std::function< Vector3D(const Vector3D &)> &func)
 Returns builder with curl function. More...
 
BuilderwithDerivativeResolution (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 jet::CustomVectorField3::Builder::build ( ) const

◆ makeShared()

CustomVectorField3Ptr jet::CustomVectorField3::Builder::makeShared ( ) const

Builds shared pointer of CustomVectorField3 instance.

◆ withCurlFunction()

Builder& jet::CustomVectorField3::Builder::withCurlFunction ( const std::function< Vector3D(const Vector3D &)> &  func)

Returns builder with curl function.

◆ withDerivativeResolution()

Builder& jet::CustomVectorField3::Builder::withDerivativeResolution ( double  resolution)

Returns builder with derivative resolution.

◆ withDivergenceFunction()

Builder& jet::CustomVectorField3::Builder::withDivergenceFunction ( const std::function< double(const Vector3D &)> &  func)

Returns builder with divergence function.

◆ withFunction()

Builder& jet::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: