CubbyFlow::CellCenteredScalarGrid< N >::Builder Class Referencefinal

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

#include <Core/Grid/CellCenteredScalarGrid.hpp>

Inheritance diagram for CubbyFlow::CellCenteredScalarGrid< N >::Builder:
CubbyFlow::ScalarGridBuilder< N >

Public Member Functions

BuilderWithResolution (const Vector< size_t, N > &resolution)
 Returns builder with resolution. More...
 
BuilderWithGridSpacing (const Vector< double, N > &gridSpacing)
 Returns builder with grid spacing. More...
 
BuilderWithOrigin (const Vector< double, N > &gridOrigin)
 Returns builder with grid origin. More...
 
BuilderWithInitialValue (double initialVal)
 Returns builder with initial value. More...
 
CellCenteredScalarGrid< N > Build () const
 Builds CellCenteredScalarGrid instance. More...
 
std::shared_ptr< CellCenteredScalarGrid< N > > MakeShared () const
 Builds shared pointer of CellCenteredScalarGrid instance. More...
 
std::shared_ptr< ScalarGrid< N > > Build (const Vector< size_t, N > &resolution, const Vector< double, N > &gridSpacing, const Vector< double, N > &gridOrigin, double initialVal) const override
 Builds shared pointer of CellCenteredScalarGrid instance. More...
 
- Public Member Functions inherited from CubbyFlow::ScalarGridBuilder< N >
 ScalarGridBuilder ()=default
 Creates a builder. More...
 
virtual ~ScalarGridBuilder ()=default
 Default virtual destructor. More...
 
 ScalarGridBuilder (const ScalarGridBuilder &other)=delete
 Deleted copy constructor. More...
 
 ScalarGridBuilder (ScalarGridBuilder &&other) noexcept=delete
 Deleted move constructor. More...
 
ScalarGridBuilderoperator= (const ScalarGridBuilder &other)=delete
 Deleted copy assignment operator. More...
 
ScalarGridBuilderoperator= (ScalarGridBuilder &&other) noexcept=delete
 Deleted move assignment operator. More...
 

Detailed Description

template<size_t N>
class CubbyFlow::CellCenteredScalarGrid< N >::Builder

Front-end to create CellCenteredScalarGrid objects step by step.

Member Function Documentation

◆ Build() [1/2]

template<size_t N>
CellCenteredScalarGrid<N> CubbyFlow::CellCenteredScalarGrid< N >::Builder::Build ( ) const

Builds CellCenteredScalarGrid instance.

◆ Build() [2/2]

template<size_t N>
std::shared_ptr<ScalarGrid<N> > CubbyFlow::CellCenteredScalarGrid< N >::Builder::Build ( const Vector< size_t, N > &  resolution,
const Vector< double, N > &  gridSpacing,
const Vector< double, N > &  gridOrigin,
double  initialVal 
) const
overridevirtual

Builds shared pointer of CellCenteredScalarGrid instance.

This is an overriding function that implements ScalarGridBuilder2.

Implements CubbyFlow::ScalarGridBuilder< N >.

◆ MakeShared()

template<size_t N>
std::shared_ptr<CellCenteredScalarGrid<N> > CubbyFlow::CellCenteredScalarGrid< N >::Builder::MakeShared ( ) const

Builds shared pointer of CellCenteredScalarGrid instance.

◆ WithGridSpacing()

template<size_t N>
Builder& CubbyFlow::CellCenteredScalarGrid< N >::Builder::WithGridSpacing ( const Vector< double, N > &  gridSpacing)

Returns builder with grid spacing.

◆ WithInitialValue()

template<size_t N>
Builder& CubbyFlow::CellCenteredScalarGrid< N >::Builder::WithInitialValue ( double  initialVal)

Returns builder with initial value.

◆ WithOrigin()

template<size_t N>
Builder& CubbyFlow::CellCenteredScalarGrid< N >::Builder::WithOrigin ( const Vector< double, N > &  gridOrigin)

Returns builder with grid origin.

◆ WithResolution()

template<size_t N>
Builder& CubbyFlow::CellCenteredScalarGrid< N >::Builder::WithResolution ( const Vector< size_t, N > &  resolution)

Returns builder with resolution.


The documentation for this class was generated from the following file: