Coupling
Classes
Class defining objects to run one interior-atmosphere coupled model. |
Module Contents
- class Coupling.coupling(name_grid=None, pow_law_formass=0.32, j_max=30)
- Class defining objects to run one interior-atmosphere coupled model.
When this class is defined, it automatically initialises interior and atmosphere models and defines required constants.
- Args:
- path_to_file:
path to input data directory
- pow_law_formass:
power exponent to estimate the initial guess of the planet radius in the interior model. Default is 0.32. Increase if planet is very massive (greater than 5 Jupiter masses aprox). Decrease if core mass fraction is very low (< 0.03 approx.) and/or planet is low mass (15-20 Earth masses approx.)
- pow_law_formass = 0.32
- path_to_file
- j_max = 30
- myplanet
- Mearth = 5.972e+24
- main(M_P, x_core, Teq, Tint, CO=0.55, log_FeH=0.0, Zenv=0.03, FeH_flag=True, Tguess=2000.0, Rguess=11.2, tolerance=0.001, guillot=False, P_surf=1000.0, kappa_IR=0.01, gamma=0.4)
- Function that runs coupled interior-atmosphere model
## Output parameters of atmosphere class ## To access the output parameters of the atmosphere class, such as the atmospheric thickness or profiles, add “myatmmodel.” to the name of the parameter. Example: to get the pressure and temperature atm. profiles, get the attributes from the coupling class named “myatmmodel.P_ode” and “myatmmodel.T_ode”. To see the list of parameters from the atmosphere class, see the docstring of function “calc_thickness” ## Output parameters of interior class ## To access the output parameters of the interior class, such as the interior profiles, add “myplanet.” to the name of the parameter. Example: to get the gravity and radius interior profiles, get the attributes from the coupling class named “myplanet.g” and “myplanet.r”. To see the list of parameters from the interior class, see the docstring of function “calc_radius”
- Args:
- M_P:
Planet mass in Earth masses
- x_core:
Core mass fraction
- Teq:
Equilibrium temperature in K (at zero Bond albedo)
- Tint:
Internal temperature in K
- CO (optional):
C-to-O ratio. Default value is 0.55 (solar)
- FeH_flag (optional):
equals True if the amount of metals is specified as log10(metallicity) in x solar units. If specified as metal mass fraction, set FeH_flag = False. In the former case, the metal mass fraction profile is extracted from easychem data (calculated with calc_interior_mass_fraction). In the latter, it is set constant to Zenv, and converted to log10(metallicity) with Fortney+13 relation (appendix A1) to interpolate the PT profiles from atmospheric grid
- Zenv (optional):
atmospheric metal mass fraction (for FeH_flag = False). Default value is 0.03.
- log_FeH:
log10(metallicity) in x solar units (for FeH_flag = True). Default value is zero (solar composition)
- Tguess (optional):
Initial guess for the surface temperature in K. Default is 2000 K.
- Rguess (optional):
Initial guess for planet radius in Earth radii. Default is 11.2 Earth radii (Jupiter’s radius). Changing it may speed up calculations when FeH_flag = True.
- tolerance (optional):
maximum relative difference in radius between interior-atm. steps. Default is 0.001
- guillot (optional):
False if you do not want to use Guillot 2010 atm. profile
- P_surf:
Boundary pressure between interior and atmosphere. Default is 1000 bars. For models with high Tint you may need to decrease it to 9.5 bars (if using the default atm. grid)
- kappa_IR (float, optional):
The infrared opacity in units of \(\\rm cm^2/s\). Default is 0.01.
- gamma (float, optional):
The ratio between the visual and infrared opacity. Default is 0.4.
- Return:
- Rtot:
Converged total planet radius in Jupiter radii
- Mtot:
Total mass (bulk interior + atm.) in Earth masses
- T_surf:
Final surface temperature (1000 bar) in K
- CMF_conv:
Re-computed core mass fraction. It takes into account the mass of the atmosphere.
- Rbulk_Rjup:
Planet bulk radius in Jupiter radii
- Matm_earthunits:
Atmospheric mass in Earth masses