#include <BruzualCharlotSEDFamily.hpp>

Inheritance diagram for BruzualCharlotSEDFamily:

[legend]

Public Types
enum class	IMF : int { Chabrier , Salpeter }

enum class	Resolution : int { Low , High }

Public Member Functions
	BruzualCharlotSEDFamily (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
	BruzualCharlotSEDFamily ()

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 = BruzualCharlotSEDFamily

Private Attributes
IMF	_imf

Resolution	_resolution

StoredTable< 3 >	_table

Friends
class	ItemRegistry

Detailed Description

An instance of the BruzualCharlotSEDFamily class represents the family of Bruzual & Charlot 2003 SEDs for single stellar populations (SSPs), parameterized on metallicity and age and scaled by the initial mass of the SSP (Bruzual & Charlot 2003, RAS 344, 1000-1026). We use the original 2003 Padova1994/Chabrier and Padova1994/Salpeter models, the two recommended models. In other words, the SED family is available for two assumed initial mass functions (Chabrier and Salpeter). Each of those families can be loaded in two wavelength resolution versions, with respectively 1221 and 6900 wavelength points over a wavelength range from 0.009 $μ m$ to 160 $μ m$ . The spectral resolution for each version is shown in the figure below. The low-resolution version uses less resources and is sufficient for most purposes. However, if the model under study zooms in on narrow wavelength ranges in the optical regime, the high-resolution version may be preferable.

The data were downloaded from http://www.bruzual.org/~gbruzual/bc03/ and converted to SKIRT stored table format for inclusion as a resource file. The stored table is opened during setup, and it is subsequently interpolated to the desired parameters and wavelength grid when needed.

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_{i n i t} (M_{⊙}) Z (d i m e n s i o n l e s s) t (y r)$

Member Enumeration Documentation

◆ IMF

enum class BruzualCharlotSEDFamily::IMF : int

strong

The enumeration type indicating the assumed initial mass function (IMF).

Chabrier : "Chabrier IMF" .

Salpeter : "Salpeter IMF" .

◆ Resolution

enum class BruzualCharlotSEDFamily::Resolution : int

strong

The enumeration type indicating the wavelength resolution.

Low : "Low wavelength resolution (1221 points)" .

High : "High wavelength resolution (6900 points)" .

Constructor & Destructor Documentation

◆ BruzualCharlotSEDFamily() [1/2]

BruzualCharlotSEDFamily::BruzualCharlotSEDFamily ( )

inlineprotected

Default constructor for concrete Item subclass BruzualCharlotSEDFamily : "a Bruzual-Charlot SED family for single stellar populations" .

◆ BruzualCharlotSEDFamily() [2/2]

BruzualCharlotSEDFamily::BruzualCharlotSEDFamily	(	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 BruzualCharlotSEDFamily::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()

BruzualCharlotSEDFamily::imf ( ) const

inline

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

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

◆ intrinsicWavelengthRange()

Range BruzualCharlotSEDFamily::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 > BruzualCharlotSEDFamily::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()

BruzualCharlotSEDFamily::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 "Low" .

◆ setupSelfBefore()

void BruzualCharlotSEDFamily::setupSelfBefore ( )

overrideprotectedvirtual

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

Reimplemented from SimulationItem.

◆ specificLuminosity()

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

overridevirtual

This function returns the specific luminosity $L_{λ}$ (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:

BruzualCharlotSEDFamily.hpp

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ IMF

◆ Resolution

Constructor & Destructor Documentation

◆ BruzualCharlotSEDFamily() [1/2]

◆ BruzualCharlotSEDFamily() [2/2]

Member Function Documentation

◆ cdf()

◆ imf()

◆ intrinsicWavelengthRange()

◆ parameterInfo()

◆ resolution()

◆ setupSelfBefore()

◆ specificLuminosity()