The SKIRT project
advanced radiative transfer for astrophysics
Public Types | Public Member Functions | Protected Member Functions | Private Types | Private Attributes | Friends | List of all members
ToddlersSEDFamily Class Reference

#include <ToddlersSEDFamily.hpp>

Inheritance diagram for ToddlersSEDFamily:
Inheritance graph
[legend]

Public Types

enum class  PAHFraction : int { High , Low }
 
enum class  Resolution : int { Low , High }
 

Public Member Functions

 ToddlersSEDFamily (SimulationItem *parent, PAHFraction pahfraction, Resolution resolution)
 
double cdf (Array &lambdav, Array &pv, Array &Pv, const Range &wavelengthRange, const Array &parameters) const override
 
Range intrinsicWavelengthRange () const override
 
PAHFraction pahfraction () const
 
vector< SnapshotParameterparameterInfo () 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< SnapshotParameterparameterInfo () 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 ItemgetItemProperty (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)
 
Itemoperator= (const Item &)=delete
 
Itemparent () 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

 ToddlersSEDFamily ()
 
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 = ToddlersSEDFamily
 

Private Attributes

PAHFraction _pahfraction
 
Resolution _resolution
 
StoredTable< 5 > _table
 

Friends

class ItemRegistry
 

Detailed Description

An instance of the ToddlersSEDFamily class represents the TODDLERS (Time evolution of Dust Diagnostics and Line Emission from Regions containing young Stars) family of star-forming region SEDs parameterized on age, metallicity, star formation efficiency, and cloud number density. This SED template library is described in detail by Kapoor et al. in the manuscript submitted to MNRAS on May 26, 2023. The spectra were generated using the Cloudy master branch commit with SHA 69c3fa5871da3262341910e37c6ed2e5fb76dd3c.

The SEDs in the TODDLERS library are tabulated over a wavelength range from \(0.01\) to \(3000~\mu\mathrm{m}\) and include both continuum and line emission. The low-resolution version of the library uses the default Cloudy output resolution of \(R= \lambda/\Delta\lambda = 300\) to represent both the line and continuum components as calculated by Cloudy, resulting in 3787 wavelength points. The high-resolution version includes a large subset of the emission lines (as detailed in the paper), represented using high-resolution Gaussian line profiles with \(R= \lambda/\Delta\lambda_\mathrm{G} = 5\times 10^4\), where \(\Delta\lambda_\mathrm{G}\) is the width of the \(4 \sigma\) truncated Gaussian. These line profiles are added to the default \(R=300\) resolution Cloudy continuum, resulting in a total of 9756 wavelength points with the overall spectral resolution structure shown below.

The TODDLERS parameter space spans 90 ages from 0.1-30 Myr, 5 metallicity values from 0.001-0.04, 7 star formation efficiencies from 0.01-0.15, and 9 cloud number densities from 10-2560 \(\mathrm{cm}^{-3}\). The PAH-to-dust fraction is a maximum value scaled by the neutral hydrogen abundance in component shells/clouds. Two maximum PAH fractions are available: High = 4.6%, Low = 1%.

Finally, the SEDs are scaled by the mass of the imported star-forming region particle. The scaling assumes a cloud mass function obeying a power law with slope -1.8, i.e., \(dN/dM \propto M^{-1.8}\) running from a cloud mass of \(10^5\) to \(10^{6.75}~\mathrm{M}_\odot\), sampled using 8 equi-logspaced cloud masses. Given the age range of the library, stellar particles younger than 30 Myr should be considered as star-forming region candidates, with their initial mass as the mass used for scaling.

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

\[ t\,(\mathrm{yr}) \quad Z\,(\mathrm{dimensionless}) \quad \mathrm{SFE}\,(\mathrm{dimensionless}) \quad n_\mathrm{cloud} (\mathrm{cm}^{-3}) \quad M\,(\mathrm{M}_\odot) \]

Member Enumeration Documentation

◆ PAHFraction

enum class ToddlersSEDFamily::PAHFraction : int
strong

The enumeration type indicating the maximum PAH-to-dust fraction.

High : "High PAH-to-dust fraction (4.6%)" .

Low : "Low PAH-to-dust fraction (1%)" .

◆ Resolution

enum class ToddlersSEDFamily::Resolution : int
strong

The enumeration type indicating the wavelength resolution.

Low : "Low wavelength resolution (continuum and lines at R=300)" .

High : "High wavelength resolution (continuum at R=300 and lines at R=5e4)" .

Constructor & Destructor Documentation

◆ ToddlersSEDFamily() [1/2]

ToddlersSEDFamily::ToddlersSEDFamily ( )
inlineprotected

Default constructor for concrete Item subclass ToddlersSEDFamily : "a Toddlers SED family for emission from star-forming regions" .

◆ ToddlersSEDFamily() [2/2]

ToddlersSEDFamily::ToddlersSEDFamily ( SimulationItem parent,
PAHFraction  pahfraction,
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 ToddlersSEDFamily::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.

◆ intrinsicWavelengthRange()

Range ToddlersSEDFamily::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.

◆ pahfraction()

ToddlersSEDFamily::pahfraction ( ) const
inline

This function returns the value of the discoverable PAHFraction enumeration property pahfraction : "the maximum PAH-to-dust fraction" .

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

◆ parameterInfo()

vector< SnapshotParameter > ToddlersSEDFamily::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 description for the parameter.

Implements SEDFamily.

◆ resolution()

ToddlersSEDFamily::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 ToddlersSEDFamily::setupSelfBefore ( )
overrideprotectedvirtual

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

Reimplemented from SimulationItem.

◆ specificLuminosity()

double ToddlersSEDFamily::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: