mom_coord_initialization character(len=40) character(len=40) mom_coord_initialization::mdl mdl = "MOM_coord_initialization" This module's name. mom_initialize_coord subroutine, public subroutine, public mom_coord_initialization::mom_initialize_coord (GV, US, PF, write_geom, output_dir, tv, max_depth) mom_initialize_coord GV GV US US PF PF write_geom write_geom output_dir output_dir tv tv max_depth max_depth MOM_initialize_coord sets up time-invariant quantities related to MOM6's vertical coordinate. gv Ocean vertical grid structure. us A dimensional unit scaling type pf A structure indicating the open file to parse for model parameter values. write_geom If true, write grid geometry files. output_dir The directory into which to write files. tv The thermodynamic variable structure. max_depth The ocean's maximum depth [Z ~> m]. bfb_initialization::bfb_set_coord mom_error_handler::calltree_enter mom_error_handler::calltree_leave mdl set_coord_from_file set_coord_from_gprime set_coord_from_layer_density set_coord_from_ts_profile set_coord_from_ts_range set_coord_from_ts_ref set_coord_linear set_coord_to_none mom_verticalgrid::setverticalgridaxes user_initialization::user_set_coord write_vertgrid_file mom_oda_driver_mod::init_oda mom::initialize_mom subroutine subroutine mom_coord_initialization::set_coord_from_gprime (Rlay, g_prime, GV, US, param_file) set_coord_from_gprime Rlay Rlay g_prime g_prime GV GV US US param_file param_file Sets the layer densities (Rlay) and the interface reduced gravities (g). gv The ocean's vertical grid structure. rlay The layers' target coordinate values (potential density) [R ~> kg m-3]. g_prime The reduced gravity across the interfaces [L2 Z-1 T-2 ~> m s-2]. us A dimensional unit scaling type param_file A structure to parse for run-time parameters mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_coord subroutine subroutine mom_coord_initialization::set_coord_from_layer_density (Rlay, g_prime, GV, US, param_file) set_coord_from_layer_density Rlay Rlay g_prime g_prime GV GV US US param_file param_file Sets the layer densities (Rlay) and the interface reduced gravities (g). gv The ocean's vertical grid structure. rlay The layers' target coordinate values (potential density) [R ~> kg m-3]. g_prime The reduced gravity across the interfaces [L2 Z-1 T-2 ~> m s-2]. us A dimensional unit scaling type param_file A structure to parse for run-time parameters mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_coord subroutine subroutine mom_coord_initialization::set_coord_from_ts_ref (Rlay, g_prime, GV, US, param_file, eqn_of_state, P_Ref) set_coord_from_ts_ref Rlay Rlay g_prime g_prime GV GV US US param_file param_file eqn_of_state eqn_of_state P_Ref P_Ref Sets the layer densities (Rlay) and the interface reduced gravities (g) from a profile of g'. gv The ocean's vertical grid structure. rlay The layers' target coordinate values (potential density) [R ~> kg m-3]. g_prime The reduced gravity across the interfaces [L2 Z-1 T-2 ~> m s-2]. 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]. mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_coord subroutine subroutine mom_coord_initialization::set_coord_from_ts_profile (Rlay, g_prime, GV, US, param_file, eqn_of_state, P_Ref) set_coord_from_ts_profile Rlay Rlay g_prime g_prime GV GV US US param_file param_file eqn_of_state eqn_of_state P_Ref P_Ref Sets the layer densities (Rlay) and the interface reduced gravities (g) from a T-S profile. gv The ocean's vertical grid structure rlay Layer potential density [R ~> kg m-3]. g_prime The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2]. 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]. mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_coord subroutine subroutine mom_coord_initialization::set_coord_from_ts_range (Rlay, g_prime, GV, US, param_file, eqn_of_state, P_Ref) set_coord_from_ts_range Rlay Rlay g_prime g_prime GV GV US US param_file param_file eqn_of_state eqn_of_state P_Ref P_Ref Sets the layer densities (Rlay) and the interface reduced gravities (g) from a linear T-S profile. gv The ocean's vertical grid structure rlay Layer potential density [R ~> kg m-3]. g_prime The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2]. 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]. mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_coord subroutine subroutine mom_coord_initialization::set_coord_from_file (Rlay, g_prime, GV, US, param_file) set_coord_from_file Rlay Rlay g_prime g_prime GV GV US US param_file param_file gv The ocean's vertical grid structure rlay Layer potential density [R ~> kg m-3]. g_prime The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2]. us A dimensional unit scaling type param_file A structure to parse for run-time parameters mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_coord subroutine subroutine mom_coord_initialization::set_coord_linear (Rlay, g_prime, GV, US, param_file) set_coord_linear Rlay Rlay g_prime g_prime GV GV US US param_file param_file Sets the layer densities (Rlay) and the interface reduced gravities (g) according to a linear profile starting at a reference surface layer density and spanning a range of densities to the bottom defined by the parameter RLAY_RANGE (defaulting to 2.0 if not defined) gv The ocean's vertical grid structure rlay Layer potential density [R ~> kg m-3]. g_prime The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2]. us A dimensional unit scaling type param_file A structure to parse for run-time parameters mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_coord subroutine subroutine mom_coord_initialization::set_coord_to_none (Rlay, g_prime, GV, US, param_file) set_coord_to_none Rlay Rlay g_prime g_prime GV GV US US param_file param_file Sets Rlay to Rho0 and g_prime to zero except for the free surface. This is for use only in ALE mode where Rlay should not be used and g_prime(1) alone might be used. gv The ocean's vertical grid structure rlay Layer potential density [R ~> kg m-3]. g_prime The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2]. us A dimensional unit scaling type param_file A structure to parse for run-time parameters mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_coord subroutine subroutine mom_coord_initialization::write_vertgrid_file (GV, US, param_file, directory) write_vertgrid_file GV GV US US param_file param_file directory directory Writes out a file containing any available data related to the vertical grid used by the MOM ocean model. gv The ocean's vertical grid structure us A dimensional unit scaling type param_file A structure to parse for run-time parameters directory The directory into which to place the file. mom_io::var_desc mom_initialize_coord Initializes fixed aspects of the related to its vertical coordinate.