Detailed Description

Definition at line 73 of file MOM_domains.F90.

Private functions
integer function	pass_var_start_3d (array, MOM_dom, sideflag, position, complete, halo)

integer function	pass_var_start_2d (array, MOM_dom, sideflag, position, complete, halo)

Functions and subroutines

◆ pass_var_start_2d()

integer function mom_domains::pass_var_start::pass_var_start_2d	(	real, dimension(:,:), intent(inout)	array,
		type(mom_domain_type), intent(inout)	MOM_dom,
		integer, intent(in), optional	sideflag,
		integer, intent(in), optional	position,
		logical, intent(in), optional	complete,
		integer, intent(in), optional	halo
	)

private

Parameters

[in,out]	array	The array 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]	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.
[in]	position	An optional argument indicating the position. This is usally CORNER, but is CENTER by default.
[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 251 of file MOM_domains.F90.

   real, dimension(:,:),   intent(inout) :: array    !< The array 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)    :: 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.
   integer,      optional, intent(in)    :: position !< An optional argument indicating the position.
                                                     !! This is usally CORNER, but is CENTER
                                                     !! by default.
   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_var_start_2d  !<The integer index for this update.
 ! Arguments: array - The array 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)      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.
 !  (in)      position - An optional argument indicating the position.  This is
 !                       may be CORNER, but is CENTER by default.
 !  (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 :: dirflag
 
   dirflag = to_all ! 60
   if (present(sideflag)) then ; if (sideflag > 0) dirflag = sideflag ; endif
 
   if (present(halo) .and. mom_dom%thin_halo_updates) then
     pass_var_start_2d = mpp_start_update_domains(array, mom_dom%mpp_domain, &
                             flags=dirflag, position=position, &
                             whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)
   else
     pass_var_start_2d = mpp_start_update_domains(array, mom_dom%mpp_domain, &
                             flags=dirflag, position=position)
   endif

◆ pass_var_start_3d()

integer function mom_domains::pass_var_start::pass_var_start_3d	(	real, dimension(:,:,:), intent(inout)	array,
		type(mom_domain_type), intent(inout)	MOM_dom,
		integer, intent(in), optional	sideflag,
		integer, intent(in), optional	position,
		logical, intent(in), optional	complete,
		integer, intent(in), optional	halo
	)

private

Parameters

[in,out]	array	The array 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]	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.
[in]	position	An optional argument indicating the position. This is usally CORNER, but is CENTER by default.
[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 303 of file MOM_domains.F90.

   real, dimension(:,:,:), intent(inout) :: array    !< The array 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)    :: 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.
   integer,      optional, intent(in)    :: position !< An optional argument indicating the position.
                                                     !! This is usally CORNER, but is CENTER
                                                     !! by default.
   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_var_start_3d  !< The integer index for this update.
 ! Arguments: array - The array 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)      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.
 !  (in)      position - An optional argument indicating the position.  This is
 !                       may be CORNER, but is CENTER by default.
 !  (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 :: dirflag
 
   dirflag = to_all ! 60
   if (present(sideflag)) then ; if (sideflag > 0) dirflag = sideflag ; endif
 
   if (present(halo) .and. mom_dom%thin_halo_updates) then
     pass_var_start_3d = mpp_start_update_domains(array, mom_dom%mpp_domain, &
                             flags=dirflag, position=position, &
                             whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)
   else
     pass_var_start_3d = mpp_start_update_domains(array, mom_dom%mpp_domain, &
                             flags=dirflag, position=position)
   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_var_start_2d()

◆ pass_var_start_3d()