.. _physics-stellarTracks:

Stellar Tracks
==============

Class providing models of stellar tracks in luminosity and effective temperature as a function of initial mass, metallicity, and age.

**Default implementation:** ``stellarTracksFile``

Methods
-------

``luminosity`` → ``double precision``
   Returns the bolometric luminosity of a star of given ``initialMass``, ``metallicity`` and ``age``.

   * ``double precision, intent(in ) :: initialMass, metallicity, age``

``temperatureEffective`` → ``double precision``
   Returns the effective temperature of a star of given ``initialMass``, ``metallicity`` and ``age``.

   * ``double precision, intent(in ) :: initialMass, metallicity, age``

.. _physics-stellarTracksFile:

``stellarTracksFile``
---------------------

A stellar tracks class in which luminosities and effective temperatures of stars are computed from a tabulated set of stellar tracks, read from file and interpolated. The file containing the tracks to use is specified via the ``stellarTracksFile`` parameter. The file specified must be an HDF5 file with the following structure:

.. code-block:: none

    stellarTracksFile
     |
     +-> metallicity1
     |    |
     |    +-> metallicity
     |    |
     |    +-> mass1
     |    |    |
     |    |    +-> mass
     |    |    |
     |    |    +-> age
     |    |    |
     |    |    +-> luminosity
     |    |    |
     |    |    +-> effectiveTemperature
     |    |
     |    x-> massN
     |
     x-> metallicityN

Each ``metallicityN`` group tabulates tracks for a given metallicity (the value of which is stored in the ``metallicity`` dataset within each group), and may contain an arbitrary number of ``massN`` groups. Each ``massN`` group should contain a track for a star of some mass (the value of which is given in the ``mass`` dataset). Within each track three datasets specify the ``age`` (in Gyr), ``luminosity`` (in :math:`L_\odot`) and ``effectiveTemperature`` (in Kelvin) along the track.

**(Default implementation)**

**Methods**

* ``readFile`` — Read the named power spectrum file.

**Parameters**

* ``[forceZeroMetallicity]`` (default ``.false.``) — Force the use of zero metallicity (or lowest metallicity available) for all stellar populations.
* ``[fileName]`` — The path to the HDF5 file containing the tabulated stellar population spectra, with datasets for ages (Gyr), metallicities (log Solar), wavelengths (\AA), and spectra (:math:`L_\odot\,\mathrm{Hz}^{-1}`); see the ``scripts/ssps`` folder for conversion scripts.
* ``[fileName]`` — The name of the file which contains fit coefficients for the time per tree fitting function.
* ``[fileName]`` (default ``inputPath(pathTypeDataStatic)//'stellarAstrophysics/stellarPropertiesCompilationStandard.xml'``) — The name of the XML file from which to read stellar properties (ejected masses, yields, etc.).
* ``[fileName]`` (default ``inputPath(pathTypeDataStatic)//'stellarAstrophysics/Stellar_Tracks_Padova.hdf5'``) — The name of the HDF5 file from which to read stellar tracks.
* ``[fileName]`` — The name of the file from which to read intergalactic medium state data.
* ``[fileName]`` — The name of the file from which to read intergalactic background light properties.
* ``[fileName]`` — The name of a file from which to read tabulated spectra of accretion disks.
* ``[fileName]`` — The name of the file from which to read a tabulated transfer function.