#include <ListSED.hpp>

Inheritance diagram for ListSED:

[legend]

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

Public Member Functions
const vector< double > &	specificLuminosities () const

UnitStyle	unitStyle () 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

virtual double	specificLuminosity (double wavelength) const =0

virtual void	specificLuminosityArray (Array &lambdav, Array &pv, const Range &wavelengthRange) const =0

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 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
	ListSED ()

void	getWavelengthsAndLuminosities (Array &lambdav, Array &pv) const override

Protected Member Functions inherited from TabulatedSED
	TabulatedSED ()

virtual void	getWavelengthsAndLuminosities (Array &lambdav, Array &pv) const =0

void	setupSelfBefore () override

Protected Member Functions inherited from ContSED
	ContSED ()

Protected Member Functions inherited from SED
	SED ()

Random *	random () 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 = TabulatedSED

using	ItemType = ListSED

Private Attributes
vector< double >	_specificLuminosities

UnitStyle	_unitStyle

vector< double >	_wavelengths

Friends
class	ItemRegistry

Detailed Description

A ListSED object represents a spectral energy distribution 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 must be listed in increasing or decreasing order. The luminosity outside the range indicated by the first and the last wavelength in the list is considered to be zero.

The wavelengths are by default given in micron. The specific luminosity values are by default given in per-wavelength units, but the user can opt to use per-frequency or neutral units. Other than this, the scaling of the values is arbitrary because the SED will be normalized after being loaded. However, the input procedure still insists on knowing the precise units.

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.

Member Enumeration Documentation

◆ UnitStyle

enum class ListSED::UnitStyle : int

strong

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

◆ ListSED()

ListSED::ListSED ( )

inlineprotected

Default constructor for concrete Item subclass ListSED : "a spectral energy distribution specified inside the configuration file" .

Member Function Documentation

◆ getWavelengthsAndLuminosities()

void ListSED::getWavelengthsAndLuminosities	(	Array &	lambdav,
		Array &	pv
	)		const

overrideprotectedvirtual

This function verifies that the number of configured wavelengths and luminosities match, converts the luminosities to per-wavelength style if needed, and loads the data into the specified arrays.

Implements TabulatedSED.

◆ specificLuminosities()

ListSED::specificLuminosities ( ) const

inline

This function returns the value of the discoverable double list property specificLuminosities : "the specific luminosities at each of the given wavelengths" .

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

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

◆ unitStyle()

ListSED::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" .

◆ wavelengths()

ListSED::wavelengths ( ) const

inline

This function returns the value of the discoverable double list property wavelengths : "the wavelengths at which to specify 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 file:

ListSED.hpp

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ UnitStyle

Constructor & Destructor Documentation

◆ ListSED()

Member Function Documentation

◆ getWavelengthsAndLuminosities()

◆ specificLuminosities()

◆ unitStyle()

◆ wavelengths()