Declaration of a class that defines an interface to radiative transfer solvers, i.e. RtSolver. More...
#include <CD_RtSpecies.H>
Public Member Functions | |
| RtSpecies () | |
| Weak constructor. Sets absorption length and scattering coefficients to one. | |
| virtual | ~RtSpecies () |
| Weak constructor. Sets absorption length and scattering coefficients to one. | |
| std::string | getName () const |
| Get species name. | |
| virtual Real | getAbsorptionCoefficient (const RealVect a_pos) const =0 |
| Get kappa (i.e. the inverse absorption length) at physical coordinates. | |
| virtual Real | getScatteringCoefficient (const RealVect a_pos) const |
| Get scattering coefficient (i.e. the inverse scattering length) at physical coordinates. | |
Protected Attributes | |
| std::string | m_name |
| Group name. | |
Detailed Description
Declaration of a class that defines an interface to radiative transfer solvers, i.e. RtSolver.
This is a lightweight class - it just holds a name for the species as well as a function signature for obtaining the absorption and scattering coefficients. Note that this species supports spatially varying absorption and scattering coefficients.
Member Function Documentation
◆ getAbsorptionCoefficient()
Get kappa (i.e. the inverse absorption length) at physical coordinates.
- Parameters
-
[in] a_pos Physical coordinates.
Implemented in Physics::RadiativeTransfer::RadiativeTransferSpecies, Physics::CdrPlasma::RteSpeciesJSON, and Physics::ItoKMC::ItoKMCPhotonSpecies.
◆ getScatteringCoefficient()
Get scattering coefficient (i.e. the inverse scattering length) at physical coordinates.
- Parameters
-
[in] a_pos Physical coordinates.
- Note
- This is not used anywhere (yet).
The documentation for this class was generated from the following files:
- Source/RadiativeTransfer/CD_RtSpecies.H
- Source/RadiativeTransfer/CD_RtSpecies.cpp
