mom_domains::create_group_pass subroutine subroutine mom_domains::create_group_pass::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. subroutine subroutine mom_domains::create_group_pass::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. subroutine subroutine mom_domains::create_group_pass::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. subroutine subroutine mom_domains::create_group_pass::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. Set up a group of halo updates. mom_domains::create_group_passcreate_var_group_pass_2d mom_domains::create_group_passcreate_var_group_pass_3d mom_domains::create_group_passcreate_vector_group_pass_2d mom_domains::create_group_passcreate_vector_group_pass_3d