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

#include <SecondaryDustLuminosityProbe.hpp>

Inheritance diagram for SecondaryDustLuminosityProbe:
Inheritance graph
[legend]

Public Types

enum class  ProbeAfter : int { Run , Secondary }
 

Public Member Functions

void probe () override
 
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

 SecondaryDustLuminosityProbe ()
 
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 = SpatialGridFormProbe
 
using ItemType = SecondaryDustLuminosityProbe
 

Private Attributes

ProbeAfter _probeAfter
 

Friends

class ItemRegistry
 

Additional Inherited Members

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

Detailed Description

SecondaryDustLuminosityProbe probes the specific luminosity aggregated over all dust medium components in the simulation at the wavelengths specified by the dust emission wavelength grid configured for the simulation. It produces output only if the simulation has at least one dust medium component and includes dust emission.

When associated with a form that samples the luminosity per spatial cell or at a set of positions, such as for a linear or planar cut, the probe outputs a monochromatic luminosity volume density (with SI units of W/m/m3 for the per-wavelength flavor). When associated with a form that projects the luminosity along a path, the probe outputs a monochromatic luminosity surface density divided by the area of the unit sphere (with resulting SI units of W/m/m2/sr for the per-wavelength flavor). In case of parallel projection towards a distant observer, this quantity is equivalent to surface brightness. In other words, this probe can be used to produce transparent noise-free images of the dust emission.

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

Member Enumeration Documentation

◆ ProbeAfter

The enumeration type indicating when probing occurs.

Run : "after the complete simulation run" .

Secondary : "after each iteration over secondary emission" .

Constructor & Destructor Documentation

◆ SecondaryDustLuminosityProbe()

SecondaryDustLuminosityProbe::SecondaryDustLuminosityProbe ( )
inlineprotected

Default constructor for concrete Item subclass SecondaryDustLuminosityProbe : "internal spatial grid: secondary dust luminosity" .

Member Function Documentation

◆ probe()

void SecondaryDustLuminosityProbe::probe ( )
overridevirtual

This function performs probing.

Implements Probe.

◆ probeAfter()

SecondaryDustLuminosityProbe::probeAfter ( ) const
inline

This function returns the value of the discoverable ProbeAfter enumeration property probeAfter : "perform the probe after" .

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

This property is displayed only if the Boolean expression "IterateSecondary" evaluates to true after replacing the names by true or false depending on their presence.

◆ when()

When SecondaryDustLuminosityProbe::when ( ) const
overrideprotectedvirtual

This function returns an enumeration indicating when probing for this probe should be performed corresponding to the configured value of the probeAfter property.

Reimplemented from Probe.


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