CD_NeutralSpeciesJSON.H

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2022-2026 SINTEF Energy Research
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#ifndef CD_NEUTRALSPECIESJSON_H
#define CD_NEUTRALSPECIESJSON_H
 
// Std includes
#include <list>
 
// Chombo includes
#include <RealVect.H>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace CdrPlasma {
 
    class NeutralSpeciesJSON
    {
    public:
      using NumberDensityFunction = std::function<Real(const RealVect a_pos)>;
 
      NeutralSpeciesJSON();
 
      NeutralSpeciesJSON(const std::string&           a_name,
                         const Real                   a_molarFraction,
                         const NumberDensityFunction& a_function);
 
      virtual ~NeutralSpeciesJSON();
 
      void
      define(const std::string& a_name, const Real a_molarFraction, const NumberDensityFunction& a_function);
 
      Real
      operator()(const RealVect& a_pos) const;
 
      Real
      getMolarFraction() const;
 
      std::string
      getName() const;
 
    protected:
      bool m_isDefined;
 
      std::string m_name;
 
      Real m_molarFraction;
 
      NumberDensityFunction m_function;
    };
  } // namespace CdrPlasma
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#endif