Jet  v1.3.3
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
jet::GridFluidSolverBuilderBase2< DerivedBuilder > Class Template Reference

Base class for grid-based fluid solver builder. More...

#include <jet/grid_fluid_solver2.h>

Public Member Functions

DerivedBuilder & withResolution (const Size2 &resolution)
 Returns builder with grid resolution. More...
 
DerivedBuilder & withGridSpacing (const Vector2D &gridSpacing)
 Returns builder with grid spacing. More...
 
DerivedBuilder & withGridSpacing (double gridSpacing)
 Returns builder with grid spacing. More...
 
DerivedBuilder & withDomainSizeX (double domainSizeX)
 Returns builder with domain size in x-direction. More...
 
DerivedBuilder & withOrigin (const Vector2D &gridOrigin)
 Returns builder with grid origin. More...
 

Protected Member Functions

Vector2D getGridSpacing () const
 

Protected Attributes

Size2 _resolution {1, 1}
 
Vector2D _gridSpacing {1, 1}
 
Vector2D _gridOrigin {0, 0}
 
double _domainSizeX = 1.0
 
bool _useDomainSize = false
 

Detailed Description

template<typename DerivedBuilder>
class jet::GridFluidSolverBuilderBase2< DerivedBuilder >

Base class for grid-based fluid solver builder.

Member Function Documentation

◆ getGridSpacing()

template<typename T >
Vector2D jet::GridFluidSolverBuilderBase2< T >::getGridSpacing
protected

◆ withDomainSizeX()

template<typename T >
T & jet::GridFluidSolverBuilderBase2< T >::withDomainSizeX ( double  domainSizeX)

Returns builder with domain size in x-direction.

To build a solver, one can use either grid spacing directly or domain size in x-direction to set the final grid spacing.

◆ withGridSpacing() [1/2]

template<typename T >
T & jet::GridFluidSolverBuilderBase2< T >::withGridSpacing ( const Vector2D gridSpacing)

Returns builder with grid spacing.

◆ withGridSpacing() [2/2]

template<typename T >
T & jet::GridFluidSolverBuilderBase2< T >::withGridSpacing ( double  gridSpacing)

Returns builder with grid spacing.

◆ withOrigin()

template<typename T >
T & jet::GridFluidSolverBuilderBase2< T >::withOrigin ( const Vector2D gridOrigin)

Returns builder with grid origin.

◆ withResolution()

template<typename T >
T & jet::GridFluidSolverBuilderBase2< T >::withResolution ( const Size2 resolution)

Returns builder with grid resolution.

Member Data Documentation

◆ _domainSizeX

template<typename DerivedBuilder >
double jet::GridFluidSolverBuilderBase2< DerivedBuilder >::_domainSizeX = 1.0
protected

◆ _gridOrigin

template<typename DerivedBuilder >
Vector2D jet::GridFluidSolverBuilderBase2< DerivedBuilder >::_gridOrigin {0, 0}
protected

◆ _gridSpacing

template<typename DerivedBuilder >
Vector2D jet::GridFluidSolverBuilderBase2< DerivedBuilder >::_gridSpacing {1, 1}
protected

◆ _resolution

template<typename DerivedBuilder >
Size2 jet::GridFluidSolverBuilderBase2< DerivedBuilder >::_resolution {1, 1}
protected

◆ _useDomainSize

template<typename DerivedBuilder >
bool jet::GridFluidSolverBuilderBase2< DerivedBuilder >::_useDomainSize = false
protected

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