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

#include <IntegratedLuminosityNormalization.hpp>

Inheritance diagram for IntegratedLuminosityNormalization:
Inheritance graph
[legend]

Public Types

enum class  WavelengthRange : int { Source , All , Custom }
 

Public Member Functions

double integratedLuminosity () const
 
double luminosityForSED (SED *sed) const override
 
double maxWavelength () const
 
double minWavelength () const
 
WavelengthRange wavelengthRange () 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

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

Private Attributes

double _integratedLuminosity
 
double _maxWavelength
 
double _minWavelength
 
WavelengthRange _wavelengthRange
 

Friends

class ItemRegistry
 

Detailed Description

An IntegratedLuminosityNormalization instance sets the normalization of a primary source by specifying the luminosity (radiative power) integrated over a certain wavelength range.

Member Enumeration Documentation

◆ WavelengthRange

The enumeration type selecting a wavelength range: the range given for the source system, the bolometric range of the SED (i.e. including all wavelengths), or a custom range specified as properties of this object.

Source : "the wavelength range of the primary sources" .

All : "all wavelengths (i.e. over the full SED)" .

Custom : "a custom wavelength range specified here" .

Constructor & Destructor Documentation

◆ IntegratedLuminosityNormalization()

IntegratedLuminosityNormalization::IntegratedLuminosityNormalization ( )
inlineprotected

Default constructor for concrete Item subclass IntegratedLuminosityNormalization : "source normalization through the integrated luminosity for a given wavelength range" .

Member Function Documentation

◆ integratedLuminosity()

IntegratedLuminosityNormalization::integratedLuminosity ( ) const
inline

This function returns the value of the discoverable double property integratedLuminosity : "the integrated luminosity for the given wavelength range" .

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

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

◆ luminosityForSED()

double IntegratedLuminosityNormalization::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 integrated luminosity by the normalized integrated luminosity for the SED over the same wavelength range.

Implements LuminosityNormalization.

◆ maxWavelength()

IntegratedLuminosityNormalization::maxWavelength ( ) const
inline

This function returns the value of the discoverable double property maxWavelength : "the longest wavelength of the integration range" .

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 "100 micron" .

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

◆ minWavelength()

IntegratedLuminosityNormalization::minWavelength ( ) const
inline

This function returns the value of the discoverable double property minWavelength : "the shortest wavelength of the integration range" .

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 "0.09 micron" .

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

◆ wavelengthRange()

IntegratedLuminosityNormalization::wavelengthRange ( ) const
inline

This function returns the value of the discoverable WavelengthRange enumeration property wavelengthRange : "the wavelength range for which to provide the integrated luminosity" .

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


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