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
SpecificLuminosityNormalization Class Reference

#include <SpecificLuminosityNormalization.hpp>

Inheritance diagram for SpecificLuminosityNormalization:
Inheritance graph
[legend]

Public Types

enum class  UnitStyle : int { neutralmonluminosity , wavelengthmonluminosity , frequencymonluminosity , energymonluminosity }
 

Public Member Functions

double luminosityForSED (SED *sed) const override
 
double specificLuminosity () const
 
UnitStyle unitStyle () const
 
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 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

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

Private Attributes

double _specificLuminosity
 
UnitStyle _unitStyle
 
double _wavelength
 

Friends

class ItemRegistry
 

Detailed Description

A SpecificLuminosityNormalization instance sets the normalization of a primary source by specifying the specific luminosity (radiative power per units of wavelength, frequency, or energy) at a certain wavelength. This normalization cannot be used with LineSED subclasses, for which the specific luminosity is undefined. An attempt to do so will result in a fatal error.

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

Member Enumeration Documentation

◆ UnitStyle

The enumeration type indicating the specific luminosity unit style, e.g. whether to use specific luminosity per unit of wavelength, frequency or energy.

neutralmonluminosity : "neutral: λ L_λ = ν L_ν" .

wavelengthmonluminosity : "per unit of wavelength: L_λ" .

frequencymonluminosity : "per unit of frequency: L_ν" .

energymonluminosity : "counts per unit of energy: L_E" .

Constructor & Destructor Documentation

◆ SpecificLuminosityNormalization()

SpecificLuminosityNormalization::SpecificLuminosityNormalization ( )
inlineprotected

Default constructor for concrete Item subclass SpecificLuminosityNormalization : "source normalization through the specific luminosity at a given wavelength" .

Member Function Documentation

◆ luminosityForSED()

double SpecificLuminosityNormalization::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 specific luminosity by the normalized specific luminosity in the SED at the same wavelength.

Implements LuminosityNormalization.

◆ specificLuminosity()

SpecificLuminosityNormalization::specificLuminosity ( ) const
inline

This function returns the value of the discoverable double property specificLuminosity : "the specific luminosity at the given wavelength" .

This property represents a physical quantity of type "@unitStyle" .

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

◆ unitStyle()

SpecificLuminosityNormalization::unitStyle ( ) const
inline

This function returns the value of the discoverable UnitStyle enumeration property unitStyle : "the luminosity unit style" .

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

◆ wavelength()

SpecificLuminosityNormalization::wavelength ( ) const
inline

This function returns the value of the discoverable double property wavelength : "the wavelength at which to provide the specific luminosity" .

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 documentation for this class was generated from the following files: