 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <CustomStateProbe.hpp>
Public Member Functions | |
| string | indices () 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 | |
| CustomStateProbe () | |
| 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 = CustomStateProbe |
Private Attributes | |
| string | _indices |
Friends | |
| class | ItemRegistry |
Additional Inherited Members | |
| Public Types inherited from SpatialGridWhenFormProbe | |
| enum class | ProbeAfter : int { Setup , Run , Primary , Secondary } |
| Protected Types inherited from Probe | |
| enum class | When { Setup , Run , Primary , Secondary } |
CustomStateProbe probes the custom medium state quantities for medium components configured with a material mix that requests such variables. Examples include the dust fragment weights used by the FragmentDustMixDecorator, the neutral and atomic hydrogen fractions required by the SpinFlipHydrogenGasMix, and the energy level population densities used by the MolecularLineGasMix. These custom quantities are always discretized on the simulation's spatial grid. The probe outputs a compound quantity with a value for each of the custom medium state quantities. It can be used with any Form subclass, taking into account the caveat discussed below. When associated with a form that projects the quantity along a path, the value is density-weighted.
A given material mix (and thus its associated medium component) may use custom state quantities of different types and hence different output units. This is no problem for text column output files because the quantity types and units of the different columns are listed in the file header. The situation is somewhat different for FITS output files. Each quantity is stored in its own frame ("image") of the data cube using the appropriate units, but there is no mechanism to advertise the units for each of the frames. The file header lists just the units of the quantity stored in the first frame.
The indices option allows specifying a subset of the custom state quantities to be probed. This allows restricting the probe to quantities with the same units or otherwise grouping or reordering quantities. If the indices string is empty, all custom quantities are included. Otherwise, the probe expects a comma-separated list of zero-based indices or index ranges indicated with a dash. Examples of valid strings include: "5,1,2" or "0-9,17". Incorrectly formatted string segments and out-of-range indices are ignored.
The probe produces output for each medium component that has custom quantities, or if the indices string is nonempty, for each medium component that has custom quantities for at least one of the specified indices.
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 custom medium state may change during the simulation.
This item type is displayed only if the Boolean expression "Level3&CustomMediumState" evaluates to true after replacing the names by true or false depending on their presence.
|
inlineprotected |
Default constructor for concrete Item subclass CustomStateProbe : "internal spatial grid: custom medium state quantities" .
|
inline |
This function returns the value of the discoverable string property indices : "zero-based indices or index ranges of quantities to probe, or empty for all" .
The default value for this property is given by the conditional value expression "" .
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.
|
overridevirtual |
This function performs probing.
Implements Probe.