plb::RefinementParameters< T > Class Template Reference

Interface for a wrapper of refinement parameters (each level posseses specific parameters). More...

#include <multiGridParameterManager.h>

Inheritance diagram for plb::RefinementParameters< T >:

[legend]

List of all members.

Public Member Functions
	RefinementParameters (plint levelNumber_, plint referenceLevel_, IncomprFlowParam< T > parameters_)
	Interface for a wrapper of refinement parameters (each level posseses specific parameters).
	RefinementParameters (RefinementParameters< T > const &rhs)
virtual void	createParameters ()=0
	This function shall define the scaling between the grids by defining all the parameters.
virtual	~RefinementParameters ()
IncomprFlowParam< T > const &	getParameters (plint lvl) const
plint	getReferenceLevel ()
plint	getNumLevels ()
IncomprFlowParam< T > const &	operator[] (plint lvl) const
void	putParameter (IncomprFlowParam< T > &newParam)
IncomprFlowParam< T > &	getOriginalParameters ()

---

Detailed Description

template<typename T>
class plb::RefinementParameters< T >

Interface for a wrapper of refinement parameters (each level posseses specific parameters).

---

Constructor & Destructor Documentation

template<typename T >

plb::RefinementParameters< T >::RefinementParameters	(	plint	levelNumber_,
		plint	referenceLevel_,
		IncomprFlowParam< T >	parameters_
	)			[inline]

Interface for a wrapper of refinement parameters (each level posseses specific parameters).

template<typename T >

plb::RefinementParameters< T >::RefinementParameters

(

RefinementParameters< T > const &

rhs

)

[inline]

template<typename T>

virtual plb::RefinementParameters< T >::~RefinementParameters

(

)

[inline, virtual]

---

Member Function Documentation

template<typename T>

virtual void plb::RefinementParameters< T >::createParameters

(

)

[pure virtual]

This function shall define the scaling between the grids by defining all the parameters.

Implemented in plb::ConvectiveRefinementParameters< T >, and plb::DiffusiveRefinementParameters< T >.

template<typename T >

plint plb::RefinementParameters< T >::getNumLevels

(

)

[inline]

Referenced by plb::generateBGKdynamics(), and plb::generateBounceBackDynamics().

template<typename T >

IncomprFlowParam< T > & plb::RefinementParameters< T >::getOriginalParameters

(

)

[inline]

Referenced by plb::DiffusiveRefinementParameters< T >::createParameters(), and plb::ConvectiveRefinementParameters< T >::createParameters().

template<typename T >

IncomprFlowParam< T > const & plb::RefinementParameters< T >::getParameters

(

plint

lvl

)

const [inline]

References PLB_PRECONDITION.

Referenced by plb::generateBGKdynamics(), and plb::RefinementParameters< T >::operator[]().

template<typename T >

plint plb::RefinementParameters< T >::getReferenceLevel

(

)

[inline]

template<typename T >

IncomprFlowParam< T > const & plb::RefinementParameters< T >::operator[]

(

plint

lvl

)

const [inline]

References plb::RefinementParameters< T >::getParameters().

template<typename T >

void plb::RefinementParameters< T >::putParameter

(

IncomprFlowParam< T > &

newParam

)

[inline]

Referenced by plb::DiffusiveRefinementParameters< T >::createParameters(), and plb::ConvectiveRefinementParameters< T >::createParameters().

---

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

• multiGridParameterManager.h
• multiGridParameterManager.hh