The SKIRT project
advanced radiative transfer for astrophysics
LyaGaussianSEDFamily Class Reference

#include <LyaGaussianSEDFamily.hpp>

Inheritance diagram for LyaGaussianSEDFamily:

Public Member Functions

double cdf (Array &lambdav, Array &pv, Array &Pv, const Range &wavelengthRange, const Array &parameters) const override
Range intrinsicWavelengthRange () const override
vector< SnapshotParameterparameterInfo () const override
double specificLuminosity (double wavelength, const Array &parameters) const override
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

 LyaGaussianSEDFamily ()
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
using ItemType

Friends

class ItemRegistry

Detailed Description

An instance of the LyaGaussianSEDFamily class represents a family of Gaussian spectra around the central Lyman-alpha wavelength \(\lambda_\alpha\), reflecting the thermal sub-grid motion in the source. The SED family is parameterized on the bolometric Lyman-alpha line luminosity \(L_\alpha\) and the spectral dispersion \(s\) in velocity units. Using the photon velocity shift

\[ v = \frac{\lambda - \lambda_\alpha} {\lambda_\alpha} \,c \]

as the spectral variable, the spectrum can be written as (see also the LyaGaussianSED class):

\[ L_v(v) = \frac{L_\alpha}{s\,\sqrt{2\pi}} \,\exp\left( -\frac{v^2}{2s^2} \right). \]

The intrinsic range for the complete SED family is taken to be approximately \(\pm 9s\) around the center for a dispersion of \(s=1000\,\mathrm{km/s}\). This results in a range of \(1179 \text{\AA} \le \lambda \le 1253 \text{\AA}\). The source wavelength range configured by the user must fully contain this intrinsic wavelength range.

Whenever a tabular form of a Gaussian SED is requested, this class uses 100 wavelength points per dispersion unit on a regular linear grid.

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

\[ L_\alpha\,(\mathrm{W}) \quad s\,(\mathrm{km/s}) \]

This item type is displayed only if the Boolean expression "Lya|Level3" evaluates to true after replacing the names by true or false depending on their presence.

Constructor & Destructor Documentation

◆ LyaGaussianSEDFamily()

LyaGaussianSEDFamily::LyaGaussianSEDFamily ( )
inlineprotected

Default constructor for concrete Item subclass LyaGaussianSEDFamily: "a family of Gaussian spectra around the central Lyman-alpha wavelength".

Member Function Documentation

◆ cdf()

double LyaGaussianSEDFamily::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 LyaGaussianSEDFamily::intrinsicWavelengthRange ( ) const
overridevirtual

This function returns the intrinsic wavelength range of the SED family. For the LyaGaussianSEDFamily, the intrinsic range is determined as decribed in the class header.

Implements SEDFamily.

◆ parameterInfo()

vector< SnapshotParameter > LyaGaussianSEDFamily::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.

◆ specificLuminosity()

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