CD_ItoKMCBackgroundSpecies.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_ITOKMCBACKGROUNDSPECIES_H
#define CD_ITOKMCBACKGROUNDSPECIES_H
 
// Std includes
#include <string>
 
// Chombo includes
#include <RealVect.H>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace ItoKMC {
 
    class ItoKMCBackgroundSpecies
    {
    public:
      using MolarFraction = std::function<Real(const RealVect a_pos)>;
 
      ItoKMCBackgroundSpecies() noexcept;
 
      ItoKMCBackgroundSpecies(const std::string& a_name, const MolarFraction& a_molarFraction) noexcept;
 
      virtual ~ItoKMCBackgroundSpecies() noexcept;
 
      void
      define(const std::string& a_name, const MolarFraction& a_molarFraction) noexcept;
 
      Real
      molarFraction(const RealVect& a_pos) const noexcept;
 
      std::string
      getName() const noexcept;
 
    protected:
      bool m_isDefined;
 
      std::string m_name;
 
      MolarFraction m_molarFraction;
    };
  } // namespace ItoKMC
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#endif