mom_domains mom_domains::clone_mom_domain mom_domains::create_group_pass mom_domains::fill_symmetric_edges mom_domains::mom_domain_type mom_domains::pass_var mom_domains::pass_var_complete mom_domains::pass_var_start mom_domains::pass_vector mom_domains::pass_vector_complete mom_domains::pass_vector_start integer, parameter, public integer, parameter, public mom_domains::to_all to_all = To_East + To_West + To_North + To_South A flag for passing in all directions. mom_ice_shelf::add_shelf_forces mom_debugging::check_redundant_sb2d mom_debugging::chksum_vec_a2d mom_debugging::chksum_vec_a3d mom_debugging::chksum_vec_b2d mom_debugging::chksum_vec_b3d mom_debugging::chksum_vec_c2d mom_debugging::chksum_vec_c3d mom_transcribe_grid::copy_dyngrid_to_mom_grid mom_transcribe_grid::copy_mom_grid_to_dyngrid create_var_group_pass_2d create_var_group_pass_3d create_vector_group_pass_2d create_vector_group_pass_3d fill_vector_symmetric_edges_2d mom_ice_shelf_dynamics::ice_shelf_solve_inner mom_marine_ice::iceberg_forces mom_ice_shelf_dynamics::initialize_ice_shelf_dyn mom_open_boundary::open_boundary_init pass_var_2d pass_var_3d pass_var_complete_2d pass_var_complete_3d pass_var_start_2d pass_var_start_3d pass_vector_2d pass_vector_3d pass_vector_complete_2d pass_vector_complete_3d pass_vector_start_2d pass_vector_start_3d mom_shared_initialization::reset_face_lengths_file scm_cvmix_tests::scm_cvmix_tests_wind_forcing mom_ice_shelf::shelf_calc_flux mom_wave_interface::surface_bands_by_data_override mom_ice_shelf_dynamics::update_velocity_masks subroutine subroutine mom_domains::pass_var_3d (array, MOM_dom, sideflag, complete, position, halo, clock) pass_var_3d array array MOM_dom MOM_dom sideflag sideflag complete complete position position halo halo clock clock pass_var_3d does a halo update for a three-dimensional array. array The array which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. sideflag An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH. For example, TO_EAST sends the data to the processor to the east, sothe halos on the western side are filled. TO_ALL is the default if sideflag is omitted. complete An optional argument indicating whether the halo updates should be completed before progress resumes. Omitting complete is the same as setting complete to .true. position An optional argument indicating the position. This is CENTER by default and is often CORNER, but could also be EAST_FACE or NORTH_FACE. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. to_all subroutine subroutine mom_domains::pass_var_2d (array, MOM_dom, sideflag, complete, position, halo, inner_halo, clock) pass_var_2d array array MOM_dom MOM_dom sideflag sideflag complete complete position position halo halo inner_halo inner_halo clock clock pass_var_2d does a halo update for a two-dimensional array. array The array which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. sideflag An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if sideflag is omitted. complete An optional argument indicating whether the halo updates should be completed before progress resumes. Omitting complete is the same as setting complete to .true. position An optional argument indicating the position. This is CENTER by default and is often CORNER, but could also be EAST_FACE or NORTH_FACE. halo The size of the halo to update - the full halo by default. inner_halo The size of an inner halo to avoid updating, or 0 to avoid updating symmetric memory computational domain points. Setting this >=0 also enforces that complete=.true. clock The handle for a cpu time clock that should be started then stopped to time this routine. mom_error_handler::mom_error to_all integer function integer function mom_domains::pass_var_start_2d (array, MOM_dom, sideflag, position, complete, halo, clock) pass_var_start_2d array array MOM_dom MOM_dom sideflag sideflag position position complete complete halo halo clock clock pass_var_start_2d starts a halo update for a two-dimensional array. array The array which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. sideflag An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if sideflag is omitted. position An optional argument indicating the position. This is CENTER by default and is often CORNER, but could also be EAST_FACE or NORTH_FACE. complete An optional argument indicating whether the halo updates should be completed before progress resumes. Omitting complete is the same as setting complete to .true. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. The integer index for this update. to_all integer function integer function mom_domains::pass_var_start_3d (array, MOM_dom, sideflag, position, complete, halo, clock) pass_var_start_3d array array MOM_dom MOM_dom sideflag sideflag position position complete complete halo halo clock clock pass_var_start_3d starts a halo update for a three-dimensional array. array The array which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. sideflag An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if sideflag is omitted. position An optional argument indicating the position. This is CENTER by default and is often CORNER, but could also be EAST_FACE or NORTH_FACE. complete An optional argument indicating whether the halo updates should be completed before progress resumes. Omitting complete is the same as setting complete to .true. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. The integer index for this update. to_all subroutine subroutine mom_domains::pass_var_complete_2d (id_update, array, MOM_dom, sideflag, position, halo, clock) pass_var_complete_2d id_update id_update array array MOM_dom MOM_dom sideflag sideflag position position halo halo clock clock pass_var_complete_2d completes a halo update for a two-dimensional array. id_update The integer id of this update which has been returned from a previous call to pass_var_start. array The array which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. sideflag An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if sideflag is omitted. position An optional argument indicating the position. This is CENTER by default and is often CORNER, but could also be EAST_FACE or NORTH_FACE. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. to_all subroutine subroutine mom_domains::pass_var_complete_3d (id_update, array, MOM_dom, sideflag, position, halo, clock) pass_var_complete_3d id_update id_update array array MOM_dom MOM_dom sideflag sideflag position position halo halo clock clock pass_var_complete_3d completes a halo update for a three-dimensional array. id_update The integer id of this update which has been returned from a previous call to pass_var_start. array The array which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. sideflag An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if sideflag is omitted. position An optional argument indicating the position. This is CENTER by default and is often CORNER, but could also be EAST_FACE or NORTH_FACE. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. to_all subroutine subroutine mom_domains::pass_vector_2d (u_cmpt, v_cmpt, MOM_dom, direction, stagger, complete, halo, clock) pass_vector_2d u_cmpt u_cmpt v_cmpt v_cmpt MOM_dom MOM_dom direction direction stagger stagger complete complete halo halo clock clock pass_vector_2d does a halo update for a pair of two-dimensional arrays representing the compontents of a two-dimensional horizontal vector. u_cmpt The nominal zonal (u) component of the vector pair which is having its halos points exchanged. v_cmpt The nominal meridional (v) component of the vector pair which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. direction An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH, possibly plus SCALAR_PAIR if these are paired non-directional scalars discretized at the typical vector component locations. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if omitted. stagger An optional flag, which may be one of A_GRID, BGRID_NE, or CGRID_NE, indicating where the two components of the vector are discretized. Omitting stagger is the same as setting it to CGRID_NE. complete An optional argument indicating whether the halo updates should be completed before progress resumes. Omitting complete is the same as setting complete to .true. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. to_all subroutine subroutine mom_domains::fill_vector_symmetric_edges_2d (u_cmpt, v_cmpt, MOM_dom, stagger, scalar, clock) fill_vector_symmetric_edges_2d u_cmpt u_cmpt v_cmpt v_cmpt MOM_dom MOM_dom stagger stagger scalar scalar clock clock fill_vector_symmetric_edges_2d does an usual set of halo updates that only fill in the values at the edge of a pair of symmetric memory two-dimensional arrays representing the compontents of a two-dimensional horizontal vector. If symmetric memory is not being used, this subroutine does nothing except to possibly turn optional cpu clocks on or off. u_cmpt The nominal zonal (u) component of the vector pair which is having its halos points exchanged. v_cmpt The nominal meridional (v) component of the vector pair which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. stagger An optional flag, which may be one of A_GRID, BGRID_NE, or CGRID_NE, indicating where the two components of the vector are discretized. Omitting stagger is the same as setting it to CGRID_NE. scalar An optional argument indicating whether. clock The handle for a cpu time clock that should be started then stopped to time this routine. to_all subroutine subroutine mom_domains::pass_vector_3d (u_cmpt, v_cmpt, MOM_dom, direction, stagger, complete, halo, clock) pass_vector_3d u_cmpt u_cmpt v_cmpt v_cmpt MOM_dom MOM_dom direction direction stagger stagger complete complete halo halo clock clock pass_vector_3d does a halo update for a pair of three-dimensional arrays representing the compontents of a three-dimensional horizontal vector. u_cmpt The nominal zonal (u) component of the vector pair which is having its halos points exchanged. v_cmpt The nominal meridional (v) component of the vector pair which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. direction An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH, possibly plus SCALAR_PAIR if these are paired non-directional scalars discretized at the typical vector component locations. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if omitted. stagger An optional flag, which may be one of A_GRID, BGRID_NE, or CGRID_NE, indicating where the two components of the vector are discretized. Omitting stagger is the same as setting it to CGRID_NE. complete An optional argument indicating whether the halo updates should be completed before progress resumes. Omitting complete is the same as setting complete to .true. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. to_all integer function integer function mom_domains::pass_vector_start_2d (u_cmpt, v_cmpt, MOM_dom, direction, stagger, complete, halo, clock) pass_vector_start_2d u_cmpt u_cmpt v_cmpt v_cmpt MOM_dom MOM_dom direction direction stagger stagger complete complete halo halo clock clock pass_vector_start_2d starts a halo update for a pair of two-dimensional arrays representing the compontents of a two-dimensional horizontal vector. u_cmpt The nominal zonal (u) component of the vector pair which is having its halos points exchanged. v_cmpt The nominal meridional (v) component of the vector pair which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. direction An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH, possibly plus SCALAR_PAIR if these are paired non-directional scalars discretized at the typical vector component locations. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if omitted. stagger An optional flag, which may be one of A_GRID, BGRID_NE, or CGRID_NE, indicating where the two components of the vector are discretized. Omitting stagger is the same as setting it to CGRID_NE. complete An optional argument indicating whether the halo updates should be completed before progress resumes. Omitting complete is the same as setting complete to .true. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. The integer index for this update. to_all integer function integer function mom_domains::pass_vector_start_3d (u_cmpt, v_cmpt, MOM_dom, direction, stagger, complete, halo, clock) pass_vector_start_3d u_cmpt u_cmpt v_cmpt v_cmpt MOM_dom MOM_dom direction direction stagger stagger complete complete halo halo clock clock pass_vector_start_3d starts a halo update for a pair of three-dimensional arrays representing the compontents of a three-dimensional horizontal vector. u_cmpt The nominal zonal (u) component of the vector pair which is having its halos points exchanged. v_cmpt The nominal meridional (v) component of the vector pair which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. direction An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH, possibly plus SCALAR_PAIR if these are paired non-directional scalars discretized at the typical vector component locations. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if omitted. stagger An optional flag, which may be one of A_GRID, BGRID_NE, or CGRID_NE, indicating where the two components of the vector are discretized. Omitting stagger is the same as setting it to CGRID_NE. complete An optional argument indicating whether the halo updates should be completed before progress resumes. Omitting complete is the same as setting complete to .true. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. The integer index for this update. to_all subroutine subroutine mom_domains::pass_vector_complete_2d (id_update, u_cmpt, v_cmpt, MOM_dom, direction, stagger, halo, clock) pass_vector_complete_2d id_update id_update u_cmpt u_cmpt v_cmpt v_cmpt MOM_dom MOM_dom direction direction stagger stagger halo halo clock clock pass_vector_complete_2d completes a halo update for a pair of two-dimensional arrays representing the compontents of a two-dimensional horizontal vector. id_update The integer id of this update which has been returned from a previous call to pass_var_start. u_cmpt The nominal zonal (u) component of the vector pair which is having its halos points exchanged. v_cmpt The nominal meridional (v) component of the vector pair which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. direction An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH, possibly plus SCALAR_PAIR if these are paired non-directional scalars discretized at the typical vector component locations. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if omitted. stagger An optional flag, which may be one of A_GRID, BGRID_NE, or CGRID_NE, indicating where the two components of the vector are discretized. Omitting stagger is the same as setting it to CGRID_NE. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. to_all subroutine subroutine mom_domains::pass_vector_complete_3d (id_update, u_cmpt, v_cmpt, MOM_dom, direction, stagger, halo, clock) pass_vector_complete_3d id_update id_update u_cmpt u_cmpt v_cmpt v_cmpt MOM_dom MOM_dom direction direction stagger stagger halo halo clock clock pass_vector_complete_3d completes a halo update for a pair of three-dimensional arrays representing the compontents of a three-dimensional horizontal vector. id_update The integer id of this update which has been returned from a previous call to pass_var_start. u_cmpt The nominal zonal (u) component of the vector pair which is having its halos points exchanged. v_cmpt The nominal meridional (v) component of the vector pair which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. direction An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH, possibly plus SCALAR_PAIR if these are paired non-directional scalars discretized at the typical vector component locations. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if omitted. stagger An optional flag, which may be one of A_GRID, BGRID_NE, or CGRID_NE, indicating where the two components of the vector are discretized. Omitting stagger is the same as setting it to CGRID_NE. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. to_all subroutine subroutine mom_domains::create_var_group_pass_2d (group, array, MOM_dom, sideflag, position, halo, clock) create_var_group_pass_2d group group array array MOM_dom MOM_dom sideflag sideflag position position halo halo clock clock create_var_group_pass_2d sets up a group of two-dimensional array halo updates. group The data type that store information for group update. This data will be used in do_group_pass. array The array which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. sideflag An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if sideflag is omitted. position An optional argument indicating the position. This is CENTER by default and is often CORNER, but could also be EAST_FACE or NORTH_FACE. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. to_all subroutine subroutine mom_domains::create_var_group_pass_3d (group, array, MOM_dom, sideflag, position, halo, clock) create_var_group_pass_3d group group array array MOM_dom MOM_dom sideflag sideflag position position halo halo clock clock create_var_group_pass_3d sets up a group of three-dimensional array halo updates. group The data type that store information for group update. This data will be used in do_group_pass. array The array which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. sideflag An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if sideflag is omitted. position An optional argument indicating the position. This is CENTER by default and is often CORNER, but could also be EAST_FACE or NORTH_FACE. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. to_all subroutine subroutine mom_domains::create_vector_group_pass_2d (group, u_cmpt, v_cmpt, MOM_dom, direction, stagger, halo, clock) create_vector_group_pass_2d group group u_cmpt u_cmpt v_cmpt v_cmpt MOM_dom MOM_dom direction direction stagger stagger halo halo clock clock create_vector_group_pass_2d sets up a group of two-dimensional vector halo updates. group The data type that store information for group update. This data will be used in do_group_pass. u_cmpt The nominal zonal (u) component of the vector pair which is having its halos points exchanged. v_cmpt The nominal meridional (v) component of the vector pair which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent direction An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH, possibly plus SCALAR_PAIR if these are paired non-directional scalars discretized at the typical vector component locations. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if omitted. stagger An optional flag, which may be one of A_GRID, BGRID_NE, or CGRID_NE, indicating where the two components of the vector are discretized. Omitting stagger is the same as setting it to CGRID_NE. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. to_all subroutine subroutine mom_domains::create_vector_group_pass_3d (group, u_cmpt, v_cmpt, MOM_dom, direction, stagger, halo, clock) create_vector_group_pass_3d group group u_cmpt u_cmpt v_cmpt v_cmpt MOM_dom MOM_dom direction direction stagger stagger halo halo clock clock create_vector_group_pass_3d sets up a group of three-dimensional vector halo updates. group The data type that store information for group update. This data will be used in do_group_pass. u_cmpt The nominal zonal (u) component of the vector pair which is having its halos points exchanged. v_cmpt The nominal meridional (v) component of the vector pair which is having its halos points exchanged. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. direction An optional integer indicating which directions the data should be sent. It is TO_ALL or the sum of any of TO_EAST, TO_WEST, TO_NORTH, and TO_SOUTH, possibly plus SCALAR_PAIR if these are paired non-directional scalars discretized at the typical vector component locations. For example, TO_EAST sends the data to the processor to the east, so the halos on the western side are filled. TO_ALL is the default if omitted. stagger An optional flag, which may be one of A_GRID, BGRID_NE, or CGRID_NE, indicating where the two components of the vector are discretized. Omitting stagger is the same as setting it to CGRID_NE. halo The size of the halo to update - the full halo by default. clock The handle for a cpu time clock that should be started then stopped to time this routine. to_all subroutine, public subroutine, public mom_domains::do_group_pass (group, MOM_dom, clock) do_group_pass group group MOM_dom MOM_dom clock clock do_group_pass carries out a group halo update. group The data type that store information for group update. This data will be used in do_group_pass. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. clock The handle for a cpu time clock that should be started then stopped to time this routine. mom_tracer_advect::advect_tracer mom_ale::ale_regrid_accelerated mom_bulk_mixed_layer::bulkmixedlayer mom_diabatic_driver::diabatic_ale mom_diabatic_driver::layered_diabatic mom_meke::meke_init mom_meke::step_forward_meke subroutine, public subroutine, public mom_domains::start_group_pass (group, MOM_dom, clock) start_group_pass group group MOM_dom MOM_dom clock clock start_group_pass starts out a group halo update. group The data type that store information for group update. This data will be used in do_group_pass. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. clock The handle for a cpu time clock that should be started then stopped to time this routine. mom_barotropic::btstep mom_internal_tides::propagate_int_tide mom::step_mom mom_dynamics_split_rk2::step_mom_dyn_split_rk2 subroutine, public subroutine, public mom_domains::complete_group_pass (group, MOM_dom, clock) complete_group_pass group group MOM_dom MOM_dom clock clock complete_group_pass completes a group halo update. group The data type that store information for group update. This data will be used in do_group_pass. mom_dom The MOM_domain_type containing the mpp_domain needed to determine where data should be sent. clock The handle for a cpu time clock that should be started then stopped to time this routine. mom_barotropic::btstep mom_internal_tides::propagate_int_tide mom::step_mom mom_dynamics_split_rk2::step_mom_dyn_split_rk2 subroutine, public subroutine, public mom_domains::mom_domains_init (MOM_dom, param_file, symmetric, static_memory, NIHALO, NJHALO, NIGLOBAL, NJGLOBAL, NIPROC, NJPROC, min_halo, domain_name, include_name, param_suffix) mom_domains_init MOM_dom MOM_dom param_file param_file symmetric symmetric static_memory static_memory NIHALO NIHALO NJHALO NJHALO NIGLOBAL NIGLOBAL NJGLOBAL NJGLOBAL NIPROC NIPROC NJPROC NJPROC min_halo min_halo domain_name domain_name include_name include_name param_suffix param_suffix MOM_domains_init initalizes a MOM_domain_type variable, based on the information read in from a param_file_type, and optionally returns data describing various' properties of the domain type. mom_dom A pointer to the MOM_domain_type being defined here. param_file A structure to parse for run-time parameters symmetric If present, this specifies whether this domain is symmetric, regardless of whether the macro SYMMETRIC_MEMORY_ is defined. static_memory If present and true, this domain type is set up for static memory and error checking of various input values is performed against those in the input file. nihalo Default halo sizes, required with static memory. njhalo Default halo sizes, required with static memory. niglobal Total domain sizes, required with static memory. njglobal Total domain sizes, required with static memory. niproc Processor counts, required with static memory. njproc Processor counts, required with static memory. min_halo If present, this sets the minimum halo size for this domain in the i- and j- directions, and returns the actual halo size used. domain_name A name for this domain, "MOM" if missing. include_name A name for model's include file, "MOM_memory.h" if missing. param_suffix A suffix to apply to layout-specific parameters. mom_error_handler::mom_error mom_error_handler::mom_mesg mom_string_functions::slasher mom_oda_driver_mod::init_oda subroutine subroutine mom_domains::clone_md_to_md (MD_in, MOM_dom, min_halo, halo_size, symmetric, domain_name, turns) clone_md_to_md MD_in MD_in MOM_dom MOM_dom min_halo min_halo halo_size halo_size symmetric symmetric domain_name domain_name turns turns clone_MD_to_MD copies one MOM_domain_type into another, while allowing some properties of the new type to differ from the original one. md_in An existing MOM_domain mom_dom A pointer to a MOM_domain that will be allocated if it is unassociated, and will have data copied from MD_in min_halo If present, this sets the halo_size If present, this sets the halo size for the domain in the i- and j-directions. min_halo and halo_size can not both be present. symmetric If present, this specifies whether the new domain is symmetric, regardless of whether the macro SYMMETRIC_MEMORY_ is defined. domain_name A name for the new domain, "MOM" turns Number of quarter turns mom_error_handler::mom_error subroutine subroutine mom_domains::clone_md_to_d2d (MD_in, mpp_domain, min_halo, halo_size, symmetric, domain_name, turns) clone_md_to_d2d MD_in MD_in mpp_domain mpp_domain min_halo min_halo halo_size halo_size symmetric symmetric domain_name domain_name turns turns clone_MD_to_d2D uses information from a MOM_domain_type to create a new domain2d type, while allowing some properties of the new type to differ from the original one. md_in An existing MOM_domain to be cloned mpp_domain The new mpp_domain to be set up min_halo If present, this sets the halo_size If present, this sets the halo size for the domain in the i- and j-directions. min_halo and halo_size can not both be present. symmetric If present, this specifies whether the new domain is symmetric, regardless of whether the macro SYMMETRIC_MEMORY_ is defined. domain_name A name for the new domain, "MOM" turns If true, swap X and Y axes mom_error_handler::mom_error subroutine, public subroutine, public mom_domains::get_domain_extent (Domain, isc, iec, jsc, jec, isd, ied, jsd, jed, isg, ieg, jsg, jeg, idg_offset, jdg_offset, symmetric, local_indexing, index_offset) get_domain_extent Domain Domain isc isc iec iec jsc jsc jec jec isd isd ied ied jsd jsd jed jed isg isg ieg ieg jsg jsg jeg jeg idg_offset idg_offset jdg_offset jdg_offset symmetric symmetric local_indexing local_indexing index_offset index_offset Returns various data that has been stored in a MOM_domain_type. domain The MOM domain from which to extract information isc The start i-index of the computational domain iec The end i-index of the computational domain jsc The start j-index of the computational domain jec The end j-index of the computational domain isd The start i-index of the data domain ied The end i-index of the data domain jsd The start j-index of the data domain jed The end j-index of the data domain isg The start i-index of the global domain ieg The end i-index of the global domain jsg The start j-index of the global domain jeg The end j-index of the global domain idg_offset The offset between the corresponding global and data i-index spaces. jdg_offset The offset between the corresponding global and data j-index spaces. symmetric True if symmetric memory is used. local_indexing If true, local tracer array indices start at 1, as in most MOM6 code. index_offset A fixed additional offset to all indices. This can be useful for some types of debugging with dynamic memory allocation. mom_hor_index::hor_index_init subroutine, public subroutine, public mom_domains::get_domain_extent_dsamp2 (Domain, isc_d2, iec_d2, jsc_d2, jec_d2, isd_d2, ied_d2, jsd_d2, jed_d2, isg_d2, ieg_d2, jsg_d2, jeg_d2) get_domain_extent_dsamp2 Domain Domain isc_d2 isc_d2 iec_d2 iec_d2 jsc_d2 jsc_d2 jec_d2 jec_d2 isd_d2 isd_d2 ied_d2 ied_d2 jsd_d2 jsd_d2 jed_d2 jed_d2 isg_d2 isg_d2 ieg_d2 ieg_d2 jsg_d2 jsg_d2 jeg_d2 jeg_d2 domain The MOM domain from which to extract information isc_d2 The start i-index of the computational domain iec_d2 The end i-index of the computational domain jsc_d2 The start j-index of the computational domain jec_d2 The end j-index of the computational domain isd_d2 The start i-index of the data domain ied_d2 The end i-index of the data domain jsd_d2 The start j-index of the data domain jed_d2 The end j-index of the data domain isg_d2 The start i-index of the global domain ieg_d2 The end i-index of the global domain jsg_d2 The start j-index of the global domain jeg_d2 The end j-index of the global domain mom_grid::mom_grid_init subroutine, public subroutine, public mom_domains::get_simple_array_i_ind (domain, size, is, ie, symmetric) get_simple_array_i_ind domain domain size size is is ie ie symmetric symmetric Return the (potentially symmetric) computational domain i-bounds for an array passed without index specifications (i.e. indices start at 1) based on an array size. domain MOM domain from which to extract information size The i-array size is The computational domain starting i-index. ie The computational domain ending i-index. symmetric If present, indicates whether symmetric sizes can be considered. mom_error_handler::mom_error mom_io::mom_read_data_2d mom_io::mom_read_data_3d mom_io::mom_read_data_4d mom_io::mom_read_vector_2d mom_io::mom_read_vector_3d subroutine, public subroutine, public mom_domains::get_simple_array_j_ind (domain, size, js, je, symmetric) get_simple_array_j_ind domain domain size size js js je je symmetric symmetric Return the (potentially symmetric) computational domain j-bounds for an array passed without index specifications (i.e. indices start at 1) based on an array size. domain MOM domain from which to extract information size The j-array size js The computational domain starting j-index. je The computational domain ending j-index. symmetric If present, indicates whether symmetric sizes can be considered. mom_error_handler::mom_error mom_io::mom_read_data_2d mom_io::mom_read_data_3d mom_io::mom_read_data_4d mom_io::mom_read_vector_2d mom_io::mom_read_vector_3d subroutine, public subroutine, public mom_domains::get_global_shape (domain, niglobal, njglobal) get_global_shape domain domain niglobal niglobal njglobal njglobal Returns the global shape of h-point arrays. domain MOM domain niglobal i-index global size of h-point arrays njglobal j-index global size of h-point arrays mom_grid::get_global_grid_size mom_hor_index::hor_index_init Describes the decomposed MOM domain and has routines for communications across PEs.