CD_CdrPlasmaPhysics.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_CDRPLASMAPHYSICS_H
#define CD_CDRPLASMAPHYSICS_H
 
// Chombo includes
#include <RealVect.H>
#include <RefCountedPtr.H>
#include <LoHiSide.H>
 
// Our includes
#include <CD_CdrSpecies.H>
#include <CD_RtSpecies.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace CdrPlasma {
 
    class CdrPlasmaPhysics
    {
    public:
      CdrPlasmaPhysics()
      {}
 
      virtual ~CdrPlasmaPhysics()
      {}
 
      virtual void
      parseRuntimeOptions() {};
 
      virtual int
      getNumberOfPlotVariables() const
      {
        return 0;
      }
 
      virtual Vector<std::string>
      getPlotVariableNames() const
      {
        return Vector<std::string>(this->getNumberOfPlotVariables(), std::string("empty data"));
      }
 
      virtual Vector<Real>
      getPlotVariables(const Vector<Real>&     a_cdrDensities,
                       const Vector<RealVect>& a_cdrGradients,
                       const Vector<Real>&     a_rteDensities,
                       const RealVect&         a_E,
                       const RealVect&         a_position,
                       const Real              a_dx,
                       const Real              a_dt,
                       const Real              a_time,
                       const Real              a_kappa) const
      {
        return Vector<Real>(this->getNumberOfPlotVariables(), 1.0);
      }
 
      virtual Real
      computeAlpha(const Real a_E, const RealVect& a_position) const = 0;
 
      virtual Real
      computeEta(const Real a_E, const RealVect& a_position) const = 0;
 
      virtual void
      advanceReactionNetwork(Vector<Real>&           a_cdrSources,
                             Vector<Real>&           a_rteSources,
                             const Vector<Real>&     a_cdrDensities,
                             const Vector<RealVect>& a_cdrGradients,
                             const Vector<Real>&     a_rteDensities,
                             const RealVect&         a_E,
                             const RealVect&         a_pos,
                             const Real              a_dx,
                             const Real              a_dt,
                             const Real              a_time,
                             const Real              a_kappa) const = 0;
 
      virtual Vector<RealVect>
      computeCdrDriftVelocities(const Real          a_time,
                                const RealVect&     a_pos,
                                const RealVect&     a_E,
                                const Vector<Real>& a_cdrDensities) const = 0;
 
      virtual Vector<Real>
      computeCdrDiffusionCoefficients(const Real          a_time,
                                      const RealVect&     a_pos,
                                      const RealVect&     a_E,
                                      const Vector<Real>& a_cdrDensities) const = 0;
 
      virtual Vector<Real>
      computeCdrElectrodeFluxes(const Real          a_time,
                                const RealVect&     a_pos,
                                const RealVect&     a_normal,
                                const RealVect&     a_E,
                                const Vector<Real>& a_cdrDensities,
                                const Vector<Real>& a_cdrVelocities,
                                const Vector<Real>& a_cdrGradients,
                                const Vector<Real>& a_rteFluxes,
                                const Vector<Real>& a_extrapCdrFluxes) const = 0;
 
      virtual Vector<Real>
      computeCdrDielectricFluxes(const Real          a_time,
                                 const RealVect&     a_pos,
                                 const RealVect&     a_normal,
                                 const RealVect&     a_E,
                                 const Vector<Real>& a_cdrDensities,
                                 const Vector<Real>& a_cdrVelocities,
                                 const Vector<Real>& a_cdrGradients,
                                 const Vector<Real>& a_rteFluxes,
                                 const Vector<Real>& a_extrapCdrFluxes) const = 0;
 
      virtual Vector<Real>
      computeCdrDomainFluxes(const Real           a_time,
                             const RealVect&      a_pos,
                             const int            a_dir,
                             const Side::LoHiSide a_side,
                             const RealVect&      a_E,
                             const Vector<Real>&  a_cdrDensities,
                             const Vector<Real>&  a_cdrVelocities,
                             const Vector<Real>&  a_cdrGradients,
                             const Vector<Real>&  a_rteFluxes,
                             const Vector<Real>&  a_extrapCdrFluxes) const = 0;
 
      virtual Real
      initialSigma(const Real a_time, const RealVect& a_pos) const = 0;
 
      const Vector<RefCountedPtr<CdrSpecies>>&
      getCdrSpecies() const
      {
        return m_cdrSpecies;
      }
 
      const Vector<RefCountedPtr<RtSpecies>>&
      getRtSpecies() const
      {
        return m_rtSpecies;
      }
 
      int
      getNumCdrSpecies() const
      {
        return m_cdrSpecies.size();
      }
 
      int
      getNumRtSpecies() const
      {
        return m_rtSpecies.size();
      }
 
    protected:
      Vector<RefCountedPtr<CdrSpecies>> m_cdrSpecies;
 
      Vector<RefCountedPtr<RtSpecies>> m_rtSpecies;
 
      int m_numCdrSpecies;
 
      int m_numRtSpecies;
    };
  } // namespace CdrPlasma
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#endif