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

#include <LuminosityProbe.hpp>

Inheritance diagram for LuminosityProbe:
Inheritance graph
[legend]

Protected Member Functions

 LuminosityProbe ()
 
void probe () override
 
- Protected Member Functions inherited from SpecialtyWavelengthGridProbe
 SpecialtyWavelengthGridProbe ()
 
- 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 ()
 
- Protected Member Functions inherited from MaterialWavelengthRangeInterface
 MaterialWavelengthRangeInterface ()
 
- Protected Member Functions inherited from WavelengthRangeInterface
 WavelengthRangeInterface ()
 

Private Types

using BaseType = SpecialtyWavelengthGridProbe
 
using ItemType = LuminosityProbe
 

Friends

class ItemRegistry
 

Additional Inherited Members

- Public Member Functions inherited from SpecialtyWavelengthGridProbe
WavelengthGridmaterialWavelengthGrid () const override
 
WavelengthGridwavelengthGrid () const
 
Range wavelengthRange () const override
 
- 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
 
virtual WavelengthGridmaterialWavelengthGrid () const
 
- Public Member Functions inherited from WavelengthRangeInterface
virtual ~WavelengthRangeInterface ()
 
virtual Range wavelengthRange () const =0
 
- Protected Types inherited from Probe
enum class  When { Setup , Run , Primary , Secondary }
 

Detailed Description

LuminosityProbe outputs a text column file with the primary source luminosities on a specified wavelength grid (or on the default instrument wavelength grid). The file is named prefix_luminosities.txt. The first three columns list the characteristic wavelength of the wavelength bin, the total specific luminosity at that wavelength, and the total luminosity integrated over the bin (in both cases summed over all primary sources). Furthermore, there is an additional column for each primary source, listing the fractional contribution of that source. The columns are in the same order as the sources appear in the configuration file. If there is only one source, there is a single column containing one's.

Note that, by definition, the luminosity is zero outside of the primary source wavelength range configured in the source system.

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

Constructor & Destructor Documentation

◆ LuminosityProbe()

LuminosityProbe::LuminosityProbe ( )
inlineprotected

Default constructor for concrete Item subclass LuminosityProbe : "source: luminosities of primary sources" .

Member Function Documentation

◆ probe()

void LuminosityProbe::probe ( )
overrideprotectedvirtual

This function performs probing.

Implements Probe.


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