Functions reference

Functions in T_c1D

init_params

tc1d.init_params(echo_inputs=False, echo_info=True, echo_thermal_info=True, echo_ages=True, debug=False, run_type='forward', length=125.0, nx=251, time=50.0, dt=5000.0, init_moho_depth=50.0, crustal_uplift=False, fixed_moho=False, removal_fraction=0.0, removal_start_time=0.0, removal_end_time=-1.0, rho_crust=2850.0, cp_crust=800.0, k_crust=2.75, heat_prod_crust=0.5, heat_prod_decay_depth=-1.0, alphav_crust=3e-05, rho_mantle=3250.0, cp_mantle=1000.0, k_mantle=2.5, heat_prod_mantle=0.0, alphav_mantle=3e-05, rho_a=3250.0, k_a=20.0, implicit=True, temp_surf=0.0, temp_base=1300.0, mantle_adiabat=True, intrusion_temperature=750.0, intrusion_start_time=-1.0, intrusion_duration=-1.0, intrusion_thickness=-1.0, intrusion_base_depth=-1.0, vx_init=0.0, ero_type=1, ero_option1=0.0, ero_option2=0.0, ero_option3=0.0, ero_option4=0.0, ero_option5=0.0, ero_option6=0.0, ero_option7=0.0, ero_option8=0.0, ero_option9=0.0, ero_option10=0.0, calc_ages=True, ketch_aft=True, madtrax_aft=False, madtrax_aft_kinetic_model=1, madtrax_zft_kinetic_model=1, ap_rad=45.0, ap_uranium=10.0, ap_thorium=40.0, zr_rad=60.0, zr_uranium=100.0, zr_thorium=40.0, pad_time=0.0, past_age_increment=0.0, obs_ahe=[], obs_ahe_stdev=[], obs_aft=[], obs_aft_stdev=[], obs_zhe=[], obs_zhe_stdev=[], obs_zft=[], obs_zft_stdev=[], obs_age_file='', misfit_num_params=0, misfit_type=1, plot_results=True, display_plots=True, plot_ma=True, plot_depth_history=False, plot_fault_depth_history=False, invert_tt_plot=False, t_plots=[0.1, 1, 5, 10, 20, 30, 50], crust_solidus=False, crust_solidus_comp='wet_intermediate', mantle_solidus=False, mantle_solidus_xoh=0.0, solidus_ranges=False, log_output=False, log_file='', model_id='', write_temps=False, write_age_output=False, write_past_ages=False, save_plots=False, read_temps=False, compare_temps=False)

Define the model parameters.

Parameters:

echo_inputsbool, default=False

Print input values to the screen.

echo_infobool, default=True

Print basic model info to the screen.

echo_thermal_infobool, default=True

Print thermal model info to the screen.

echo_agesbool, default=True

Print calculated thermochronometer age(s) to the screen.

debugbool, default=False

Enable debug output.

run_typestr, default=”forward”

Define type of run: forward, batch, na, or mcmc.

lengthfloat or int, default=125.0

Model depth extent in km.

nxint, default=251

Number of grid points for temperature calculation.

timefloat or int, default=50.0

Total simulation time in Myr.

dtfloat or int, default=5000.0

Time step in years.

init_moho_depthfloat or int, default=50.0

Initial depth of Moho in km.

crustal_upliftbool, default=False

Uplift only the crust in the thermal model.

fixed_mohobool, default=False

Prevent changes in Moho depth (e.g., due to erosion).

removal_fractionfloat or int, default=0.0

Fraction of lithospheric mantle to remove due to delamination. 0 = none, 1 = all.

removal_start_timefloat or int, default=0.0

Timing of start of removal of lithospheric mantle in Myr from start of simulation.

removal_end_timefloat or int, default=-1.0

Timing of end of removal of lithospheric mantle in Myr from start of simulation.

rho_crustfloat or int, default=2850.0

Crustal density in kg/m^3.

cp_crustfloat or int, default=800.0

Crustal heat capacity in J/kg/K.

k_crustfloat or int, default=2.75

Crustal thermal conductivity in W/m/K.

heat_prod_crustfloat or int, default=0.5

Crustal heat production in uW/m^3.

heat_prod_decay_depthfloat or int, default=-1.0

Crustal heat production decay depth in km.

alphav_crustfloat or int, default=3.0e-5

Crustal coefficient of thermal expansion in 1/K.

rho_mantlefloat or int, default=3250.0

Mantle lithosphere density in kg/m^3.

cp_mantlefloat or int, default=1000.0

Mantle lithosphere heat capacity in J/kg/K.

k_mantlefloat or int, default=2.5

Mantle lithosphere thermal conductivity in W/m/K.

heat_prod_mantlefloat or int, default=0.0

Mantle lithosphere heat production in uW/m^3.

alphav_mantlefloat or int, default=3.0e-5

Mantle lithosphere coefficient of thermal expansion in 1/K.

rho_afloat or int, default=3250.0

Mantle asthenosphere density in kg/m^3.

k_afloat or int, default=20.0

Mantle asthenosphere thermal conductivity in W/m/K.

implicitbool, default=True

Use implicit instead of explicit finite-difference calculation.

temp_surffloat or int, default=0.0

Surface boundary condition temperature in °C.

temp_basefloat or int, default=1300.0

Basal boundary condition temperature in °C.

mantle_adiabatbool, default=True

Use adiabat for asthenosphere temperature.

intrusion_temperaturefloat or int, default=750.0

Intrusion temperature in deg. C.

intrusion_start_timefloat or int, default=-1.0

Time for when magmatic intrusion becomes active in Myr.

intrusion_durationfloat or int, default=-1.0

Duration for which a magmatic intrusion is active in Myr.

intrusion_thicknessfloat or int, default=-1.0

Thickness of magmatic intrusion in km.

intrusion_base_depthfloat or int, default=-1.0

Depth of base of intrusion in km.

vx_initfloat or int, default=0.0

Initial steady-state advection velocity in mm/yr.

ero_typeint, default=1

Type of erosion model (1, 2, 3, 4, 5, 6, 7 - see https://tc1d.readthedocs.io/en/latest/erosion-models.html).

ero_option1float or int, default=0.0

Erosion model option 1 (see https://tc1d.readthedocs.io/en/latest/erosion-models.html).

ero_option2float or int, default=0.0

Erosion model option 2 (see https://tc1d.readthedocs.io/en/latest/erosion-models.html).

ero_option3float or int, default=0.0

Erosion model option 3 (see https://tc1d.readthedocs.io/en/latest/erosion-models.html).

ero_option4float or int, default=0.0

Erosion model option 4 (see https://tc1d.readthedocs.io/en/latest/erosion-models.html).

ero_option5float or int, default=0.0

Erosion model option 5 (see https://tc1d.readthedocs.io/en/latest/erosion-models.html).

ero_option6float or int, default=0.0

Erosion model option 6 (see https://tc1d.readthedocs.io/en/latest/erosion-models.html).

ero_option7float or int, default=0.0

Erosion model option 7 (see https://tc1d.readthedocs.io/en/latest/erosion-models.html).

ero_option8float or int, default=0.0

Erosion model option 8 (see https://tc1d.readthedocs.io/en/latest/erosion-models.html).

ero_option9float or int, default=0.0

Erosion model option 8 (see https://tc1d.readthedocs.io/en/latest/erosion-models.html).

ero_option10float or int, default=0.0

Erosion model option 8 (see https://tc1d.readthedocs.io/en/latest/erosion-models.html).

calc_agesbool, default=True

Enable calculation of thermochronometer ages.

ketch_aftbool, default=True

Use the Ketcham et al. (2007) model for predicting FT ages.

madtrax_aftbool, default=False

Use the MadTrax algorithm for predicting apatite FT ages.

madtrax_aft_kinetic_modelint, default=1

Kinetic model to use for AFT age prediction with MadTrax (see https://tc1d.readthedocs.io).

madtrax_zft_kinetic_modelint, default=1

Kinetic model to use for ZFT age prediction with MadTrax (see https://tc1d.readthedocs.io).

ap_radfloat or int, default=45.0

Apatite grain radius in um.

ap_uraniumfloat or int, default=10.0

Apatite U concentration in ppm.

ap_thoriumfloat or int, default=40.0

Apatite Th concentration radius in ppm.

zr_radfloat or int, default=60.0

Zircon grain radius in um.

zr_uraniumfloat or int, default=100.0

Zircon U concentration in ppm.

zr_thoriumfloat or int, default=40.0

Zircon Th concentration radius in ppm.

pad_timefloat or int, default=0.0

Additional time added at starting temperature in t-T history in Myr.

past_age_incrementfloat or int, default=0.0

Time increment in past (in Myr) at which ages should be calculated. Works only if greater than 0.0.

obs_ahelist of float or int, default=[]

Measured apatite (U-Th)/He age(s) in Ma.

obs_ahe_stdevlist of float or int, default=[]

Measured apatite (U-Th)/He age standard deviation(s) in Ma.

obs_aftlist of float or int, default=[]

Measured apatite fission-track age(s) in Ma.

obs_aft_stdevlist of float or int, default=[]

Measured apatite fission-track age standard deviation(s) in Ma.

obs_zhelist of float or int, default=[]

Measured zircon (U-Th)/He age(s) in Ma.

obs_zhe_stdevlist of float or int, default=[]

Measured zircon (U-Th)/He age standard deviation(s) in Ma.

obs_zftlist of float or int, default=[]

Measured zircon fission-track age(s) in Ma.

obs_zft_stdevlist of float or int, default=[]

Measured zircon fission-track age standard deviation(s) in Ma.

obs_age_filestr, default=””

CSV file containing measured ages.

misfit_num_paramsint, default=0

Number of model parameters to use in misfit calculation. Only applies to misfit type 2.

misfit_typeint, default=1

Misfit type for misfit calculation.

plot_resultsbool, default=True

Plot calculated results.

display_plotsbool, default=True

Display plots on screen.

plot_mabool, default=True

Plot time in Ma rather than Myr from start of model.

plot_depth_historybool, default=False

Plot depth history on thermal history plot.

plot_fault_depth_historybool, default=False

Plot fault depth history on thermal history plot.

invert_tt_plotbool, default=False

Invert depth/temperature axis on thermal history plot.

t_plotslist of float or int, default=[0.1, 1, 5, 10, 20, 30, 50]

Output times for temperature plotting in Myr. Treated as increment if only one value given.

crust_solidusbool, default=False

Calculate and plot a crustal solidus.

crust_solidus_compstr, default=”wet_intermediate”

Crustal composition for solidus.

mantle_solidusbool, default=False

Calculate and plot a mantle solidus.

mantle_solidus_xohfloat or int, default=0.0

Water content for mantle solidus calculation in ppm.

solidus_rangesbool, default=False

Plot ranges for the crustal and mantle solidii.

log_outputbool, default=False

Write model summary info to a csv file.

log_filestr, default=””

CSV filename for log output.

model_idstr, default=””

Model identification character string.

write_tempsbool, default=False

Save model temperatures to a file.

write_age_outputbool, default=False

Save predicted and observed ages to a file.

write_past_agesbool, default=False

Write out incremental past ages to csv file.

save_plotsbool, default=False

Save plots to a file.

read_tempsbool, default=False

Read temperatures from a file.

compare_tempsbool, default=False

Compare model temperatures to those from a file.

Returns:

paramsdict

Dictionary of model parameter values.

prep_model

tc1d.prep_model(params)

Prepares models to be run as single models or in batch mode.

Parameters:

paramsdict

Dictionary of model parameter values.

Returns:

None