mom_shared_initialization subroutine, public subroutine, public mom_shared_initialization::mom_shared_init_init (PF) mom_shared_init_init PF PF MOM_shared_init_init just writes the code version. pf A structure indicating the open file to parse for model parameter values. subroutine, public subroutine, public mom_shared_initialization::mom_initialize_rotation (f, G, PF, US) mom_initialize_rotation f f G G PF PF US US MOM_initialize_rotation makes the appropriate call to set up the Coriolis parameter. g The dynamic horizontal grid type f The Coriolis parameter [T-1 ~> s-1] pf Parameter file structure us A dimensional unit scaling type mom_error_handler::calltree_enter mom_error_handler::calltree_leave set_rotation_beta_plane set_rotation_planetary subroutine, public subroutine, public mom_shared_initialization::mom_calculate_grad_coriolis (dF_dx, dF_dy, G, US) mom_calculate_grad_coriolis dF_dx dF_dx dF_dy dF_dy G G US US Calculates the components of grad f (Coriolis parameter) g The dynamic horizontal grid type df_dx x-component of grad f [T-1 L-1 ~> s-1 m-1] df_dy y-component of grad f [T-1 L-1 ~> s-1 m-1] us A dimensional unit scaling type real function, public real function, public mom_shared_initialization::diagnosemaximumdepth (D, G) diagnosemaximumdepth D D G G Return the global maximum ocean bottom depth in the same units as the input depth. g The dynamic horizontal grid type d Ocean bottom depth in m or Z The global maximum ocean bottom depth in m or Z subroutine, public subroutine, public mom_shared_initialization::initialize_topography_from_file (D, G, param_file, US) initialize_topography_from_file D D G G param_file param_file US US Read gridded depths from file. g The dynamic horizontal grid type d Ocean bottom depth in m or Z if US is present param_file Parameter file structure us A dimensional unit scaling type apply_topography_edits_from_file mom_error_handler::calltree_enter mom_error_handler::calltree_leave subroutine, public subroutine, public mom_shared_initialization::apply_topography_edits_from_file (D, G, param_file, US) apply_topography_edits_from_file D D G G param_file param_file US US Applies a list of topography overrides read from a netcdf file. g The dynamic horizontal grid type d Ocean bottom depth in m or Z if US is present param_file Parameter file structure us A dimensional unit scaling type mom_error_handler::calltree_enter mom_error_handler::calltree_leave initialize_topography_from_file subroutine, public subroutine, public mom_shared_initialization::initialize_topography_named (D, G, param_file, topog_config, max_depth, US) initialize_topography_named D D G G param_file param_file topog_config topog_config max_depth max_depth US US initialize the bathymetry based on one of several named idealized configurations g The dynamic horizontal grid type d Ocean bottom depth in m or Z if US is present param_file Parameter file structure topog_config The name of an idealized topographic configuration max_depth Maximum depth of model in the units of D us A dimensional unit scaling type mom_error_handler::calltree_enter mom_error_handler::calltree_leave subroutine, public subroutine, public mom_shared_initialization::limit_topography (D, G, param_file, max_depth, US) limit_topography D D G G param_file param_file max_depth max_depth US US limit_topography ensures that min_depth < D(x,y) < max_depth g The dynamic horizontal grid type d Ocean bottom depth in m or Z if US is present param_file Parameter file structure max_depth Maximum depth of model in the units of D us A dimensional unit scaling type mom_error_handler::calltree_enter mom_error_handler::calltree_leave subroutine, public subroutine, public mom_shared_initialization::set_rotation_planetary (f, G, param_file, US) set_rotation_planetary f f G G param_file param_file US US This subroutine sets up the Coriolis parameter for a sphere. g The dynamic horizontal grid f Coriolis parameter (vertical component) [T-1 ~> s-1] param_file A structure to parse for run-time parameters us A dimensional unit scaling type mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_rotation subroutine, public subroutine, public mom_shared_initialization::set_rotation_beta_plane (f, G, param_file, US) set_rotation_beta_plane f f G G param_file param_file US US This subroutine sets up the Coriolis parameter for a beta-plane or f-plane. g The dynamic horizontal grid f Coriolis parameter (vertical component) [T-1 ~> s-1] param_file A structure to parse for run-time parameters us A dimensional unit scaling type mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_initialize_rotation subroutine, public subroutine, public mom_shared_initialization::initialize_grid_rotation_angle (G, PF) initialize_grid_rotation_angle G G PF PF initialize_grid_rotation_angle initializes the arrays with the sine and cosine of the angle between logical north on the grid and true north. g The dynamic horizontal grid pf A structure indicating the open file to parse for model parameter values. modulo_around_point real function real function mom_shared_initialization::modulo_around_point (x, xc, Lx) modulo_around_point x x xc xc Lx Lx Return the modulo value of x in an interval [xc-(Lx/2) xc+(Lx/2)] If Lx<=0, then it returns x without applying modulo arithmetic. x Value to which to apply modulo arithmetic xc Center of modulo range lx Modulo range width x shifted by an integer multiple of Lx to be close to xc. initialize_grid_rotation_angle subroutine, public subroutine, public mom_shared_initialization::reset_face_lengths_named (G, param_file, name, US) reset_face_lengths_named G G param_file param_file name name US US This subroutine sets the open face lengths at selected points to restrict passages to their observed widths based on a named set of sizes. g The dynamic horizontal grid param_file A structure to parse for run-time parameters name The name for the set of face lengths. Only "global_1deg" is currently implemented. us A dimensional unit scaling type subroutine, public subroutine, public mom_shared_initialization::reset_face_lengths_file (G, param_file, US) reset_face_lengths_file G G param_file param_file US US This subroutine sets the open face lengths at selected points to restrict passages to their observed widths from a arrays read from a file. g The dynamic horizontal grid param_file A structure to parse for run-time parameters us A dimensional unit scaling type mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_domains::to_all subroutine, public subroutine, public mom_shared_initialization::reset_face_lengths_list (G, param_file, US) reset_face_lengths_list G G param_file param_file US US This subroutine sets the open face lengths at selected points to restrict passages to their observed widths from a list read from a file. g The dynamic horizontal grid param_file A structure to parse for run-time parameters us A dimensional unit scaling type mom_error_handler::calltree_enter mom_error_handler::calltree_leave read_face_length_list mom_string_functions::uppercase subroutine, public subroutine, public mom_shared_initialization::read_face_length_list (iounit, filename, num_lines, lines) read_face_length_list iounit iounit filename filename num_lines num_lines lines lines This subroutine reads and counts the non-blank lines in the face length list file, after removing comments. iounit An open I/O unit number for the file filename The name of the face-length file to read num_lines The number of non-blank lines in the file lines The non-blank lines, after removing comments mom_string_functions::uppercase reset_face_lengths_list subroutine, public subroutine, public mom_shared_initialization::set_velocity_depth_max (G) set_velocity_depth_max G G Set the bathymetry at velocity points to be the maximum of the depths at the neighoring tracer points. g The dynamic horizontal grid subroutine, public subroutine, public mom_shared_initialization::set_velocity_depth_min (G) set_velocity_depth_min G G Set the bathymetry at velocity points to be the minimum of the depths at the neighoring tracer points. g The dynamic horizontal grid subroutine, public subroutine, public mom_shared_initialization::compute_global_grid_integrals (G, US) compute_global_grid_integrals G G US US Pre-compute global integrals of grid quantities (like masked ocean area) for later use in reporting diagnostics. g The dynamic horizontal grid us A dimensional unit scaling type mom_fixed_initialization::mom_initialize_fixed subroutine, public subroutine, public mom_shared_initialization::write_ocean_geometry_file (G, param_file, directory, geom_file, US) write_ocean_geometry_file G G param_file param_file directory directory geom_file geom_file US US Write out a file describing the topography, Coriolis parameter, grid locations and various other fixed fields from the grid. g The dynamic horizontal grid param_file Parameter file structure directory The directory into which to place the geometry file. geom_file If present, the name of the geometry file (otherwise the file is "ocean_geometry") us A dimensional unit scaling type mom_error_handler::calltree_enter mom_error_handler::calltree_leave mom_io::var_desc mom_fixed_initialization::mom_initialize_fixed Code that initializes fixed aspects of the model grid, such as horizontal grid metrics, topography and Coriolis, and can be shared between components.