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

#include <BlackBodySEDFamily.hpp>

Inheritance diagram for BlackBodySEDFamily:
Inheritance graph
[legend]

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

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

Friends

class ItemRegistry
 

Detailed Description

An instance of the BlackBodySEDFamily class represents a family of black body SEDs, i.e. emission spectra of perfect absorbers in thermal equilibrium. The SED family is parameterized on the temperature \(T\) of the black body (defining the form of the spectrum) and the radius \(R\) of the black body (determining the absolute luminosity scale). As a function of these two parameters, the specific luminosity is given by

\[ L_\lambda(\lambda,R,T) = 4\pi\,R^2\;\pi\;B_\lambda(\lambda,T) \]

where \(B_\lambda(\lambda,T)\) is the Planck function.

Whenever a tabular form of a black body SED is requested, this class uses a spectral resolution of \(R\triangleq\lambda/\Delta\lambda\geq 1000\) (see PlanckFunction::cdf()).

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

\[ R\,(\mathrm{km}) \quad T\,(\mathrm{K}) \]

Constructor & Destructor Documentation

◆ BlackBodySEDFamily()

BlackBodySEDFamily::BlackBodySEDFamily ( )
inlineprotected

Default constructor for concrete Item subclass BlackBodySEDFamily : "a black body SED family" .

Member Function Documentation

◆ cdf()

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

This function returns the intrinsic wavelength range of the SED family. For the BlackBodySEDFamily, the intrinsic range is unlimited, so this function returns a range including all representable positive floating point values.

Implements SEDFamily.

◆ parameterInfo()

vector< SnapshotParameter > BlackBodySEDFamily::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 BlackBodySEDFamily::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: