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

#include <DustGrainPopulationsProbe.hpp>

Inheritance diagram for DustGrainPopulationsProbe:
Inheritance graph
[legend]

Protected Member Functions

 DustGrainPopulationsProbe ()
 
void probe () override
 
- Protected Member Functions inherited from SpecialtyProbe
 SpecialtyProbe ()
 
- 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 = SpecialtyProbe
 
using ItemType = DustGrainPopulationsProbe
 

Friends

class ItemRegistry
 

Additional Inherited Members

- 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

DustGrainPopulationsProbe outputs column text files listing information on the dust grain populations of the applicable dust media configured in the simulation. For each medium component, the probe retrieves a representative material mix (the mix at the origin of the model coordinate system). If the material mix offers MultiGrainDustMix capabilities (i.e. it is described by one or more individual dust grain populations), the probe creates a file with information on each of the grain populations in that mix. The files are named prefix_probe_grainpops_N.fits where N is replaced with the zero-based index of the medium in the configuration (i.e. in the ski file).

The columns in each text file list the following properties for each grain population: the zero-based population index; a short name identifying the type of grain material in the population; the dust mass in the population as a percentage of the total, as a mass per hydrogen atom, and as a mass per hydrogen mass; and the size range of the grains in the population.

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

Constructor & Destructor Documentation

◆ DustGrainPopulationsProbe()

DustGrainPopulationsProbe::DustGrainPopulationsProbe ( )
inlineprotected

Default constructor for concrete Item subclass DustGrainPopulationsProbe : "properties: dust grain population mass and size information" .

Member Function Documentation

◆ probe()

void DustGrainPopulationsProbe::probe ( )
overrideprotectedvirtual

This function performs probing.

Implements Probe.


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