LBMBase< micro_type, macro_type, dim > Class Template Reference

Basic class for derivation of Lattice Boltzmann operators. More...

#include <LBMBase.h>

Inheritance diagram for LBMBase< micro_type, macro_type, dim >:

List of all members.

Public Types
enum	Scaling { Physical, Lattice }
typedef micro_type	MicroType
typedef macro_type	MacroType
typedef base::DataType	DataType
typedef base::vec_grid_data_type	vec_grid_data_type
Public Member Functions
	LBMBase ()
virtual	~LBMBase ()
virtual MacroType	MacroVariables (const MicroType &f) const =0
virtual MicroType	Equilibrium (const MacroType &q) const =0
virtual void	LocalStep (vec_grid_data_type &fvec, vec_grid_data_type &ovec, const BBox &bb, const double &dt) const =0
virtual void	ReverseStream (vec_grid_data_type &fvec, const BBox &bb, const int side) const =0
virtual int	IncomingIndices (const int side, int indices[]) const =0
virtual int	OutgoingIndices (const int side, int indices[]) const =0
virtual const DataType	Omega (const DataType dt) const =0
virtual bool	GFMUseTransform () const
virtual void	GFMTransform (vec_grid_data_type &fvec, vec_grid_data_type &fvechelp) const
virtual int	NMaxPass () const
virtual void	SetLengthScale (const DataType l0)
virtual void	SetTimeScale (const DataType t0)
const DataType &	LengthScale () const
const DataType &	TimeScale () const
const int &	NMicroVar () const
const int &	NMacroVar () const
Protected Attributes
int	_MacroVariables
DataType	L0
DataType	T0

---

Detailed Description

template<class micro_type, class macro_type, int dim>
class LBMBase< micro_type, macro_type, dim >

Basic class for derivation of Lattice Boltzmann operators.

Author:

Ralf Deiterding

Version:

1.0

Date:

Nov-2012

---

Member Typedef Documentation

template<class micro_type, class macro_type, int dim>

typedef base::DataType LBMBase< micro_type, macro_type, dim >::DataType

Reimplemented from SchemeBase< micro_type, dim >.

template<class micro_type, class macro_type, int dim>

typedef macro_type LBMBase< micro_type, macro_type, dim >::MacroType

Reimplemented in LBM4SWED2Q9< DataType >, LBMD1Q3< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9DR< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9Smag< DataType >, LBMD2Q9Thermal< DataType >, LBMD2Q9Thermal< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19DR< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19Thermal< DataType >, LBMD3Q19Thermal< DataType >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, and LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >.

template<class micro_type, class macro_type, int dim>

typedef micro_type LBMBase< micro_type, macro_type, dim >::MicroType

Reimplemented in LBM4SWED2Q9< DataType >, LBMD1Q3< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9DR< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9Smag< DataType >, LBMD2Q9Thermal< DataType >, LBMD2Q9Thermal< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19DR< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19Thermal< DataType >, LBMD3Q19Thermal< DataType >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, and LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >.

template<class micro_type, class macro_type, int dim>

typedef base::vec_grid_data_type LBMBase< micro_type, macro_type, dim >::vec_grid_data_type

Reimplemented from SchemeBase< micro_type, dim >.

Reimplemented in LBM4SWED2Q9< DataType >, LBMD1Q3< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9DR< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9Smag< DataType >, LBMD2Q9Thermal< DataType >, LBMD2Q9Thermal< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19DR< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19Thermal< DataType >, LBMD3Q19Thermal< DataType >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, and LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >.

---

Member Enumeration Documentation

template<class micro_type, class macro_type, int dim>

enum LBMBase::Scaling

Enumerator:

Physical
Lattice

---

Constructor & Destructor Documentation

template<class micro_type, class macro_type, int dim>

LBMBase< micro_type, macro_type, dim >::LBMBase

(

)

[inline]

template<class micro_type, class macro_type, int dim>

virtual LBMBase< micro_type, macro_type, dim >::~LBMBase

(

)

[inline, virtual]

---

Member Function Documentation

template<class micro_type, class macro_type, int dim>

virtual MicroType LBMBase< micro_type, macro_type, dim >::Equilibrium

(

const MacroType &

q

)

const [pure virtual]

Implemented in LBM4SWED2Q9< DataType >, LBMD1Q3< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9Smag< DataType >, LBMD2Q9Thermal< DataType >, LBMD2Q9Thermal< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19Thermal< DataType >, LBMD3Q19Thermal< DataType >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, and LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >.

template<class micro_type, class macro_type, int dim>

virtual void LBMBase< micro_type, macro_type, dim >::GFMTransform	(	vec_grid_data_type &	fvec,
		vec_grid_data_type &	fvechelp
	)			const [inline, virtual]

template<class micro_type, class macro_type, int dim>

virtual bool LBMBase< micro_type, macro_type, dim >::GFMUseTransform

(

)

const [inline, virtual]

Implements SchemeBase< micro_type, dim >.

template<class micro_type, class macro_type, int dim>

virtual int LBMBase< micro_type, macro_type, dim >::IncomingIndices	(	const int	side,
		int	indices[]
	)			const [pure virtual]

Implemented in LBM4SWED2Q9< DataType >, LBMD1Q3< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9Smag< DataType >, LBMD2Q9Thermal< DataType >, LBMD2Q9Thermal< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19Thermal< DataType >, LBMD3Q19Thermal< DataType >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, and LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >.

template<class micro_type, class macro_type, int dim>

const DataType& LBMBase< micro_type, macro_type, dim >::LengthScale

(

)

const [inline]

template<class micro_type, class macro_type, int dim>

virtual void LBMBase< micro_type, macro_type, dim >::LocalStep	(	vec_grid_data_type &	fvec,
		vec_grid_data_type &	ovec,
		const BBox &	bb,
		const double &	dt
	)			const [pure virtual]

Implemented in LBM4SWED2Q9< DataType >, LBMD1Q3< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9Smag< DataType >, LBMD2Q9Thermal< DataType >, LBMD2Q9Thermal< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19Thermal< DataType >, LBMD3Q19Thermal< DataType >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, and LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >.

template<class micro_type, class macro_type, int dim>

virtual MacroType LBMBase< micro_type, macro_type, dim >::MacroVariables

(

const MicroType &

f

)

const [pure virtual]

Implemented in LBM4SWED2Q9< DataType >, LBMD1Q3< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9Smag< DataType >, LBMD2Q9Thermal< DataType >, LBMD2Q9Thermal< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19Thermal< DataType >, LBMD3Q19Thermal< DataType >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, and LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >.

template<class micro_type, class macro_type, int dim>

const int& LBMBase< micro_type, macro_type, dim >::NMacroVar

(

)

const [inline]

template<class micro_type, class macro_type, int dim>

virtual int LBMBase< micro_type, macro_type, dim >::NMaxPass

(

)

const [inline, virtual]

Implements SchemeBase< micro_type, dim >.

template<class micro_type, class macro_type, int dim>

const int& LBMBase< micro_type, macro_type, dim >::NMicroVar

(

)

const [inline]

template<class micro_type, class macro_type, int dim>

virtual const DataType LBMBase< micro_type, macro_type, dim >::Omega

(

const DataType

dt

)

const [inline, pure virtual]

Implemented in LBM4SWED2Q9< DataType >, LBMD1Q3< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9Smag< DataType >, LBMD2Q9Thermal< DataType >, LBMD2Q9Thermal< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19Thermal< DataType >, and LBMD3Q19Thermal< DataType >.

template<class micro_type, class macro_type, int dim>

virtual int LBMBase< micro_type, macro_type, dim >::OutgoingIndices	(	const int	side,
		int	indices[]
	)			const [pure virtual]

Implemented in LBM4SWED2Q9< DataType >, LBMD1Q3< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9Smag< DataType >, LBMD2Q9Thermal< DataType >, LBMD2Q9Thermal< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19Thermal< DataType >, LBMD3Q19Thermal< DataType >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, and LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >.

template<class micro_type, class macro_type, int dim>

virtual void LBMBase< micro_type, macro_type, dim >::ReverseStream	(	vec_grid_data_type &	fvec,
		const BBox &	bb,
		const int	side
	)			const [pure virtual]

Implemented in LBM4SWED2Q9< DataType >, LBMD1Q3< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9Smag< DataType >, LBMD2Q9Thermal< DataType >, LBMD2Q9Thermal< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19Thermal< DataType >, LBMD3Q19Thermal< DataType >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >, and LBMD2Q9< Vector< DataType, 9 >, Vector< DataType, 3 >, 2 >.

template<class micro_type, class macro_type, int dim>

virtual void LBMBase< micro_type, macro_type, dim >::SetLengthScale

(

const DataType

l0

)

[inline, virtual]

template<class micro_type, class macro_type, int dim>

virtual void LBMBase< micro_type, macro_type, dim >::SetTimeScale

(

const DataType

t0

)

[inline, virtual]

Reimplemented in LBM4SWED2Q9< DataType >, LBMD1Q3< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9< DataType >, LBMD2Q9Smag< DataType >, LBMD2Q9Thermal< DataType >, LBMD2Q9Thermal< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19< DataType >, LBMD3Q19Thermal< DataType >, and LBMD3Q19Thermal< DataType >.

template<class micro_type, class macro_type, int dim>

const DataType& LBMBase< micro_type, macro_type, dim >::TimeScale

(

)

const [inline]

---

Member Data Documentation

template<class micro_type, class macro_type, int dim>

int LBMBase< micro_type, macro_type, dim >::_MacroVariables [protected]

Referenced by LBMBase< Vector< DataType, 19 >, Vector< DataType, 4 >, 3 >::NMacroVar().

template<class micro_type, class macro_type, int dim>

DataType LBMBase< micro_type, macro_type, dim >::L0 [protected]

Referenced by LBMBase< Vector< DataType, 19 >, Vector< DataType, 4 >, 3 >::LengthScale(), and LBMBase< Vector< DataType, 19 >, Vector< DataType, 4 >, 3 >::SetLengthScale().

template<class micro_type, class macro_type, int dim>

DataType LBMBase< micro_type, macro_type, dim >::T0 [protected]

Referenced by LBMBase< Vector< DataType, 19 >, Vector< DataType, 4 >, 3 >::SetTimeScale(), and LBMBase< Vector< DataType, 19 >, Vector< DataType, 4 >, 3 >::TimeScale().

---

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

• amroc/lbm/LBMBase.h