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

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

#include <jet/face_centered_grid3.h>

Inheritance diagram for jet::FaceCenteredGrid3::Builder:
jet::VectorGridBuilder3

Public Member Functions

BuilderwithResolution (const Size3 &resolution)
 Returns builder with resolution. More...
 
BuilderwithResolution (size_t resolutionX, size_t resolutionY, size_t resolutionZ)
 Returns builder with resolution. More...
 
BuilderwithGridSpacing (const Vector3D &gridSpacing)
 Returns builder with grid spacing. More...
 
BuilderwithGridSpacing (double gridSpacingX, double gridSpacingY, double gridSpacingZ)
 Returns builder with grid spacing. More...
 
BuilderwithOrigin (const Vector3D &gridOrigin)
 Returns builder with grid origin. More...
 
BuilderwithOrigin (double gridOriginX, double gridOriginY, double gridOriginZ)
 Returns builder with grid origin. More...
 
BuilderwithInitialValue (const Vector3D &initialVal)
 Returns builder with initial value. More...
 
BuilderwithInitialValue (double initialValX, double initialValY, double initialValZ)
 Returns builder with initial value. More...
 
FaceCenteredGrid3 build () const
 Builds CellCenteredScalarGrid3 instance. More...
 
FaceCenteredGrid3Ptr makeShared () const
 Builds shared pointer of FaceCenteredGrid3 instance. More...
 
VectorGrid3Ptr build (const Size3 &resolution, const Vector3D &gridSpacing, const Vector3D &gridOrigin, const Vector3D &initialVal) const override
 Builds shared pointer of FaceCenteredGrid3 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 CellCenteredScalarGrid3 objects step by step.

Member Function Documentation

◆ build() [1/2]

FaceCenteredGrid3 jet::FaceCenteredGrid3::Builder::build ( ) const

Builds CellCenteredScalarGrid3 instance.

◆ build() [2/2]

VectorGrid3Ptr jet::FaceCenteredGrid3::Builder::build ( const Size3 resolution,
const Vector3D gridSpacing,
const Vector3D gridOrigin,
const Vector3D initialVal 
) const
overridevirtual

Builds shared pointer of FaceCenteredGrid3 instance.

This is an overriding function that implements VectorGridBuilder3.

Implements jet::VectorGridBuilder3.

◆ makeShared()

FaceCenteredGrid3Ptr jet::FaceCenteredGrid3::Builder::makeShared ( ) const

Builds shared pointer of FaceCenteredGrid3 instance.

◆ withGridSpacing() [1/2]

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

Returns builder with grid spacing.

◆ withGridSpacing() [2/2]

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

Returns builder with grid spacing.

◆ withInitialValue() [1/2]

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

Returns builder with initial value.

◆ withInitialValue() [2/2]

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

Returns builder with initial value.

◆ withOrigin() [1/2]

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

Returns builder with grid origin.

◆ withOrigin() [2/2]

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

Returns builder with grid origin.

◆ withResolution() [1/2]

Builder& jet::FaceCenteredGrid3::Builder::withResolution ( const Size3 resolution)

Returns builder with resolution.

◆ withResolution() [2/2]

Builder& jet::FaceCenteredGrid3::Builder::withResolution ( size_t  resolutionX,
size_t  resolutionY,
size_t  resolutionZ 
)

Returns builder with resolution.


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