CD_ItoKMCTagger.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_ITOKMCTAGGER_H
#define CD_ITOKMCTAGGER_H
 
// Our includes
#include <CD_CellTagger.H>
#include <CD_ItoKMCStepper.H>
#include <CD_ItoKMCPhysics.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace ItoKMC {
 
    template <typename S>
    class ItoKMCTagger : public CellTagger
    {
    public:
      ItoKMCTagger();
 
      ItoKMCTagger(const RefCountedPtr<ItoKMCPhysics>& a_physics,
                   const RefCountedPtr<S>&             a_timeStepper,
                   const RefCountedPtr<AmrMesh>&       a_amr) noexcept;
 
      virtual ~ItoKMCTagger() noexcept;
 
      virtual void
      define(const RefCountedPtr<ItoKMCPhysics>& a_physics,
             const RefCountedPtr<S>&             a_timeStepper,
             const RefCountedPtr<AmrMesh>&       a_amr) noexcept;
 
      virtual int
      getNumberOfPlotVariables() const noexcept override;
 
      virtual Vector<std::string>
      getPlotVariableNames() const noexcept override;
 
      virtual void
      writePlotData(LevelData<EBCellFAB>& a_output,
                    int&                  a_icomp,
                    const std::string&    a_outputRealm,
                    const int             a_level) const noexcept override;
 
      virtual void
      computeTagFields() const noexcept = 0;
 
      virtual void
      parseOptions() override = 0;
 
      virtual void
      parseRuntimeOptions() override = 0;
 
      virtual void
      regrid() noexcept override;
 
      virtual bool
      tagCells(EBAMRTags& a_tags) noexcept override;
 
      virtual void
      setPhase(const phase::which_phase a_phase) noexcept;
 
      virtual Vector<EBAMRCellData>&
      getTagFields() noexcept;
 
    protected:
      bool m_isDefined;
 
      bool m_plotData;
 
      std::string m_realm;
 
      phase::which_phase m_phase;
 
      RefCountedPtr<ItoKMCPhysics> m_physics;
 
      RefCountedPtr<S> m_timeStepper;
 
      RefCountedPtr<AmrMesh> m_amr;
 
      int m_numTagFields;
 
      mutable Vector<EBAMRCellData> m_tagFields;
 
      mutable Vector<EBAMRCellData> m_gradTagFields;
 
      virtual void
      tagCellsBox(DenseIntVectSet&          a_refinedCells,
                  DenseIntVectSet&          a_coarsenedCells,
                  const Vector<EBCellFAB*>& a_tagFields,
                  const Vector<EBCellFAB*>& a_gradTagFields,
                  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) const noexcept;
 
      virtual bool
      coarsenCell(const RealVect&         a_pos,
                  const Real              a_time,
                  const Real              a_dx,
                  const int               a_lvl,
                  const Vector<Real>&     a_tagFields,
                  const Vector<RealVect>& a_gradTagFields) const noexcept = 0;
 
      virtual bool
      refineCell(const RealVect&         a_pos,
                 const Real              a_time,
                 const Real              a_dx,
                 const int               a_lvl,
                 const Vector<Real>&     a_tagFields,
                 const Vector<RealVect>& a_gradTagFields) const noexcept = 0;
    };
  } // namespace ItoKMC
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ItoKMCTaggerImplem.H>
 
#endif