CD_ItoKMCPhotoReaction.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_ITOKMCPHOTOREACTION_H
#define CD_ITOKMCPHOTOREACTION_H
 
// Std includes
#include <list>
 
// Chombo includes
#include <REAL.H>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace ItoKMC {
 
    class ItoKMCPhotoReaction
    {
    public:
      ItoKMCPhotoReaction() = default;
 
      inline ItoKMCPhotoReaction(const size_t            a_source,
                                 const std::list<size_t> a_targets,
                                 const Real              a_efficiency = 1.0) noexcept;
 
      virtual inline ~ItoKMCPhotoReaction() noexcept;
 
      inline void
      define(const size_t a_source, const std::list<size_t> a_targets, const Real a_efficiency = 1.0) noexcept;
 
      inline const size_t&
      getSourcePhoton() const noexcept;
 
      inline const std::list<size_t>&
      getTargetSpecies() const noexcept;
 
      inline const Real&
      getEfficiency() const noexcept;
 
    protected:
      size_t m_source;
 
      std::list<size_t> m_targets;
 
      Real m_efficiency;
    };
  } // namespace ItoKMC
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ItoKMCPhotoReactionImplem.H>
 
#endif