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

#include <ImportedMediumTemperatureProbe.hpp>

Inheritance diagram for ImportedMediumTemperatureProbe:
Inheritance graph
[legend]

Protected Member Functions

 ImportedMediumTemperatureProbe ()
 
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 = ImportedMediumTemperatureProbe
 

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

ImportedMediumTemperatureProbe probes the temperature of each imported medium component in the simulation for which that information is available. The probe uses the data as represented by the imported snapshot, without involving the spatial grid of the simulation. The temperature is (mass or number) density-weighted where necessary, i.e. when the probe is associated with a form that projects the quantity along a path, or when two or more smoothed particles in the imported data overlap.

For dust medium components, if metallicity is being imported in addition to temperature, the weighting is based on the (dusty) gas density rather than the dust density itself. In other words, the probe uses the medium density before the automatic multiplication with metallicity occurs, but ignoring any cells or particles that do not contain dust (because the corresponding information is removed during import).

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

◆ ImportedMediumTemperatureProbe()

ImportedMediumTemperatureProbe::ImportedMediumTemperatureProbe ( )
inlineprotected

Default constructor for concrete Item subclass ImportedMediumTemperatureProbe : "imported medium: temperature" .

Member Function Documentation

◆ probeImportedMedium()

void ImportedMediumTemperatureProbe::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: