 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <OpacityProbe.hpp>
Public Types | |
| enum class | Aggregation : int { Fragment , Component , Type , System } |
 Public Types inherited from SpatialGridWhenFormProbe | |
| enum class | ProbeAfter : int { Setup , Run , Primary , Secondary } |
Public Member Functions | |
| Aggregation | aggregation () const |
| void | probe () override |
| double | wavelength () const |
| Range | wavelengthRange () const 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 |
| Public Member Functions inherited from MaterialWavelengthRangeInterface | |
| virtual WavelengthGrid * | materialWavelengthGrid () const |
| Public Member Functions inherited from WavelengthRangeInterface | |
| virtual | ~WavelengthRangeInterface () |
| virtual Range | wavelengthRange () const =0 |
Protected Member Functions | |
| OpacityProbe () | |
| 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 () | |
| Protected Member Functions inherited from MaterialWavelengthRangeInterface | |
| MaterialWavelengthRangeInterface () | |
| Protected Member Functions inherited from WavelengthRangeInterface | |
| WavelengthRangeInterface () | |
Private Types | |
| using | BaseType = SpatialGridWhenFormProbe |
| using | ItemType = OpacityProbe |
Private Attributes | |
| Aggregation | _aggregation |
| double | _wavelength |
Friends | |
| class | ItemRegistry |
Additional Inherited Members | |
| Protected Types inherited from Probe | |
| enum class | When { Setup , Run , Primary , Secondary } |
OpacityProbe probes the opacity of the medium at a given wavelength, as discretized on the spatial grid of the simulation. In the context of this probe, the opacity \(k\) of a medium (at a given position and wavelength) is defined as the product of the local density and extinction cross section, \(k=n\varsigma=\rho\kappa\). The probe can be used with any Form subclass. When associated with a form that projects the quantity along a path \(s\), the probe outputs optical depth, \(\tau=\int_s k(s) \mathrm{d}s\).
Because probing is performed without the context of a photon packet, default values are used for any relevant incoming photon packet properties. For example, the effects of kinematics are ignored and the radiation is assumed to be unpolarized.
The user can select the aggregation level, i.e. whether to produce an output file per medium component, per medium type (dust, electrons, gas), or for the complete medium system. If one or more medium components in the simulation are equipped with a FragmentDustMixDecorator, the probe can provide information for each of the dust grain populations represented by the decorator. 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.
There is also an option to decide whether the probe should be performed after setup or after the full simulation run. The latter option is meaningful if the density and/or cross section of the media may change during the simulation.
This probe implements the MaterialWavelengthRangeInterface to indicate that wavelength-dependent material properties may be required for the configured wavelength.
This item type is displayed only if the Boolean expression "Medium&SpatialGrid" 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, per medium type (dust, electrons, gas), or for the complete medium system.
Fragment : "per fragment (dust grain material type and/or size bin)" .
Component : "per medium component" .
Type : "per medium type (dust, electrons, gas)" .
System : "for the complete medium system" .
|
inlineprotected |
Default constructor for concrete Item subclass OpacityProbe : "internal spatial grid: opacity of the medium" .
|
inline |
This function returns the value of the discoverable Aggregation enumeration property aggregation : "how to aggregate the opacity" .
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.
|
overridevirtual |
This function performs probing.
Implements Probe.
|
inline |
This function returns the value of the discoverable double property wavelength : "the wavelength at which to determine the opacity" .
This property represents a physical quantity of type "wavelength" .
The minimum value for this property is "1 pm" .
The maximum value for this property is "1 m" .
The default value for this property is given by the conditional value expression "0.55 micron" .
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.
|
overridevirtual |
This function returns a wavelength range corresponding to the user-configured wavelength, indicating that wavelength-dependent material properties may be required for this wavelength.
Implements WavelengthRangeInterface.