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

Density and Velocity are stored inside dynamics. More...

#include <boundaryDynamics.h>

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

[legend]

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

[legend]

List of all members.

Public Member Functions
	StoreDensityAndVelocityDynamics (Dynamics< T, Descriptor > *baseDynamics_, bool automaticPrepareCollision_=true)
	StoreDensityAndVelocityDynamics (HierarchicUnserializer &unserializer)
virtual StoreDensityAndVelocityDynamics < T, Descriptor > *	clone () const
	Clone the object, based 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 T	computeDensity (Cell< T, Descriptor > const &cell) const
	Compute the local particle density in lattice units.
virtual void	computeVelocity (Cell< T, Descriptor > const &cell, Array< T, Descriptor< T >::d > &velocity_) const
	Compute the local fluid velocity in lattice units.
virtual void	defineDensity (Cell< T, Descriptor > &cell, T rho_)
	Define density. Stores the value inside the Dynamics object.
virtual void	defineVelocity (Cell< T, Descriptor > &cell, Array< T, Descriptor< T >::d > const &velocity_)
	Define velocity. Stores value inside Dynamics object.
virtual T	computeRhoBar (Cell< T, Descriptor > const &cell) const
	Compute order-0 moment rho-bar.
virtual void	computeRhoBarJ (Cell< T, Descriptor > const &cell, T &rhoBar_, Array< T, Descriptor< T >::d > &j) const
	Compute order-0 moment rho-bar and order-1 moment j.
Protected Attributes
T	rhoBar
Array< T, Descriptor< T >::d >	velocity

---

Detailed Description

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

Density and Velocity are stored inside dynamics.

---

Constructor & Destructor Documentation

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

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

References plb::Array< T, size >::resetToZero(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::rhoBar, and plb::StoreDensityAndVelocityDynamics< T, Descriptor >::velocity.

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

plb::StoreDensityAndVelocityDynamics< T, Descriptor >::StoreDensityAndVelocityDynamics

(

HierarchicUnserializer &

unserializer

)

[inline]

References plb::StoreDensityAndVelocityDynamics< T, Descriptor >::unserialize().

---

Member Function Documentation

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

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

(

)

const [inline, virtual]

Clone the object, based on its dynamic type.

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

Reimplemented in plb::EquilibriumDensityAndVelocityBoundaryDynamics< T, Descriptor >.

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

T plb::StoreDensityAndVelocityDynamics< T, Descriptor >::computeDensity

(

Cell< T, Descriptor > const &

cell

)

const [inline, virtual]

Compute the local particle density in lattice units.

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

References plb::StoreDensityAndVelocityDynamics< T, Descriptor >::rhoBar.

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

T plb::StoreDensityAndVelocityDynamics< T, Descriptor >::computeRhoBar

(

Cell< T, Descriptor > const &

cell

)

const [inline, virtual]

Compute order-0 moment rho-bar.

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

References plb::StoreDensityAndVelocityDynamics< T, Descriptor >::rhoBar.

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

void plb::StoreDensityAndVelocityDynamics< T, Descriptor >::computeRhoBarJ	(	Cell< T, Descriptor > const &	cell,
		T &	rhoBar_,
		Array< T, Descriptor< T >::d > &	j
	)			const [inline, virtual]

Compute order-0 moment rho-bar and order-1 moment j.

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

References plb::getExternalForceComponent(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::rhoBar, and plb::StoreDensityAndVelocityDynamics< T, Descriptor >::velocity.

Referenced by plb::EquilibriumDensityAndVelocityBoundaryDynamics< T, Descriptor >::completePopulations().

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

void plb::StoreDensityAndVelocityDynamics< T, Descriptor >::computeVelocity	(	Cell< T, Descriptor > const &	cell,
		Array< T, Descriptor< T >::d > &	velocity_
	)			const [inline, virtual]

Compute the local fluid velocity in lattice units.

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

References plb::StoreDensityAndVelocityDynamics< T, Descriptor >::rhoBar, plb::CompositeDynamics< T, Descriptor >::velIsJ(), and plb::StoreDensityAndVelocityDynamics< T, Descriptor >::velocity.

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

void plb::StoreDensityAndVelocityDynamics< T, Descriptor >::defineDensity	(	Cell< T, Descriptor > &	cell,
		T	rho_
	)			[inline, virtual]

Define density. Stores the value inside the Dynamics object.

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

References plb::StoreDensityAndVelocityDynamics< T, Descriptor >::rhoBar.

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

void plb::StoreDensityAndVelocityDynamics< T, Descriptor >::defineVelocity	(	Cell< T, Descriptor > &	cell,
		Array< T, Descriptor< T >::d > const &	velocity_
	)			[inline, virtual]

Define velocity. Stores value inside Dynamics object.

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

References plb::StoreDensityAndVelocityDynamics< T, Descriptor >::velocity.

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

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

(

)

const [inline, virtual]

Return a unique ID for this class.

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

Reimplemented in plb::EquilibriumDensityAndVelocityBoundaryDynamics< T, Descriptor >.

Referenced by plb::StoreDensityAndVelocityDynamics< T, Descriptor >::unserialize().

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

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

(

HierarchicSerializer &

serializer

)

const [inline, virtual]

Serialize the dynamics object.

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

References plb::HierarchicSerializer::addValue(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::rhoBar, and plb::StoreDensityAndVelocityDynamics< T, Descriptor >::velocity.

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

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

(

HierarchicUnserializer &

unserializer

)

[inline, virtual]

Un-Serialize the dynamics object.

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

References plb::StoreDensityAndVelocityDynamics< T, Descriptor >::getId(), plb::HierarchicUnserializer::getId(), PLB_PRECONDITION, plb::HierarchicUnserializer::readValue(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::rhoBar, and plb::StoreDensityAndVelocityDynamics< T, Descriptor >::velocity.

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

---

Member Data Documentation

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

T plb::StoreDensityAndVelocityDynamics< T, Descriptor >::rhoBar [protected]

Referenced by plb::EquilibriumDensityAndVelocityBoundaryDynamics< T, Descriptor >::completePopulations(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::computeDensity(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::computeRhoBar(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::computeRhoBarJ(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::computeVelocity(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::defineDensity(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::serialize(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::StoreDensityAndVelocityDynamics(), and plb::StoreDensityAndVelocityDynamics< T, Descriptor >::unserialize().

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

Array<T,Descriptor<T>::d> plb::StoreDensityAndVelocityDynamics< T, Descriptor >::velocity [protected]

Referenced by plb::StoreDensityAndVelocityDynamics< T, Descriptor >::computeRhoBarJ(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::computeVelocity(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::defineVelocity(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::serialize(), plb::StoreDensityAndVelocityDynamics< T, Descriptor >::StoreDensityAndVelocityDynamics(), and plb::StoreDensityAndVelocityDynamics< T, Descriptor >::unserialize().

---

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

• boundaryDynamics.h
• boundaryDynamics.hh