A grid builder class that returns 2-D vertex-centered vector grid. More...

#include <jet/vertex_centered_vector_grid2.h>

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

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

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

VertexCenteredVectorGrid2Ptr	makeShared () const
	Builds shared pointer of VertexCenteredVectorGrid2 instance. More...

VectorGrid2Ptr	build (const Size2 &resolution, const Vector2D &gridSpacing, const Vector2D &gridOrigin, const Vector2D &initialVal) const override
	Builds shared pointer of VertexCenteredVectorGrid2 instance. More...

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

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

Detailed Description

A grid builder class that returns 2-D vertex-centered vector grid.

Member Function Documentation

◆ build() [1/2]

VertexCenteredVectorGrid2 jet::VertexCenteredVectorGrid2::Builder::build ( ) const

Builds VertexCenteredVectorGrid2 instance.

◆ build() [2/2]

VectorGrid2Ptr jet::VertexCenteredVectorGrid2::Builder::build	(	const Size2 &	resolution,
		const Vector2D &	gridSpacing,
		const Vector2D &	gridOrigin,
		const Vector2D &	initialVal
	)		const

overridevirtual

Builds shared pointer of VertexCenteredVectorGrid2 instance.

This is an overriding function that implements VectorGridBuilder2.

Implements jet::VectorGridBuilder2.

◆ makeShared()

VertexCenteredVectorGrid2Ptr jet::VertexCenteredVectorGrid2::Builder::makeShared ( ) const

Builds shared pointer of VertexCenteredVectorGrid2 instance.

◆ withGridSpacing() [1/2]

Builder& jet::VertexCenteredVectorGrid2::Builder::withGridSpacing ( const Vector2D & gridSpacing )

Returns builder with grid spacing.

◆ withGridSpacing() [2/2]

Builder& jet::VertexCenteredVectorGrid2::Builder::withGridSpacing	(	double	gridSpacingX,
		double	gridSpacingY
	)

Returns builder with grid spacing.

◆ withInitialValue() [1/2]

Builder& jet::VertexCenteredVectorGrid2::Builder::withInitialValue ( const Vector2D & initialVal )

Returns builder with initial value.

◆ withInitialValue() [2/2]

Builder& jet::VertexCenteredVectorGrid2::Builder::withInitialValue	(	double	initialValX,
		double	initialValY
	)

Returns builder with initial value.

◆ withOrigin() [1/2]

Builder& jet::VertexCenteredVectorGrid2::Builder::withOrigin ( const Vector2D & gridOrigin )

Returns builder with grid origin.

◆ withOrigin() [2/2]

Builder& jet::VertexCenteredVectorGrid2::Builder::withOrigin	(	double	gridOriginX,
		double	gridOriginY
	)