chombo-discharge
Loading...
Searching...
No Matches
CD_ItoKMCPhotonSpecies.H
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
3 *
4 * SPDX-License-Identifier: GPL-3.0-or-later
5 */
6
13#ifndef CD_ITOKMCPHOTONSPECIES_H
14#define CD_ITOKMCPHOTONSPECIES_H
15
16// Our includes
17#include <CD_RtSpecies.H>
18#include <CD_NamespaceHeader.H>
19
20namespace Physics {
21namespace ItoKMC {
22
27{
28public:
34 ItoKMCPhotonSpecies(const std::string& a_name, const std::function<Real(const RealVect& a_pos)>& a_kappaFunction)
35 : m_kappa(a_kappaFunction)
36 {
37 m_name = a_name;
38 }
39
43 ~ItoKMCPhotonSpecies() noexcept override = default;
44
49 ItoKMCPhotonSpecies(const ItoKMCPhotonSpecies& a_other) = default;
50
57 operator=(const ItoKMCPhotonSpecies& a_other) = default;
58
64
71 operator=(ItoKMCPhotonSpecies&& a_other) = default;
72
78 Real
79 getAbsorptionCoefficient(const RealVect& a_pos) const final
80 {
81 return m_kappa(a_pos);
82 }
83
84protected:
88 std::function<Real(const RealVect& a_position)> m_kappa;
89};
90} // namespace ItoKMC
91} // namespace Physics
92
93#include <CD_NamespaceFooter.H>
94
95#endif
Declaration of a class which supplies a user interface to radiative transfer code.
Simple RtSpecies class for usage with ItoKMCJSON.
Definition CD_ItoKMCPhotonSpecies.H:27
std::function< Real(const RealVect &a_position)> m_kappa
Absorption function.
Definition CD_ItoKMCPhotonSpecies.H:88
Real getAbsorptionCoefficient(const RealVect &a_pos) const final
Get absorption coefficient at a physical position.
Definition CD_ItoKMCPhotonSpecies.H:79
~ItoKMCPhotonSpecies() noexcept override=default
Destructor. Does nothing.
ItoKMCPhotonSpecies(const std::string &a_name, const std::function< Real(const RealVect &a_pos)> &a_kappaFunction)
Full constructor.
Definition CD_ItoKMCPhotonSpecies.H:34
Declaration of a class that defines an interface to radiative transfer solvers, i....
Definition CD_RtSpecies.H:32
std::string m_name
Group name.
Definition CD_RtSpecies.H:72
Namespace containing physics models for use with chombo-discharge.
Definition CD_AdvectionDiffusion.H:16