CubbyFlow::GridFluidSolverBuilderBase2< DerivedBuilder > Class Template Reference

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

#include <Core/Solver/Grid/GridFluidSolver2.hpp>

Public Member Functions
DerivedBuilder &	WithResolution (const Vector2UZ &resolution)
	Returns builder with grid resolution.
DerivedBuilder &	WithGridSpacing (const Vector2D &gridSpacing)
	Returns builder with grid spacing.
DerivedBuilder &	WithGridSpacing (double gridSpacing)
	Returns builder with grid spacing.
DerivedBuilder &	WithDomainSizeX (double domainSizeX)
	Returns builder with domain size in x-direction.
DerivedBuilder &	WithOrigin (const Vector2D &gridOrigin)
	Returns builder with grid origin.

Protected Member Functions
Vector2D	GetGridSpacing () const

Protected Attributes
Vector2UZ	m_resolution { 1, 1 }
Vector2D	m_gridSpacing { 1, 1 }
Vector2D	m_gridOrigin { 0, 0 }
double	m_domainSizeX = 1.0
bool	m_useDomainSize = false

Detailed Description

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

Base class for grid-based fluid solver builder.

Member Function Documentation

GetGridSpacing()

template<typename T >

Vector2D CubbyFlow::GridFluidSolverBuilderBase2< T >::GetGridSpacing ( ) const

protected

WithDomainSizeX()

template<typename T >

T & CubbyFlow::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 & CubbyFlow::GridFluidSolverBuilderBase2< T >::WithGridSpacing

(

const Vector2D &

gridSpacing

)

Returns builder with grid spacing.

WithGridSpacing() [2/2]

template<typename T >

T & CubbyFlow::GridFluidSolverBuilderBase2< T >::WithGridSpacing

(

double

gridSpacing

)

Returns builder with grid spacing.

WithOrigin()

template<typename T >

T & CubbyFlow::GridFluidSolverBuilderBase2< T >::WithOrigin

(

const Vector2D &

gridOrigin

)

Returns builder with grid origin.

WithResolution()

template<typename T >

T & CubbyFlow::GridFluidSolverBuilderBase2< T >::WithResolution

(

const Vector2UZ &

resolution

)

Returns builder with grid resolution.

Member Data Documentation

m_domainSizeX

template<typename DerivedBuilder >

double CubbyFlow::GridFluidSolverBuilderBase2< DerivedBuilder >::m_domainSizeX = 1.0

protected

m_gridOrigin

template<typename DerivedBuilder >

Vector2D CubbyFlow::GridFluidSolverBuilderBase2< DerivedBuilder >::m_gridOrigin { 0, 0 }

protected

m_gridSpacing

template<typename DerivedBuilder >

Vector2D CubbyFlow::GridFluidSolverBuilderBase2< DerivedBuilder >::m_gridSpacing { 1, 1 }

protected

m_resolution

template<typename DerivedBuilder >

Vector2UZ CubbyFlow::GridFluidSolverBuilderBase2< DerivedBuilder >::m_resolution { 1, 1 }

protected

m_useDomainSize

template<typename DerivedBuilder >

bool CubbyFlow::GridFluidSolverBuilderBase2< DerivedBuilder >::m_useDomainSize = false

protected

---

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

• Core/Solver/Grid/GridFluidSolver2.hpp