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