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

A grid builder class that returns N-D vertex-centered vector grid. More...

#include <Core/Grid/VertexCenteredVectorGrid.hpp>

Inheritance diagram for CubbyFlow::VertexCenteredVectorGrid< N >::Builder:
CubbyFlow::VectorGridBuilder< 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 (const Vector< double, N > &initialVal)
 Returns builder with initial value. More...
 
VertexCenteredVectorGrid Build () const
 Builds VertexCenteredVectorGrid instance. More...
 
std::shared_ptr< VertexCenteredVectorGrid< N > > MakeShared () const
 Builds shared pointer of VertexCenteredVectorGrid 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 VertexCenteredVectorGrid 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...
 
VectorGridBuilderoperator= (const VectorGridBuilder &other)=delete
 Deleted copy assignment operator. More...
 
VectorGridBuilderoperator= (VectorGridBuilder &&other) noexcept=delete
 Deleted move assignment operator. More...
 

Detailed Description

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

A grid builder class that returns N-D vertex-centered vector grid.

Member Function Documentation

◆ Build() [1/2]

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

Builds VertexCenteredVectorGrid instance.

◆ Build() [2/2]

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

Builds shared pointer of VertexCenteredVectorGrid instance.

This is an overriding function that implements VectorGridBuilder2.

Implements CubbyFlow::VectorGridBuilder< N >.

◆ MakeShared()

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

Builds shared pointer of VertexCenteredVectorGrid instance.

◆ WithGridSpacing()

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

Returns builder with grid spacing.

◆ WithInitialValue()

template<size_t N>
Builder& CubbyFlow::VertexCenteredVectorGrid< N >::Builder::WithInitialValue ( const Vector< double, N > &  initialVal)

Returns builder with initial value.

◆ WithOrigin()

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

Returns builder with grid origin.

◆ WithResolution()

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

Returns builder with resolution.


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