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

#include <LineLuminosityNormalization.hpp>

Inheritance diagram for LineLuminosityNormalization:
Inheritance graph
[legend]

Public Member Functions

double luminosity () const
 
double luminosityForSED (SED *sed) const override
 
double wavelength () const
 
virtual double luminosityForSED (SED *sed) const =0
 
- 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 Item * getItemProperty (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)
 
Item & operator= (const Item &)=delete
 
Item * parent () 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

 LineLuminosityNormalization ()
 
- Protected Member Functions inherited from LuminosityNormalization
 LuminosityNormalization ()
 
- 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 = LuminosityNormalization
 
using ItemType = LineLuminosityNormalization
 

Private Attributes

double _luminosity
 
double _wavelength
 

Friends

class ItemRegistry
 

Detailed Description

A LineLuminosityNormalization instance sets the normalization of a primary source by specifying the luminosity (radiative power) for a given emission line. In practice, the normalization occurs by integrating over a very narrow wavelength range centered on a given wavelength value. This class is intended for use with sources of line emission, i.e. sources equipped with one of the LineSED subclasses.

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

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

Constructor & Destructor Documentation

◆ LineLuminosityNormalization()

LineLuminosityNormalization::LineLuminosityNormalization ( )
inlineprotected

Default constructor for concrete Item subclass LineLuminosityNormalization : "source normalization through the luminosity for a given emission line" .

Member Function Documentation

◆ luminosity()

LineLuminosityNormalization::luminosity ( ) const
inline

This function returns the value of the discoverable double property luminosity : "the luminosity for the emission line" .

This property represents a physical quantity of type "bolluminosity" .

The minimum value for this property is "]0" .

◆ luminosityForSED()

double LineLuminosityNormalization::luminosityForSED ( SED *  sed) const
overridevirtual

This function returns the luminosity of a source with the specified SED, limited to the source's wavelength range. Given that the luminosity of the spectrum described by the SED object over the source wavelength range is normalized to unity, the requested luminosity is obtained by dividing the user-configured luminosity by the normalized luminosity for the line in the specified SED.

Implements LuminosityNormalization.

◆ wavelength()

LineLuminosityNormalization::wavelength ( ) const
inline

This function returns the value of the discoverable double property wavelength : "the central wavelength of the emission line" .

This property represents a physical quantity of type "wavelength" .

The minimum value for this property is "1 pm" .

The maximum value for this property is "1 m" .

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

The documentation for this class was generated from the following file:
The SKIRT project -- advanced radiative transfer for astrophysics © Astronomical Observatory, Ghent University