A grid builder class that returns 3-D vertex-centered scalar grid. More...

#include <jet/vertex_centered_scalar_grid3.h>

Inheritance diagram for jet::VertexCenteredScalarGrid3::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...

VertexCenteredScalarGrid3	build () const
	Builds VertexCenteredScalarGrid3 instance. More...

VertexCenteredScalarGrid3Ptr	makeShared () const
	Builds shared pointer of VertexCenteredScalarGrid3 instance. More...

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

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

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

Detailed Description

A grid builder class that returns 3-D vertex-centered scalar grid.

Member Function Documentation

◆ build() [1/2]

VertexCenteredScalarGrid3 jet::VertexCenteredScalarGrid3::Builder::build ( ) const

Builds VertexCenteredScalarGrid3 instance.

◆ build() [2/2]

ScalarGrid3Ptr jet::VertexCenteredScalarGrid3::Builder::build	(	const Size3 &	resolution,
		const Vector3D &	gridSpacing,
		const Vector3D &	gridOrigin,
		double	initialVal
	)		const

overridevirtual

Builds shared pointer of VertexCenteredScalarGrid3 instance.

This is an overriding function that implements ScalarGridBuilder3.

Implements jet::ScalarGridBuilder3.

◆ makeShared()

VertexCenteredScalarGrid3Ptr jet::VertexCenteredScalarGrid3::Builder::makeShared ( ) const

Builds shared pointer of VertexCenteredScalarGrid3 instance.

◆ withGridSpacing() [1/2]

Builder& jet::VertexCenteredScalarGrid3::Builder::withGridSpacing ( const Vector3D & gridSpacing )

Returns builder with grid spacing.

◆ withGridSpacing() [2/2]

Builder& jet::VertexCenteredScalarGrid3::Builder::withGridSpacing	(	double	gridSpacingX,
		double	gridSpacingY,
		double	gridSpacingZ
	)

Returns builder with grid spacing.

◆ withInitialValue()

Builder& jet::VertexCenteredScalarGrid3::Builder::withInitialValue ( double initialVal )

Returns builder with initial value.

◆ withOrigin() [1/2]

Builder& jet::VertexCenteredScalarGrid3::Builder::withOrigin ( const Vector3D & gridOrigin )

Returns builder with grid origin.

◆ withOrigin() [2/2]

Builder& jet::VertexCenteredScalarGrid3::Builder::withOrigin	(	double	gridOriginX,
		double	gridOriginY,
		double	gridOriginZ
	)