 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <DustEmissionOptions.hpp>
Public Types | |
| enum class | EmissionType : int { Equilibrium , Stochastic } |
Public Member Functions | |
| SpatialCellLibrary * | cellLibrary () const |
| EmissionType | dustEmissionType () const |
| DisjointWavelengthGrid * | dustEmissionWLG () const |
| bool | includeHeatingByCMB () const |
| double | maxFractionOfPrevious () const |
| double | maxFractionOfPrimary () const |
| double | sourceWeight () const |
| double | wavelengthBias () const |
| WavelengthDistribution * | wavelengthBiasDistribution () const |
| Range | wavelengthRange () const override |
 Public Member Functions inherited from SimulationItem | |
| template<class T > | |
| T * | find (bool setup=true) const |
| template<class T > | |
| T * | interface (int levels=-999999, bool setup=true) const |
| virtual string | itemName () const |
| void | setup () |
| string | typeAndName () const |
| Public Member Functions inherited from Item | |
| Item (const Item &)=delete | |
| virtual | ~Item () |
| void | addChild (Item *child) |
| const vector< Item * > & | children () const |
| virtual void | clearItemListProperty (const PropertyDef *property) |
| void | destroyChild (Item *child) |
| virtual bool | getBoolProperty (const PropertyDef *property) const |
| virtual vector< double > | getDoubleListProperty (const PropertyDef *property) const |
| virtual double | getDoubleProperty (const PropertyDef *property) const |
| virtual string | getEnumProperty (const PropertyDef *property) const |
| virtual int | getIntProperty (const PropertyDef *property) const |
| virtual vector< Item * > | getItemListProperty (const PropertyDef *property) const |
| virtual Item * | getItemProperty (const PropertyDef *property) const |
| virtual string | getStringProperty (const PropertyDef *property) const |
| int | getUtilityProperty (string name) const |
| virtual void | insertIntoItemListProperty (const PropertyDef *property, int index, Item *item) |
| Item & | operator= (const Item &)=delete |
| Item * | parent () const |
| virtual void | removeFromItemListProperty (const PropertyDef *property, int index) |
| virtual void | setBoolProperty (const PropertyDef *property, bool value) |
| virtual void | setDoubleListProperty (const PropertyDef *property, vector< double > value) |
| virtual void | setDoubleProperty (const PropertyDef *property, double value) |
| virtual void | setEnumProperty (const PropertyDef *property, string value) |
| virtual void | setIntProperty (const PropertyDef *property, int value) |
| virtual void | setItemProperty (const PropertyDef *property, Item *item) |
| virtual void | setStringProperty (const PropertyDef *property, string value) |
| void | setUtilityProperty (string name, int value) |
| virtual string | type () const |
| Public Member Functions inherited from WavelengthRangeInterface | |
| virtual | ~WavelengthRangeInterface () |
| virtual Range | wavelengthRange () const =0 |
Protected Member Functions | |
| DustEmissionOptions () | |
| Protected Member Functions inherited from SimulationItem | |
| SimulationItem () | |
| virtual bool | offersInterface (const std::type_info &interfaceTypeInfo) const |
| virtual void | setupSelfAfter () |
| virtual void | setupSelfBefore () |
| Protected Member Functions inherited from Item | |
| Item () | |
| Protected Member Functions inherited from SourceWavelengthRangeInterface | |
| SourceWavelengthRangeInterface () | |
| Protected Member Functions inherited from WavelengthRangeInterface | |
| WavelengthRangeInterface () | |
Private Types | |
| using | BaseType = SimulationItem |
| using | ItemType = DustEmissionOptions |
Private Attributes | |
| SpatialCellLibrary * | _cellLibrary |
| EmissionType | _dustEmissionType |
| DisjointWavelengthGrid * | _dustEmissionWLG |
| bool | _includeHeatingByCMB |
| double | _maxFractionOfPrevious |
| double | _maxFractionOfPrimary |
| double | _sourceWeight |
| double | _wavelengthBias |
| WavelengthDistribution * | _wavelengthBiasDistribution |
Friends | |
| class | ItemRegistry |
The DustEmissionOptions class simply offers a number of configuration options related to thermal emission from dust. In a mode where dust emission is enabled, the simulation also needs a wavelength grid on which to calculate the dust emission spectrum.
|
strong |
The enumeration type indicating the method used for dust emission calculations.
Equilibrium : "assume local thermal equilibrium (LTE)" .
Stochastic : "handle stochastically heated grains (non-LTE)" .
|
inlineprotected |
Default constructor for concrete Item subclass DustEmissionOptions : "a set of options related to thermal emission from dust" .
|
inline |
This function returns the value of the discoverable item property cellLibrary : "the spatial cell grouping scheme for calculating dust emission" .
The default value for this property is given by the conditional value expression "AllCellsLibrary" .
This property is required only if the Boolean expression "false" evaluates to true after replacing the names by true or false depending on their presence.
This property is displayed only if the Boolean expression "Level2" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable EmissionType enumeration property dustEmissionType : "the method used for dust emission calculations" .
The default value for this property is given by the conditional value expression "Equilibrium" .
When a value is entered for this property, the names provided by the conditional value expression "dustEmissionTypeStochastic:StochasticDustEmission" are inserted into the name sets used for evaluating Boolean expressions.
This property is displayed only if the Boolean expression "Level2" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable item property dustEmissionWLG : "the wavelength grid for calculating the dust emission spectrum" .
The default value for this property is given by the conditional value expression "LogWavelengthGrid" .
|
inline |
This function returns the value of the discoverable Boolean property includeHeatingByCMB : "add the cosmic microwave background (CMB) as a dust heating source term" .
The default value for this property is given by the conditional value expression "false" .
This property is displayed only if the Boolean expression "NonZeroRedshift" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable double property maxFractionOfPrevious : "convergence is reached when the total absorbed dust luminosity " "has changed by less than this fraction compared to the previous iteration" .
The minimum value for this property is "]0" .
The maximum value for this property is "1[" .
The default value for this property is given by the conditional value expression "0.03" .
This property is relevant only if the Boolean expression "IterateSecondary" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable double property maxFractionOfPrimary : "convergence is reached when the total absorbed dust luminosity " "is less than this fraction of the total absorbed primary luminosity" .
The minimum value for this property is "]0" .
The maximum value for this property is "1[" .
The default value for this property is given by the conditional value expression "0.01" .
This property is relevant only if the Boolean expression "IterateSecondary" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable double property sourceWeight : "the weight of dust emission for the number of photon packets launched" .
The minimum value for this property is "]0" .
The maximum value for this property is "1000]" .
The default value for this property is given by the conditional value expression "1" .
This property is displayed only if the Boolean expression "Level3" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable double property wavelengthBias : "the fraction of secondary photon packet wavelengths sampled from a bias distribution" .
The minimum value for this property is "[0" .
The maximum value for this property is "1]" .
The default value for this property is given by the conditional value expression "0.5" .
This property is displayed only if the Boolean expression "Level3" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable item property wavelengthBiasDistribution : "the bias distribution for sampling secondary photon packet wavelengths" .
The default value for this property is given by the conditional value expression "DefaultWavelengthDistribution" .
This property is relevant only if the Boolean expression "wavelengthBias" evaluates to true after replacing the names by true or false depending on their presence.
This property is displayed only if the Boolean expression "Level3" evaluates to true after replacing the names by true or false depending on their presence.
|
inlineoverridevirtual |
This function returns the wavelength range of the dust emission wavelength grid, implementing the SourceWavelengthRangeInterface interface so that the wavelength bias distribution configured here can locate its associated "source" wavelength range.
Implements WavelengthRangeInterface.