The SKIRT project
advanced radiative transfer for astrophysics
Protected Member Functions | Private Types | Friends | List of all members
ImportedMediumDensityProbe Class Reference

#include <ImportedMediumDensityProbe.hpp>

Inheritance diagram for ImportedMediumDensityProbe:
Inheritance graph
[legend]

Protected Member Functions

 ImportedMediumDensityProbe ()
 
void probeImportedMedium (string sh, const ImportedMedium *medium, const Snapshot *snapshot) 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 = ImportedMediumDensityProbe
 

Friends

class ItemRegistry
 

Additional Inherited Members

- Public Member Functions inherited from InputModelFormProbe
GenericFormform () 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 ItemgetItemProperty (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)
 
Itemoperator= (const Item &)=delete
 
Itemparent () 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 Types inherited from Probe
enum class  When { Setup , Run , Primary , Secondary }
 

Detailed Description

ImportedMediumDensityProbe probes the density of each imported medium component in the simulation as represented by the imported snapshot, without involving the spatial grid of the simulation. The probe outputs the mass or number density depending on which one has been imported. When associated with a form that projects the quantity along a path, the probe outputs mass surface density or number surface density (column density).

This item type is displayed only if the Boolean expression "ImportedMedium" evaluates to true after replacing the names by true or false depending on their presence.

Constructor & Destructor Documentation

◆ ImportedMediumDensityProbe()

ImportedMediumDensityProbe::ImportedMediumDensityProbe ( )
inlineprotected

Default constructor for concrete Item subclass ImportedMediumDensityProbe : "imported medium: mass or number density" .

Member Function Documentation

◆ probeImportedMedium()

void ImportedMediumDensityProbe::probeImportedMedium ( string  sh,
const ImportedMedium medium,
const Snapshot snapshot 
)
overrideprotectedvirtual

This function probes the specified imported medium component.

Reimplemented from InputModelFormProbe.


The documentation for this class was generated from the following file: