CubbyFlow::CustomVectorField2::Builder Class Referencefinal

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

#include <Core/Field/CustomVectorField2.h>

Public Member Functions

BuilderWithFunction (const std::function< Vector2D(const Vector2D &)> &func)
 Returns builder with field function. More...
 
BuilderWithDivergenceFunction (const std::function< double(const Vector2D &)> &func)
 Returns builder with divergence function. More...
 
BuilderWithCurlFunction (const std::function< double(const Vector2D &)> &func)
 Returns builder with curl function. More...
 
BuilderWithDerivativeResolution (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 CubbyFlow::CustomVectorField2::Builder::Build ( ) const

◆ MakeShared()

CustomVectorField2Ptr CubbyFlow::CustomVectorField2::Builder::MakeShared ( ) const

Builds shared pointer of CustomVectorField2 instance.

◆ WithCurlFunction()

Builder& CubbyFlow::CustomVectorField2::Builder::WithCurlFunction ( const std::function< double(const Vector2D &)> &  func)

Returns builder with curl function.

◆ WithDerivativeResolution()

Builder& CubbyFlow::CustomVectorField2::Builder::WithDerivativeResolution ( double  resolution)

Returns builder with derivative resolution.

◆ WithDivergenceFunction()

Builder& CubbyFlow::CustomVectorField2::Builder::WithDivergenceFunction ( const std::function< double(const Vector2D &)> &  func)

Returns builder with divergence function.

◆ WithFunction()

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