BpassSED Class Reference

#include <BpassSED.hpp>

Inheritance diagram for BpassSED:

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

Public Member Functions
double	age () const
IMF	imf () const
double	metallicity () const
Resolution	resolution () const
Public Member Functions inherited from FamilySED
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 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
	BpassSED ()
const SEDFamily *	getFamilyAndParameters (Array &parameters) override
Protected Member Functions inherited from FamilySED
	FamilySED ()
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 ()
Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType
using	ItemType

Private Attributes
double	_age
IMF	_imf
double	_metallicity
Resolution	_resolution

Friends
class	ItemRegistry

Detailed Description

BpassSED is a class that represents spectral energy distributions of simple stellar populations (SSPs), parameterized on metallicity and age according to the BPASS model that includes binary stellar systems and that assumes a Chabrier or Kroupa IMF with upper mass limits of 100 or 300 solar masses. See the BpassSEDFamily class for more information.

Member Enumeration Documentation

IMF

enum class BpassSED::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)".

Kroupa100 : "Kroupa IMF (0.1-100 Msun)".

Kroupa300 : "Kroupa IMF (0.1-300 Msun)".

Resolution

enum class BpassSED::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

BpassSED()

BpassSED::BpassSED ( )

inlineprotected

Default constructor for concrete Item subclass BpassSED: "a BPASS single stellar population SED".

Member Function Documentation

age()

double BpassSED::age ( ) const

inline

This function returns the value of the discoverable double property age: "the age of the SSP".

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

The minimum value for this property is "[1 Myr".

The maximum value for this property is "100 Gyr]".

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

getFamilyAndParameters()

const SEDFamily * BpassSED::getFamilyAndParameters ( Array & parameters )

overrideprotectedvirtual

This function returns a newly created SEDFamily object (which is already hooked into the simulation item hierachy so it will be automatically deleted) and stores the parameters for the specific SED configured by the user in the specified array.

Implements FamilySED.

imf()

IMF BpassSED::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 "Chabrier300".

metallicity()

double BpassSED::metallicity ( ) const

inline

This function returns the value of the discoverable double property metallicity: "the metallicity of the SSP".

The minimum value for this property is "[1e-5".

The maximum value for this property is "0.04]".

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

resolution()

Resolution BpassSED::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".

---

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

• BpassSED.hpp