plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor > Class Template Reference

A useful class for the conversion between dimensionless and lattice units. More...

#include <advectionDiffusionUnits.h>

Collaboration diagram for plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >:

[legend]

List of all members.

Public Member Functions
	RayleighBenardFlowParam (T Ra_, T Pr_, T uMax_, T coldTemperature_, T hotTemperature_, T resolution_, T lx_, T ly_, T lz_=T())
	Constructor.
T	getRe () const
	Reynolds number.
T	getRa () const
	Rayleigh number.
T	getPr () const
	Prandlt number.
T	getColdTemperature () const
	delta temperature number
T	getHotTemperature () const
	delta temperature number
T	getDeltaTemperature () const
	delta temperature number
T	getAverageTemperature () const
	delta temperature number
T	getResolution () const
	resolution (a lattice of size 1 has getN()+1 cells)
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 () const
	number of lattice cells in x-direction
plint	getNy () const
	number of lattice cells in y-direction
plint	getNz () const
	number of lattice cells in z-direction
T	getLatticeU () const
	velocity in lattice units (proportional to Mach number)
T	getLatticeNu () const
	viscosity in lattice units
T	getLatticeKappa () const
	thermal conductivity in lattice units
T	getLatticeGravity () const
	viscosity in lattice units
T	getSolventTau () const
	relaxation time
T	getSolventOmega () const
	relaxation frequency
T	getTemperatureTau () const
	relaxation time
T	getTemperatureOmega () const
	relaxation frequency

---

Detailed Description

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>
class plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >

A useful class for the conversion between dimensionless and lattice units.

---

Constructor & Destructor Documentation

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::RayleighBenardFlowParam	(	T	Ra_,
		T	Pr_,
		T	uMax_,
		T	coldTemperature_,
		T	hotTemperature_,
		T	resolution_,
		T	lx_,
		T	ly_,
		T	lz_ = T()
	)			[inline]

Constructor.

Parameters:

	Re_	Reynolds number
	Ra_	Raylegh number
	Pr_	Prandtl number
	coldTemperature_	minimum temperature
	hotTemperature_	maximum temperature
	deltaT_	time discretization 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)

---

Member Function Documentation

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getAverageTemperature

(

)

const [inline]

delta temperature number

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getColdTemperature

(

)

const [inline]

delta temperature number

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getDeltaT

(

)

const [inline]

time step in dimensionless units

References plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeU().

Referenced by plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeGravity(), plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeNu(), plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::nStep(), and plb::writeLogFile().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getDeltaTemperature

(

)

const [inline]

delta temperature number

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getDeltaX

(

)

const [inline]

lattice spacing in dimensionless units

Referenced by plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeGravity(), plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeNu(), plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::nCell(), and plb::writeLogFile().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getHotTemperature

(

)

const [inline]

delta temperature number

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeGravity

(

)

const [inline]

viscosity in lattice units

References plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getDeltaT(), and plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getDeltaX().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeKappa

(

)

const [inline]

thermal conductivity in lattice units

References plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeNu(), and plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getPr().

Referenced by plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getTemperatureTau(), and plb::writeLogFile().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeNu

(

)

const [inline]

viscosity in lattice units

References plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getDeltaT(), plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getDeltaX(), and plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getRe().

Referenced by plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeKappa(), plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getSolventTau(), and plb::writeLogFile().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeU

(

)

const [inline]

velocity in lattice units (proportional to Mach number)

Referenced by plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getDeltaT(), and plb::writeLogFile().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLx

(

)

const [inline]

x-length in dimensionless units

Referenced by plb::writeLogFile().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLy

(

)

const [inline]

y-length in dimensionless units

Referenced by plb::writeLogFile().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLz

(

)

const [inline]

z-length in dimensionless units

Referenced by plb::writeLogFile().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

plint plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getNx

(

)

const [inline]

number of lattice cells in x-direction

References plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::nCell().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

plint plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getNy

(

)

const [inline]

number of lattice cells in y-direction

References plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::nCell().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

plint plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getNz

(

)

const [inline]

number of lattice cells in z-direction

References plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::nCell().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getPr

(

)

const [inline]

Prandlt number.

Referenced by plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeKappa(), plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getRe(), and plb::writeLogFile().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getRa

(

)

const [inline]

Rayleigh number.

Referenced by plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getRe(), and plb::writeLogFile().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getRe

(

)

const [inline]

Reynolds number.

References plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getPr(), and plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getRa().

Referenced by plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeNu(), and plb::writeLogFile().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getResolution

(

)

const [inline]

resolution (a lattice of size 1 has getN()+1 cells)

Referenced by plb::writeLogFile().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getSolventOmega

(

)

const [inline]

relaxation frequency

References plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getSolventTau().

Referenced by plb::writeLogFile().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getSolventTau

(

)

const [inline]

relaxation time

References plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeNu().

Referenced by plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getSolventOmega().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getTemperatureOmega

(

)

const [inline]

relaxation frequency

References plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getTemperatureTau().

Referenced by plb::writeLogFile().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

T plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getTemperatureTau

(

)

const [inline]

relaxation time

References plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getLatticeKappa().

Referenced by plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getTemperatureOmega().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

plint plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::nCell

(

T

l

)

const [inline]

conversion from dimensionless to lattice units for space coordinate

References plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getDeltaX().

Referenced by plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getNx(), plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getNy(), and plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getNz().

template<typename T, template< typename NSU > class nsDescriptor, template< typename ADU > class adDescriptor>

plint plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::nStep

(

T

t

)

const [inline]

conversion from dimensionless to lattice units for time coordinate

References plb::RayleighBenardFlowParam< T, nsDescriptor, adDescriptor >::getDeltaT().

---

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

• advectionDiffusionUnits.h