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

#include <DustEmissivityProbe.hpp>

Inheritance diagram for DustEmissivityProbe:
Inheritance graph
[legend]

Public Member Functions

bool writeWavelengthGrid () 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

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

Private Attributes

bool _writeWavelengthGrid
 

Friends

class ItemRegistry
 

Additional Inherited Members

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

Detailed Description

DustEmissivityProbe outputs column text files tabulating the emissivity spectra for the representative dust mix of each medium in the medium system (i.e. the dust mix at the model coordinate origin), using the dust emissivity calculator configured for the simulation, and assuming the dust would be embedded in a range of predefined input fields.

The output emissivity spectra are discretized on the emission spectrum wavelength grid as returned by the Configuration::dustEmissionWLG() function. The input radiation fields used for the calculations are discretized on the radiation field wavelength grid as returned by the Configuration::radiationFieldWLG() function. As a result, this probe requires the configuration of the simulation to include dust emission, so that a dust emissivity calculator, a radiation field wavelength grid, and an emission spectrum wavelength grid have been properly configured.

The built-in embedding fields include scaled versions of the solar neighborhood interstellar radiation field presented by Mathis et al. (1983, A&A, 128, 212), which is essentially a sum of three diluted blackbodies with a UV extension, and a set of diluted blackbodies at varying temperatures.

A separate output file is written for each embedding field. Each file contains a line per wavelength. The first column lists the wavelength, amd the subsequent columns list the emmissivity at that wavelength for each of the medium components that actually contain dust. The emmissivity values are always given in units of Watt per steradian per hydrogen atom ("W/sr/H"), regardless of the configured output unit style.

The probe offers an option to output a separate text column file with additional details on the emission spectrum wavelength grid. For each wavelength bin, the file lists the characteristic wavelength, the wavelength bin width, and the left and right borders of the bin.

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

Constructor & Destructor Documentation

◆ DustEmissivityProbe()

DustEmissivityProbe::DustEmissivityProbe ( )
inlineprotected

Default constructor for concrete Item subclass DustEmissivityProbe : "properties: emissivity spectrum for each dust mix in a range of standard fields" .

Member Function Documentation

◆ probe()

void DustEmissivityProbe::probe ( )
overrideprotectedvirtual

This function performs probing.

Implements Probe.

◆ writeWavelengthGrid()

DustEmissivityProbe::writeWavelengthGrid ( ) const
inline

This function returns the value of the discoverable Boolean property writeWavelengthGrid : "output a text file with the emission spectrum wavelength grid" .

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


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