mom_state_initialization character(len=40) character(len=40) mom_state_initialization::mdl mdl = "MOM_state_initialization" This module's name. mom_initialize_state subroutine, public subroutine, public mom_state_initialization::mom_initialize_state (u, v, h, tv, Time, G, GV, US, PF, dirs, restart_CS, ALE_CSp, tracer_Reg, sponge_CSp, ALE_sponge_CSp, OBC, Time_in) mom_initialize_state u u v v h h tv tv Time Time G G GV GV US US PF PF dirs dirs restart_CS restart_CS ALE_CSp ALE_CSp tracer_Reg tracer_Reg sponge_CSp sponge_CSp ALE_sponge_CSp ALE_sponge_CSp OBC OBC Time_in Time_in Initialize temporally evolving fields, either as initial conditions or by reading them from a restart (or saves) file. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type u The zonal velocity that is being v The meridional velocity that is being h Layer thicknesses [H ~> m or kg m-2] tv A structure pointing to various thermodynamic variables time Time at the start of the run segment. pf A structure indicating the open file to parse for model parameter values. dirs A structure containing several relevant directory paths. restart_cs A pointer to the restart control structure. ale_csp The ALE control structure for remapping tracer_reg A pointer to the tracer registry sponge_csp The layerwise sponge control structure. ale_sponge_csp The ALE sponge control structure. obc The open boundary condition control structure. time_in Time at the start of the run segment. Time_in overrides any value set for Time. adjustment_initialization::adjustment_initialize_temperature_salinity baroclinic_zone_initialization::baroclinic_zone_init_temperature_salinity benchmark_initialization::benchmark_init_temperature_salinity bfb_initialization::bfb_initialize_sponges_southonly mom_error_handler::calltree_enter mom_error_handler::calltree_leave circle_obcs_initialization::circle_obcs_initialize_thickness convert_thickness dense_water_initialization::dense_water_initialize_sponges depress_surface mom_restart::determine_is_new_run dome2d_initialization::dome2d_initialize_sponges dome_initialization::dome_initialize_sponges dumbbell_initialization::dumbbell_initialize_sponges dyed_channel_initialization::dyed_channel_set_obc_tracer_data dyed_obcs_initialization::dyed_obcs_set_obc_data external_gwave_initialization::external_gwave_initialize_thickness initialize_sponges_file initialize_temp_salt_fit initialize_temp_salt_from_file initialize_temp_salt_from_profile initialize_temp_salt_linear initialize_thickness_from_file initialize_thickness_list initialize_thickness_search initialize_thickness_uniform initialize_velocity_circular initialize_velocity_from_file initialize_velocity_uniform initialize_velocity_zero isomip_initialization::isomip_initialize_temperature_salinity lock_exchange_initialization::lock_exchange_initialize_thickness mom_string_functions::lowercase mdl mom_temp_salt_initialize_from_z neverworld_initialization::neverworld_initialize_thickness phillips_initialization::phillips_initialize_sponges mom_restart::restore_state rgc_initialization::rgc_initialize_sponges rossby_front_2d_initialization::rossby_front_initialize_velocity scm_cvmix_tests::scm_cvmix_tests_ts_init seamount_initialization::seamount_initialize_temperature_salinity sloshing_initialization::sloshing_initialize_temperature_salinity soliton_initialization::soliton_initialize_thickness supercritical_initialization::supercritical_set_obc_data trim_for_ice mom_open_boundary::update_obc_segment_data user_initialization::user_initialize_sponges subroutine subroutine mom_state_initialization::initialize_thickness_from_file (h, G, GV, US, param_file, file_has_thickness, just_read_params) initialize_thickness_from_file h h G G GV GV US US param_file param_file file_has_thickness file_has_thickness just_read_params just_read_params Reads the layer thicknesses or interface heights from a file. g The ocean's grid structure gv The ocean's vertical grid structure us A dimensional unit scaling type h The thickness that is being initialized [H ~> m or kg m-2]. param_file A structure indicating the open file to parse for model parameter values. file_has_thickness If true, this file contains layer thicknesses; otherwise it contains interface heights. just_read_params If present and true, this call will only read parameters without changing h. adjustetatofitbathymetry mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_state subroutine subroutine mom_state_initialization::adjustetatofitbathymetry (G, GV, US, eta, h) adjustetatofitbathymetry G G GV GV US US eta eta h h Adjust interface heights to fit the bathymetry and diagnose layer thickness. If the bottom most interface is below the topography then the bottom-most layers are contracted to GVAngstrom_m. If the bottom most interface is above the topography then the entire column is dilated (expanded) to fill the void. {There is a (hard-wired) "tolerance" parameter such that the criteria for adjustment must equal or exceed 10cm.} g The ocean's grid structure gv The ocean's vertical grid structure us A dimensional unit scaling type eta Interface heights [Z ~> m]. h Layer thicknesses [H ~> m or kg m-2] initialize_thickness_from_file mom_temp_salt_initialize_from_z subroutine subroutine mom_state_initialization::initialize_thickness_uniform (h, G, GV, param_file, just_read_params) initialize_thickness_uniform h h G G GV GV param_file param_file just_read_params just_read_params Initializes thickness to be uniform. g The ocean's grid structure. gv The ocean's vertical grid structure. h The thickness that is being initialized [H ~> m or kg m-2]. param_file A structure indicating the open file to parse for model parameter values. just_read_params If present and true, this call will only read parameters without changing h. mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_state subroutine subroutine mom_state_initialization::initialize_thickness_list (h, G, GV, US, param_file, just_read_params) initialize_thickness_list h h G G GV GV US US param_file param_file just_read_params just_read_params Initialize thickness from a 1D list. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type h The thickness that is being initialized [H ~> m or kg m-2]. param_file A structure indicating the open file to parse for model parameter values. just_read_params If present and true, this call will only read parameters without changing h. mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_state subroutine subroutine mom_state_initialization::initialize_thickness_search initialize_thickness_search Search density space for location of layers (not implemented!) mom_initialize_state subroutine subroutine mom_state_initialization::convert_thickness (h, G, GV, US, tv) convert_thickness h h G G GV GV US US tv tv Converts thickness from geometric to pressure units. g The ocean's grid structure gv The ocean's vertical grid structure us A dimensional unit scaling type h Input geometric layer thicknesses being converted tv A structure pointing to various thermodynamic variables mom_initialize_state subroutine subroutine mom_state_initialization::depress_surface (h, G, GV, US, param_file, tv, just_read_params) depress_surface h h G G GV GV US US param_file param_file tv tv just_read_params just_read_params Depress the sea-surface based on an initial condition file. g The ocean's grid structure gv The ocean's vertical grid structure us A dimensional unit scaling type h Layer thicknesses [H ~> m or kg m-2] param_file A structure to parse for run-time parameters tv A structure pointing to various thermodynamic variables just_read_params If present and true, this call will only read parameters without changing h. mom_initialize_state subroutine subroutine mom_state_initialization::trim_for_ice (PF, G, GV, US, ALE_CSp, tv, h, just_read_params) trim_for_ice PF PF G G GV GV US US ALE_CSp ALE_CSp tv tv h h just_read_params just_read_params Adjust the layer thicknesses by cutting away the top of each model column at the depth where the hydrostatic pressure matches an imposed surface pressure read from file. pf Parameter file structure g Ocean grid structure gv Vertical grid structure us A dimensional unit scaling type ale_csp ALE control structure tv Thermodynamics structure h Layer thickness [H ~> m or kg m-2] just_read_params If present and true, this call will only read parameters without changing h. cut_off_column_top mom_ale::ts_plm_edge_values mom_initialize_state subroutine subroutine mom_state_initialization::cut_off_column_top (nk, tv, GV, US, G_earth, depth, min_thickness, T, T_t, T_b, S, S_t, S_b, p_surf, h, remap_CS, z_tol, remap_answers_2018) cut_off_column_top nk nk tv tv GV GV US US G_earth G_earth depth depth min_thickness min_thickness T T T_t T_t T_b T_b S S S_t S_t S_b S_b p_surf p_surf h h remap_CS remap_CS z_tol z_tol remap_answers_2018 remap_answers_2018 Adjust the layer thicknesses by removing the top of the water column above the depth where the hydrostatic pressure matches p_surf. nk Number of layers tv Thermodynamics structure gv The ocean's vertical grid structure. us A dimensional unit scaling type g_earth Gravitational acceleration [L2 Z-1 T-2 ~> m s-2] depth Depth of ocean column [Z ~> m]. min_thickness Smallest thickness allowed [Z ~> m]. t Layer mean temperature [degC] t_t Temperature at top of layer [degC] t_b Temperature at bottom of layer [degC] s Layer mean salinity [ppt] s_t Salinity at top of layer [ppt] s_b Salinity at bottom of layer [ppt] p_surf Imposed pressure on ocean at surface [R L2 T-2 ~> Pa] h Layer thickness [H ~> m or kg m-2] remap_cs Remapping structure for remapping T and S, if associated z_tol The tolerance with which to find the depth matching the specified pressure [Z ~> m]. remap_answers_2018 If true, use the order of arithmetic and expressions that recover the answers for remapping from the end of 2018. Otherwise, use more robust forms of the same expressions. mom_density_integrals::find_depth_of_pressure_in_cell mom_remapping::remapping_core_h mom_state_init_tests trim_for_ice subroutine subroutine mom_state_initialization::initialize_velocity_from_file (u, v, G, US, param_file, just_read_params) initialize_velocity_from_file u u v v G G US US param_file param_file just_read_params just_read_params Initialize horizontal velocity components from file. g The ocean's grid structure u The zonal velocity that is being initialized [L T-1 ~> m s-1] v The meridional velocity that is being initialized [L T-1 ~> m s-1] us A dimensional unit scaling type param_file A structure indicating the open file to parse for modelparameter values. just_read_params If present and true, this call will only read parameters without changing h. mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_state subroutine subroutine mom_state_initialization::initialize_velocity_zero (u, v, G, param_file, just_read_params) initialize_velocity_zero u u v v G G param_file param_file just_read_params just_read_params Initialize horizontal velocity components to zero. g The ocean's grid structure u The zonal velocity that is being initialized [L T-1 ~> m s-1] v The meridional velocity that is being initialized [L T-1 ~> m s-1] param_file A structure indicating the open file to parse for modelparameter values. just_read_params If present and true, this call will only read parameters without changing h. mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_state subroutine subroutine mom_state_initialization::initialize_velocity_uniform (u, v, G, US, param_file, just_read_params) initialize_velocity_uniform u u v v G G US US param_file param_file just_read_params just_read_params Sets the initial velocity components to uniform. g The ocean's grid structure u The zonal velocity that is being initialized [L T-1 ~> m s-1] v The meridional velocity that is being initialized [L T-1 ~> m s-1] us A dimensional unit scaling type param_file A structure indicating the open file to parse for modelparameter values. just_read_params If present and true, this call will only read parameters without changing h. mom_initialize_state subroutine subroutine mom_state_initialization::initialize_velocity_circular (u, v, G, US, param_file, just_read_params) initialize_velocity_circular u u v v G G US US param_file param_file just_read_params just_read_params Sets the initial velocity components to be circular with no flow at edges of domain and center. g The ocean's grid structure u The zonal velocity that is being initialized [L T-1 ~> m s-1] v The meridional velocity that is being initialized [L T-1 ~> m s-1] us A dimensional unit scaling type param_file A structure indicating the open file to parse for model parameter values. just_read_params If present and true, this call will only read parameters without changing h. my_psi mom_initialize_state subroutine subroutine mom_state_initialization::initialize_temp_salt_from_file (T, S, G, param_file, just_read_params) initialize_temp_salt_from_file T T S S G G param_file param_file just_read_params just_read_params Initializes temperature and salinity from file. g The ocean's grid structure t The potential temperature that is being initialized [degC] s The salinity that is being initialized [ppt] param_file A structure to parse for run-time parameters just_read_params If present and true, this call will only read parameters without changing h. mom_error_handler::mom_error mom_initialize_state subroutine subroutine mom_state_initialization::initialize_temp_salt_from_profile (T, S, G, param_file, just_read_params) initialize_temp_salt_from_profile T T S S G G param_file param_file just_read_params just_read_params Initializes temperature and salinity from a 1D profile. g The ocean's grid structure t The potential temperature that is being initialized [degC] s The salinity that is being initialized [ppt] param_file A structure to parse for run-time parameters just_read_params If present and true, this call will only read parameters without changing h. mom_error_handler::mom_error mom_initialize_state subroutine subroutine mom_state_initialization::initialize_temp_salt_fit (T, S, G, GV, US, param_file, eqn_of_state, P_Ref, just_read_params) initialize_temp_salt_fit T T S S G G GV GV US US param_file param_file eqn_of_state eqn_of_state P_Ref P_Ref just_read_params just_read_params Initializes temperature and salinity by fitting to density. g The ocean's grid structure. gv The ocean's vertical grid structure. t The potential temperature that is being initialized [degC]. s The salinity that is being initialized [ppt]. us A dimensional unit scaling type param_file A structure to parse for run-time parameters. eqn_of_state Equation of state structure p_ref The coordinate-density reference pressure [R L2 T-2 ~> Pa]. just_read_params If present and true, this call will only read parameters without changing h. mom_initialize_state subroutine subroutine mom_state_initialization::initialize_temp_salt_linear (T, S, G, param_file, just_read_params) initialize_temp_salt_linear T T S S G G param_file param_file just_read_params just_read_params Initializes T and S with linear profiles according to reference surface layer salinity and temperature and a specified range. Note that the linear distribution is set up with respect to the layer number, not the physical position). g The ocean's grid structure t The potential temperature that is being initialized [degC] s The salinity that is being initialized [ppt] param_file A structure to parse for run-time parameters just_read_params If present and true, this call will only read parameters without changing h. mom_initialize_state subroutine subroutine mom_state_initialization::initialize_sponges_file (G, GV, US, use_temperature, tv, param_file, Layer_CSp, ALE_CSp, Time) initialize_sponges_file G G GV GV US US use_temperature use_temperature tv tv param_file param_file Layer_CSp Layer_CSp ALE_CSp ALE_CSp Time Time This subroutine sets the inverse restoration time (Idamp), and the values towards which the interface heights and an arbitrary number of tracers should be restored within each sponge. The interface height is always subject to damping, and must always be the first registered field. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type use_temperature If true, T & S are state variables. tv A structure pointing to various thermodynamic variables. param_file A structure to parse for run-time parameters. layer_csp A pointer that is set to point to the control structure for this module (in layered mode). ale_csp A pointer that is set to point to the control structure for this module (in ALE mode). time Time at the start of the run segment. Time_in overrides any value set for Time. mom_error_handler::mom_error mom_initialize_state subroutine subroutine mom_state_initialization::set_velocity_depth_max (G) set_velocity_depth_max G G This subroutine sets the 4 bottom depths at velocity points to be the maximum of the adjacent depths. g The ocean's grid structure subroutine subroutine mom_state_initialization::compute_global_grid_integrals (G, US) compute_global_grid_integrals G G US US Subroutine to pre-compute global integrals of grid quantities for later use in reporting diagnostics. g The ocean's grid structure us A dimensional unit scaling type subroutine subroutine mom_state_initialization::set_velocity_depth_min (G) set_velocity_depth_min G G This subroutine sets the 4 bottom depths at velocity points to be the minimum of the adjacent depths. g The ocean's grid structure subroutine subroutine mom_state_initialization::mom_temp_salt_initialize_from_z (h, tv, G, GV, US, PF, just_read_params) mom_temp_salt_initialize_from_z h h tv tv G G GV GV US US PF PF just_read_params just_read_params This subroutine determines the isopycnal or other coordinate interfaces and layer potential temperatures and salinities directly from a z-space file on a latitude-longitude grid. g The ocean's grid structure h Layer thicknesses being initialized [H ~> m or kg m-2] tv A structure pointing to various thermodynamic variables including temperature and salinity gv The ocean's vertical grid structure us A dimensional unit scaling type pf A structure indicating the open file to parse for model parameter values. just_read_params If present and true, this call will only read parameters without changing h. adjustetatofitbathymetry find_interfaces mom_error_handler::mom_error mom_initialize_state subroutine subroutine mom_state_initialization::find_interfaces (rho, zin, nk_data, Rb, depth, zi, G, US, nlevs, nkml, hml, eps_z, eps_rho) find_interfaces rho rho zin zin nk_data nk_data Rb Rb depth depth zi zi G G US US nlevs nlevs nkml nkml hml hml eps_z eps_z eps_rho eps_rho Find interface positions corresponding to interpolated depths in a density profile. g The ocean's grid structure nk_data The number of levels in the input data rho Potential density in z-space [R ~> kg m-3] zin Input data levels [Z ~> m]. rb target interface densities [R ~> kg m-3] depth ocean depth [Z ~> m]. zi The returned interface heights [Z ~> m] us A dimensional unit scaling type nlevs number of valid points in each column nkml number of mixed layer pieces to distribute over a depth of hml. hml mixed layer depth [Z ~> m]. eps_z A negligibly small layer thickness [Z ~> m]. eps_rho A negligibly small density difference [R ~> kg m-3]. mom_temp_salt_initialize_from_z subroutine subroutine mom_state_initialization::mom_state_init_tests (G, GV, US, tv) mom_state_init_tests G G GV GV US US tv tv Run simple unit tests. g The ocean's grid structure. gv The ocean's vertical grid structure. us A dimensional unit scaling type tv Thermodynamics structure. cut_off_column_top Initialization functions for state variables, u, v, h, T and S.