API Reference

Mbol(logL::Number, solmbol::Number=4.74)

Returns the bolometric magnitude corresponding to the provided logarithmic bolometric luminosity logL which is provided in units of solar luminosities (e.g., logL = log10(L / L⊙)). This is given by Mbol⊙ - 2.5 * logL; the zeropoint of bolometric magnitude scale is defined by the solar bolometric magnitude, which you can specify as the second argument. The default (4.74) was recommended by IAU Resolution B2.

logL(Mbol::Number, solmbol::Number=4.74)

Returns the logarithmic bolometric luminosity in units of solar luminosities (e.g., logL = log10(L / L⊙)) corresponding to the provided bolometric magnitude. This is given by (Mbol⊙ - Mbol) / 2.5; the zeropoint of bolometric magnitude scale is defined by the solar bolometric magnitude, which you can specify as the second argument. The default (4.74) was recommended by IAU Resolution B2.

radius(Teff::Number, logL::Number)

Returns the radius of a star in units of solar radii given its effective temperature Teff in Kelvin and the logarithm of its luminosity in units of solar luminosities (e.g., logL = log10(L / L⊙)).

Assumes solar properties following IAU 2015 Resolution B3.

julia> isapprox(BolometricCorrections.radius(5772, 0.0), 1.0; rtol=0.001) # For solar Teff and logL, radius ≈ 1
true

surface_gravity(M, R)

Returns the surface gravity of a star in cgs units cm / s^2 given its mass in solar masses and radius in solar radii.

Assumes solar properties following IAU 2015 Resolution B3.

julia> isapprox(BolometricCorrections.surface_gravity(1, 1), 27420; rtol=0.001) # For solar M and R, g ≈ 27430 cm / s^2
true

AbstractBCGrid{T <: Real} is the abstract supertype for all bolometric correction grids. T is the data type to use internally and is returned by eltype. Generally, concrete subtypes should be callable with population properties (e.g., metallicity, reddening, etc.) to interpolate the full grid to these properties, returning a concrete subtype of BolometricCorrections.AbstractBCTable. As different grids will have different population properties available (e.g., some support different α-element abundances in addition to total metallicity), the call signature to interpolate the grid is specific for each concrete subtype, which include

• MISTBCGrid
• PHOENIXYBCGrid
• ATLAS9YBCGrid

gridname(::Type{<:AbstractBCGrid})

Returns a human-readable String identifier for the provided grid; should be provided for all grid types.

gridname(grid::AbstractBCGrid) = gridname(typeof(grid))

Generic method provided to return the gridname for instances of concrete subtypes of AbstractBCGrid.

filternames(grid::AbstractBCGrid)

Returns a Vector{String} containing the names of the photometric filters contained in the provided bolometric correction grid. See columnnames if you also want to retrieve names of dependent variable columns.

extrema(grid::AbstractBCGrid)

Returns a NamedTuple containing the bounds of the dependent variables in the bolometric correction grids (e.g., [Fe/H], Av).

Table(grid::AbstractBCGrid)

Returns a TypedTables.Table containing the data underlying the bolometric correction grid.

AbstractBCTable{T <: Real} is the abstract supertype for all bolometric correction tables with extraneous dependent variables (e.g., [Fe/H], Av) fixed – typically only dependent variables such as logg and Teff should remain. T is the data type to use internally and is returned by eltype. Most AbstractBCTables should be callable with scalar (Teff, logg) arguments, returning the interpolated BCs at those values. Some tables may require additional arguments args... such as the mass loss rate Mdot for the WM-basic tables.

(table::AbstractTable)(Teff::Number, logg::Number, args...)

Tables may also be called with a single argument (usually a NamedTuple) which has the necessary values stored as – for example, arg = (Teff = 2750, logg = 2.5) could be passed directly to a AbstractBCTable without splatting.

(table::AbstractTable)(arg)

We additionally support automatic broadcasting over input arrays – the following method formats the result into a stacked matrix or a TypedTables.Table, if that is the first argument. The creation of the table has a roughly fixed runtime overhead cost of 3–5 μs to perform the type conversion. Examples of this usage are provided in the docstrings for each subtype of AbstractBCTable (see, for example, MISTBCTable).

(table::AbstractBCTable)([::Type{TypedTables.Table},]
                         args::Vararg{AbstractArray{<:Real}, N}) where {N}

gridname(::Type{<:AbstractBCTable})

Returns a human-readable String identifier of the grid from which the provided table was derived. This should be provided for all table types.

gridname(table::AbstractBCTable) = gridname(typeof(table))

Generic method provided to return the gridname for instances of concrete subtypes of AbstractBCTable.

filternames(table::AbstractBCGrid)

Returns a NTuple{N, Symbol} containing the names of the photometric filters contained in the provided bolometric correction table. See columnnames if you also want to retrieve names of dependent variable columns.

extrema(table::AbstractBCTable)

Returns a NamedTuple containing the bounds of the dependent variables in the bolometric correction table (e.g., logg, Teff).

Table(table::AbstractBCTable)

Returns a TypedTables.Table containing the data underlying the bolometric correction table.

AbstractZeropoints is the abstract supertype for information regarding the photometric zeropoints assumed for a particular grid of bolometric corrections and supports conversion between systems (AB, Vega, ST).

zeropoints(grid::AbstractBCGrid)
zeropoints(table::AbstractBCTable)

Return the correct concrete instance of AbstractZeropoints for the type of grid or table.

julia> zeropoints(MISTBCGrid("JWST")) isa BolometricCorrections.MIST.MISTZeropoints
true

filternames(zpt::AbstractZeropoints)

Returns a Vector{String} containing the names of the photometric filters in the table of zeropoints.

vegamags(zpt::AbstractZeropoints, filter, mags)

Uses the photometric zeropoint information in zpt to convert magnitudes mags in the given filter to the Vega magnitude system.

abmags(zpt::AbstractZeropoints, filter, mags)

Uses the photometric zeropoint information in zpt to convert magnitudes mags in the given filter to the AB magnitude system.

stmags(zpt::AbstractZeropoints, filter, mags)

Uses the photometric zeropoint information in zpt to convert magnitudes mags in the given filter to the ST magnitude system.

Mbol(zpt::AbstractZeropoints)

Returns the absolute bolometric magnitude of the Sun assumed in the definition of the BC grid.

Lbol(zpt::AbstractZeropoints)

Returns the bolometric luminosity [erg / s] of the Sun assumed in the definition of the BC grid.

AbstractChemicalMixture is the abstract supertype for information regarding the chemical mixtures available or assumed for a particular grid of bolometric corrections. It also supports evaluation and conversion between different chemical conventions (i.e., conversion between metal mass fraction Z and logarithmic metallicity [M/H]).

chemistry(mix::AbstractBCTable)
chemistry(mix::AbstractBCGrid)

Returns the correct concrete instance of AbstractChemicalMixture for the provided bolometric correction grid or table. This provides a convenient programmatic way to obtain this chemical information.

julia> grid = MISTBCGrid("JWST");

julia> chemistry(grid)
BolometricCorrections.MIST.MISTChemistry()

julia> table = grid(-1.5, 0.03);

julia> chemistry(table)
BolometricCorrections.MIST.MISTChemistry()

X(mix::AbstractChemicalMixture)

Returns the protostellar solar hydrogen mass fraction assumed in the provided chemical mixture.

X_phot(mix::AbstractChemicalMixture)

Returns the photospheric solar hydrogen mass fraction assumed in the provided chemical mixture.

Y_p(mix::AbstractChemicalMixture)

Returns the primordial helium mass fraction assumed in the provided chemical mixture.

Y(mix::AbstractChemicalMixture)

Returns the protostellar solar helium mass fraction. May use [Z] internally.

Y_phot(mix::AbstractChemicalMixture)

Returns the photospheric solar helium mass fraction. May use [Z_phot] internally.

Z(mix::AbstractChemicalMixture)

Returns the protostellar solar metal mass fraction assumed in the provided chemical mixture.

Z_phot(mix::AbstractChemicalMixture)

Returns the photospheric solar metal mass fraction assumed in the provided chemical mixture.

X(mix::AbstractChemicalMixture, Z)

Returns protostellar hydrogen mass fraction given the protostellar metal mass Z and the provided chemical mixture. Generic method returns 1 - Y(mix, Z) - Z.

Y(mix::AbstractChemicalMixture, Z)

Returns the protostellar helium mass fraction given the protostellar metal mass fraction Z. Only valid for grids in which $Y$ is a function of $Z$.

Z(mix::AbstractChemicalMixture, MH)

Returns the protostellar metal mass fraction given the logarithmic metallicity MH and the provided chemical mixture.

MH(mix::AbstractChemicalMixture, Z)

Returns the protostellar logarithmic metallicity [M/H] = log10(Z/X) - log10(Z⊙/X⊙) given the metal mass fraction Z and the provided chemical mixture.