plb::IncomprFlowParam< T > Class Template Reference

Numeric parameters for isothermal, incompressible flow. More...

#include <units.h>

Collaboration diagram for plb::IncomprFlowParam< T >:

[legend]

List of all members.

Public Member Functions
	IncomprFlowParam (T physicalU_, T latticeU_, T Re_, T physicalLength_, plint resolution_, T lx_, T ly_, T lz_=T())
	Constructor.
	IncomprFlowParam (T latticeU_, T Re_, plint resolution_, T lx_, T ly_, T lz_=T())
T	getLatticeU () const
	velocity in lattice units (proportional to Mach number)
T	getPhysicalU () const
	velocity in physical units
T	getRe () const
	Reynolds number.
T	getPhysicalLength () const
	physical resolution
plint	getResolution () const
	resolution
T	getLx () const
	x-length in dimensionless units
T	getLy () const
	y-length in dimensionless units
T	getLz () const
	z-length in dimensionless units
T	getDeltaX () const
	lattice spacing in dimensionless units
T	getDeltaT () const
	time step in dimensionless units
plint	nCell (T l) const
	conversion from dimensionless to lattice units for space coordinate
plint	nStep (T t) const
	conversion from dimensionless to lattice units for time coordinate
plint	getNx (bool offLattice=false) const
	number of lattice cells in x-direction
plint	getNy (bool offLattice=false) const
	number of lattice cells in y-direction
plint	getNz (bool offLattice=false) const
	number of lattice cells in z-direction
T	getLatticeNu () const
	viscosity in lattice units
T	getTau () const
	relaxation time
T	getOmega () const
	relaxation frequency

---

Detailed Description

template<typename T>
class plb::IncomprFlowParam< T >

Numeric parameters for isothermal, incompressible flow.

---

Constructor & Destructor Documentation

template<typename T>

plb::IncomprFlowParam< T >::IncomprFlowParam	(	T	physicalU_,
		T	latticeU_,
		T	Re_,
		T	physicalLength_,
		plint	resolution_,
		T	lx_,
		T	ly_,
		T	lz_ = T()
	)			[inline]

Constructor.

Parameters:

	latticeU_	Characteristic velocity in lattice units (proportional to Mach number).
	Re_	Reynolds number.
	N_	Resolution (a lattice of size 1 has N_+1 cells).
	lx_	x-length in dimensionless units (e.g. 1).
	ly_	y-length in dimensionless units (e.g. 1).
	lz_	z-length in dimensionless units (e.g. 1).

template<typename T>

plb::IncomprFlowParam< T >::IncomprFlowParam	(	T	latticeU_,
		T	Re_,
		plint	resolution_,
		T	lx_,
		T	ly_,
		T	lz_ = T()
	)			[inline]

---

Member Function Documentation

template<typename T>

T plb::IncomprFlowParam< T >::getDeltaT

(

)

const [inline]

time step in dimensionless units

References plb::IncomprFlowParam< T >::getDeltaX(), plb::IncomprFlowParam< T >::getLatticeU(), and plb::IncomprFlowParam< T >::getPhysicalU().

Referenced by plb::IncomprFlowParam< T >::nStep(), and plb::writeLogFile().

template<typename T>

T plb::IncomprFlowParam< T >::getDeltaX

(

)

const [inline]

lattice spacing in dimensionless units

References plb::IncomprFlowParam< T >::getPhysicalLength(), and plb::IncomprFlowParam< T >::getResolution().

Referenced by plb::IncomprFlowParam< T >::getDeltaT(), plb::IncomprFlowParam< T >::nCell(), and plb::writeLogFile().

template<typename T>

T plb::IncomprFlowParam< T >::getLatticeNu

(

)

const [inline]

viscosity in lattice units

References plb::IncomprFlowParam< T >::getLatticeU(), and plb::IncomprFlowParam< T >::getResolution().

Referenced by plb::IncomprFlowParam< T >::getTau().

template<typename T>

T plb::IncomprFlowParam< T >::getLatticeU

(

)

const [inline]

velocity in lattice units (proportional to Mach number)

Referenced by plb::DiffusiveRefinementParameters< T >::createParameters(), plb::ConvectiveRefinementParameters< T >::createParameters(), plb::IncomprFlowParam< T >::getDeltaT(), plb::IncomprFlowParam< T >::getLatticeNu(), and plb::writeLogFile().

template<typename T>

T plb::IncomprFlowParam< T >::getLx

(

)

const [inline]

x-length in dimensionless units

References plb::IncomprFlowParam< T >::getPhysicalLength().

Referenced by plb::DiffusiveRefinementParameters< T >::createParameters(), plb::ConvectiveRefinementParameters< T >::createParameters(), plb::IncomprFlowParam< T >::getNx(), and plb::writeLogFile().

template<typename T>

T plb::IncomprFlowParam< T >::getLy

(

)

const [inline]

y-length in dimensionless units

References plb::IncomprFlowParam< T >::getPhysicalLength().

Referenced by plb::DiffusiveRefinementParameters< T >::createParameters(), plb::ConvectiveRefinementParameters< T >::createParameters(), plb::IncomprFlowParam< T >::getNy(), and plb::writeLogFile().

template<typename T>

T plb::IncomprFlowParam< T >::getLz

(

)

const [inline]

z-length in dimensionless units

References plb::IncomprFlowParam< T >::getPhysicalLength().

Referenced by plb::DiffusiveRefinementParameters< T >::createParameters(), plb::ConvectiveRefinementParameters< T >::createParameters(), plb::IncomprFlowParam< T >::getNz(), and plb::writeLogFile().

template<typename T>

plint plb::IncomprFlowParam< T >::getNx

(

bool

offLattice = false

)

const [inline]

number of lattice cells in x-direction

References plb::IncomprFlowParam< T >::getLx(), and plb::IncomprFlowParam< T >::nCell().

template<typename T>

plint plb::IncomprFlowParam< T >::getNy

(

bool

offLattice = false

)

const [inline]

number of lattice cells in y-direction

References plb::IncomprFlowParam< T >::getLy(), and plb::IncomprFlowParam< T >::nCell().

template<typename T>

plint plb::IncomprFlowParam< T >::getNz

(

bool

offLattice = false

)

const [inline]

number of lattice cells in z-direction

References plb::IncomprFlowParam< T >::getLz(), and plb::IncomprFlowParam< T >::nCell().

template<typename T>

T plb::IncomprFlowParam< T >::getOmega

(

)

const [inline]

relaxation frequency

References plb::IncomprFlowParam< T >::getTau().

Referenced by plb::writeLogFile().

template<typename T>

T plb::IncomprFlowParam< T >::getPhysicalLength

(

)

const [inline]

physical resolution

Referenced by plb::IncomprFlowParam< T >::getDeltaX(), plb::IncomprFlowParam< T >::getLx(), plb::IncomprFlowParam< T >::getLy(), and plb::IncomprFlowParam< T >::getLz().

template<typename T>

T plb::IncomprFlowParam< T >::getPhysicalU

(

)

const [inline]

velocity in physical units

Referenced by plb::IncomprFlowParam< T >::getDeltaT().

template<typename T>

T plb::IncomprFlowParam< T >::getRe

(

)

const [inline]

Reynolds number.

Referenced by plb::DiffusiveRefinementParameters< T >::createParameters(), plb::ConvectiveRefinementParameters< T >::createParameters(), and plb::writeLogFile().

template<typename T>

plint plb::IncomprFlowParam< T >::getResolution

(

)

const [inline]

resolution

Referenced by plb::DiffusiveRefinementParameters< T >::createParameters(), plb::ConvectiveRefinementParameters< T >::createParameters(), plb::IncomprFlowParam< T >::getDeltaX(), plb::IncomprFlowParam< T >::getLatticeNu(), and plb::writeLogFile().

template<typename T>

T plb::IncomprFlowParam< T >::getTau

(

)

const [inline]

relaxation time

References plb::IncomprFlowParam< T >::getLatticeNu().

Referenced by plb::IncomprFlowParam< T >::getOmega().

template<typename T>

plint plb::IncomprFlowParam< T >::nCell

(

T

l

)

const [inline]

conversion from dimensionless to lattice units for space coordinate

References plb::IncomprFlowParam< T >::getDeltaX().

Referenced by plb::IncomprFlowParam< T >::getNx(), plb::IncomprFlowParam< T >::getNy(), and plb::IncomprFlowParam< T >::getNz().

template<typename T>

plint plb::IncomprFlowParam< T >::nStep

(

T

t

)

const [inline]

conversion from dimensionless to lattice units for time coordinate

References plb::IncomprFlowParam< T >::getDeltaT().

---

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

• units.h