CubbyFlow::ScalarGridBuilder< N > Class Template Referenceabstract

Abstract base class for N-D scalar grid builder. More...

#include <Core/Grid/ScalarGrid.hpp>

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

Public Member Functions

 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...
 
virtual 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 =0
 Returns N-D scalar grid with given parameters. More...
 

Detailed Description

template<size_t N>
class CubbyFlow::ScalarGridBuilder< N >

Abstract base class for N-D scalar grid builder.

Constructor & Destructor Documentation

◆ ScalarGridBuilder() [1/3]

template<size_t N>
CubbyFlow::ScalarGridBuilder< N >::ScalarGridBuilder ( )
default

Creates a builder.

◆ ~ScalarGridBuilder()

template<size_t N>
virtual CubbyFlow::ScalarGridBuilder< N >::~ScalarGridBuilder ( )
virtualdefault

Default virtual destructor.

◆ ScalarGridBuilder() [2/3]

template<size_t N>
CubbyFlow::ScalarGridBuilder< N >::ScalarGridBuilder ( const ScalarGridBuilder< N > &  other)
delete

Deleted copy constructor.

◆ ScalarGridBuilder() [3/3]

template<size_t N>
CubbyFlow::ScalarGridBuilder< N >::ScalarGridBuilder ( ScalarGridBuilder< N > &&  other)
deletenoexcept

Deleted move constructor.

Member Function Documentation

◆ Build()

template<size_t N>
virtual std::shared_ptr<ScalarGrid<N> > CubbyFlow::ScalarGridBuilder< N >::Build ( const Vector< size_t, N > &  resolution,
const Vector< double, N > &  gridSpacing,
const Vector< double, N > &  gridOrigin,
double  initialVal 
) const
pure virtual

Returns N-D scalar grid with given parameters.

Implemented in CubbyFlow::VertexCenteredScalarGrid< N >::Builder, and CubbyFlow::CellCenteredScalarGrid< N >::Builder.

◆ operator=() [1/2]

template<size_t N>
ScalarGridBuilder& CubbyFlow::ScalarGridBuilder< N >::operator= ( const ScalarGridBuilder< N > &  other)
delete

Deleted copy assignment operator.

◆ operator=() [2/2]

template<size_t N>
ScalarGridBuilder& CubbyFlow::ScalarGridBuilder< N >::operator= ( ScalarGridBuilder< N > &&  other)
deletenoexcept

Deleted move assignment operator.


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