CubbyFlow::CustomScalarField3::Builder Class Referencefinal

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

#include <Core/Field/CustomScalarField3.h>

Public Member Functions

BuilderWithFunction (const std::function< double(const Vector3D &)> &func)
 Returns builder with field function. More...
 
BuilderWithGradientFunction (const std::function< Vector3D(const Vector3D &)> &func)
 Returns builder with divergence function. More...
 
BuilderWithLaplacianFunction (const std::function< double(const Vector3D &)> &func)
 Returns builder with curl function. More...
 
BuilderWithDerivativeResolution (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 CubbyFlow::CustomScalarField3::Builder::Build ( ) const

◆ MakeShared()

CustomScalarField3Ptr CubbyFlow::CustomScalarField3::Builder::MakeShared ( ) const

Builds shared pointer of CustomScalarField3 instance.

◆ WithDerivativeResolution()

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

Returns builder with derivative resolution.

◆ WithFunction()

Builder& CubbyFlow::CustomScalarField3::Builder::WithFunction ( const std::function< double(const Vector3D &)> &  func)

Returns builder with field function.

◆ WithGradientFunction()

Builder& CubbyFlow::CustomScalarField3::Builder::WithGradientFunction ( const std::function< Vector3D(const Vector3D &)> &  func)

Returns builder with divergence function.

◆ WithLaplacianFunction()

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