CD_CdrPlasmaTagger.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_CDRPLASMATAGGER_H
#define CD_CDRPLASMATAGGER_H
 
// Our includes
#include <CD_CellTagger.H>
#include <CD_CdrPlasmaStepper.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace CdrPlasma {
 
    class CdrPlasmaTagger : public CellTagger
    {
    public:
      CdrPlasmaTagger();
 
      CdrPlasmaTagger(const RefCountedPtr<CdrPlasmaPhysics>&      a_physics,
                      const RefCountedPtr<CdrPlasmaStepper>&      a_timeStepper,
                      const RefCountedPtr<AmrMesh>&               a_amr,
                      const RefCountedPtr<ComputationalGeometry>& a_computationalGeometry);
 
      virtual ~CdrPlasmaTagger();
 
      void
      define(const RefCountedPtr<CdrPlasmaPhysics>&      a_physics,
             const RefCountedPtr<CdrPlasmaStepper>&      a_timeStepper,
             const RefCountedPtr<AmrMesh>&               a_amr,
             const RefCountedPtr<ComputationalGeometry>& a_computationalGeometry);
 
      virtual void
      computeTracers() const = 0;
 
      virtual void
      parseOptions() override = 0;
 
      virtual void
      prePlot() const noexcept override;
 
      virtual void
      preRegrid() noexcept override;
 
      virtual void
      regrid() override final;
 
      virtual bool
      tagCells(EBAMRTags& a_tags) override final;
 
      virtual int
      getNumberOfPlotVariables() const override final;
 
      virtual Vector<std::string>
      getPlotVariableNames() const override final;
 
      virtual void
      writePlotData(LevelData<EBCellFAB>& a_output,
                    int&                  a_icomp,
                    const std::string&    a_outputRealm,
                    const int             a_level) const override final;
 
    protected:
      std::string m_realm;
 
      phase::which_phase m_phase;
 
      RefCountedPtr<CdrPlasmaPhysics> m_physics;
 
      RefCountedPtr<CdrPlasmaStepper> m_timeStepper;
 
      RefCountedPtr<AmrMesh> m_amr;
 
      RefCountedPtr<ComputationalGeometry> m_computationalGeometry;
 
      int m_numTracers;
 
      mutable Vector<EBAMRCellData> m_tracers;
 
      mutable Vector<EBAMRCellData> m_gradTracers;
 
      virtual void
      refineCellsBox(DenseIntVectSet&          a_refinedCells,
                     const Vector<EBCellFAB*>& a_tracers,
                     const Vector<EBCellFAB*>& a_gradTracers,
                     const int                 a_lvl,
                     const DataIndex&          a_dit,
                     const Box&                a_box,
                     const EBISBox&            a_ebisbox,
                     const Real                a_time,
                     const Real                a_dx,
                     const RealVect&           a_probLo);
 
      virtual void
      coarsenCellsBox(DenseIntVectSet&          a_coarsenedCells,
                      const Vector<EBCellFAB*>& a_tracers,
                      const Vector<EBCellFAB*>& a_gradTracers,
                      const int                 a_lvl,
                      const DataIndex&          a_dit,
                      const Box&                a_box,
                      const EBISBox&            a_ebisbox,
                      const Real                a_time,
                      const Real                a_dx,
                      const RealVect&           a_probLo);
 
      virtual bool
      coarsenCell(const RealVect&         a_pos,
                  const Real              a_time,
                  const Real              a_dx,
                  const int               a_lvl,
                  const Vector<Real>&     a_tracers,
                  const Vector<RealVect>& a_gradTracers) const = 0;
 
      virtual bool
      refineCell(const RealVect&         a_pos,
                 const Real              a_time,
                 const Real              a_dx,
                 const int               a_lvl,
                 const Vector<Real>&     a_tracers,
                 const Vector<RealVect>& a_gradTracers) const = 0;
    };
  } // namespace CdrPlasma
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#endif