CD_ItoKMCSurfaceReactions.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_ITOKMCSURFACEREACTIONS_H
#define CD_ITOKMCSURFACEREACTIONS_H
 
// Std includes
#include <random>
 
// Our includes
#include <CD_ItoKMCSurfaceReaction.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
namespace ItoKMC {
 
class ItoKMCSurfaceReactions
{
public:
  using Products = std::list<size_t>;
 
  inline ItoKMCSurfaceReactions() noexcept;
 
  virtual inline ~ItoKMCSurfaceReactions() noexcept;
 
  inline void
  add(const ItoKMCSurfaceReaction& a_surfaceReaction) noexcept;
 
  inline void
  reset() noexcept;
 
  inline const size_t&
  getReactant() const noexcept;
 
  inline const std::vector<Products>&
  getProducts() const noexcept;
 
  inline const std::vector<Real>&
  getEfficiencies() const noexcept;
 
  inline std::discrete_distribution<int>&
  getDistribution() const noexcept;
 
protected:
  bool m_isDefined;
 
  size_t m_reactant;
 
  std::vector<Products> m_products;
 
  std::vector<Real> m_efficiencies;
 
  mutable std::discrete_distribution<int> m_distribution;
};
} // namespace ItoKMC
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ItoKMCSurfaceReactionsImplem.H>
 
#endif