Detailed Description

Definition at line 81 of file MOM_domains.F90.

Private functions
integer function	pass_vector_start_3d (u_cmpt, v_cmpt, MOM_dom, direction, stagger, complete, halo)

integer function	pass_vector_start_2d (u_cmpt, v_cmpt, MOM_dom, direction, stagger, complete, halo)

Functions and subroutines

◆ pass_vector_start_2d()

integer function mom_domains::pass_vector_start::pass_vector_start_2d	(	real, dimension(:,:), intent(inout)	u_cmpt,
		real, dimension(:,:), intent(inout)	v_cmpt,
		type(mom_domain_type), intent(inout)	MOM_dom,
		integer, intent(in), optional	direction,
		integer, intent(in), optional	stagger,
		logical, intent(in), optional	complete,
		integer, intent(in), optional	halo
	)

private

Parameters

[in,out]	u_cmpt	The nominal zonal (u) component of the vector pair which is having its halos points exchanged.
[in,out]	v_cmpt	The nominal meridional (v) component of the vector pair which is having its halos points exchanged.
[in,out]	mom_dom	The MOM_domain_type containing the mpp_domain needed to determine where data should be sent.
[in]	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.
[in]	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.
[in]	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.
[in]	halo	The size of the halo to update - the full halo by default.

Returns: The integer index for this update.

Definition at line 680 of file MOM_domains.F90.

   real, dimension(:,:),   intent(inout) :: u_cmpt   !< The nominal zonal (u) component of the vector
                                                     !! pair which is having its halos points
                                                     !! exchanged.
   real, dimension(:,:),   intent(inout) :: v_cmpt   !< The nominal meridional (v) component of the
                                                     !! vector pair which is having its halos points
                                                     !! exchanged.
   type(mom_domain_type),  intent(inout) :: mom_dom  !< The MOM_domain_type containing the mpp_domain
                                                     !! needed to determine where data should be
                                                     !! sent.
   integer,      optional, intent(in)    :: 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.
   integer,      optional, intent(in)    :: 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.
   logical,      optional, intent(in)    :: 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.
   integer,      optional, intent(in)    :: halo     !< The size of the halo to update - the full
                                                     !! halo by default.
   integer                               :: pass_vector_start_2d !< The integer index for this
                                                                 !! update.
 ! Arguments: u_cmpt - The nominal zonal (u) component of the vector pair which
 !                     is having its halos points exchanged.
 !  (inout)   v_cmpt - The nominal meridional (v) component of the vector pair
 !                     which is having its halos points exchanged.
 !  (in)      MOM_dom - The MOM_domain_type containing the mpp_domain needed to
 !                      determine where data should be sent.
 !  (in)      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.
 !  (in)      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.
 !  (in)      complete - An optional argument indicating whether the halo updates
 !                       should be initiated immediately or wait for second
 !                       pass_..._start call.  Omitting complete is the same as
 !                       setting complete to .true.
 !  (in,opt)  halo - The size of the halo to update - the full halo by default.
 !  (return value) - The integer index for this update.
   integer :: stagger_local
   integer :: dirflag
 
   stagger_local = cgrid_ne ! Default value for type of grid
   if (present(stagger)) stagger_local = stagger
 
   dirflag = to_all ! 60
   if (present(direction)) then ; if (direction > 0) dirflag = direction ; endif
 
   if (present(halo) .and. mom_dom%thin_halo_updates) then
     pass_vector_start_2d = mpp_start_update_domains(u_cmpt, v_cmpt, &
         mom_dom%mpp_domain, flags=dirflag, gridtype=stagger_local, &
         whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)
   else
     pass_vector_start_2d = mpp_start_update_domains(u_cmpt, v_cmpt, &
         mom_dom%mpp_domain, flags=dirflag, gridtype=stagger_local)
   endif
 

◆ pass_vector_start_3d()

integer function mom_domains::pass_vector_start::pass_vector_start_3d	(	real, dimension(:,:,:), intent(inout)	u_cmpt,
		real, dimension(:,:,:), intent(inout)	v_cmpt,
		type(mom_domain_type), intent(inout)	MOM_dom,
		integer, intent(in), optional	direction,
		integer, intent(in), optional	stagger,
		logical, intent(in), optional	complete,
		integer, intent(in), optional	halo
	)

private

Parameters

[in,out]	u_cmpt	The nominal zonal (u) component of the vector pair which is having its halos points exchanged.
[in,out]	v_cmpt	The nominal meridional (v) component of the vector pair which is having its halos points exchanged.
[in,out]	mom_dom	The MOM_domain_type containing the mpp_domain needed to determine where data should be sent.
[in]	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.
[in]	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.
[in]	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.
[in]	halo	The size of the halo to update - the full halo by default.

Returns: The integer index for this update.

Definition at line 750 of file MOM_domains.F90.

   real, dimension(:,:,:), intent(inout) :: u_cmpt   !< The nominal zonal (u) component of the vector
                                                     !! pair which is having its halos points
                                                     !! exchanged.
   real, dimension(:,:,:), intent(inout) :: v_cmpt   !< The nominal meridional (v) component of the
                                                     !! vector pair which is having its halos points
                                                     !! exchanged.
   type(mom_domain_type),  intent(inout) :: mom_dom  !< The MOM_domain_type containing the mpp_domain
                                                     !! needed to determine where data should be
                                                     !! sent.
   integer,      optional, intent(in)    :: 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.
   integer,      optional, intent(in)    :: 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.
   logical,      optional, intent(in)    :: 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.
   integer,      optional, intent(in)    :: halo     !< The size of the halo to update - the full
                                                     !! halo by default.
   integer                               :: pass_vector_start_3d !< The integer index for this
                                                                 !! update.
 ! Arguments: u_cmpt - The nominal zonal (u) component of the vector pair which
 !                     is having its halos points exchanged.
 !  (inout)   v_cmpt - The nominal meridional (v) component of the vector pair
 !                     which is having its halos points exchanged.
 !  (in)      MOM_dom - The MOM_domain_type containing the mpp_domain needed to
 !                      determine where data should be sent.
 !  (in)      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.
 !  (in)      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.
 !  (in)      complete - An optional argument indicating whether the halo updates
 !                       should be initiated immediately or wait for second
 !                       pass_..._start call.  Omitting complete is the same as
 !                       setting complete to .true.
 !  (in,opt)  halo - The size of the halo to update - the full halo by default.
 !  (return value) - The integer index for this update.
   integer :: stagger_local
   integer :: dirflag
 
   stagger_local = cgrid_ne ! Default value for type of grid
   if (present(stagger)) stagger_local = stagger
 
   dirflag = to_all ! 60
   if (present(direction)) then ; if (direction > 0) dirflag = direction ; endif
 
   if (present(halo) .and. mom_dom%thin_halo_updates) then
     pass_vector_start_3d = mpp_start_update_domains(u_cmpt, v_cmpt, &
         mom_dom%mpp_domain, flags=dirflag, gridtype=stagger_local, &
         whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)
   else
     pass_vector_start_3d = mpp_start_update_domains(u_cmpt, v_cmpt, &
         mom_dom%mpp_domain, flags=dirflag, gridtype=stagger_local)
   endif
 

The documentation for this interface was generated from the following file:

/home/adcroft/GitHub/workspace/Gaea-stats-MOM6-examples/MOM6-examples/src/MOM6/src/framework/MOM_domains.F90

Detailed Description

Private functions

Functions and subroutines

◆ pass_vector_start_2d()

◆ pass_vector_start_3d()