CD_ItoKMCBackgroundEvaluator.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_ITOKMCBACKGROUNDEVALUATOR_H
#define CD_ITOKMCBACKGROUNDEVALUATOR_H
 
// Our includes
#include <CD_ItoKMCGodunovStepper.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace ItoKMC {
 
    template <typename I = ItoSolver, typename C = CdrCTU, typename R = McPhoto, typename F = FieldSolverGMG>
    class ItoKMCBackgroundEvaluator : public ItoKMCGodunovStepper<I, C, R, F>
    {
    public:
      ItoKMCBackgroundEvaluator(RefCountedPtr<ItoKMCPhysics>& a_physics) noexcept;
 
      virtual void
      postInitialize() noexcept override final;
 
      virtual void
      postRegrid() noexcept override final;
 
      virtual void
      postCheckpointSetup() noexcept override final;
 
      virtual void
      printStepReport() noexcept override final;
 
      virtual Real
      advance(const Real a_dt) override;
 
      virtual Real
      computeDt() override;
 
    protected:
      Real m_maxFieldExitCrit;
 
      Real m_relFieldExitCrit;
 
      Real m_maxInitialTimeStep;
 
      Real m_maxFieldChange;
 
      Real m_relFieldChange;
 
      Real m_electrodeCharge;
 
      Real m_ohmicCharge;
 
      Real m_sumOpticalPhi;
 
      Real m_sumOpticalSrc;
 
      std::string m_opticalSolver;
 
      MFAMRCellData m_backgroundField;
 
      virtual void
      computeBackgroundField() noexcept;
 
      [[nodiscard]]
      virtual std::pair<Real, Real>
      evaluateSpaceChargeEffects() noexcept;
 
      [[nodiscard]]
      virtual Real
      integrateElectrodeSurfaceCharge() const noexcept;
 
      [[nodiscard]]
      virtual Real
      integrateOhmicCharge() const noexcept;
 
      [[nodiscard]]
      virtual std::pair<Real, Real>
      integrateOpticalExcitations() const noexcept;
    };
  } // namespace ItoKMC
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ItoKMCBackgroundEvaluatorImplem.H>
 
#endif