plb::CarreauFlowParam< T > Class Template Reference

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

#include <carreauUnits.h>

Collaboration diagram for plb::CarreauFlowParam< T >:

[legend]

List of all members.

Public Member Functions
	CarreauFlowParam (T latticeU_, T Re_, T Cu_, T nuInf_, T n_, plint resolution_, T lx_, T ly_, T lz_=T())
	Constructor.
T	getLatticeU () const
	velocity in lattice units (proportional to Mach number)
T	getRe () const
	Reynolds number.
T	getCu () const
	Carreau number (lambda*u/L).
T	getExponent () const
	The exponent of the power-law.
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	getLatticeNu0 () const
	solvent viscosity at zero shear rate in lattice units
T	getLatticeNuInf () const
	solvent viscosity at infinite shear rate in lattice units
T	getLatticeLambda () const
	lambda paramter in lattice units
T	getTau0 () const
	solvent relaxation time
T	getOmega0 () const
	solvent relaxation frequency
T	getTauInf () const
	solvent relaxation time
T	getOmegaInf () const
	solvent relaxation frequency

---

Detailed Description

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

Numeric parameters for isothermal, incompressible flow.

---

Constructor & Destructor Documentation

template<typename T>

plb::CarreauFlowParam< T >::CarreauFlowParam	(	T	latticeU_,
		T	Re_,
		T	Cu_,
		T	nuInf_,
		T	n_,
		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).

---

Member Function Documentation

template<typename T>

T plb::CarreauFlowParam< T >::getCu

(

)

const [inline]

Carreau number (lambda*u/L).

Referenced by plb::CarreauFlowParam< T >::getLatticeLambda(), and plb::writeLogFile().

template<typename T>

T plb::CarreauFlowParam< T >::getDeltaT

(

)

const [inline]

time step in dimensionless units

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

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

template<typename T>

T plb::CarreauFlowParam< T >::getDeltaX

(

)

const [inline]

lattice spacing in dimensionless units

References plb::CarreauFlowParam< T >::getResolution().

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

template<typename T>

T plb::CarreauFlowParam< T >::getExponent

(

)

const [inline]

The exponent of the power-law.

Referenced by plb::writeLogFile().

template<typename T>

T plb::CarreauFlowParam< T >::getLatticeLambda

(

)

const [inline]

lambda paramter in lattice units

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

Referenced by plb::writeLogFile().

template<typename T>

T plb::CarreauFlowParam< T >::getLatticeNu0

(

)

const [inline]

solvent viscosity at zero shear rate in lattice units

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

Referenced by plb::CarreauFlowParam< T >::getTau0(), and plb::writeLogFile().

template<typename T>

T plb::CarreauFlowParam< T >::getLatticeNuInf

(

)

const [inline]

solvent viscosity at infinite shear rate in lattice units

Referenced by plb::CarreauFlowParam< T >::getTauInf(), and plb::writeLogFile().

template<typename T>

T plb::CarreauFlowParam< T >::getLatticeU

(

)

const [inline]

velocity in lattice units (proportional to Mach number)

Referenced by plb::CarreauFlowParam< T >::getDeltaT(), plb::CarreauFlowParam< T >::getLatticeLambda(), plb::CarreauFlowParam< T >::getLatticeNu0(), and plb::writeLogFile().

template<typename T>

T plb::CarreauFlowParam< T >::getLx

(

)

const [inline]

x-length in dimensionless units

Referenced by plb::writeLogFile().

template<typename T>

T plb::CarreauFlowParam< T >::getLy

(

)

const [inline]

y-length in dimensionless units

Referenced by plb::writeLogFile().

template<typename T>

T plb::CarreauFlowParam< T >::getLz

(

)

const [inline]

z-length in dimensionless units

Referenced by plb::writeLogFile().

template<typename T>

plint plb::CarreauFlowParam< T >::getNx

(

bool

offLattice = false

)

const [inline]

number of lattice cells in x-direction

References plb::CarreauFlowParam< T >::nCell().

template<typename T>

plint plb::CarreauFlowParam< T >::getNy

(

bool

offLattice = false

)

const [inline]

number of lattice cells in y-direction

References plb::CarreauFlowParam< T >::nCell().

template<typename T>

plint plb::CarreauFlowParam< T >::getNz

(

bool

offLattice = false

)

const [inline]

number of lattice cells in z-direction

References plb::CarreauFlowParam< T >::nCell().

template<typename T>

T plb::CarreauFlowParam< T >::getOmega0

(

)

const [inline]

solvent relaxation frequency

References plb::CarreauFlowParam< T >::getTau0().

Referenced by plb::writeLogFile().

template<typename T>

T plb::CarreauFlowParam< T >::getOmegaInf

(

)

const [inline]

solvent relaxation frequency

References plb::CarreauFlowParam< T >::getTauInf().

Referenced by plb::writeLogFile().

template<typename T>

T plb::CarreauFlowParam< T >::getRe

(

)

const [inline]

Reynolds number.

Referenced by plb::CarreauFlowParam< T >::getLatticeNu0(), and plb::writeLogFile().

template<typename T>

plint plb::CarreauFlowParam< T >::getResolution

(

)

const [inline]

resolution

Referenced by plb::CarreauFlowParam< T >::getDeltaX(), plb::CarreauFlowParam< T >::getLatticeLambda(), plb::CarreauFlowParam< T >::getLatticeNu0(), and plb::writeLogFile().

template<typename T>

T plb::CarreauFlowParam< T >::getTau0

(

)

const [inline]

solvent relaxation time

References plb::CarreauFlowParam< T >::getLatticeNu0().

Referenced by plb::CarreauFlowParam< T >::getOmega0().

template<typename T>

T plb::CarreauFlowParam< T >::getTauInf

(

)

const [inline]

solvent relaxation time

References plb::CarreauFlowParam< T >::getLatticeNuInf().

Referenced by plb::CarreauFlowParam< T >::getOmegaInf().

template<typename T>

plint plb::CarreauFlowParam< T >::nCell

(

T

l

)

const [inline]

conversion from dimensionless to lattice units for space coordinate

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

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

template<typename T>

plint plb::CarreauFlowParam< T >::nStep

(

T

t

)

const [inline]

conversion from dimensionless to lattice units for time coordinate

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

---

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

• carreauUnits.h