 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <ImportedSourceDensityProbe.hpp>
Public Types | |
| enum class | MassType : int { InitialMass , CurrentMass } |
Public Member Functions | |
| MassType | massType () const |
 Public Member Functions inherited from InputModelFormProbe | |
| GenericForm * | form () const |
| void | probe () override |
| 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 | |
| ImportedSourceDensityProbe () | |
| void | probeImportedSources (const vector< const ImportedSource * > &sources, const vector< const Snapshot * > &snapshots) override |
| Protected Member Functions inherited from InputModelFormProbe | |
| InputModelFormProbe () | |
| virtual void | probeImportedMedium (string sh, const ImportedMedium *medium, const Snapshot *snapshot) |
| virtual void | probeImportedSources (const vector< const ImportedSource * > &sources, const vector< const Snapshot * > &snapshots) |
| 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 = InputModelFormProbe |
| using | ItemType = ImportedSourceDensityProbe |
Private Attributes | |
| MassType | _massType |
Friends | |
| class | ItemRegistry |
Additional Inherited Members | |
| Protected Types inherited from Probe | |
| enum class | When { Setup , Run , Primary , Secondary } |
ImportedSourceDensityProbe probes the initial or current mass density aggregated over all imported sources in the simulation. It uses the data as represented by the imported snapshot(s), without involving the spatial grid of the simulation. When associated with a form that projects the quantity along a path, the probe outputs mass surface density.
The probe produces output only if the simulation has at least one source component, if all sources are imported, and if all of these sources offer the requested type of mass density.
In most use cases, one will be interested in probing the current stellar mass of a source component. However, this information is usually not automatically available to the SKIRT input model. SED families that model single stellar populations (e.g. BruzualCharlotSEDFamily, FSPSSEDFamily) often require the initial stellar mass of the population as an input parameter, as opposed to the current stellar mass. Many other SED families (e.g. MappingsSEDFamily, CastelliKuruczSEDFamily, BlackBodySEDFamily) do not rely (directly) on stellar mass information at all.
Therefore this probe offers the massType option. When set to InitialMass, the probe will use the initial mass imported as one of the SED family parameters as a suboptimal solution. However, assuming that the current mass can be obtained when preparing SKIRT's input data, a better solution is to provide it as a separate, additional column to the import process, enable the importCurrentMass option for the ImportedSource component(s), and set the massType option for the probe to CurrentMass. Now the probe will use the separately imported current mass. Note that, as indicated above, the requested mass type must be available for all source components for the probe to produce output.
This item type is displayed only if the Boolean expression "ImportedSource" evaluates to true after replacing the names by true or false depending on their presence.
|
strong |
The enumeration type indicating whether to use initial mass or current mass.
InitialMass : "initial mass" .
CurrentMass : "current mass" .
|
inlineprotected |
Default constructor for concrete Item subclass ImportedSourceDensityProbe : "imported source: mass density" .
|
inline |
This function returns the value of the discoverable MassType enumeration property massType : "type of mass being probed" .
The default value for this property is given by the conditional value expression "InitialMass" .
This property is displayed only if the Boolean expression "CurrentMass" evaluates to true after replacing the names by true or false depending on their presence.
|
overrideprotectedvirtual |
This function probes the specified imported source components.
Reimplemented from InputModelFormProbe.