CubbyFlow::CustomScalarField2::Builder Class Referencefinal
Front-end to create CustomScalarField2 objects step by step. More...
#include <Core/Field/CustomScalarField2.h>
Public Member Functions | |
Builder & | WithFunction (const std::function< double(const Vector2D &)> &func) |
Returns builder with field function. More... | |
Builder & | WithGradientFunction (const std::function< Vector2D(const Vector2D &)> &func) |
Returns builder with divergence function. More... | |
Builder & | WithLaplacianFunction (const std::function< double(const Vector2D &)> &func) |
Returns builder with curl function. More... | |
Builder & | WithDerivativeResolution (double resolution) |
Returns builder with derivative resolution. More... | |
CustomScalarField2 | Build () const |
Builds CustomScalarField2. More... | |
CustomScalarField2Ptr | MakeShared () const |
Builds shared pointer of CustomScalarField2 instance. More... | |
Detailed Description
Front-end to create CustomScalarField2 objects step by step.
Member Function Documentation
◆ Build()
CustomScalarField2 CubbyFlow::CustomScalarField2::Builder::Build | ( | ) | const |
Builds CustomScalarField2.
◆ MakeShared()
CustomScalarField2Ptr CubbyFlow::CustomScalarField2::Builder::MakeShared | ( | ) | const |
Builds shared pointer of CustomScalarField2 instance.
◆ WithDerivativeResolution()
Builder& CubbyFlow::CustomScalarField2::Builder::WithDerivativeResolution | ( | double | resolution | ) |
Returns builder with derivative resolution.
◆ WithFunction()
Builder& CubbyFlow::CustomScalarField2::Builder::WithFunction | ( | const std::function< double(const Vector2D &)> & | func | ) |
Returns builder with field function.
◆ WithGradientFunction()
Builder& CubbyFlow::CustomScalarField2::Builder::WithGradientFunction | ( | const std::function< Vector2D(const Vector2D &)> & | func | ) |
Returns builder with divergence function.
◆ WithLaplacianFunction()
Builder& CubbyFlow::CustomScalarField2::Builder::WithLaplacianFunction | ( | const std::function< double(const Vector2D &)> & | func | ) |
Returns builder with curl function.
The documentation for this class was generated from the following file:
- Core/Field/CustomScalarField2.h