petitRADTRANS.chemistry.clouds#

This file allows the calculation of equilibrium cloud abundances and base pressures

Attributes#

Functions#

__get_species_molar_mass(species)

setup_clouds(pressures, parameters, cloud_species)

This function provides the set of cloud parameters used in

setup_simple_clouds_hazes(parameters)

Setup clouds for transmission spectrum

cloud_dict(parameters, parameter_name, cloud_species)

This is a generic method to create a dictionary of

get_fseds(parameters, cloud_species)

This function checks to see if the fsed values are input on a per-cloud basis

get_bhans(parameters, cloud_species[, shape])

This function checks to see if the bhans values are input on a per-cloud basis

return_cloud_mass_fraction(name, metallicity, co_ratio)

simple_cdf(name, press, temp, metallicity, co_ratio[, mmw])

simple_cdf_free(name, press, temp, metallicity, mfrac)

return_x_fe(metallicity, co_ratio)

return_x_mgsio3(metallicity, co_ratio)

return_x_mg2sio4(metallicity, co_ratio)

return_x_mgfesio4(metallicity, co_ratio)

return_x_sio(metallicity, co_ratio)

return_x_na2s(metallicity, co_ratio)

return_x_kcl(metallicity, co_ratio)

return_t_cond_fe(metallicity, co_ratio[, mmw])

return_t_cond_fe_l(metallicity, co_ratio[, mmw])

return_t_cond_fe_comb(metallicity, co_ratio[, mmw])

return_t_cond_fe_free(x_fe[, mmw])

return_t_cond_fe_l_free(x_fe[, mmw])

return_t_cond_fe_comb_free(x_fe[, mmw])

return_t_cond_mgsio3(metallicity, co_ratio[, mmw])

return_t_cond_mg2sio4(metallicity, co_ratio[, mmw])

return_t_cond_mgsio3_free(x_mgsio3[, mmw])

return_t_cond_mg2sio4_free(x_mg2sio4[, mmw])

return_t_cond_na2s(metallicity, co_ratio[, mmw])

return_t_cond_na2s_free(x_na2s[, mmw])

return_t_cond_kcl(metallicity, co_ratio[, mmw])

return_t_cond_kcl_free(x_kcl[, mmw])

simple_cdf_fe(press, temp, metallicity, co_ratio[, mmw])

simple_cdf_fe_free(press, temp, x_fe[, mmw])

simple_cdf_mgsio3(press, temp, metallicity, co_ratio)

simple_cdf_mgsio3_free(press, temp, x_mgsio3[, mmw])

simple_cdf_mg2sio4(press, temp, metallicity, co_ratio)

simple_cdf_mg2sio4_free(press, temp, x_mg2sio4[, mmw])

simple_cdf_na2s(press, temp, metallicity, co_ratio[, mmw])

simple_cdf_na2s_free(press, temp, x_na2s[, mmw])

simple_cdf_kcl(press, temp, metallicity, co_ratio[, mmw])

simple_cdf_kcl_free(press, temp, x_kcl[, mmw])

Module Contents#

petitRADTRANS.chemistry.clouds.__metals = ['C', 'N', 'O', 'Na', 'Mg', 'Al', 'Si', 'P', 'S', 'Cl', 'K', 'Ca', 'Ti', 'V', 'Fe', 'Ni']#
petitRADTRANS.chemistry.clouds.__elemental_abundances#
petitRADTRANS.chemistry.clouds.__molar_masses#
petitRADTRANS.chemistry.clouds.__get_species_molar_mass(species)#
petitRADTRANS.chemistry.clouds.setup_clouds(pressures, parameters, cloud_species)#

This function provides the set of cloud parameters used in petitRADTRANS. This will be some combination of atmospheric parameters (fsed and Kzz), distribution descriptions (log normal or hansen) and the cloud particle radius. Fsed and the particle radii can be provided on a per-cloud basis.

Args:
pressuresnp.ndarray

The pressure array used to provide the atmospheric grid

parametersdict
The dictionary of parameters passed to the model function. Should contain:
  • fsed : sedimentation parameter - can be unique to each cloud type

One of:
  • sigma_lnorm : Width of cloud particle size distribution (log normal)

  • b_hans : Width of cloud particle size distribution (hansen)

One of:
  • log_cloud_radius_* : Central particle radius (typically computed with fsed and Kzz)

  • log_kzz : Vertical mixing parameter

cloud_specieslist

A list of the names of each of the cloud species used in the atmosphere.

Returns:
sigma_lnormfloat, None

The width of a log normal particle size distribution.

fsedsdict, None

The sedimentation fraction for each cloud species in the atmosphere.

kzznp.ndarray, None

The vertical mixing parameter.

b_hansfloat, None

The width of a hansen particle size distribution.

radiidict, None

The central radius of the particle size distribution.

distributionstring

Either “lognormal” or “hansen” - tells pRT which distribution to use.

petitRADTRANS.chemistry.clouds.setup_simple_clouds_hazes(parameters)#

Setup clouds for transmission spectrum

Args:

parameters (dict): dictionary of atmospheric parameters

petitRADTRANS.chemistry.clouds.cloud_dict(parameters, parameter_name, cloud_species, shape=0)#

This is a generic method to create a dictionary of parameters values for a given cloud parameterization, testing if the parameter should be filled on a per-species basis or if each cloud species should have the same value.

petitRADTRANS.chemistry.clouds.get_fseds(parameters, cloud_species)#

This function checks to see if the fsed values are input on a per-cloud basis or only as a single value, and returns the dictionary providing the fsed values for each cloud, or None, if no cloud is used.

petitRADTRANS.chemistry.clouds.get_bhans(parameters, cloud_species, shape=0)#

This function checks to see if the bhans values are input on a per-cloud basis or only as a single value, and returns the dictionary providing the fsed values for each cloud, or None, if no cloud is used.

petitRADTRANS.chemistry.clouds.return_cloud_mass_fraction(name, metallicity, co_ratio)#
petitRADTRANS.chemistry.clouds.simple_cdf(name, press, temp, metallicity, co_ratio, mmw=2.33)#
petitRADTRANS.chemistry.clouds.simple_cdf_free(name, press, temp, metallicity, mfrac, mmw=2.33)#
petitRADTRANS.chemistry.clouds.return_x_fe(metallicity, co_ratio)#
petitRADTRANS.chemistry.clouds.return_x_mgsio3(metallicity, co_ratio)#
petitRADTRANS.chemistry.clouds.return_x_mg2sio4(metallicity, co_ratio)#
petitRADTRANS.chemistry.clouds.return_x_mgfesio4(metallicity, co_ratio)#
petitRADTRANS.chemistry.clouds.return_x_sio(metallicity, co_ratio)#
petitRADTRANS.chemistry.clouds.return_x_na2s(metallicity, co_ratio)#
petitRADTRANS.chemistry.clouds.return_x_kcl(metallicity, co_ratio)#
petitRADTRANS.chemistry.clouds.return_t_cond_fe(metallicity, co_ratio, mmw=2.33)#
petitRADTRANS.chemistry.clouds.return_t_cond_fe_l(metallicity, co_ratio, mmw=2.33)#
petitRADTRANS.chemistry.clouds.return_t_cond_fe_comb(metallicity, co_ratio, mmw=2.33)#
petitRADTRANS.chemistry.clouds.return_t_cond_fe_free(x_fe, mmw=2.33)#
petitRADTRANS.chemistry.clouds.return_t_cond_fe_l_free(x_fe, mmw=2.33)#
petitRADTRANS.chemistry.clouds.return_t_cond_fe_comb_free(x_fe, mmw=2.33)#
petitRADTRANS.chemistry.clouds.return_t_cond_mgsio3(metallicity, co_ratio, mmw=2.33)#
petitRADTRANS.chemistry.clouds.return_t_cond_mg2sio4(metallicity, co_ratio, mmw=2.33)#
petitRADTRANS.chemistry.clouds.return_t_cond_mgsio3_free(x_mgsio3, mmw=2.33)#
petitRADTRANS.chemistry.clouds.return_t_cond_mg2sio4_free(x_mg2sio4, mmw=2.33)#
petitRADTRANS.chemistry.clouds.return_t_cond_na2s(metallicity, co_ratio, mmw=2.33)#
petitRADTRANS.chemistry.clouds.return_t_cond_na2s_free(x_na2s, mmw=2.33)#
petitRADTRANS.chemistry.clouds.return_t_cond_kcl(metallicity, co_ratio, mmw=2.33)#
petitRADTRANS.chemistry.clouds.return_t_cond_kcl_free(x_kcl, mmw=2.33)#
petitRADTRANS.chemistry.clouds.simple_cdf_fe(press, temp, metallicity, co_ratio, mmw=2.33)#
petitRADTRANS.chemistry.clouds.simple_cdf_fe_free(press, temp, x_fe, mmw=2.33)#
petitRADTRANS.chemistry.clouds.simple_cdf_mgsio3(press, temp, metallicity, co_ratio, mmw=2.33)#
petitRADTRANS.chemistry.clouds.simple_cdf_mgsio3_free(press, temp, x_mgsio3, mmw=2.33)#
petitRADTRANS.chemistry.clouds.simple_cdf_mg2sio4(press, temp, metallicity, co_ratio, mmw=2.33)#
petitRADTRANS.chemistry.clouds.simple_cdf_mg2sio4_free(press, temp, x_mg2sio4, mmw=2.33)#
petitRADTRANS.chemistry.clouds.simple_cdf_na2s(press, temp, metallicity, co_ratio, mmw=2.33)#
petitRADTRANS.chemistry.clouds.simple_cdf_na2s_free(press, temp, x_na2s, mmw=2.33)#
petitRADTRANS.chemistry.clouds.simple_cdf_kcl(press, temp, metallicity, co_ratio, mmw=2.33)#
petitRADTRANS.chemistry.clouds.simple_cdf_kcl_free(press, temp, x_kcl, mmw=2.33)#