mom_state_initialization module reference¶

Initialization functions for state variables, u, v, h, T and S.

Functions/Subroutines¶

`mom_initialize_state()`	Initialize temporally evolving fields, either as initial conditions or by reading them from a restart (or saves) file.
`initialize_thickness_from_file()`	Reads the layer thicknesses or interface heights from a file.
`adjustetatofitbathymetry()`	Adjust interface heights to fit the bathymetry and diagnose layer thickness.
`initialize_thickness_uniform()`	Initializes thickness to be uniform.
`initialize_thickness_list()`	Initialize thickness from a 1D list.
`initialize_thickness_search()`	Search density space for location of layers (not implemented!)
`depress_surface()`	Depress the sea-surface based on an initial condition file.
`trim_for_ice()`	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.
`calc_sfc_displacement()`	Calculate the hydrostatic equilibrium position of the surface under an ice shelf.
`cut_off_column_top()`	Adjust the layer thicknesses by removing the top of the water column above the depth where the hydrostatic pressure matches p_surf.
`initialize_velocity_from_file()`	Initialize horizontal velocity components from file.
`initialize_velocity_zero()`	Initialize horizontal velocity components to zero.
`initialize_velocity_uniform()`	Sets the initial velocity components to uniform.
`initialize_velocity_circular()`	Sets the initial velocity components to be circular with no flow at edges of domain and center.
`initialize_temp_salt_from_file()`	Initializes temperature and salinity from file.
`initialize_temp_salt_from_profile()`	Initializes temperature and salinity from a 1D profile.
`initialize_temp_salt_fit()`	Initializes temperature and salinity by fitting to density.
`initialize_temp_salt_linear()`	Initializes T and S with linear profiles according to reference surface layer salinity and temperature and a specified range.
`initialize_sponges_file()`	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.
`initialize_oda_incupd_file()`
`set_velocity_depth_max()`	This subroutine sets the 4 bottom depths at velocity points to be the maximum of the adjacent depths.
`compute_global_grid_integrals()`	Subroutine to pre-compute global integrals of grid quantities for later use in reporting diagnostics.
`set_velocity_depth_min()`	This subroutine sets the 4 bottom depths at velocity points to be the minimum of the adjacent depths.
`mom_temp_salt_initialize_from_z()`	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.
`find_interfaces()`	Find interface positions corresponding to interpolated depths in a density profile.
`mom_state_init_tests()`	Run simple unit tests.

Detailed Description¶

Initialization functions for state variables, u, v, h, T and S.

Function/Subroutine Documentation¶

subroutine 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, oda_incupd_CSp, OBC, Time_in, frac_shelf_h, mass_shelf)¶

Initialize temporally evolving fields, either as initial conditions or by reading them from a restart (or saves) file.

Parameters:

g :: [inout] The ocean’s grid structure.
gv :: [in] The ocean’s vertical grid structure.
us :: [in] A dimensional unit scaling type
u :: [out] The zonal velocity that is being
v :: [out] The meridional velocity that is being
h :: [out] Layer thicknesses [H ~> m or kg m-2]
tv :: [inout] A structure pointing to various thermodynamic variables
time :: [inout] Time at the start of the run segment.
pf :: [in] A structure indicating the open file to parse for model parameter values.
dirs :: [in] A structure containing several relevant directory paths.
restart_cs :: [inout] MOM 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.
oda_incupd_csp :: The oda_incupd control structure.
time_in :: [in] Time at the start of the run segment.
frac_shelf_h :: [in] The fraction of the grid cell covered
mass_shelf :: [in] The mass per unit area of the overlying

Call to:

adjustment_initialization::adjustment_initialize_temperature_salinity mom_ale::ale_regrid_accelerated baroclinic_zone_initialization::baroclinic_zone_init_temperature_salinity benchmark_initialization::benchmark_init_temperature_salinity bfb_initialization::bfb_initialize_sponges_southonly mom_interface_heights::calc_derived_thermo calc_sfc_displacement mom_error_handler::calltree_enter mom_error_handler::calltree_leave circle_obcs_initialization::circle_obcs_initialize_thickness dense_water_initialization::dense_water_initialize_sponges depress_surface 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_oda_incupd_file 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::restart_registry_lock 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

Called from:

mom::initialize_mom

subroutine mom_state_initialization/initialize_thickness_from_file(h, depth_tot, G, GV, US, param_file, file_has_thickness, just_read, mass_file)¶

Reads the layer thicknesses or interface heights from a file.

Parameters:

g :: [in] The ocean’s grid structure
gv :: [in] The ocean’s vertical grid structure
us :: [in] A dimensional unit scaling type
h :: [out] The thickness that is being initialized, in height
depth_tot :: [in] The nominal total depth of the ocean [Z ~> m]
param_file :: [in] A structure indicating the open file to parse for model parameter values.
file_has_thickness :: [in] If true, this file contains layer thicknesses; otherwise it contains interface heights.
just_read :: [in] If true, this call will only read parameters without changing h.
mass_file :: [in] If true, this file contains layer thicknesses in units of mass per unit area.

Call to:

adjustetatofitbathymetry mom_error_handler::calltree_enter mom_error_handler::calltree_leave

Called from: