CD_TracerParticleSolver.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_TRACERPARTICLESOLVER_H
#define CD_TRACERPARTICLESOLVER_H
 
// Our includes
#include <CD_AmrMesh.H>
#include <CD_ComputationalGeometry.H>
#include <CD_TracerParticle.H>
#include <CD_ParticleContainer.H>
#include <CD_NamespaceHeader.H>
 
template <typename P>
class TracerParticleSolver
{
public:
  TracerParticleSolver();
 
  TracerParticleSolver(const TracerParticleSolver& a_other) = delete;
 
  TracerParticleSolver(const TracerParticleSolver&& a_other) = delete;
 
  TracerParticleSolver(const RefCountedPtr<AmrMesh>& a_amr, const RefCountedPtr<ComputationalGeometry>& a_compGeom);
 
  TracerParticleSolver&
  operator=(const TracerParticleSolver& a_other) = delete;
 
  TracerParticleSolver&
  operator=(const TracerParticleSolver&& a_other) = delete;
 
  virtual ~TracerParticleSolver();
 
  virtual void
  allocate();
 
  virtual void
  registerOperators() const;
 
  virtual void
  setAmr(const RefCountedPtr<AmrMesh>& a_amrMesh);
 
  virtual void
  setComputationalGeometry(const RefCountedPtr<ComputationalGeometry>& a_compGeom);
 
  virtual void
  setName(const std::string& a_name) noexcept;
 
  virtual void
  setVolumeScale(const bool a_scale) noexcept;
 
  virtual void
  setRealm(const std::string& a_realm);
 
  virtual void
  setPhase(const phase::which_phase& a_phase);
 
  virtual void
  setTime(const int a_step, const Real a_time, const Real a_dt);
 
  virtual void
  setVelocity(const EBAMRCellData& a_velocityField);
 
  virtual void
  preRegrid(const int a_lbase, const int a_oldFinestLevel);
 
  virtual void
  regrid(const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel);
 
  virtual void
  remap();
 
  virtual void
  setDeposition(const DepositionType a_deposition) noexcept;
 
  virtual void
  deposit(EBAMRCellData& a_phi) const noexcept;
 
  virtual void
  interpolateWeight(const EBAMRCellData& a_scalar) noexcept;
 
  virtual void
  interpolateVelocities();
 
  virtual void
  parseOptions();
 
  virtual void
  parseRuntimeOptions();
 
  virtual void
  writePlotFile();
 
  virtual int
  getNumberOfPlotVariables() const;
 
  virtual Vector<std::string>
  getPlotVariableNames() const;
 
  virtual void
  writePlotData(LevelData<EBCellFAB>& a_output,
                int&                  a_comp,
                const std::string&    a_outputRealm,
                const int             a_level) const noexcept;
 
#ifdef CH_USE_HDF5
  virtual void
  writeCheckpointLevel(HDF5Handle& a_handle, const int a_level) const;
#endif
 
#ifdef CH_USE_HDF5
  virtual void
  readCheckpointLevel(HDF5Handle& a_handle, const int a_level);
#endif
 
  virtual Real
  computeDt() const;
 
  virtual ParticleContainer<P>&
  getParticles();
 
  virtual const ParticleContainer<P>&
  getParticles() const;
 
  const EBAMRCellData&
  getVelocityField() const;
 
  virtual DepositionType
  getDepositionType() const;
 
  virtual CoarseFineDeposition
  getCoarseFineDepositionType() const;
 
  virtual DepositionType
  getInterpolationType() const;
 
protected:
  RefCountedPtr<AmrMesh> m_amr;
 
  RefCountedPtr<ComputationalGeometry> m_computationalGeometry;
 
  DepositionType m_deposition;
 
  DepositionType m_interpolation;
 
  CoarseFineDeposition m_coarseFineDeposition;
 
  std::string m_realm;
 
  std::string m_name;
 
  std::string m_className;
 
  phase::which_phase m_phase;
 
  Real m_dt;
 
  Real m_time;
 
  int m_timeStep;
 
  int m_verbosity;
 
  bool m_plotWeight;
 
  bool m_plotVelocity;
 
  bool m_volumeScale;
 
  EBAMRCellData m_velocityField;
 
  ParticleContainer<P> m_particles;
 
  void
  parseDeposition();
 
  void
  parsePlotVariables();
 
  void
  parseVerbosity();
 
  template <class T, class Ret, Ret (T::*MemberFunc)() const>
  void
  depositParticles(EBAMRCellData&              a_phi,
                   const ParticleContainer<T>& a_particles,
                   const DepositionType        a_baseDeposition,
                   const CoarseFineDeposition  a_coarseFineDeposition) const noexcept;
 
  virtual void
  writeData(LevelData<EBCellFAB>& a_output,
            int&                  a_comp,
            const EBAMRCellData&  a_data,
            const std::string     a_outputRealm,
            const int             a_level,
            const bool            a_interpToCentroids,
            const bool            a_interpGhost) const noexcept;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_TracerParticleSolverImplem.H>
 
#endif