BpassSEDFamily Class Reference

#include <BpassSEDFamily.hpp>

Inheritance diagram for BpassSEDFamily:

Public Types
enum class	IMF : int { Chabrier100 , Chabrier300 }
enum class	Resolution : int { Original , Downsampled }

Public Member Functions
	BpassSEDFamily (SimulationItem *parent, IMF imf, Resolution resolution)
double	cdf (Array &lambdav, Array &pv, Array &Pv, const Range &wavelengthRange, const Array &parameters) const override
IMF	imf () const
Range	intrinsicWavelengthRange () const override
vector< SnapshotParameter >	parameterInfo () const override
Resolution	resolution () const
double	specificLuminosity (double wavelength, const Array &parameters) const override
virtual double	cdf (Array &lambdav, Array &pv, Array &Pv, const Range &wavelengthRange, const Array &parameters) const =0
virtual Range	intrinsicWavelengthRange () const =0
virtual vector< SnapshotParameter >	parameterInfo () const =0
virtual double	specificLuminosity (double wavelength, const Array &parameters) 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 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
	BpassSEDFamily ()
void	setupSelfBefore () override
Protected Member Functions inherited from SEDFamily
	SEDFamily ()
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 = SEDFamily
using	ItemType = BpassSEDFamily

Private Attributes
IMF	_imf
Resolution	_resolution
StoredTable< 3 >	_table

Friends
class	ItemRegistry

Detailed Description

An instance of the BpassSEDFamily class represents a BPASS family of single stellar population (SSP) SED templates (Eldridge, Stanway et al, 2017, PASA 34, 58; Stanway and Eldridge, 2018, MNRAS, 479, 75). We use the BPASS data release version 2.2.1 (July 2018) of the model that includes binary stellar systems and that assumes a Chabrier IMF.

The SED templates are parametrized on metallicity (1e-5 - 0.04) and age (1 Myr - 100 Gyr), and scale with the initial mass of the SSP.

This class offers two user-configured options:

imf determines the IMF, more specifically the upper limit of the stellar mass range:

• Chabrier100: Chabrier IMF with stellar masses from 0.1 to 100 ${\mathrm{M}}_{\odot }$
• Chabrier300: Chabrier IMF with stellar masses from 0.1 to 300 ${\mathrm{M}}_{\odot }$

resolution determines the spectral resolution and the wavelength coverage:

• Original: the wavelength grid has a resolution of 1 Angstrom over the wavelength range between 1 Angstrom and 10 micron. This is the original resolution and wavelength coverage of the BPASS library, downloaded from the BPASS web site at https://bpass.auckland.ac.nz/9.html.
• Downsampled: the wavelength coverage is downsampled. Between 1 Angstrom and 0.6 micron, the original resolution of 1 Angstrom is retained. Between 0.6 and 10 micron the resolution is lowered to $R=711$ (2000 grid points). Finally, a flux point is added at 160 micron to ensure that the Rayleigh-Jeans tail of the SED is properly covered. This one additional point is using the slope between 8 and 10 micron.

When imported from a text column file, the parameters for this SED family must appear in the following order in the specified default units (unless these units are overridden by column header info):

$$M_{\mathrm{i}\mathrm{n}\mathrm{i}\mathrm{t}}({\mathrm{M}}_{\odot })Z(\mathrm{d}\mathrm{i}\mathrm{m}\mathrm{e}\mathrm{n}\mathrm{s}\mathrm{i}\mathrm{o}\mathrm{n}\mathrm{l}\mathrm{e}\mathrm{s}\mathrm{s})t(\mathrm{y}\mathrm{r})$$

IMPORTANT NOTE TO THE USER

Because of their substantial size, the resource files required by this class are contained in a separate, optional resource pack, which can be installed by running the downloadResources.sh shell script in the SKIRT git directory or can be obtained from the download page on the SKIRT web site.

Member Enumeration Documentation

IMF

enum class BpassSEDFamily::IMF : int

strong

The enumeration type indicating the IMF to use

Chabrier100 : "Chabrier IMF (0.1-100 Msun)" .

Chabrier300 : "Chabrier IMF (0.1-300 Msun)" .

Resolution

enum class BpassSEDFamily::Resolution : int

strong

The enumeration type indicating the wavelength resolution and spectral range

Original : "Original wavelength resolution and range" .

Downsampled : "Downsampled wavelength resolution and extended wavelength range" .

Constructor & Destructor Documentation

BpassSEDFamily() [1/2]

BpassSEDFamily::BpassSEDFamily ( )

inlineprotected

Default constructor for concrete Item subclass BpassSEDFamily : "a BPASS SED family for single stellar populations" .

BpassSEDFamily() [2/2]

BpassSEDFamily::BpassSEDFamily ( SimulationItem *  parent, IMF  imf, Resolution  resolution  )

explicit

This constructor can be invoked programmatically by classes that use a hard-coded SED family (as opposed to selected through the ski file). Before the constructor returns, the newly created object is hooked up as a child to the specified parent in the simulation hierarchy (so it will automatically be deleted), and its setup() function has been called.

Member Function Documentation

cdf()

double BpassSEDFamily::cdf ( Array &  lambdav, Array &  pv, Array &  Pv, const Range &  wavelengthRange, const Array &  parameters  ) const

overridevirtual

This function constructs both the normalized probability density function (pdf) and the corresponding normalized cumulative distribution function (cdf) for the SED with the specified parameters over the specified wavelength range. The function returns the normalization factor. The number and type of parameters must match the information returned by the parameterInfo() function; if not the behavior is undefined.

Implements SEDFamily.

imf()

BpassSEDFamily::imf ( ) const

inline

This function returns the value of the discoverable IMF enumeration property imf : "IMF" .

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

intrinsicWavelengthRange()

Range BpassSEDFamily::intrinsicWavelengthRange ( ) const

overridevirtual

This function returns the intrinsic wavelength range of the SED family. It retrieves this range from the underlying stored table.

Implements SEDFamily.

parameterInfo()

vector< SnapshotParameter > BpassSEDFamily::parameterInfo ( ) const

overridevirtual

This function returns the number and type of parameters used by this particular SED family as a list of SnapshotParameter objects. Each of these objects specifies unit information and a human-readable descripton for the parameter.

Implements SEDFamily.

resolution()

BpassSEDFamily::resolution ( ) const

inline

This function returns the value of the discoverable Resolution enumeration property resolution : "the wavelength resolution" .

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

setupSelfBefore()

void BpassSEDFamily::setupSelfBefore ( )

overrideprotectedvirtual

This function opens the appropriate resource file (in SKIRT stored table format).

Reimplemented from SimulationItem.

specificLuminosity()

double BpassSEDFamily::specificLuminosity ( double  wavelength, const Array &  parameters  ) const

overridevirtual

This function returns the specific luminosity $L_{\lambda }$ (i.e. radiative power per unit of wavelength) for the SED with the specified parameters at the specified wavelength, or zero if the wavelength is outside of the SED's intrinsic wavelength range. The number and type of parameters must match the information returned by the parameterInfo() function; if not the behavior is undefined.

Implements SEDFamily.

---

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

• BpassSEDFamily.hpp