Complete a non-blocking halo update on an array.
Definition at line 64 of file MOM_domains.F90.
|
subroutine | pass_var_complete_3d (id_update, array, MOM_dom, sideflag, position, halo, clock) |
| pass_var_complete_3d completes a halo update for a three-dimensional array. More...
|
|
subroutine | pass_var_complete_2d (id_update, array, MOM_dom, sideflag, position, halo, clock) |
| pass_var_complete_2d completes a halo update for a two-dimensional array. More...
|
|
◆ pass_var_complete_2d()
subroutine mom_domains::pass_var_complete::pass_var_complete_2d |
( |
integer, intent(in) |
id_update, |
|
|
real, dimension(:,:), intent(inout) |
array, |
|
|
type(mom_domain_type), intent(inout) |
MOM_dom, |
|
|
integer, intent(in), optional |
sideflag, |
|
|
integer, intent(in), optional |
position, |
|
|
integer, intent(in), optional |
halo, |
|
|
integer, intent(in), optional |
clock |
|
) |
| |
|
private |
pass_var_complete_2d completes a halo update for a two-dimensional array.
- Parameters
-
[in] | id_update | The integer id of this update which has been returned from a previous call to pass_var_start. |
[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] | halo | The size of the halo to update - the full halo by default. |
[in] | clock | The handle for a cpu time clock that should be started then stopped to time this routine. |
Definition at line 377 of file MOM_domains.F90.
377 integer,
intent(in) :: id_update
380 real,
dimension(:,:),
intent(inout) :: array
382 type(MOM_domain_type),
intent(inout) :: MOM_dom
385 integer,
optional,
intent(in) :: sideflag
389 integer,
optional,
intent(in) :: position
392 integer,
optional,
intent(in) :: halo
394 integer,
optional,
intent(in) :: clock
399 if (
present(clock))
then ;
if (clock>0)
call cpu_clock_begin(clock) ;
endif
402 if (
present(sideflag))
then ;
if (sideflag > 0) dirflag = sideflag ;
endif
404 if (
present(halo) .and. mom_dom%thin_halo_updates)
then
405 call mpp_complete_update_domains(id_update, array, mom_dom%mpp_domain, &
406 flags=dirflag, position=position, &
407 whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)
409 call mpp_complete_update_domains(id_update, array, mom_dom%mpp_domain, &
410 flags=dirflag, position=position)
413 if (
present(clock))
then ;
if (clock>0)
call cpu_clock_end(clock) ;
endif
◆ pass_var_complete_3d()
subroutine mom_domains::pass_var_complete::pass_var_complete_3d |
( |
integer, intent(in) |
id_update, |
|
|
real, dimension(:,:,:), intent(inout) |
array, |
|
|
type(mom_domain_type), intent(inout) |
MOM_dom, |
|
|
integer, intent(in), optional |
sideflag, |
|
|
integer, intent(in), optional |
position, |
|
|
integer, intent(in), optional |
halo, |
|
|
integer, intent(in), optional |
clock |
|
) |
| |
|
private |
pass_var_complete_3d completes a halo update for a three-dimensional array.
- Parameters
-
[in] | id_update | The integer id of this update which has been returned from a previous call to pass_var_start. |
[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] | halo | The size of the halo to update - the full halo by default. |
[in] | clock | The handle for a cpu time clock that should be started then stopped to time this routine. |
Definition at line 420 of file MOM_domains.F90.
420 integer,
intent(in) :: id_update
423 real,
dimension(:,:,:),
intent(inout) :: array
425 type(MOM_domain_type),
intent(inout) :: MOM_dom
428 integer,
optional,
intent(in) :: sideflag
432 integer,
optional,
intent(in) :: position
435 integer,
optional,
intent(in) :: halo
437 integer,
optional,
intent(in) :: clock
442 if (
present(clock))
then ;
if (clock>0)
call cpu_clock_begin(clock) ;
endif
445 if (
present(sideflag))
then ;
if (sideflag > 0) dirflag = sideflag ;
endif
447 if (
present(halo) .and. mom_dom%thin_halo_updates)
then
448 call mpp_complete_update_domains(id_update, array, mom_dom%mpp_domain, &
449 flags=dirflag, position=position, &
450 whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)
452 call mpp_complete_update_domains(id_update, array, mom_dom%mpp_domain, &
453 flags=dirflag, position=position)
456 if (
present(clock))
then ;
if (clock>0)
call cpu_clock_end(clock) ;
endif
The documentation for this interface was generated from the following file:
- /glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/src/framework/MOM_domains.F90