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

#include <Core/Grid/CellCenteredScalarGrid2.h>

Inheritance diagram for CubbyFlow::CellCenteredScalarGrid2::Builder:

Public Member Functions
Builder &	WithResolution (const Size2 &resolution)
	Returns builder with resolution. More...

Builder &	WithResolution (size_t resolutionX, size_t resolutionY)
	Returns builder with resolution. More...

Builder &	WithGridSpacing (const Vector2D &gridSpacing)
	Returns builder with grid spacing. More...

Builder &	WithGridSpacing (double gridSpacingX, double gridSpacingY)
	Returns builder with grid spacing. More...

Builder &	WithOrigin (const Vector2D &gridOrigin)
	Returns builder with grid origin. More...

Builder &	WithOrigin (double gridOriginX, double gridOriginY)
	Returns builder with grid origin. More...

Builder &	WithInitialValue (double initialVal)
	Returns builder with initial value. More...

CellCenteredScalarGrid2	Build () const
	Builds CellCenteredScalarGrid2 instance. More...

CellCenteredScalarGrid2Ptr	MakeShared () const
	Builds shared pointer of CellCenteredScalarGrid2 instance. More...

ScalarGrid2Ptr	Build (const Size2 &resolution, const Vector2D &gridSpacing, const Vector2D &gridOrigin, double initialVal) const override
	Builds shared pointer of CellCenteredScalarGrid2 instance. More...

Public Member Functions inherited from CubbyFlow::ScalarGridBuilder2
	ScalarGridBuilder2 ()
	Creates a builder. More...

virtual	~ScalarGridBuilder2 ()
	Default destructor. More...

Detailed Description

Front-end to create CellCenteredScalarGrid2 objects step by step.

Member Function Documentation

◆ Build() [1/2]

CellCenteredScalarGrid2 CubbyFlow::CellCenteredScalarGrid2::Builder::Build ( ) const

Builds CellCenteredScalarGrid2 instance.

◆ Build() [2/2]

ScalarGrid2Ptr CubbyFlow::CellCenteredScalarGrid2::Builder::Build	(	const Size2 &	resolution,
		const Vector2D &	gridSpacing,
		const Vector2D &	gridOrigin,
		double	initialVal
	)		const

overridevirtual

Builds shared pointer of CellCenteredScalarGrid2 instance.

This is an overriding function that implements ScalarGridBuilder2.

Implements CubbyFlow::ScalarGridBuilder2.

◆ MakeShared()

CellCenteredScalarGrid2Ptr CubbyFlow::CellCenteredScalarGrid2::Builder::MakeShared ( ) const

Builds shared pointer of CellCenteredScalarGrid2 instance.

◆ WithGridSpacing() [1/2]

Builder& CubbyFlow::CellCenteredScalarGrid2::Builder::WithGridSpacing ( const Vector2D & gridSpacing )

Returns builder with grid spacing.

◆ WithGridSpacing() [2/2]

Builder& CubbyFlow::CellCenteredScalarGrid2::Builder::WithGridSpacing	(	double	gridSpacingX,
		double	gridSpacingY
	)

Returns builder with grid spacing.

◆ WithInitialValue()

Builder& CubbyFlow::CellCenteredScalarGrid2::Builder::WithInitialValue ( double initialVal )

Returns builder with initial value.

◆ WithOrigin() [1/2]

Builder& CubbyFlow::CellCenteredScalarGrid2::Builder::WithOrigin ( const Vector2D & gridOrigin )

Returns builder with grid origin.

◆ WithOrigin() [2/2]

Builder& CubbyFlow::CellCenteredScalarGrid2::Builder::WithOrigin	(	double	gridOriginX,
		double	gridOriginY
	)