Jet  v1.3.3
Public Member Functions | List of all members
jet::VertexCenteredScalarGrid2::Builder Class Referencefinal

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

#include <jet/vertex_centered_scalar_grid2.h>

Inheritance diagram for jet::VertexCenteredScalarGrid2::Builder:
jet::ScalarGridBuilder2

Public Member Functions

BuilderwithResolution (const Size2 &resolution)
 Returns builder with resolution. More...
 
BuilderwithResolution (size_t resolutionX, size_t resolutionY)
 Returns builder with resolution. More...
 
BuilderwithGridSpacing (const Vector2D &gridSpacing)
 Returns builder with grid spacing. More...
 
BuilderwithGridSpacing (double gridSpacingX, double gridSpacingY)
 Returns builder with grid spacing. More...
 
BuilderwithOrigin (const Vector2D &gridOrigin)
 Returns builder with grid origin. More...
 
BuilderwithOrigin (double gridOriginX, double gridOriginY)
 Returns builder with grid origin. More...
 
BuilderwithInitialValue (double initialVal)
 Returns builder with initial value. More...
 
VertexCenteredScalarGrid2 build () const
 Builds VertexCenteredScalarGrid2 instance. More...
 
VertexCenteredScalarGrid2Ptr makeShared () const
 Builds shared pointer of VertexCenteredScalarGrid2 instance. More...
 
ScalarGrid2Ptr build (const Size2 &resolution, const Vector2D &gridSpacing, const Vector2D &gridOrigin, double initialVal) const override
 Builds shared pointer of VertexCenteredScalarGrid2 instance. More...
 
- Public Member Functions inherited from jet::ScalarGridBuilder2
 ScalarGridBuilder2 ()
 Creates a builder. More...
 
virtual ~ScalarGridBuilder2 ()
 Default destructor. More...
 

Detailed Description

Front-end to create VertexCenteredScalarGrid2 objects step by step.

Member Function Documentation

◆ build() [1/2]

VertexCenteredScalarGrid2 jet::VertexCenteredScalarGrid2::Builder::build ( ) const

Builds VertexCenteredScalarGrid2 instance.

◆ build() [2/2]

ScalarGrid2Ptr jet::VertexCenteredScalarGrid2::Builder::build ( const Size2 resolution,
const Vector2D gridSpacing,
const Vector2D gridOrigin,
double  initialVal 
) const
overridevirtual

Builds shared pointer of VertexCenteredScalarGrid2 instance.

This is an overriding function that implements ScalarGridBuilder2.

Implements jet::ScalarGridBuilder2.

◆ makeShared()

VertexCenteredScalarGrid2Ptr jet::VertexCenteredScalarGrid2::Builder::makeShared ( ) const

Builds shared pointer of VertexCenteredScalarGrid2 instance.

◆ withGridSpacing() [1/2]

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

Returns builder with grid spacing.

◆ withGridSpacing() [2/2]

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

Returns builder with grid spacing.

◆ withInitialValue()

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

Returns builder with initial value.

◆ withOrigin() [1/2]

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

Returns builder with grid origin.

◆ withOrigin() [2/2]

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

Returns builder with grid origin.

◆ withResolution() [1/2]

Builder& jet::VertexCenteredScalarGrid2::Builder::withResolution ( const Size2 resolution)

Returns builder with resolution.

◆ withResolution() [2/2]

Builder& jet::VertexCenteredScalarGrid2::Builder::withResolution ( size_t  resolutionX,
size_t  resolutionY 
)

Returns builder with resolution.


The documentation for this class was generated from the following file: