CD_ItoKMCSurfaceReaction.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_ITOKMCSURFACEREACTION_H
#define CD_ITOKMCSURFACEREACTION_H
 
// Std includes
#include <list>
 
// Chombo includes
#include <REAL.H>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
namespace Physics {
namespace ItoKMC {
 
class ItoKMCSurfaceReaction
{
public:
  ItoKMCSurfaceReaction() = default;
 
  inline ItoKMCSurfaceReaction(const size_t            a_reactant,
                               const std::list<size_t> a_products,
                               const Real              a_efficiency) noexcept;
 
  virtual inline ~ItoKMCSurfaceReaction() noexcept;
 
  inline void
  define(const size_t a_reactant, const std::list<size_t> a_products, const Real a_efficiency) noexcept;
 
  inline const size_t&
  getReactant() const noexcept;
 
  inline size_t&
  getReactant() noexcept;
 
  inline const std::list<size_t>&
  getProducts() const noexcept;
 
  inline std::list<size_t>&
  getProducts() noexcept;
 
  inline const Real&
  getEfficiency() const noexcept;
 
  inline Real&
  getEfficiency() noexcept;
 
protected:
  size_t m_reactant;
 
  std::list<size_t> m_products;
 
  Real m_efficiency;
};
} // namespace ItoKMC
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ItoKMCSurfaceReactionImplem.H>
 
#endif