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

#include <jet/vertex_centered_vector_grid3.h>

Inheritance diagram for jet::VertexCenteredVectorGrid3::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 (const Vector3D &initialVal)
	Returns builder with initial value. More...

Builder &	withInitialValue (double initialValX, double initialValY, double initialValZ)
	Returns builder with initial value. More...

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

VertexCenteredVectorGrid3Ptr	makeShared () const
	Builds shared pointer of VertexCenteredVectorGrid3 instance. More...

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

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

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

Detailed Description

Front-end to create VertexCenteredVectorGrid3 objects step by step.

Member Function Documentation

◆ build() [1/2]

VertexCenteredVectorGrid3 jet::VertexCenteredVectorGrid3::Builder::build ( ) const

Builds VertexCenteredVectorGrid3 instance.

◆ build() [2/2]

VectorGrid3Ptr jet::VertexCenteredVectorGrid3::Builder::build	(	const Size3 &	resolution,
		const Vector3D &	gridSpacing,
		const Vector3D &	gridOrigin,
		const Vector3D &	initialVal
	)		const

overridevirtual

Builds shared pointer of VertexCenteredVectorGrid3 instance.

This is an overriding function that implements VectorGridBuilder3.

Implements jet::VectorGridBuilder3.

◆ makeShared()

VertexCenteredVectorGrid3Ptr jet::VertexCenteredVectorGrid3::Builder::makeShared ( ) const

Builds shared pointer of VertexCenteredVectorGrid3 instance.

◆ withGridSpacing() [1/2]

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

Returns builder with grid spacing.

◆ withGridSpacing() [2/2]

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

Returns builder with grid spacing.

◆ withInitialValue() [1/2]

Builder& jet::VertexCenteredVectorGrid3::Builder::withInitialValue ( const Vector3D & initialVal )

Returns builder with initial value.

◆ withInitialValue() [2/2]

Builder& jet::VertexCenteredVectorGrid3::Builder::withInitialValue	(	double	initialValX,
		double	initialValY,
		double	initialValZ
	)

Returns builder with initial value.

◆ withOrigin() [1/2]

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

Returns builder with grid origin.

◆ withOrigin() [2/2]

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