CD_ItoKMCFieldTagger.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_ITOKMCFIELDTAGGER_H
#define CD_ITOKMCFIELDTAGGER_H
 
// Our includes
#include <CD_ItoKMCTagger.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
namespace ItoKMC {
 
template <typename S>
class ItoKMCFieldTagger : public ItoKMCTagger<S>
{
public:
  ItoKMCFieldTagger() noexcept;
 
  virtual ~ItoKMCFieldTagger() noexcept;
 
  virtual void
  computeTagFields() const noexcept override;
 
  virtual void
  parseOptions() override = 0;
 
  virtual void
  parseRuntimeOptions() override = 0;
 
protected:
  mutable EBAMRCellData m_scratch;
 
  mutable EBAMRCellData m_E;
 
  mutable EBAMRCellData m_gradE;
 
  virtual void
  allocateStorage() const noexcept;
 
  virtual void
  deallocateStorage() const noexcept;
 
  virtual void
  computeElectricField(EBAMRCellData& a_E, EBAMRCellData& a_gradE) const noexcept;
 
  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 = 0;
 
  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 = 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 override = 0;
};
} // namespace ItoKMC
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ItoKMCFieldTaggerImplem.H>
 
#endif