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

#include <ListLineSED.hpp>

Inheritance diagram for ListLineSED:
Inheritance graph
[legend]

Public Member Functions

const vector< double > & luminosities () const
 
const vector< double > & wavelengths () const
 
- Public Member Functions inherited from LineSED
double generateWavelength () const override
 
double integratedLuminosity (const Range &wavelengthRange) const override
 
Range intrinsicWavelengthRange () const override
 
- Public Member Functions inherited from SED
virtual double generateWavelength () const =0
 
virtual double integratedLuminosity (const Range &wavelengthRange) const =0
 
virtual Range intrinsicWavelengthRange () const =0
 
Range normalizationWavelengthRange () const
 
- 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

 ListLineSED ()
 
void getWavelengthsAndLuminosities (Array &lambdav, Array &Lv) const override
 
- Protected Member Functions inherited from LineSED
 LineSED ()
 
virtual void getWavelengthsAndLuminosities (Array &lambdav, Array &Lv) const =0
 
void setupSelfBefore () override
 
- Protected Member Functions inherited from SED
 SED ()
 
Randomrandom () const
 
void setupSelfBefore () override
 
- 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 = LineSED
 
using ItemType = ListLineSED
 

Private Attributes

vector< double > _luminosities
 
vector< double > _wavelengths
 

Friends

class ItemRegistry
 

Detailed Description

A ListLineSED object represents a spectral energy distribution that consist of one or more discrete emission lines with zero width and that is fully specified inside the configuration file (i.e. without referring to an input file). It is intended for use in cases where there are just a few wavelength/luminosity pairs, but nothing keeps the user from specifying a long list.

The wavelengths are by default given in micron and may be listed in any order. The corresponding luminosity values are given in luminosity units, but the scaling of the values is arbitrary because the SED will be normalized after being loaded.

Because the specific luminosity of the spectrum is undefined, there are important restrictions on the use of this SED. See the description of the LineSED class for more information.

Constructor & Destructor Documentation

◆ ListLineSED()

ListLineSED::ListLineSED ( )
inlineprotected

Default constructor for concrete Item subclass ListLineSED : "a discrete line SED specified inside the configuration file" .

Member Function Documentation

◆ getWavelengthsAndLuminosities()

void ListLineSED::getWavelengthsAndLuminosities ( Array lambdav,
Array Lv 
) const
overrideprotectedvirtual

This function verifies that the number of configured wavelengths and luminosities match and loads the data into the specified arrays.

Implements LineSED.

◆ luminosities()

ListLineSED::luminosities ( ) const
inline

This function returns the value of the discoverable double list property luminosities : "the line luminosities" .

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

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

◆ wavelengths()

ListLineSED::wavelengths ( ) const
inline

This function returns the value of the discoverable double list property wavelengths : "the line wavelengths" .

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 file: