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

#include <Core/Grid/CellCenteredScalarGrid3.h>

Inheritance diagram for CubbyFlow::CellCenteredScalarGrid3::Builder:

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

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

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

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

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

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

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

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

CellCenteredScalarGrid3Ptr	MakeShared () const
	Builds shared pointer of CellCenteredScalarGrid3 instance. More...

ScalarGrid3Ptr	Build (const Size3 &resolution, const Vector3D &gridSpacing, const Vector3D &gridOrigin, double initialVal) const override
	Builds shared pointer of CellCenteredScalarGrid3 instance. More...

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

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

Detailed Description

Front-end to create CellCenteredScalarGrid3 objects step by step.

Member Function Documentation

◆ Build() [1/2]

CellCenteredScalarGrid3 CubbyFlow::CellCenteredScalarGrid3::Builder::Build ( ) const

Builds CellCenteredScalarGrid3 instance.

◆ Build() [2/2]

ScalarGrid3Ptr CubbyFlow::CellCenteredScalarGrid3::Builder::Build	(	const Size3 &	resolution,
		const Vector3D &	gridSpacing,
		const Vector3D &	gridOrigin,
		double	initialVal
	)		const

overridevirtual

Builds shared pointer of CellCenteredScalarGrid3 instance.

This is an overriding function that implements ScalarGridBuilder3.

Implements CubbyFlow::ScalarGridBuilder3.

◆ MakeShared()

CellCenteredScalarGrid3Ptr CubbyFlow::CellCenteredScalarGrid3::Builder::MakeShared ( ) const

Builds shared pointer of CellCenteredScalarGrid3 instance.

◆ WithGridSpacing() [1/2]

Builder& CubbyFlow::CellCenteredScalarGrid3::Builder::WithGridSpacing ( const Vector3D & gridSpacing )

Returns builder with grid spacing.

◆ WithGridSpacing() [2/2]

Builder& CubbyFlow::CellCenteredScalarGrid3::Builder::WithGridSpacing	(	double	gridSpacingX,
		double	gridSpacingY,
		double	gridSpacingZ
	)

Returns builder with grid spacing.

◆ WithInitialValue()

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

Returns builder with initial value.

◆ WithOrigin() [1/2]

Builder& CubbyFlow::CellCenteredScalarGrid3::Builder::WithOrigin ( const Vector3D & gridOrigin )

Returns builder with grid origin.

◆ WithOrigin() [2/2]

Builder& CubbyFlow::CellCenteredScalarGrid3::Builder::WithOrigin	(	double	gridOriginX,
		double	gridOriginY,
		double	gridOriginZ
	)