CD_ItoPlasmaGodunovStepper.H

Go to the documentation of this file.

/* chombo-discharge
 * Copyright © 2021 SINTEF Energy Research.
 * Please refer to Copyright.txt and LICENSE in the chombo-discharge root directory.
 */
 
#ifndef CD_ItoPlasmaGodunovStepper_H
#define CD_ItoPlasmaGodunovStepper_H
 
// Our includes
#include <CD_ItoPlasmaStepper.H>
#include <CD_Timer.H>
#include <CD_PointParticle.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace ItoPlasma {
 
    class ItoPlasmaGodunovStepper : public ItoPlasmaStepper
    {
    public:
      ItoPlasmaGodunovStepper() = delete;
 
      ItoPlasmaGodunovStepper(RefCountedPtr<ItoPlasmaPhysics>& a_physics);
 
      virtual ~ItoPlasmaGodunovStepper();
 
      virtual Real
      advance(const Real a_dt) override;
 
      virtual void
      allocate() override;
 
      virtual void
      parseOptions() override;
 
      virtual void
      parseRuntimeOptions() override;
 
      virtual void
      preRegrid(const int a_lmin, const int a_oldFinestLevel) override;
 
      virtual void
      regrid(const int a_lmin, const int a_oldFinestLevel, const int a_newFinestLevel) override;
 
#ifdef CH_USE_HDF5
      virtual void
      readCheckpointHeader(HDF5HeaderData& a_header) override;
#endif
 
#ifdef CH_USE_HDF5
      virtual void
      writeCheckpointHeader(HDF5HeaderData& a_header) const override;
#endif
 
#ifdef CH_USE_HDF5
      virtual void
      writeCheckpointData(HDF5Handle& a_handle, const int a_lvl) const override;
#endif
 
#ifdef CH_USE_HDF5
      virtual void
      readCheckpointData(HDF5Handle& a_handle, const int a_lvl) override;
#endif
 
    protected:
      enum class WhichAlgorithm
      {
        EulerMaruyama,
      };
 
      bool m_writeCheckpointParticles;
 
      bool m_readCheckpointParticles;
 
      bool m_canRegridOnRestart;
 
      bool m_gradientFix;
 
      Real m_prevDt;
 
      WhichAlgorithm m_algorithm;
 
      Timer m_timer;
 
      Vector<RefCountedPtr<ParticleContainer<PointParticle>>> m_conductivityParticles;
 
      Vector<RefCountedPtr<ParticleContainer<PointParticle>>> m_rhoDaggerParticles;
 
      virtual void
      parseAlgorithm() noexcept;
 
      virtual void
      parseCheckpointParticles() noexcept;
 
      virtual void
      setOldPositions() noexcept;
 
      virtual void
      barrier() const noexcept;
 
      virtual void
      remapPointParticles(Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_particles,
                          const SpeciesSubset                                      a_subset) noexcept;
 
      virtual void
      depositPointParticles(const Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_particles,
                            const SpeciesSubset                                            a_subset) noexcept;
 
      virtual void
      clearPointParticles(const Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_particles,
                          const SpeciesSubset                                            a_subset) noexcept;
 
      virtual void
      computeConductivities(const Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_particles) noexcept;
 
      virtual void
      computeCellConductivity(EBAMRCellData&                                                 a_conductivityCell,
                              const Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_particles) noexcept;
 
      virtual void
      computeFaceConductivity() noexcept;
 
      virtual void
      setupSemiImplicitPoisson(const Real a_dt) noexcept;
 
      virtual void
      removeCoveredPointParticles(Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_particles,
                                  const EBRepresentation                                   a_representation,
                                  const Real                                               a_tolerance) const noexcept;
 
      virtual void
      copyConductivityParticles(
        Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_conductivityParticles) noexcept;
 
      virtual void
      advanceParticlesEulerMaruyama(const Real a_dt) noexcept;
 
      virtual void
      diffuseParticlesEulerMaruyama(Vector<RefCountedPtr<ParticleContainer<PointParticle>>>& a_rhoDaggerParticles,
                                    const Real                                               a_dt) noexcept;
 
      virtual void
      stepEulerMaruyama(const Real a_dt) noexcept;
    };
  } // namespace ItoPlasma
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#endif