 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <TemperatureProbe.hpp>
Public Types | |
| enum class | Aggregation : int { Fragment , Component , Type } |
 Public Types inherited from SpatialGridWhenFormProbe | |
| enum class | ProbeAfter : int { Setup , Run , Primary , Secondary } |
Public Member Functions | |
| Aggregation | aggregation () const |
| void | probe () override |
| Public Member Functions inherited from SpatialGridWhenFormProbe | |
| ProbeAfter | probeAfter () const |
| Public Member Functions inherited from SpatialGridFormProbe | |
| Form * | form () const |
| Public Member Functions inherited from Probe | |
| string | itemName () const override |
| int | iter () const |
| string | probeName () const |
| void | probePrimary (int iter) |
| void | probeRun () |
| void | probeSecondary (int iter) |
| void | probeSetup () |
| 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 |
Protected Member Functions | |
| TemperatureProbe () | |
| Protected Member Functions inherited from SpatialGridWhenFormProbe | |
| SpatialGridWhenFormProbe () | |
| When | when () const override |
| Protected Member Functions inherited from SpatialGridFormProbe | |
| SpatialGridFormProbe () | |
| Protected Member Functions inherited from Probe | |
| Probe () | |
| virtual void | initialize () |
| virtual void | probe ()=0 |
| virtual When | when () const |
| 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 () | |
Private Types | |
| using | BaseType = SpatialGridWhenFormProbe |
| using | ItemType = TemperatureProbe |
Private Attributes | |
| Aggregation | _aggregation |
Friends | |
| class | ItemRegistry |
Additional Inherited Members | |
| Protected Types inherited from Probe | |
| enum class | When { Setup , Run , Primary , Secondary } |
TemperatureProbe probes the indicative temperature of the medium as discretized on the spatial grid of the simulation. The meaning of the indicative temperature depends heavily on the material type; see the discussion below. The probe can be used with any Form subclass. When associated with a form that projects the quantity along a path, the indicative temperature value is density-weighted.
The user can select the aggregation level, i.e. whether to produce an output file per medium component or per medium type (dust, electrons, gas). There is also an option to decide whether the probe should be performed after setup or after the full simulation run. See the discussion below for more information on these options.
Indicative temperature for a single medium component
The definition of the indicative temperature \({\bar{T}}\) depends heavily on the material type. Note that the indicative temperature almost never corresponds to a physical temperature; it is intended to provide an indication, as implied by its name.
For a dust component, the indicative temperature in a given spatial cell is obtained by solving the energy balance equation under local thermal equilibrium (LTE) assumptions for a single representative grain of the associated dust mix (even if the dust mix includes multiple grain composition types and/or grains size bins). This implies that the indicative temperature for a dust component can be calculated only after the radiation field has been calculated by the simulation.
For an electron or gas component, the indicative temperature is equal to the imported or default temperature provided as part of the input model and stored in the medium state for each spatial cell during setup. In principle, a gas mix may update the temperature during the simulation, however none of the current or foreseeable gas mixes do this.
In all cases, if a cell does not contain any material for the requested component, the indicative temperature is taken to be zero.
Indicative temperature for all medium components of a given material type
The aggregated indicative temperature for all medium components of a given material type (dust, electrons, gas) is obtained by averaging the individual indicative temperatures, as defined above, weighted by the relative masses in the cell under consideration. In formula form, for a spatial cell \(m\) with components \(h\) of the specified material type, the indicative dust temperature is defined as
\[{\bar{T}}_m = \frac{\sum_h \rho_{m,h}\,{\bar{T}}_{m,h}} {\sum_h \rho_{m,h}} \]
where \({\bar{T}}_{m,h}\) is the indicative temperature for each component \(h\) and \(\rho_{m,h}\) is the corresponding (mass or number) density.
Indicative temperature for individual grain populations in a dust mixture
If one or more medium components in the simulation are equipped with a FragmentDustMixDecorator, this probe can provide the individual indicative temperature for each of the dust grain populations represented by the decorator by specifying the aggregation value of Fragment. Depending on the value of the fragmentSizeBins flag on the decorator, there are fragments for each of the grain material types or even for each of the grain size bins defined by the underlying dust mixture. The probed information is written in a separate file for each fragment, identified by a zero-based fragment index in addition to the zero-based component index. Also in this case, the indicative temperature is calculated under the LTE assumption, so it does not necessarily reflect a physical temperature.
Indicative temperature along a path
When a TemperatureProbe is associated with a Form subclass that projects the probed quantity along a path, the indicative temperature is similarly density-weighted over the path, i.e.
\[{\bar{T}} = \frac{\sum_m \rho_m \,{\bar{T}}_m \,\Delta s_m} {\sum_m \rho_m \,\Delta s_m}\]
where \(\Delta s_m\) is the length of the path segment in each crossed cell \(m\).
Probing after setup or at the end of the simulation run
As mentioned above, the indicative dust temperature can be obtained only after the simulation has calculated the radiation field. The probe will skip any dust components if it is invoked after setup or if the simulation does not record a panchromatic radiation field.
This consideration does not hold for electron and gas components; the indicative electron or gas temperature can be probed either after setup or at the end of the simulation run.
This item type is displayed only if the Boolean expression "Medium&SpatialGrid&((DustMix&RadiationField&Panchromatic)|ElectronMix|GasMix)" evaluates to true after replacing the names by true or false depending on their presence.
|
strong |
The enumeration type indicating how to aggregate the output: per medium component or per medium type (dust, electrons, gas).
Fragment : "per fragment (dust grain material type and/or size bin)" .
Component : "per medium component" .
Type : "per medium type (dust, electrons, gas)" .
|
inlineprotected |
Default constructor for concrete Item subclass TemperatureProbe : "internal spatial grid: indicative temperature of the medium" .
|
inline |
This function returns the value of the discoverable Aggregation enumeration property aggregation : "how to aggregate the indicative temperature" .
The default value for this property is given by the conditional value expression "Type" .
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.
When a value is entered for this property, the names provided by the conditional value expression "thisIsTemperatureProbe" are inserted into the name sets used for evaluating Boolean expressions.
|
overridevirtual |
This function performs probing.
Implements Probe.