CubbyFlow::CellCenteredVectorGrid< N >::Builder Class Referencefinal
Front-end to create CellCenteredVectorGrid objects step by step. More...
#include <Core/Grid/CellCenteredVectorGrid.hpp>
Inheritance diagram for CubbyFlow::CellCenteredVectorGrid< N >::Builder:
Public Member Functions | |
| Builder & | WithResolution (const Vector< size_t, N > &resolution) |
| Returns builder with resolution. More... | |
| Builder & | WithGridSpacing (const Vector< double, N > &gridSpacing) |
| Returns builder with grid spacing. More... | |
| Builder & | WithOrigin (const Vector< double, N > &gridOrigin) |
| Returns builder with grid origin. More... | |
| Builder & | WithInitialValue (const Vector< double, N > &initialVal) |
| Returns builder with initial value. More... | |
| CellCenteredVectorGrid | Build () const |
| Builds CellCenteredVectorGrid instance. More... | |
| std::shared_ptr< CellCenteredVectorGrid > | MakeShared () const |
| Builds shared pointer of CellCenteredVectorGrid instance. More... | |
| std::shared_ptr< VectorGrid< N > > | Build (const Vector< size_t, N > &resolution, const Vector< double, N > &gridSpacing, const Vector< double, N > &gridOrigin, const Vector< double, N > &initialVal) const override |
| Builds shared pointer of CellCenteredVectorGrid instance. More... | |
 Public Member Functions inherited from CubbyFlow::VectorGridBuilder< N > | |
| VectorGridBuilder ()=default | |
| Creates a builder. More... | |
| virtual | ~VectorGridBuilder ()=default |
| Default virtual destructor. More... | |
| VectorGridBuilder (const VectorGridBuilder &other)=delete | |
| Deleted copy constructor. More... | |
| VectorGridBuilder (VectorGridBuilder &&other) noexcept=delete | |
| Deleted move constructor. More... | |
| VectorGridBuilder & | operator= (const VectorGridBuilder &other)=delete |
| Deleted copy assignment operator. More... | |
| VectorGridBuilder & | operator= (VectorGridBuilder &&other) noexcept=delete |
| Deleted move assignment operator. More... | |
Detailed Description
template<size_t N>
class CubbyFlow::CellCenteredVectorGrid< N >::Builder
Front-end to create CellCenteredVectorGrid objects step by step.
Member Function Documentation
◆ Build() [1/2]
template<size_t N>
| CellCenteredVectorGrid CubbyFlow::CellCenteredVectorGrid< N >::Builder::Build | ( | ) | const |
Builds CellCenteredVectorGrid instance.
◆ Build() [2/2]
template<size_t N>
|
overridevirtual |
Builds shared pointer of CellCenteredVectorGrid instance.
This is an overriding function that implements VectorGridBuilder.
Implements CubbyFlow::VectorGridBuilder< N >.
◆ MakeShared()
template<size_t N>
| std::shared_ptr<CellCenteredVectorGrid> CubbyFlow::CellCenteredVectorGrid< N >::Builder::MakeShared | ( | ) | const |
Builds shared pointer of CellCenteredVectorGrid instance.
◆ WithGridSpacing()
template<size_t N>
| Builder& CubbyFlow::CellCenteredVectorGrid< N >::Builder::WithGridSpacing | ( | const Vector< double, N > & | gridSpacing | ) |
Returns builder with grid spacing.
◆ WithInitialValue()
template<size_t N>
| Builder& CubbyFlow::CellCenteredVectorGrid< N >::Builder::WithInitialValue | ( | const Vector< double, N > & | initialVal | ) |
Returns builder with initial value.
◆ WithOrigin()
template<size_t N>
| Builder& CubbyFlow::CellCenteredVectorGrid< N >::Builder::WithOrigin | ( | const Vector< double, N > & | gridOrigin | ) |
Returns builder with grid origin.
◆ WithResolution()
template<size_t N>
| Builder& CubbyFlow::CellCenteredVectorGrid< N >::Builder::WithResolution | ( | const Vector< size_t, N > & | resolution | ) |
Returns builder with resolution.
The documentation for this class was generated from the following file:
- Core/Grid/CellCenteredVectorGrid.hpp
