ListGaussianLinesSED Class Reference

#include <ListGaussianLinesSED.hpp>

Inheritance diagram for ListGaussianLinesSED:

Public Member Functions
const vector< double > &	dispersions () const
const vector< double > &	luminosities () const
const vector< double > &	wavelengths () const
Public Member Functions inherited from TabulatedSED
double	generateWavelength () const override
double	integratedLuminosity (const Range &wavelengthRange) const override
Range	intrinsicWavelengthRange () const override
double	specificLuminosity (double wavelength) const override
void	specificLuminosityArray (Array &lambdav, Array &pv, const Range &wavelengthRange) const override
Public Member Functions inherited from SED
Range	normalizationWavelengthRange () const
Public Member Functions inherited from SimulationItem
template<class T>
T *	find (bool setup=true) const
template<class T>
T *	interface (int upLevels, int downLevels, bool setup) 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
	ListGaussianLinesSED ()
void	getLineProperties (Array &lambdav, Array &dispersionv, Array &Lv) const override
Protected Member Functions inherited from GaussianLinesSED
	GaussianLinesSED ()
void	getWavelengthsAndLuminosities (Array &lambdav, Array &pv) const override
Protected Member Functions inherited from TabulatedSED
	TabulatedSED ()
void	setupSelfBefore () override
Protected Member Functions inherited from ContSED
	ContSED ()
Protected Member Functions inherited from SED
	SED ()
Random *	random () const
Protected Member Functions inherited from SimulationItem
	SimulationItem ()
virtual bool	offersInterface (const std::type_info &interfaceTypeInfo) const
virtual void	setupSelfAfter ()
Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType
using	ItemType

Private Attributes
vector< double >	_dispersions
vector< double >	_luminosities
vector< double >	_wavelengths

Friends
class	ItemRegistry

Detailed Description

A ListGaussianLinesSED object represents a spectral energy distribution that consists of one or more Gaussian emission lines 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 lines, but nothing keeps the user from specifying a long list. The lines may be listed in any order.

The wavelengths are by default given in micron, but any wavelength, frequency or photon energy unit supported by SKIRT may be used instead. The velocity dispersions are given in velocity units. The luminosity values are given in luminosity units, but the scaling of the values is arbitrary because the SED will be normalized after being loaded.

See the description of the GaussianLinesSED class for more information on how the lines specified here are combined into a single tabulated SED.

Constructor & Destructor Documentation

ListGaussianLinesSED()

ListGaussianLinesSED::ListGaussianLinesSED ( )

inlineprotected

Default constructor for concrete Item subclass ListGaussianLinesSED: "a multiple Gaussian-line SED specified inside the configuration file".

Member Function Documentation

dispersions()

const vector< double > & ListGaussianLinesSED::dispersions ( ) const

inline

This function returns the value of the discoverable double list property dispersions: "the Gaussian velocity dispersion for each line".

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

The minimum value for this property is "]0 km/s".

The maximum value for this property is "1000 km/s]".

getLineProperties()

void ListGaussianLinesSED::getLineProperties ( Array & lambdav, Array & dispersionv, Array & Lv ) const

overrideprotectedvirtual

This function loads the configured wavelengths, dispersions and luminosities into the specified arrays. The GaussianLinesSED base class verifies that the three lists have a matching, nonzero length.

Implements GaussianLinesSED.

luminosities()

const vector< double > & ListGaussianLinesSED::luminosities ( ) const

inline

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

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

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

wavelengths()

const vector< double > & ListGaussianLinesSED::wavelengths ( ) const

inline

This function returns the value of the discoverable double list property wavelengths: "the line center 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:

• ListGaussianLinesSED.hpp