CdrIterator< T > Class Template Reference

Iterator class for CdrLayout. This allows iteration through solvers (or subsets of solvers). More...

#include <CD_CdrIterator.H>

Public Types
enum class	SpeciesIteration {   All , Charged , Negative , Positive ,   Neutral }
	Enum class for iterating through subsets of species.

Public Member Functions
	CdrIterator ()=delete
	Disallowed weak construction. Always use the full constructor.
	CdrIterator (CdrLayout< T > &a_layout, const SpeciesIteration a_mode=SpeciesIteration::All)
	Full constructor.
virtual	~CdrIterator ()
	Destructor (does nothing).
virtual int	getNumberOfSolvers ()
	Get number of solvers.
virtual int	index () const
	Get current solver number (i.e. index in CdrLayouts solvers).
virtual void	reset ()
	Reset iterator to the beginning.
virtual bool	ok () const
	Check if the iterator is valid.
virtual void	operator++ ()
	Increment the iterator. Behavior depends on iteration mode.
virtual RefCountedPtr< T > &	operator() ()
	Return the current solver.
virtual RefCountedPtr< CdrSpecies > &	getSpecies ()
	Return the current species.

Protected Attributes
SpeciesIteration	m_mode
	Which species to iterate over.
int	m_isolver
	Current solver index.
int	m_numSolvers
	Number of solvers.
bool	m_isDefined
	Defined or not.
Vector< RefCountedPtr< T > >	m_solvers
	Cdr solvers.
Vector< RefCountedPtr< CdrSpecies > >	m_species
	Cdr species.

Detailed Description

template<class T>
class CdrIterator< T >

Iterator class for CdrLayout. This allows iteration through solvers (or subsets of solvers).

Forward declare iterator.

CdrLayout is a class for holding sets of CdrSolvers on a realm and a phase. In the simplest case it is used as a container for keeping track of a single set of CdrSolvers, and it greatly cuts down on typing. This class allows iteration through one such layout. The user can specify to only iterate through subsets of CdrSolvers, e.g. only for charged species or neutral species, etc.

See also

CD_CdrIterator.H

Constructor & Destructor Documentation

CdrIterator()

template<class T >

CdrIterator< T >::CdrIterator	(	CdrLayout< T > &	a_layout,
		const SpeciesIteration	a_mode = SpeciesIteration::All
	)

Full constructor.

Parameters

[in]	a_layout	CdrLayout to iterate through.
[in]	a_mode	Iteration mode.

Member Function Documentation

getNumberOfSolvers()

template<class T >

int CdrIterator< T >::getNumberOfSolvers ( )

virtual

Get number of solvers.

Returns

Total number of solvers in the layout.

getSpecies()

template<class T >

RefCountedPtr< CdrSpecies > & CdrIterator< T >::getSpecies ( )

virtual

Return the current species.

Returns

Reference to the current species.

index()

template<class T >

int CdrIterator< T >::index ( ) const

virtual

Get current solver number (i.e. index in CdrLayouts solvers).

Returns

Current solver index.

ok()

template<class T >

bool CdrIterator< T >::ok ( ) const

virtual

Check if the iterator is valid.

Returns

True if the iterator points to a valid solver.

operator()()

template<class T >

RefCountedPtr< T > & CdrIterator< T >::operator() ( )

virtual

Return the current solver.

Returns

Reference to the current solver.

---

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

• Source/ConvectionDiffusionReaction/CD_CdrIterator.H
• Source/ConvectionDiffusionReaction/CD_CdrIteratorImplem.H