chombo-discharge
Loading...
Searching...
No Matches
CD_RtIterator.H
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
3 *
4 * SPDX-License-Identifier: GPL-3.0-or-later
5 */
6
13#ifndef CD_RTITERATOR_H
14#define CD_RTITERATOR_H
15
16// Our includes
17#include <CD_RtLayout.H>
18#include <CD_NamespaceHeader.H>
19
23template <class T>
25{
26public:
30 RtIterator() = delete;
31
36
40 virtual ~RtIterator();
41
46 virtual int
48
53 virtual int
54 index() const;
55
59 virtual void
60 reset();
61
66 virtual bool
67 ok();
68
72 virtual void
73 operator++();
74
79 virtual RefCountedPtr<T>&
80 operator()();
81
87 getSpecies();
88
89protected:
94
98 int m_num;
99
104
109};
110
111#include <CD_NamespaceFooter.H>
112
113#include <CD_RtIteratorImplem.H>
114#endif
Implementation of RtIterator.H.
Declaration of a class that holds a set of RtSolvers.
Iterator class for RtLayout.
Definition CD_RtIterator.H:25
Vector< RefCountedPtr< T > > m_solvers
Ion solvers.
Definition CD_RtIterator.H:103
virtual RefCountedPtr< T > & operator()()
Get the solver pointed to by the iterator.
Definition CD_RtIteratorImplem.H:79
virtual int index() const
Get current solver number/index.
Definition CD_RtIteratorImplem.H:51
int m_num
Number of solvers.
Definition CD_RtIterator.H:98
virtual ~RtIterator()
Destructor (does nothing)
Definition CD_RtIteratorImplem.H:37
virtual void operator++()
Incrementation operator. Cycles to next solver.
Definition CD_RtIteratorImplem.H:72
int m_isolver
Solver currently pointed to.
Definition CD_RtIterator.H:93
virtual void reset()
Reset iterator to first solver.
Definition CD_RtIteratorImplem.H:58
virtual int getNumberOfSolvers()
Get number of solvers.
Definition CD_RtIteratorImplem.H:44
virtual bool ok()
Check if we can cycle further through the solvers.
Definition CD_RtIteratorImplem.H:65
Vector< RefCountedPtr< RtSpecies > > m_species
Ions.
Definition CD_RtIterator.H:108
RtIterator()=delete
Empty constructor.
virtual RefCountedPtr< RtSpecies > & getSpecies()
Get current species pointed to by the iterator.
Definition CD_RtIteratorImplem.H:86
Base class for a tracer particle solver. This solver can advance particles in a pre-defined velocity ...
Definition CD_TracerParticleSolver.H:38