CD_ItoLayout.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_ITOLAYOUT_H
#define CD_ITOLAYOUT_H
 
// Our includes
#include <CD_ItoSolver.H>
#include <CD_NamespaceHeader.H>
 
template <class T>
class ItoIterator;
 
template <class T>
class ItoLayout
{
public:
  ItoLayout() = delete;
 
  ItoLayout(const Vector<RefCountedPtr<ItoSpecies>>& a_species);
 
  virtual ~ItoLayout();
 
  virtual phase::which_phase
  getPhase() const;
 
  virtual ItoIterator<T>
  iterator();
 
  virtual const std::string
  getRealm() const;
 
  virtual void
  setRealm(const std::string& a_realm);
 
  virtual void
  define(const Vector<RefCountedPtr<ItoSpecies>>& a_species);
 
  virtual void
  parseOptions();
 
  virtual void
  parseRuntimeOptions();
 
  virtual void
  allocate();
 
  virtual void
  addSolver(RefCountedPtr<T>& a_solver);
 
  virtual void
  preRegrid(const int a_lbase, const int a_finestLevel);
 
  virtual void
  initialData();
 
  virtual void
  depositParticles();
 
  virtual void
  depositParticles(const ItoSolver::WhichContainer a_whichContainer);
 
  virtual void
  remap();
 
  virtual void
  remap(const ItoSolver::WhichContainer a_whichContainer);
 
  virtual void
  interpolateVelocities();
 
  virtual void
  regrid(const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel);
 
  virtual void
  registerOperators();
 
  virtual void
  setAmr(const RefCountedPtr<AmrMesh>& a_amr);
 
  virtual void
  setComputationalGeometry(const RefCountedPtr<ComputationalGeometry>& a_computationalGeometry);
 
  virtual void
  setPhase(phase::which_phase a_phase);
 
  virtual void
  setVerbosity(const int a_verbosity);
 
  virtual void
  setTime(const int a_step, const Real a_time, const Real a_dt);
 
  virtual void
  organizeParticlesByCell(const ItoSolver::WhichContainer a_whichContainer);
 
  virtual void
  organizeParticlesByPatch(const ItoSolver::WhichContainer a_whichContainer);
 
  virtual void
  makeSuperparticles(const ItoSolver::WhichContainer a_whichContainer);
 
  virtual void
  makeSuperparticles(const ItoSolver::WhichContainer a_whichContainer, const int a_ppc);
  virtual void
  makeSuperparticles(const ItoSolver::WhichContainer a_whichContainer, const Vector<int>& a_ppc);
 
  virtual void
  makeSuperparticles(const ItoSolver::WhichContainer               a_whichContainer,
                     const Vector<int>&                            a_ppc,
                     const ParticleManagement::ParticleMergeMethod a_method);
 
  virtual Real
  computeDt();
 
  virtual Real
  computeAdvectiveDt();
 
  virtual Real
  computeHopDt(const Real a_maxCellsToMove);
 
  virtual Real
  computeDiffusiveDt();
 
  virtual size_t
  getNumParticles(const ItoSolver::WhichContainer a_ptype, const bool a_localOnly);
 
  virtual Vector<RefCountedPtr<T>>&
  getSolvers();
 
  virtual Vector<RefCountedPtr<ItoSpecies>>&
  getSpecies();
 
  virtual Vector<EBAMRCellData*>
  getVelocityFunctions();
 
  virtual Vector<EBAMRCellData*>
  getDensities();
 
  virtual Vector<EBAMRCellData*>
  getDiffusionFunctions();
 
  virtual Vector<EBAMRCellData*>
  getMobilityFunctions();
 
  virtual Vector<ParticleContainer<ItoParticle>*>
  getParticles(const ItoSolver::WhichContainer a_whichContainer);
 
protected:
  std::string m_realm;
 
  Vector<RefCountedPtr<T>> m_solvers;
 
  Vector<RefCountedPtr<ItoSpecies>> m_species;
 
  int m_verbosity;
 
  phase::which_phase m_phase;
 
  bool m_isDefined;
};
 
template <class T, class S>
class ItoFactory
{
public:
  ItoFactory();
 
  ~ItoFactory();
 
  RefCountedPtr<ItoLayout<T>>
  newLayout(const Vector<RefCountedPtr<ItoSpecies>>& a_species) const;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ItoLayoutImplem.H>
 
#endif