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

#include <TemperatureWavelengthCellLibrary.hpp>

Inheritance diagram for TemperatureWavelengthCellLibrary:
Inheritance graph
[legend]

Public Member Functions

int numTemperatures () const
 
int numWavelengths () const
 
virtual vector< int > mapping (const Array &bv) const =0
 
virtual int numEntries () 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

 TemperatureWavelengthCellLibrary ()
 
vector< int > mapping (const Array &bv) const override
 
int numEntries () const override
 
- Protected Member Functions inherited from SpatialCellLibrary
 SpatialCellLibrary ()
 
- 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 = SpatialCellLibrary
 
using ItemType = TemperatureWavelengthCellLibrary
 

Private Attributes

int _numTemperatures
 
int _numWavelengths
 

Friends

class ItemRegistry
 

Detailed Description

The TemperatureWavelengthCellLibrary class provides a library scheme for grouping spatial cells based on the indicative dust temperature and the indicative dust wavelength of the stored radiation field in each cell. The library contains a two-dimensional table of entries corresponding to different values for each of these properties. The user can configure the number of bins in each of the two dimensions.

Note: the current implementation of this class takes into account only the dust media; media with other material types are ignored.

The indicative dust temperature for a cell is obtained by averaging the LTE equilibrium temperatures for the various dust mixes present in the cell. For a definition and more information about the indicative dust temperature, refer to the MediumSystem::indicativeDustTemperature() function.

The indicative dust wavelength for a cell \(m\) is defined as

\[ {\bar{\lambda}}_m = \frac{\int_0^\infty k_{m,\lambda}^{\text{abs}}\, J_{m,\lambda}\, \lambda\, {\text{d}}\lambda }{ \int_0^\infty k_{m,\lambda}^{\text{abs}}\, J_{m,\lambda}\, {\text{d}}\lambda} \]

where \(k_{m,\lambda}^{\text{abs}}\) is the dust absorption opacity in the cell,

\[ k_{m,\lambda}^{\text{abs}} = \sum_h \kappa_{m,h,\lambda}^{\text{abs}} \, \rho_{m,h}\]

with the sum running over dusty media only.

When an item of this type is used, the names provided by the conditional value expression "NonIdentitySpatialCellLibrary" are inserted into the name sets used for evaluating Boolean expressions.

Constructor & Destructor Documentation

◆ TemperatureWavelengthCellLibrary()

TemperatureWavelengthCellLibrary::TemperatureWavelengthCellLibrary ( )
inlineprotected

Default constructor for concrete Item subclass TemperatureWavelengthCellLibrary : "a library scheme for grouping spatial cells based on indicative temperature and wavelength" .

Member Function Documentation

◆ mapping()

vector< int > TemperatureWavelengthCellLibrary::mapping ( const Array bv) const
overrideprotectedvirtual

This function returns a vector nv with length \(N_{\text{cells}}\) that maps each cell index \(m\) to the corresponding library entry index \(n_m\). In this class the function loops over all spatial cells and calculates the indicative dust temperature and the indicative dust wavelength of the stored radiation field for each of them. Based on these values, a two-dimensional grid is established such that it fits all the measured values. The temperature grid points \({\bar{T}}_{(i)}\) are distributed linearly, i.e.

\[ {\bar{T}}_{(i)} = {\bar{T}}_{\text{min}} + \frac{i}{N_{\bar{T}}}\, ({\bar{T}}_{\text{max}} - {\bar{T}}_{\text{min}}) \qquad i=0,\ldots,N_{\bar{T}} \]

where \({\bar{T}}_{\text{min}}\) and \({\bar{T}}_{\text{max}}\) represent the smallest and largest values of the indicative dust temperature found among all spatial cells. The wavelength grid points have logarithmic distribution,

\[ {\bar{\lambda}}_{(j)} = {\bar{\lambda}}_{\text{min}} \left( \frac{ {\bar{\lambda}}_{\text{max}} }{ {\bar{\lambda}}_{\text{min}} } \right)^{j/N_{\bar{\lambda}}} \qquad j=0,\ldots,N_{\bar{\lambda}}. \]

The function then calculates for each cell \(m\) its library entry \(n \equiv (i,j)\).

Implements SpatialCellLibrary.

◆ numEntries()

int TemperatureWavelengthCellLibrary::numEntries ( ) const
overrideprotectedvirtual

This function returns the number of entries in the library. In this class the function returns the user-configured number of bins, i.e. the product of the number of temperature bins and the number of wavelength bins.

Implements SpatialCellLibrary.

◆ numTemperatures()

TemperatureWavelengthCellLibrary::numTemperatures ( ) const
inline

This function returns the value of the discoverable integer property numTemperatures : "the number of temperature bins" .

The minimum value for this property is "5" .

The maximum value for this property is "10000" .

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

◆ numWavelengths()

TemperatureWavelengthCellLibrary::numWavelengths ( ) const
inline

This function returns the value of the discoverable integer property numWavelengths : "the number of wavelength bins" .

The minimum value for this property is "5" .

The maximum value for this property is "10000" .

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


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