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

#include <BlackBodySED.hpp>

Inheritance diagram for BlackBodySED:
Inheritance graph
[legend]

Public Member Functions

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
 
double temperature () const
 
virtual double specificLuminosity (double wavelength) const =0
 
virtual void specificLuminosityArray (Array &lambdav, Array &pv, const Range &wavelengthRange) const =0
 
- Public Member Functions inherited from SED
virtual double generateWavelength () const =0
 
virtual double integratedLuminosity (const Range &wavelengthRange) const =0
 
virtual Range intrinsicWavelengthRange () const =0
 
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 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

 BlackBodySED ()
 
 ~BlackBodySED ()
 
void setupSelfBefore () override
 
- Protected Member Functions inherited from ContSED
 ContSED ()
 
- Protected Member Functions inherited from SED
 SED ()
 
Randomrandom () const
 
void setupSelfBefore () override
 
- 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 = ContSED
 
using ItemType = BlackBodySED
 

Private Attributes

Array _lambdav
 
double _Ltot
 
PlanckFunction_planck
 
Array _pv
 
Array _Pv
 
double _temperature
 

Friends

class ItemRegistry
 

Detailed Description

BlackBodySED is a class that describes black-body spectral energy distributions, i.e. the emission spectra of perfect absorbers which are in thermal equilibrium. Such an SED is characterized by the temperature of the object, and its spectrum is the Planck spectrum.

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

Constructor & Destructor Documentation

◆ BlackBodySED()

BlackBodySED::BlackBodySED ( )
inlineprotected

Default constructor for concrete Item subclass BlackBodySED : "a black-body spectral energy distribution" .

◆ ~BlackBodySED()

BlackBodySED::~BlackBodySED ( )
protected

This function destructs the Planck function object.

Member Function Documentation

◆ generateWavelength()

double BlackBodySED::generateWavelength ( ) const
overridevirtual

This function draws a random wavelength from the normalized spectral energy distribution.

Implements SED.

◆ integratedLuminosity()

double BlackBodySED::integratedLuminosity ( const Range wavelengthRange) const
overridevirtual

This function returns the normalized integrated luminosity \(L\) (i.e. radiative power) over the specified wavelength range.

Implements SED.

◆ intrinsicWavelengthRange()

Range BlackBodySED::intrinsicWavelengthRange ( ) const
overridevirtual

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

Implements SED.

◆ setupSelfBefore()

void BlackBodySED::setupSelfBefore ( )
overrideprotectedvirtual

This function constructs a Planck function object corresponding to the user-configured temperature and sets up the cumulative distribution that will be used to sample random wavelengths.

Reimplemented from SimulationItem.

◆ specificLuminosity()

double BlackBodySED::specificLuminosity ( double  wavelength) const
overridevirtual

This function returns the normalized specific luminosity \(L_\lambda\) (i.e. radiative power per unit of wavelength) at the specified wavelength.

Implements ContSED.

◆ specificLuminosityArray()

void BlackBodySED::specificLuminosityArray ( Array lambdav,
Array pv,
const Range wavelengthRange 
) const
overridevirtual

This function returns the normalized specific luminosity \(L_\lambda\) (i.e. radiative power per unit of wavelength) at a number of wavelength points within the specified wavelength range.

Implements ContSED.

◆ temperature()

BlackBodySED::temperature ( ) const
inline

This function returns the value of the discoverable double property temperature : "the black body temperature" .

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

The minimum value for this property is "]0 K" .

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


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