CD_ItoIterator.H

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#ifndef CD_ITOITERATOR_H
#define CD_ITOITERATOR_H
 
#include <CD_ItoLayout.H>
#include <CD_NamespaceHeader.H>
 
template <class T>
class ItoIterator
{
public:
  enum class SpeciesIteration
  {
    All,
    Charged,
    Negative,
    Positive,
    Neutral
  };
 
  ItoIterator() = delete;
 
  ItoIterator(ItoLayout<T>& a_layout, const SpeciesIteration a_mode = SpeciesIteration::All);
 
  virtual ~ItoIterator();
 
  virtual int
  getNumberOfSolvers();
 
  virtual int
  index() const;
 
  virtual void
  reset();
 
  virtual bool
  ok();
 
  virtual void
  operator++();
 
  virtual RefCountedPtr<T>&
  operator()();
 
  virtual RefCountedPtr<ItoSpecies>&
  getSpecies();
 
protected:
  SpeciesIteration m_mode;
 
  int m_isolver;
 
  int m_numSolvers;
 
  bool m_isDefined;
 
  Vector<RefCountedPtr<T>> m_solvers;
 
  Vector<RefCountedPtr<ItoSpecies>> m_species;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ItoIteratorImplem.H>
 
#endif