mom_open_boundary mom_open_boundary::file_obc_cs mom_open_boundary::obc_registry_type mom_open_boundary::obc_segment_data_type mom_open_boundary::obc_segment_tracer_type mom_open_boundary::obc_segment_type mom_open_boundary::obc_struct_type mom_open_boundary::ocean_obc_type mom_open_boundary::segment_tracer_registry_type integer, parameter, public integer, parameter, public mom_open_boundary::obc_none obc_none = 0 Indicates the use of no open boundary. mom_lateral_mixing_coeffs::calc_slope_functions_using_just_e mom_lateral_mixing_coeffs::calc_visbeck_coeffs mask_outside_obcs open_boundary_config open_boundary_impose_land_mask rotate_obc_segment_config integer, parameter, public integer, parameter, public mom_open_boundary::obc_simple obc_simple = 1 Indicates the use of a simple inflow open boundary. integer, parameter, public integer, parameter, public mom_open_boundary::obc_wall obc_wall = 2 Indicates the use of a closed wall. integer, parameter, public integer, parameter, public mom_open_boundary::obc_flather obc_flather = 3 Indicates the use of a Flather open boundary. integer, parameter, public integer, parameter, public mom_open_boundary::obc_radiation obc_radiation = 4 Indicates the use of a radiation open boundary. integer, parameter, public integer, parameter, public mom_open_boundary::obc_direction_n obc_direction_n = 100 Indicates the boundary is an effective northern boundary. mom_barotropic::apply_velocity_obcs mom_barotropic::btcalc mom_barotropic::btstep mom_coriolisadv::coradcalc mom_vert_friction::find_coupling_coef gradient_at_q_points mask_outside_obcs mom_continuity_ppm::merid_face_thickness mom_continuity_ppm::merid_flux_layer mom_continuity_ppm::meridional_mass_flux open_boundary_impose_normal_slope open_boundary_test_extern_h open_boundary_test_extern_uv mom_continuity_ppm::ppm_reconstruction_y radiation_open_bdry_conds mom_ale::remap_all_state_vars rotate_obc_segment_config mom_set_diffusivity::set_bbl_tke set_tracer_data mom_barotropic::set_up_bt_obc setup_v_point_obc update_obc_segment_data mom_vert_friction::vertvisc_coef mom_sum_output::write_energy integer, parameter, public integer, parameter, public mom_open_boundary::obc_direction_s obc_direction_s = 200 Indicates the boundary is an effective southern boundary. mom_barotropic::apply_velocity_obcs mom_barotropic::btcalc mom_barotropic::btstep fill_temp_salt_segments mom_vert_friction::find_coupling_coef mask_outside_obcs open_boundary_impose_land_mask open_boundary_impose_normal_slope mom_continuity_ppm::ppm_reconstruction_y radiation_open_bdry_conds rotate_obc_segment_config set_tracer_data mom_barotropic::set_up_bt_obc setup_v_point_obc update_obc_segment_data update_segment_tracer_reservoirs mom_vert_friction::vertvisc_coef mom_sum_output::write_energy integer, parameter, public integer, parameter, public mom_open_boundary::obc_direction_e obc_direction_e = 300 Indicates the boundary is an effective eastern boundary. gradient_at_q_points mask_outside_obcs open_boundary_impose_land_mask open_boundary_impose_normal_slope open_boundary_test_extern_h open_boundary_test_extern_uv mom_continuity_ppm::ppm_reconstruction_x radiation_open_bdry_conds rotate_obc_segment_config mom_set_diffusivity::set_bbl_tke set_tracer_data setup_u_point_obc update_obc_segment_data mom_sum_output::write_energy mom_continuity_ppm::zonal_face_thickness mom_continuity_ppm::zonal_flux_layer mom_continuity_ppm::zonal_mass_flux integer, parameter, public integer, parameter, public mom_open_boundary::obc_direction_w obc_direction_w = 400 Indicates the boundary is an effective western boundary. fill_temp_salt_segments mom_vert_friction::find_coupling_coef mask_outside_obcs open_boundary_impose_land_mask open_boundary_impose_normal_slope mom_continuity_ppm::ppm_reconstruction_x radiation_open_bdry_conds rotate_obc_segment_config set_tracer_data setup_u_point_obc update_obc_segment_data update_segment_tracer_reservoirs mom_vert_friction::vertvisc_coef mom_sum_output::write_energy integer, parameter integer, parameter mom_open_boundary::max_obc_fields max_obc_fields = 100 Maximum number of data fields needed for OBC segments. integer integer mom_open_boundary::id_clock_pass id_clock_pass A CPU time clock. open_boundary_init radiation_open_bdry_conds character(len=40) character(len=40) mom_open_boundary::mdl mdl = "MOM_open_boundary" This module's name. initialize_obc_tides initialize_segment_data mask_outside_obcs open_boundary_config parse_for_tracer_reservoirs segment_tracer_registry_init setup_u_point_obc setup_v_point_obc subroutine, public subroutine, public mom_open_boundary::open_boundary_config (G, US, param_file, OBC) open_boundary_config G G US US param_file param_file OBC OBC Enables OBC module and reads configuration parameters This routine is called from MOM_initialize_fixed which occurs before the initialization of the vertical coordinate and ALE_init. Therefore segment data are not fully initialized here. The remainder of the segment data are initialized in a later call to update_open_boundary_data. g Ocean grid structure us A dimensional unit scaling type param_file Parameter file handle obc Open boundary control structure initialize_obc_tides mom_remapping::initialize_remapping mask_outside_obcs mdl obc_none open_boundary_dealloc open_boundary_query mom_string_functions::remove_spaces setup_u_point_obc setup_v_point_obc subroutine, public subroutine, public mom_open_boundary::initialize_segment_data (G, OBC, PF) initialize_segment_data G G OBC OBC PF PF Allocate space for reading OBC data from files. It sets up the required vertical remapping. In the process, it does funky stuff with the MPI processes. g Ocean grid structure obc Open boundary control structure pf Parameter file handle mdl parse_segment_data_str parse_segment_manifest_str subroutine subroutine mom_open_boundary::initialize_obc_tides (OBC, param_file) initialize_obc_tides OBC OBC param_file param_file obc Open boundary control structure param_file Parameter file handle mom_tidal_forcing::astro_longitudes_init mom_tidal_forcing::eq_phase mdl mom_tidal_forcing::nodal_fu mom_tidal_forcing::tidal_frequency open_boundary_config subroutine subroutine mom_open_boundary::setup_segment_indices (G, seg, Is_obc, Ie_obc, Js_obc, Je_obc) setup_segment_indices G G seg seg Is_obc Is_obc Ie_obc Ie_obc Js_obc Js_obc Je_obc Je_obc Define indices for segment and store in hor_index_type using global segment bounds corresponding to q-points. g grid type seg Open boundary segment is_obc Q-point global i-index of start of segment ie_obc Q-point global i-index of end of segment js_obc Q-point global j-index of start of segment je_obc Q-point global j-index of end of segment rotate_obc_segment_config setup_u_point_obc setup_v_point_obc subroutine subroutine mom_open_boundary::setup_u_point_obc (OBC, G, US, segment_str, l_seg, PF, reentrant_y) setup_u_point_obc OBC OBC G G US US segment_str segment_str l_seg l_seg PF PF reentrant_y reentrant_y Parse an OBC_SEGMENT_%%% string starting with "I=" and configure placement and type of OBC accordingly. obc Open boundary control structure g Ocean grid structure us A dimensional unit scaling type segment_str A string in form of "I=%,J=%:%,string" l_seg which segment is this? pf Parameter file handle reentrant_y is the domain reentrant in y? allocate_obc_segment_data mdl obc_direction_e obc_direction_w parse_segment_str setup_segment_indices open_boundary_config subroutine subroutine mom_open_boundary::setup_v_point_obc (OBC, G, US, segment_str, l_seg, PF, reentrant_x) setup_v_point_obc OBC OBC G G US US segment_str segment_str l_seg l_seg PF PF reentrant_x reentrant_x Parse an OBC_SEGMENT_%%% string starting with "J=" and configure placement and type of OBC accordingly. obc Open boundary control structure g Ocean grid structure us A dimensional unit scaling type segment_str A string in form of "J=%,I=%:%,string" l_seg which segment is this? pf Parameter file handle reentrant_x is the domain reentrant in x? allocate_obc_segment_data mdl obc_direction_n obc_direction_s parse_segment_str setup_segment_indices open_boundary_config subroutine subroutine mom_open_boundary::parse_segment_str (ni_global, nj_global, segment_str, l, m, n, action_str, reentrant) parse_segment_str ni_global ni_global nj_global nj_global segment_str segment_str l l m m n n action_str action_str reentrant reentrant Parse an OBC_SEGMENT_%%% string. ni_global Number of h-points in zonal direction nj_global Number of h-points in meridional direction segment_str A string in form of "I=l,J=m:n,string" or "J=l,I=m,n,string" l The value of I=l, if segment_str begins with I=l, or the value of J=l m The value of J=m, if segment_str begins with I=, or the value of I=m n The value of J=n, if segment_str begins with I=, or the value of I=n action_str The "string" part of segment_str reentrant is domain reentrant in relevant direction? mom_string_functions::extract_word interpret_int_expr setup_u_point_obc setup_v_point_obc subroutine subroutine mom_open_boundary::parse_segment_manifest_str (segment_str, num_fields, fields) parse_segment_manifest_str segment_str segment_str num_fields num_fields fields fields Parse an OBC_SEGMENT_%%_DATA string and determine its fields. segment_str A string in form of "VAR1=file:foo1.nc(varnam1),VAR2=file:foo2.nc(varnam2),..." num_fields The number of fields in the segment data fields List of fieldnames for each segment mom_string_functions::extract_word initialize_segment_data parse_for_tracer_reservoirs subroutine subroutine mom_open_boundary::parse_segment_data_str (segment_str, idx, var, value, filename, fieldname) parse_segment_data_str segment_str segment_str idx idx var var value value filename filename fieldname fieldname Parse an OBC_SEGMENT_%%_DATA string. segment_str A string in form of "VAR1=file:foo1.nc(varnam1),VAR2=file:foo2.nc(varnam2),..." idx Index of segment_str record var The name of the variable for which parameters are needed filename The name of the input file if using "file" method fieldname The name of the variable in the input file if using "file" method value A constant value if using the "value" method mom_string_functions::extract_word initialize_segment_data parse_for_tracer_reservoirs subroutine subroutine mom_open_boundary::parse_for_tracer_reservoirs (OBC, PF, use_temperature) parse_for_tracer_reservoirs OBC OBC PF PF use_temperature use_temperature Parse all the OBC_SEGMENT_%%_DATA strings again to see which need tracer reservoirs (all pes need to know). obc Open boundary control structure pf Parameter file handle use_temperature If true, T and S are used mdl parse_segment_data_str parse_segment_manifest_str open_boundary_register_restarts subroutine subroutine mom_open_boundary::parse_segment_param_real (segment_str, var, param_value, debug) parse_segment_param_real segment_str segment_str var var param_value param_value debug debug Parse an OBC_SEGMENT_%%_PARAMS string. segment_str A string in form of "VAR1=file:foo1.nc(varnam1),VAR2=file:foo2.nc(varnam2),..." var The name of the variable for which parameters are needed param_value The value of the parameter debug If present and true, write verbose debugging messages mom_string_functions::extract_word subroutine, public subroutine, public mom_open_boundary::open_boundary_init (G, GV, US, param_file, OBC, restart_CSp) open_boundary_init G G GV GV US US param_file param_file OBC OBC restart_CSp restart_CSp Initialize open boundary control structure and do any necessary rescaling of OBC fields that have been read from a restart file. g Ocean grid structure gv Container for vertical grid information us A dimensional unit scaling type param_file Parameter file handle obc Open boundary control structure restart_csp Restart structure, data intent(inout) mom_cpu_clock::cpu_clock_id id_clock_pass mom_domains::to_all rotate_obc_init logical function, public logical function, public mom_open_boundary::open_boundary_query (OBC, apply_open_OBC, apply_specified_OBC, apply_Flather_OBC, apply_nudged_OBC, needs_ext_seg_data) open_boundary_query OBC OBC apply_open_OBC apply_open_OBC apply_specified_OBC apply_specified_OBC apply_Flather_OBC apply_Flather_OBC apply_nudged_OBC apply_nudged_OBC needs_ext_seg_data needs_ext_seg_data obc Open boundary control structure apply_open_obc Returns True if open_*_BCs_exist_globally is true apply_specified_obc Returns True if specified_*_BCs_exist_globally is true apply_flather_obc Returns True if Flather_*_BCs_exist_globally is true apply_nudged_obc Returns True if nudged_*_BCs_exist_globally is true needs_ext_seg_data Returns True if external segment data needed open_boundary_config subroutine subroutine mom_open_boundary::open_boundary_dealloc (OBC) open_boundary_dealloc OBC OBC Deallocate open boundary data. obc Open boundary control structure deallocate_obc_segment_data open_boundary_config open_boundary_end subroutine, public subroutine, public mom_open_boundary::open_boundary_end (OBC) open_boundary_end OBC OBC Close open boundary data. obc Open boundary control structure open_boundary_dealloc subroutine, public subroutine, public mom_open_boundary::open_boundary_impose_normal_slope (OBC, G, depth) open_boundary_impose_normal_slope OBC OBC G G depth depth Sets the slope of bathymetry normal to an open bounndary to zero. obc Open boundary control structure g Ocean grid structure depth Bathymetry at h-points obc_direction_e obc_direction_n obc_direction_s obc_direction_w subroutine, public subroutine, public mom_open_boundary::open_boundary_impose_land_mask (OBC, G, areaCu, areaCv, US) open_boundary_impose_land_mask OBC OBC G G areaCu areaCu areaCv areaCv US US Reconcile masks and open boundaries, deallocate OBC on PEs where it is not needed. Also adjust u- and v-point cell area on specified open boundaries and mask all points outside open boundaries. obc Open boundary control structure g Ocean grid structure us A dimensional unit scaling type areacu Area of a u-cell [L2 ~> m2] areacv Area of a u-cell [L2 ~> m2] obc_direction_e obc_direction_s obc_direction_w obc_none mom_fixed_initialization::mom_initialize_fixed subroutine subroutine mom_open_boundary::setup_obc_tracer_reservoirs (G, OBC) setup_obc_tracer_reservoirs G G OBC OBC Make sure the OBC tracer reservoirs are initialized. g Ocean grid structure obc Open boundary control structure fill_temp_salt_segments subroutine, public subroutine, public mom_open_boundary::radiation_open_bdry_conds (OBC, u_new, u_old, v_new, v_old, G, US, dt) radiation_open_bdry_conds OBC OBC u_new u_new u_old u_old v_new v_new v_old v_old G G US US dt dt Apply radiation conditions to 3D u,v at open boundaries. g Ocean grid structure obc Open boundary control structure u_new On exit, new u values on open boundaries On entry, the old time-level v but including barotropic accelerations [L T-1 ~> m s-1]. u_old Original unadjusted u [L T-1 ~> m s-1] v_new On exit, new v values on open boundaries. On entry, the old time-level v but including barotropic accelerations [L T-1 ~> m s-1]. v_old Original unadjusted v [L T-1 ~> m s-1] us A dimensional unit scaling type dt Appropriate timestep [T ~> s] gradient_at_q_points id_clock_pass obc_direction_e obc_direction_n obc_direction_s obc_direction_w open_boundary_apply_normal_flow subroutine, public subroutine, public mom_open_boundary::open_boundary_apply_normal_flow (OBC, G, u, v) open_boundary_apply_normal_flow OBC OBC G G u u v v Applies OBC values stored in segments to 3d u,v fields. obc Open boundary control structure g Ocean grid structure u u field to update on open boundaries [L T-1 ~> m s-1] v v field to update on open boundaries [L T-1 ~> m s-1] radiation_open_bdry_conds subroutine, public subroutine, public mom_open_boundary::open_boundary_zero_normal_flow (OBC, G, u, v) open_boundary_zero_normal_flow OBC OBC G G u u v v Applies zero values to 3d u,v fields on OBC segments. obc Open boundary control structure g Ocean grid structure u u field to update on open boundaries v v field to update on open boundaries mom_dynamics_unsplit::step_mom_dyn_unsplit mom_dynamics_unsplit_rk2::step_mom_dyn_unsplit_rk2 subroutine subroutine mom_open_boundary::gradient_at_q_points (G, segment, uvel, vvel) gradient_at_q_points G G segment segment uvel uvel vvel vvel Calculate the tangential gradient of the normal flow at the boundary q-points. g Ocean grid structure segment OBC segment structure uvel zonal velocity [L T-1 ~> m s-1] vvel meridional velocity [L T-1 ~> m s-1] obc_direction_e obc_direction_n radiation_open_bdry_conds subroutine, public subroutine, public mom_open_boundary::set_tracer_data (OBC, tv, h, G, PF, tracer_Reg) set_tracer_data OBC OBC tv tv h h G G PF PF tracer_Reg tracer_Reg Sets the initial values of the tracer open boundary conditions. Redoing this elsewhere. g Ocean grid structure obc Open boundary structure tv Thermodynamics structure h Thickness pf Parameter file handle tracer_reg Tracer registry obc_direction_e obc_direction_n obc_direction_s obc_direction_w integer function integer function mom_open_boundary::lookup_seg_field (OBC_seg, field) lookup_seg_field OBC_seg OBC_seg field field Needs documentation. obc_seg OBC segment field The field name subroutine subroutine mom_open_boundary::allocate_obc_segment_data (OBC, segment) allocate_obc_segment_data OBC OBC segment segment Allocate segment data fields. obc Open boundary structure segment Open boundary segment rotate_obc_config setup_u_point_obc setup_v_point_obc subroutine subroutine mom_open_boundary::deallocate_obc_segment_data (OBC, segment) deallocate_obc_segment_data OBC OBC segment segment Deallocate segment data fields. obc Open boundary structure segment Open boundary segment segment_tracer_registry_end open_boundary_dealloc subroutine, public subroutine, public mom_open_boundary::open_boundary_test_extern_uv (G, OBC, u, v) open_boundary_test_extern_uv G G OBC OBC u u v v Set tangential velocities outside of open boundaries to silly values (used for checking the interior state is independent of values outside of the domain). g Ocean grid structure obc Open boundary structure u Zonal velocity [L T-1 ~> m s-1] v Meridional velocity [L T-1 ~> m s-1] obc_direction_e obc_direction_n subroutine, public subroutine, public mom_open_boundary::open_boundary_test_extern_h (G, GV, OBC, h) open_boundary_test_extern_h G G GV GV OBC OBC h h Set thicknesses outside of open boundaries to silly values (used for checking the interior state is independent of values outside of the domain). g Ocean grid structure gv Ocean vertical grid structure obc Open boundary structure h Layer thickness [H ~> m or kg m-2] obc_direction_e obc_direction_n mom_dynamics_split_rk2::step_mom_dyn_split_rk2 subroutine, public subroutine, public mom_open_boundary::update_obc_segment_data (G, GV, US, OBC, tv, h, Time) update_obc_segment_data G G GV GV US US OBC OBC tv tv h h Time Time Update the OBC values on the segments. g Ocean grid structure gv Ocean vertical grid structure us A dimensional unit scaling type obc Open boundary structure tv Thermodynamics structure h Thickness [H ~> m or kg m-2] time Model time adjustsegmentetatofitbathymetry obc_direction_e obc_direction_n obc_direction_s obc_direction_w mom_remapping::remapping_core_h mom_state_initialization::mom_initialize_state subroutine, public subroutine, public mom_open_boundary::update_obc_ramp (Time, OBC, activate) update_obc_ramp Time Time OBC OBC activate activate Update the OBC ramp value as a function of time. If called with the optional argument activate=.true., record the value of Time as the beginning of the ramp period. time Current model time obc Open boundary structure activate Specifiy whether to record the value of Time as the beginning of the ramp period mom_dynamics_split_rk2::step_mom_dyn_split_rk2 subroutine, public subroutine, public mom_open_boundary::register_obc (name, param_file, Reg) register_obc name name param_file param_file Reg Reg register open boundary objects for boundary updates. name OBC name used for error messages param_file file to parse for model parameter values reg pointer to the tracer registry obc_registry_init dyed_channel_initialization::register_dyed_channel_obc register_file_obc subroutine, public subroutine, public mom_open_boundary::obc_registry_init (param_file, Reg) obc_registry_init param_file param_file Reg Reg This routine include declares and sets the variable "version". param_file open file to parse for model parameters reg pointer to OBC registry register_obc logical function, public logical function, public mom_open_boundary::register_file_obc (param_file, CS, OBC_Reg) register_file_obc param_file param_file CS CS OBC_Reg OBC_Reg Add file to OBC registry. param_file parameter file. cs file control structure. obc_reg OBC registry. register_obc mom_boundary_update::call_obc_register subroutine, public subroutine, public mom_open_boundary::file_obc_end (CS) file_obc_end CS CS Clean up the file OBC from registry. cs OBC file control structure. mom_boundary_update::obc_register_end subroutine, public subroutine, public mom_open_boundary::segment_tracer_registry_init (param_file, segment) segment_tracer_registry_init param_file param_file segment segment Initialize the segment tracer registry. param_file open file to parse for model parameters segment the segment mdl register_segment_tracer subroutine, public subroutine, public mom_open_boundary::register_segment_tracer (tr_ptr, param_file, GV, segment, OBC_scalar, OBC_array) register_segment_tracer tr_ptr tr_ptr param_file param_file GV GV segment segment OBC_scalar OBC_scalar OBC_array OBC_array gv ocean vertical grid structure tr_ptr A target that can be used to set a pointer to the stored value of tr. This target must be an enduring part of the control structure, because the tracer registry will use this memory, but it also means that any updates to this structure in the calling module will be available subsequently to the tracer registry. param_file file to parse for model parameter values segment current segment data structure obc_scalar If present, use scalar value for segment tracer inflow concentration. obc_array If true, use array values for segment tracer inflow concentration. segment_tracer_registry_init dome_initialization::dome_set_obc_data dyed_obcs_initialization::dyed_obcs_set_obc_data register_temp_salt_segments subroutine, public subroutine, public mom_open_boundary::segment_tracer_registry_end (Reg) segment_tracer_registry_end Reg Reg Clean up the segment tracer registry. reg pointer to tracer registry deallocate_obc_segment_data subroutine, public subroutine, public mom_open_boundary::register_temp_salt_segments (GV, OBC, tr_Reg, param_file) register_temp_salt_segments GV GV OBC OBC tr_Reg tr_Reg param_file param_file gv ocean vertical grid structure obc Open boundary structure tr_reg Tracer registry param_file file to parse for model parameter values register_segment_tracer mom_tracer_registry::tracer_name_lookup subroutine, public subroutine, public mom_open_boundary::fill_temp_salt_segments (G, OBC, tv) fill_temp_salt_segments G G OBC OBC tv tv g Ocean grid structure obc Open boundary structure tv Thermodynamics structure obc_direction_s obc_direction_w setup_obc_tracer_reservoirs rotate_obc_init subroutine subroutine mom_open_boundary::mask_outside_obcs (G, US, param_file, OBC) mask_outside_obcs G G US US param_file param_file OBC OBC Find the region outside of all open boundary segments and make sure it is set to land mask. Gonna need to know global land mask as well to get it right... g Ocean grid structure param_file Parameter file handle obc Open boundary structure us A dimensional unit scaling type flood_fill flood_fill2 mdl obc_direction_e obc_direction_n obc_direction_s obc_direction_w obc_none open_boundary_config subroutine subroutine mom_open_boundary::flood_fill (G, color, cin, cout, cland) flood_fill G G color color cin cin cout cout cland cland flood the cin, cout values g Ocean grid structure color For sorting inside from outside cin color for inside the domain cout color for outside the domain cland color for inside the land mask mask_outside_obcs subroutine subroutine mom_open_boundary::flood_fill2 (G, color, cin, cout, cland) flood_fill2 G G color color cin cin cout cout cland cland flood the cin, cout values g Ocean grid structure color For sorting inside from outside cin color for inside the domain cout color for outside the domain cland color for inside the land mask mask_outside_obcs subroutine, public subroutine, public mom_open_boundary::open_boundary_register_restarts (HI, GV, OBC, Reg, param_file, restart_CSp, use_temperature) open_boundary_register_restarts HI HI GV GV OBC OBC Reg Reg param_file param_file restart_CSp restart_CSp use_temperature use_temperature Register OBC segment data for restarts. hi Horizontal indices gv Container for vertical grid information obc OBC data structure, data intent(inout) reg pointer to tracer registry param_file Parameter file handle restart_csp Restart structure, data intent(inout) use_temperature If true, T and S are used parse_for_tracer_reservoirs mom_io::var_desc subroutine, public subroutine, public mom_open_boundary::update_segment_tracer_reservoirs (G, GV, uhr, vhr, h, OBC, dt, Reg) update_segment_tracer_reservoirs G G GV GV uhr uhr vhr vhr h h OBC OBC dt dt Reg Reg Update the OBC tracer reservoirs after the tracers have been updated. g The ocean's grid structure gv Ocean vertical grid structure uhr accumulated volume/mass flux through the zonal face [H L2 ~> m3 or kg] vhr accumulated volume/mass flux through the meridional face [H L2 ~> m3 or kg] h layer thickness after advection [H ~> m or kg m-2] obc Open boundary structure dt time increment [T ~> s] reg pointer to tracer registry obc_direction_s obc_direction_w subroutine subroutine mom_open_boundary::adjustsegmentetatofitbathymetry (G, GV, US, segment, fld) adjustsegmentetatofitbathymetry G G GV GV US US segment segment fld fld 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 segment pointer to segment type fld field index to adjust thickness update_obc_segment_data subroutine, public subroutine, public mom_open_boundary::rotate_obc_config (OBC_in, G_in, OBC, G, turns) rotate_obc_config OBC_in OBC_in G_in G_in OBC OBC G G turns turns This is more of a rotate initialization than an actual rotate. obc_in Input OBC g_in Input grid metric obc Rotated OBC g Rotated grid metric turns Number of quarter turns allocate_obc_segment_data rotate_obc_segment_config rotate_obc_segment_data subroutine subroutine mom_open_boundary::rotate_obc_segment_config (segment_in, G_in, segment, G, turns) rotate_obc_segment_config segment_in segment_in G_in G_in segment segment G G turns turns Rotate the OBC segment configuration data from the input to model index map. segment_in Input OBC segment g_in Input grid metric segment Rotated OBC segment g Rotated grid metric turns Number of quarter turns obc_direction_e obc_direction_n obc_direction_s obc_direction_w obc_none setup_segment_indices rotate_obc_config subroutine, public subroutine, public mom_open_boundary::rotate_obc_init (OBC_in, G, GV, US, param_file, tv, restart_CSp, OBC) rotate_obc_init OBC_in OBC_in G G GV GV US US param_file param_file tv tv restart_CSp restart_CSp OBC OBC Initialize the segments and field-related data of a rotated OBC. obc_in OBC on input map g Rotated grid metric gv Vertical grid us Unit scaling param_file Input parameters tv Tracer fields restart_csp Restart CS obc Rotated OBC fill_temp_salt_segments open_boundary_init rotate_obc_segment_data subroutine subroutine mom_open_boundary::rotate_obc_segment_data (segment_in, segment, turns) rotate_obc_segment_data segment_in segment_in segment segment turns turns Rotate an OBC segment's fields from the input to the model index map. rotate_obc_config rotate_obc_init Controls where open boundary conditions are applied. This module implements some aspects of internal open boundary conditions in MOM.A small fragment of the grid is shown below:j+1 x ^ x ^ x At x: q, CoriolisBu j+1 > o > o > At ^: v, tauy j x ^ x ^ x At >: u, taux j > o > o > At o: h, bathyT, buoy, tr, T, S, Rml, ustar j-1 x ^ x ^ x i-1 i i+1 At x & ^: i i+1 At > & o:The boundaries always run through q grid points (x).