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

#include <MetallicityProbe.hpp>

Inheritance diagram for MetallicityProbe:
Inheritance graph
[legend]

Public Member Functions

void probe () override
 
- Public Member Functions inherited from SpatialGridWhenFormProbe
ProbeAfter probeAfter () const
 
- Public Member Functions inherited from SpatialGridFormProbe
Formform () 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 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 Member Functions

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

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 }
 

Detailed Description

MetallicityProbe probes the metallicity of gas medium components as discretized on the spatial grid of the simulation. It works only for gas components that store a metallicity value in the medium state. Electrons do not have metallicity. Dust components do not store metallicity in the medium state even if the value is imported from an input file; the metallicity value is discarded immediately after being used for calculating the dust density.

A seperate output file is produced for each gas medium component that stores a metallicity value in the medium state. The probe can be used with any Form subclass. When associated with a form that projects the quantity along a path, the value is density-weighted.

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

Constructor & Destructor Documentation

◆ MetallicityProbe()

MetallicityProbe::MetallicityProbe ( )
inlineprotected

Default constructor for concrete Item subclass MetallicityProbe : "internal spatial grid: metallicity of the gas medium" .

Member Function Documentation

◆ probe()

void MetallicityProbe::probe ( )
overridevirtual

This function performs probing.

Implements Probe.


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