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

#include <mrtDynamics.h>

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

[legend]

List of all members.

Public Types
typedef T	MatT [Descriptor< T >::q][Descriptor< T >::q]
Public Member Functions
	MRTparam ()
virtual	~MRTparam ()
	MRTparam (T omega_)
	MRTparam (T omega_, T lambda_)
	MRTparam (std::vector< T > s_)
	MRTparam (HierarchicUnserializer &unserializer)
void	serialize (HierarchicSerializer &serializer) const
void	unserialize (HierarchicUnserializer &unserializer)
MRTparam< T, Descriptor > *	clone () const
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.
virtual T	getOmega () const
	Get local relaxation parameter for shear viscosity.
virtual void	setOmega (T omega_)
	Set local relaxation parameter for shear viscosity.
T	getLambda () const
	Get local relaxation parameter for bulk viscosity.
void	setLambda (T lambda_)
	Set local relaxation parameter for bulk viscosity.
T	getOmegaQ () const
	Get local relaxation parameter for q parameter.
void	setOmegaQ (T q_)
	Set local relaxation parameter for q parameter.
T	getOmegaEpsilon () const
	Get local relaxation parameter for epsilon parameter.
void	setOmegaEpsilon (T epsilon_)
	Set local relaxation parameter for epsilon parameter.
std::vector< T > const &	getS () const
	Returns the relaxation frequencies vector.
MatT &	getInvM ()
	Returns relaxation time matrix.

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

---

Member Typedef Documentation

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

typedef T plb::MRTparam< T, Descriptor >::MatT[Descriptor< T >::q][Descriptor< T >::q]

---

Constructor & Destructor Documentation

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

plb::MRTparam< T, Descriptor >::MRTparam

(

)

[inline]

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

virtual plb::MRTparam< T, Descriptor >::~MRTparam

(

)

[inline, virtual]

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

plb::MRTparam< T, Descriptor >::MRTparam

(

T

omega_

)

[inline]

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

plb::MRTparam< T, Descriptor >::MRTparam	(	T	omega_,
		T	lambda_
	)			[inline]

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

plb::MRTparam< T, Descriptor >::MRTparam

(

std::vector< T >

s_

)

[inline]

References PLB_ASSERT.

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

plb::MRTparam< T, Descriptor >::MRTparam

(

HierarchicUnserializer &

unserializer

)

[inline]

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

---

Member Function Documentation

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

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

(

)

const [inline]

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

MRTparam< T, Descriptor >::MatT & plb::MRTparam< T, Descriptor >::getInvM

(

)

[inline]

Returns relaxation time matrix.

Referenced by plb::ExternalVelocityIncMRTdynamics< T, Descriptor >::collide(), plb::IncMRTdynamics< T, Descriptor >::collide(), plb::ExternalVelocityMRTdynamics< T, Descriptor >::collide(), and plb::MRTdynamics< T, Descriptor >::collide().

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

T plb::MRTparam< T, Descriptor >::getLambda

(

)

const [inline]

Get local relaxation parameter for bulk viscosity.

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

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

T plb::MRTparam< T, Descriptor >::getOmega

(

)

const [inline, virtual]

Get local relaxation parameter for shear viscosity.

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

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

T plb::MRTparam< T, Descriptor >::getOmegaEpsilon

(

)

const [inline]

Get local relaxation parameter for epsilon parameter.

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

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

T plb::MRTparam< T, Descriptor >::getOmegaQ

(

)

const [inline]

Get local relaxation parameter for q parameter.

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

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

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

(

plint

whichParameter

)

const [inline, virtual]

Get local value of any generic parameter.

References plb::MRTparam< T, Descriptor >::getLambda(), plb::MRTparam< T, Descriptor >::getOmega(), plb::MRTparam< T, Descriptor >::getOmegaEpsilon(), plb::MRTparam< T, Descriptor >::getOmegaQ(), plb::dynamicParams::omega_bulk, plb::dynamicParams::omega_epsilon, plb::dynamicParams::omega_q, and plb::dynamicParams::omega_shear.

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

std::vector< T > const & plb::MRTparam< T, Descriptor >::getS

(

)

const [inline]

Returns the relaxation frequencies vector.

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

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

(

HierarchicSerializer &

serializer

)

const [inline]

References plb::HierarchicSerializer::addValue(), and plb::HierarchicSerializer::addValues().

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

void plb::MRTparam< T, Descriptor >::setLambda

(

T

lambda_

)

[inline]

Set local relaxation parameter for bulk viscosity.

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

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

void plb::MRTparam< T, Descriptor >::setOmega

(

T

omega_

)

[inline, virtual]

Set local relaxation parameter for shear viscosity.

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

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

void plb::MRTparam< T, Descriptor >::setOmegaEpsilon

(

T

epsilon_

)

[inline]

Set local relaxation parameter for epsilon parameter.

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

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

void plb::MRTparam< T, Descriptor >::setOmegaQ

(

T

q_

)

[inline]

Set local relaxation parameter for q parameter.

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

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

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

Set local value of any generic parameter.

References plb::dynamicParams::omega_bulk, plb::dynamicParams::omega_epsilon, plb::dynamicParams::omega_q, plb::dynamicParams::omega_shear, plb::MRTparam< T, Descriptor >::setLambda(), plb::MRTparam< T, Descriptor >::setOmega(), plb::MRTparam< T, Descriptor >::setOmegaEpsilon(), and plb::MRTparam< T, Descriptor >::setOmegaQ().

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

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

(

HierarchicUnserializer &

unserializer

)

[inline]

References plb::HierarchicUnserializer::readValue(), and plb::HierarchicUnserializer::readValues().

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

---

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

• mrtDynamics.h
• mrtDynamics.hh