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

#include <Cosmology.hpp>

Inheritance diagram for Cosmology:
Inheritance graph
[legend]

Public Member Functions

virtual double angularDiameterDistance () const =0
 
virtual double luminosityDistance () const =0
 
virtual double modelRedshift () const =0
 
virtual double relativeExpansionRate () 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

 Cosmology ()
 
- 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 = SimulationItem
 
using ItemType = Cosmology
 

Friends

class ItemRegistry
 

Detailed Description

An instance of a Cosmology subclass specifies the cosmology related parameters of the simulated model, including the redshift at which the model coordinate frame is assumed to reside, as well as the spatial geometry and expansion behavior of the universe.

Constructor & Destructor Documentation

◆ Cosmology()

Cosmology::Cosmology ( )
inlineprotected

Default constructor for abstract Item subclass Cosmology : "a set of cosmology parameters, including redshift" .

Member Function Documentation

◆ angularDiameterDistance()

virtual double Cosmology::angularDiameterDistance ( ) const
pure virtual

This function returns the angular-diameter distance \(d_\mathrm{A}(z)\), which converts a proper transverse separation \(\mathrm{d}l\) to the corresponding observed angular separation \(\mathrm{d}\psi\),

\[ \mathrm{d}\psi = \frac{\mathrm{d}l}{d_\mathrm{A}(z)}. \]

Implemented in FlatUniverseCosmology, and LocalUniverseCosmology.

◆ luminosityDistance()

virtual double Cosmology::luminosityDistance ( ) const
pure virtual

This function returns the luminosity distance, which converts a total luminosity \(L_\mathrm{tot}\) to the corresponding observed total flux \(F_\mathrm{tot}\),

\[ F_\mathrm{tot} = \frac{L_\mathrm{tot}}{4\pi\,d_\mathrm{L}^2(z)} \]

or a neutral-style monochromatic luminosity \(\lambda L_\lambda\) to the corresponding observed neutral-style flux,

\[ (1+z)\lambda \, F_\lambda[(1+z)\lambda] = \frac{\lambda L_\lambda[\lambda]}{4\pi\,d_\mathrm{L}^2(z)} \]

where \(\lambda\) is the emitted wavelength and \((1+z)\lambda\) is the observed wavelength.

Implemented in FlatUniverseCosmology, and LocalUniverseCosmology.

◆ modelRedshift()

virtual double Cosmology::modelRedshift ( ) const
pure virtual

This function returns the redshift at which the model resides, or zero if it resides in the Local Universe.

Implemented in FlatUniverseCosmology, and LocalUniverseCosmology.

◆ relativeExpansionRate()

virtual double Cosmology::relativeExpansionRate ( ) const
pure virtual

This function returns the relative expansion rate of the universe, \(\dot{a}/a\), where \(a\) is the dimensionless scale factor. The relative expansion rate has units of \(\mathrm{s}^{-1}\).

Implemented in FlatUniverseCosmology, and LocalUniverseCosmology.


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