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

#include <DustGrainSizeDistributionProbe.hpp>

Inheritance diagram for DustGrainSizeDistributionProbe:
Inheritance graph
[legend]

Public Member Functions

int numSamples () 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

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

Private Attributes

int _numSamples
 

Friends

class ItemRegistry
 

Additional Inherited Members

- Protected Types inherited from Probe
enum class  When { Setup , Run , Primary , Secondary }
 

Detailed Description

DustGrainSizeDistributionProbe outputs column text files tabulating the dust grain size distributions of the applicable dust grain populations 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. if it is described by one or more individual dust grain populations, the probe creates a size distribution file for each of those populations. The files are named prefix_probe_grainsizes_N_M.fits where N is replaced with the zero-based index of the medium in the configuration and M is replaced with the zero-based index of the grain population in the corresponding material mix.

Each text file tabulates \(\text{dnda}(a)\) (second column) as a function of \(a\) (first column). In other words, it tabulates the relative number of dust grains with size \(a\) in the population,

\[ \text{dnda}(a) \propto \frac{\text{d}n_\text{D}}{\text{d}a} \qquad \text{for}\quad a_\text{min} \leq a \leq a_\text{max}. \]

The probe reports the \(\text{dnda}(a)\) values as returned by the grain size distribution, without extra scaling or normalization. The grain size values in the table are distributed logarithmically over the range of the size distribution. The number of values in the table can be configured by the user.

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

◆ DustGrainSizeDistributionProbe()

DustGrainSizeDistributionProbe::DustGrainSizeDistributionProbe ( )
inlineprotected

Default constructor for concrete Item subclass DustGrainSizeDistributionProbe : "properties: dust grain size distribution" .

Member Function Documentation

◆ numSamples()

DustGrainSizeDistributionProbe::numSamples ( ) const
inline

This function returns the value of the discoverable integer property numSamples : "the number of samples in the size distribution table" .

The minimum value for this property is "3" .

The maximum value for this property is "100000" .

The default value for this property is given by the conditional value expression "250" .

◆ probe()

void DustGrainSizeDistributionProbe::probe ( )
overrideprotectedvirtual

This function performs probing.

Implements Probe.


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