Implementation of RtSpecies for usage in RadiativeTransfer module. More...
#include <CD_RadiativeTransferSpecies.H>
Inheritance diagram for Physics::RadiativeTransfer::RadiativeTransferSpecies:
Collaboration diagram for Physics::RadiativeTransfer::RadiativeTransferSpecies:
Public Member Functions | |
| RadiativeTransferSpecies () | |
| Constructor (reads from input script) | |
| virtual | ~RadiativeTransferSpecies () |
| Destructor (does nothing) | |
| virtual Real | getAbsorptionCoefficient (const RealVect a_pos) const override |
| Get absorption coefficient (i.e. the inverse absorption length) at physical coordinates. | |
 Public Member Functions inherited from RtSpecies | |
| 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 | getScatteringCoefficient (const RealVect a_pos) const |
| Get scattering coefficient (i.e. the inverse scattering length) at physical coordinates. | |
Protected Attributes | |
| std::function< Real(const RealVect a_pos)> | m_kappa |
| Absorption coefficient. | |
| Protected Attributes inherited from RtSpecies | |
| std::string | m_name |
| Group name. | |
Detailed Description
Implementation of RtSpecies for usage in RadiativeTransfer module.
This reads a constant kappa from the input file which it uses as Beer's length.
Member Function Documentation
◆ getAbsorptionCoefficient()
Member Data Documentation
◆ m_kappa
|
protected |
Absorption coefficient.
Storing this as a std::function to show to easily use lambdas for returning spatially varying coefficients.
The documentation for this class was generated from the following files:
- Physics/RadiativeTransfer/CD_RadiativeTransferSpecies.H
- Physics/RadiativeTransfer/CD_RadiativeTransferSpecies.cpp
