CD_CdrPlasmaGodunovStepper.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_CDRPLASMAGODUNOVSTEPPER_H
#define CD_CDRPLASMAGODUNOVSTEPPER_H
 
// Std includes
#include <memory>
 
// Our includes
#include <CD_AmrMesh.H>
#include <CD_CdrPlasmaStepper.H>
#include <CD_CdrIterator.H>
#include <CD_RtIterator.H>
#include <CD_Timer.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace CdrPlasma {
 
    class CdrPlasmaGodunovStepper : public CdrPlasmaStepper
    {
    public:
      // Forward declared utility classes for handling the extra memory when advancing the solvers.
      class CdrStorage;
      class FieldStorage;
      class RtStorage;
      class SigmaStorage;
 
      CdrPlasmaGodunovStepper() = delete;
 
      CdrPlasmaGodunovStepper(RefCountedPtr<CdrPlasmaPhysics>& a_physics);
 
      ~CdrPlasmaGodunovStepper() override;
 
      CdrPlasmaGodunovStepper(const CdrPlasmaGodunovStepper&) = delete;
      CdrPlasmaGodunovStepper&
      operator=(const CdrPlasmaGodunovStepper&)          = delete;
      CdrPlasmaGodunovStepper(CdrPlasmaGodunovStepper&&) = delete;
      CdrPlasmaGodunovStepper&
      operator=(CdrPlasmaGodunovStepper&&) = delete;
 
      void
      parseOptions() override;
 
      void
      parseRuntimeOptions() override;
 
      Real
      advance(Real a_dt) override;
 
      void
      preRegrid(int a_lbase, int a_finestLevel) override;
 
      void
      regrid(int a_lmin, int a_oldFinestLevel, int a_newFinestLevel) override;
 
      void
      postRegrid() override;
 
      Real
      computeDt() override;
 
      void
      postCheckpointSetup() override;
 
    protected:
      enum class FieldCoupling
      {
        Explicit,    
        SemiImplicit 
      };
 
      enum class AdvectionSolver
      {
        Euler, 
        RK2,   
        MUSCL  
      };
 
      enum class DiffusionAlgorithm
      {
        Explicit,  
        Implicit,  
        Automatic, 
      };
 
      FieldCoupling m_fieldCoupling;
 
      DiffusionAlgorithm m_diffusionAlgorithm;
 
      AdvectionSolver m_advectionSolver;
 
      std::unique_ptr<Timer> m_timer;
 
      Vector<RefCountedPtr<CdrStorage>> m_cdrScratch;
 
      Vector<RefCountedPtr<RtStorage>> m_rteScratch;
 
      RefCountedPtr<FieldStorage> m_fieldScratch;
 
      RefCountedPtr<SigmaStorage> m_sigmaScratch;
 
      EBAMRCellData m_semiImplicitRho;
 
      EBAMRCellData m_conductivityFactorCell;
 
      EBAMRFluxData m_conductivityFactorFace;
 
      EBAMRIVData m_conductivityFactorEB;
 
      EBAMRCellData m_scratchSemiImplicitRho;
 
      EBAMRCellData m_scratchConductivity;
 
      bool m_extrapAdvect;
 
      bool m_debug;
 
      bool m_profile;
 
      bool m_floor;
 
      bool m_fhd;
 
      bool m_regridSlopes;
 
      bool m_filterCompensate;
 
      Real m_implicitDiffusionThreshold;
 
      int m_diffusionOrder;
 
      int m_numFilterRho;
 
      std::vector<bool> m_useImplicitDiffusion;
 
      RefCountedPtr<CdrStorage>&
      getCdrStorage(const CdrIterator<CdrSolver>& a_solverIt);
 
      RefCountedPtr<RtStorage>&
      getRtStorage(const RtIterator<RtSolver>& a_solverIt);
 
      void
      regridInternals(int a_lmin, int a_oldFinestLevel, int a_newFinestLevel) override;
 
      void
      allocateInternals() override;
 
      void
      allocateScratch();
 
      void
      deallocateInternals() override;
 
      void
      deallocateScratch();
 
      void
      computeElectricFieldIntoScratch();
 
      void
      computeCdrGradients();
 
      void
      extrapolateWithSourceTerm(Real a_dt);
 
      void
      extrapolateCdrToEB();
 
      void
      computeCdrFluxesEB();
 
      void
      extrapolateCdrToDomain();
 
      void
      computeCdrDomainFluxes();
 
      void
      computeSigmaFlux();
 
      void
      advanceTransport(Real a_dt);
 
      void
      advanceTransportExplicitField(Real a_dt);
 
      void
      advanceTransportSemiImplicit(Real a_dt);
 
      void
      advanceCdrReactions(Real a_dt);
 
      void
      advanceRadiativeTransfer(Real a_dt);
 
      void
      floorMass(EBAMRCellData& a_data, const std::string& a_message, const RefCountedPtr<CdrSolver>& a_solver) const;
 
      void
      postStep();
 
      void
      computeCdrDriftVelocities(Real a_time);
 
      void
      computeCdrDiffusionCoefficients(Real a_time);
 
      void
      computeSourceTerms(Real a_dt);
 
      void
      parseAdvection();
 
      void
      parseDiffusion();
 
      void
      parseField();
 
      void
      parseFloor();
 
      void
      parseDebug();
 
      void
      parseProfile();
 
      void
      parseFHD();
 
      void
      parseRegridSlopes();
 
      void
      parseFiltering();
 
      bool
      solveSemiImplicitPoisson();
 
#ifdef CH_USE_HDF5
      void
      writeCheckpointData(HDF5Handle& a_handle, int a_lvl) const override;
#endif
 
#ifdef CH_USE_HDF5
      void
      readCheckpointData(HDF5Handle& a_handle, int a_lvl) override;
#endif
    };
  } // namespace CdrPlasma
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#endif