plb::VariableOmegaDynamics< T, Descriptor > Class Template Reference

A dynamics for space-dependent relaxation parameter, generic with respect to base dynamics. More...

#include <variableOmegaDynamics.h>

Inheritance diagram for plb::VariableOmegaDynamics< T, Descriptor >:

[legend]

Collaboration diagram for plb::VariableOmegaDynamics< T, Descriptor >:

[legend]

List of all members.

Public Member Functions
	VariableOmegaDynamics (Dynamics< T, Descriptor > *baseDynamics_, bool automaticPrepareCollision_=true)
virtual void	serialize (HierarchicSerializer &serializer) const
	Serialize the dynamics object.
virtual void	unserialize (HierarchicUnserializer &unserializer)
	Un-Serialize the dynamics object.
virtual void	prepareCollision (Cell< T, Descriptor > &cell)
	Do something before execution of main collision step.
virtual T	getOmegaFromCell (Cell< T, Descriptor > const &cell) const =0

---

Detailed Description

template<typename T, template< typename U > class Descriptor>
class plb::VariableOmegaDynamics< T, Descriptor >

A dynamics for space-dependent relaxation parameter, generic with respect to base dynamics.

Important: The philosophy here is that the actual relaxation parameter used during collision is omega=omega0+deltaOmega. When you refer to an object "o" of type VariableOmegaDynamics, the "omega" used in "o.setOmega()" and "o.getOmega()" is omega0, whereas the "omega" in "o.getBaseDynamics().setOmega()" and in "o.getBaseDynamics().getOemga()" is omega0+deltaOmega.

---

Constructor & Destructor Documentation

template<typename T , template< typename U > class Descriptor>

plb::VariableOmegaDynamics< T, Descriptor >::VariableOmegaDynamics	(	Dynamics< T, Descriptor > *	baseDynamics_,
		bool	automaticPrepareCollision_ = true
	)			[inline]

---

Member Function Documentation

template<typename T , template< typename U > class Descriptor>

virtual T plb::VariableOmegaDynamics< T, Descriptor >::getOmegaFromCell

(

Cell< T, Descriptor > const &

cell

)

const [pure virtual]

Implemented in plb::OmegaFromPiDynamics< T, Descriptor >.

Referenced by plb::VariableOmegaDynamics< T, Descriptor >::prepareCollision().

template<typename T , template< typename U > class Descriptor>

void plb::VariableOmegaDynamics< T, Descriptor >::prepareCollision

(

Cell< T, Descriptor > &

cell

)

[inline, virtual]

Do something before execution of main collision step.

Implements plb::CompositeDynamics< T, Descriptor >.

References plb::CompositeDynamics< T, Descriptor >::getBaseDynamics(), and plb::VariableOmegaDynamics< T, Descriptor >::getOmegaFromCell().

template<typename T , template< typename U > class Descriptor>

void plb::VariableOmegaDynamics< T, Descriptor >::serialize

(

HierarchicSerializer &

serializer

)

const [inline, virtual]

Serialize the dynamics object.

Reimplemented from plb::CompositeDynamics< T, Descriptor >.

Reimplemented in plb::SmagorinskyDynamics< T, Descriptor >, and plb::OmegaFromPiDynamics< T, Descriptor >.

template<typename T , template< typename U > class Descriptor>

void plb::VariableOmegaDynamics< T, Descriptor >::unserialize

(

HierarchicUnserializer &

unserializer

)

[inline, virtual]

Un-Serialize the dynamics object.

Reimplemented from plb::CompositeDynamics< T, Descriptor >.

Reimplemented in plb::SmagorinskyDynamics< T, Descriptor >, and plb::OmegaFromPiDynamics< T, Descriptor >.

---

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

• variableOmegaDynamics.h
• variableOmegaDynamics.hh