CD_ItoKMCStreamerTagger.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_ITOKMCSTREAMERTAGGER_H
#define CD_ITOKMCSTREAMERTAGGER_H
 
// Our includes
#include <CD_ItoKMCFieldTagger.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
namespace ItoKMC {
 
template <typename S>
class ItoKMCStreamerTagger : public ItoKMCFieldTagger<S>
{
public:
  ItoKMCStreamerTagger() noexcept;
 
  ItoKMCStreamerTagger(const RefCountedPtr<ItoKMCPhysics>& a_physics,
                       const RefCountedPtr<S>&             a_timeStepper,
                       const RefCountedPtr<AmrMesh>&       a_amr) noexcept;
 
  virtual ~ItoKMCStreamerTagger() noexcept;
 
  virtual void
  parseOptions() noexcept override;
 
  virtual void
  parseRuntimeOptions() noexcept override;
 
protected:
  Real m_coarsenCurvature;
 
  Real m_refineCurvature;
 
  Real m_refineAlpha;
 
  Real m_coarsenAlpha;
 
  int m_maxCoarsenLevel;
 
  virtual Vector<Real>
  computeTagFields(const RealVect& a_pos,
                   const Real      a_time,
                   const Real      a_dx,
                   const RealVect& a_E,
                   const Real      a_minE,
                   const Real      a_maxE,
                   const RealVect& a_gradE,
                   const Real      a_minGradE,
                   const Real      a_maxGradE) const noexcept override;
 
  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 override;
 
  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 override;
};
} // namespace ItoKMC
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ItoKMCStreamerTaggerImplem.H>
 
#endif