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

Implementation of O(Ma^2) BGK dynamics with adjustable speed of sound. More...

#include <isoThermalDynamics.h>

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

[legend]

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

[legend]

List of all members.

Public Member Functions
	ChopardDynamics (T vs2_, T omega_)
virtual ChopardDynamics< T, Descriptor > *	clone () const
	Clone the object on its dynamic type.
virtual int	getId () const
	Return a unique ID for this class.
virtual void	serialize (HierarchicSerializer &serializer) const
	Serialize the dynamics object.
virtual void	unserialize (HierarchicUnserializer &unserializer)
	Un-Serialize the dynamics object.
virtual void	collide (Cell< T, Descriptor > &cell, BlockStatistics &statistics_)
	Implementation of the collision step.
virtual void	collide (Cell< T, Descriptor > &cell, T rhoBar, Array< T, Descriptor< T >::d > const &j, T thetaBar, BlockStatistics &stat)
	Implementation of the collision step, with imposed macroscopic variables.
virtual T	computeEquilibrium (plint iPop, T rhoBar, Array< T, Descriptor< T >::d > const &j, T jSqr, T thetaBar=T()) const
	Compute equilibrium distribution function.
virtual void	setParameter (plint whichParameter, T value)
	Set local value of any generic parameter.
virtual T	getParameter (plint whichParameter) const
	Get local value of any generic parameter.
void	setVs2 (T vs2_)
	Set local speed of sound.
T	getVs2 () const
	Get local speed of sound.

---

Detailed Description

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

Implementation of O(Ma^2) BGK dynamics with adjustable speed of sound.

---

Constructor & Destructor Documentation

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

plb::ChopardDynamics< T, Descriptor >::ChopardDynamics	(	T	vs2_,
		T	omega_
	)			[inline]

Parameters:

	vs2_	speed of sound
	omega_	relaxation parameter, related to the dynamic viscosity

---

Member Function Documentation

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

ChopardDynamics< T, Descriptor > * plb::ChopardDynamics< T, Descriptor >::clone

(

)

const [inline, virtual]

Clone the object on its dynamic type.

Implements plb::Dynamics< T, Descriptor >.

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

void plb::ChopardDynamics< T, Descriptor >::collide	(	Cell< T, Descriptor > &	cell,
		T	rhoBar,
		Array< T, Descriptor< T >::d > const &	j,
		T	thetaBar,
		BlockStatistics &	stat
	)			[inline, virtual]

Implementation of the collision step, with imposed macroscopic variables.

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

References plb::BasicBulkDynamics< T, Descriptor >::getOmega().

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

void plb::ChopardDynamics< T, Descriptor >::collide	(	Cell< T, Descriptor > &	cell,
		BlockStatistics &	statistics_
	)			[inline, virtual]

Implementation of the collision step.

Implements plb::Dynamics< T, Descriptor >.

References plb::gatherStatistics(), plb::BasicBulkDynamics< T, Descriptor >::getOmega(), and plb::Cell< T, Descriptor >::takesStatistics().

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

T plb::ChopardDynamics< T, Descriptor >::computeEquilibrium	(	plint	iPop,
		T	rhoBar,
		Array< T, Descriptor< T >::d > const &	j,
		T	jSqr,
		T	thetaBar = T()
	)			const [inline, virtual]

Compute equilibrium distribution function.

Implements plb::Dynamics< T, Descriptor >.

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

int plb::ChopardDynamics< T, Descriptor >::getId

(

)

const [inline, virtual]

Return a unique ID for this class.

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

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

T plb::ChopardDynamics< T, Descriptor >::getParameter

(

plint

whichParameter

)

const [inline, virtual]

Get local value of any generic parameter.

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

References plb::BasicBulkDynamics< T, Descriptor >::getOmega(), plb::ChopardDynamics< T, Descriptor >::getVs2(), plb::dynamicParams::omega_shear, and plb::dynamicParams::sqrSpeedOfSound.

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

T plb::ChopardDynamics< T, Descriptor >::getVs2

(

)

const [inline]

Get local speed of sound.

Referenced by plb::ChopardDynamics< T, Descriptor >::getParameter().

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

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

(

HierarchicSerializer &

serializer

)

const [inline, virtual]

Serialize the dynamics object.

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

References plb::HierarchicSerializer::addValue(), and plb::BasicBulkDynamics< T, Descriptor >::getOmega().

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

void plb::ChopardDynamics< T, Descriptor >::setParameter	(	plint	whichParameter,
		T	value
	)			[inline, virtual]

Set local value of any generic parameter.

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

References plb::dynamicParams::omega_shear, plb::BasicBulkDynamics< T, Descriptor >::setOmega(), plb::ChopardDynamics< T, Descriptor >::setVs2(), and plb::dynamicParams::sqrSpeedOfSound.

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

void plb::ChopardDynamics< T, Descriptor >::setVs2

(

T

vs2_

)

[inline]

Set local speed of sound.

Referenced by plb::ChopardDynamics< T, Descriptor >::setParameter().

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

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

(

HierarchicUnserializer &

unserializer

)

[inline, virtual]

Un-Serialize the dynamics object.

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

References plb::HierarchicUnserializer::readValue(), and plb::BasicBulkDynamics< T, Descriptor >::setOmega().

---

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

• isoThermalDynamics.h
• isoThermalDynamics.hh