CubbyFlow::VertexCenteredScalarGrid2::Builder Class Referencefinal
A grid builder class that returns 2-D vertex-centered scalar grid. More...
#include <Core/Grid/VertexCenteredScalarGrid2.h>
Inheritance diagram for CubbyFlow::VertexCenteredScalarGrid2::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 (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 CubbyFlow::ScalarGridBuilder2 | |
| ScalarGridBuilder2 () | |
| Creates a builder. More... | |
| virtual | ~ScalarGridBuilder2 () |
| Default destructor. More... | |
Detailed Description
A grid builder class that returns 2-D vertex-centered scalar grid.
Member Function Documentation
◆ Build() [1/2]
| VertexCenteredScalarGrid2 CubbyFlow::VertexCenteredScalarGrid2::Builder::Build | ( | ) | const |
Builds VertexCenteredScalarGrid2 instance.
◆ Build() [2/2]
|
overridevirtual |
Builds shared pointer of VertexCenteredScalarGrid2 instance.
This is an overriding function that implements ScalarGridBuilder2.
Implements CubbyFlow::ScalarGridBuilder2.
◆ MakeShared()
| VertexCenteredScalarGrid2Ptr CubbyFlow::VertexCenteredScalarGrid2::Builder::MakeShared | ( | ) | const |
Builds shared pointer of VertexCenteredScalarGrid2 instance.
◆ WithGridSpacing() [1/2]
| Builder& CubbyFlow::VertexCenteredScalarGrid2::Builder::WithGridSpacing | ( | const Vector2D & | gridSpacing | ) |
Returns builder with grid spacing.
◆ WithGridSpacing() [2/2]
| Builder& CubbyFlow::VertexCenteredScalarGrid2::Builder::WithGridSpacing | ( | double | gridSpacingX, |
| double | gridSpacingY | ||
| ) |
Returns builder with grid spacing.
◆ WithInitialValue()
| Builder& CubbyFlow::VertexCenteredScalarGrid2::Builder::WithInitialValue | ( | double | initialVal | ) |
Returns builder with initial value.
◆ WithOrigin() [1/2]
Returns builder with grid origin.
◆ WithOrigin() [2/2]
| Builder& CubbyFlow::VertexCenteredScalarGrid2::Builder::WithOrigin | ( | double | gridOriginX, |
| double | gridOriginY | ||
| ) |
Returns builder with grid origin.
◆ WithResolution() [1/2]
Returns builder with resolution.
◆ WithResolution() [2/2]
| Builder& CubbyFlow::VertexCenteredScalarGrid2::Builder::WithResolution | ( | size_t | resolutionX, |
| size_t | resolutionY | ||
| ) |
Returns builder with resolution.
The documentation for this class was generated from the following file:
- Core/Grid/VertexCenteredScalarGrid2.h
