Do a halo update on a pair of arrays representing the two components of a vector.
Definition at line 54 of file MOM_domains.F90.
|
subroutine | pass_vector_3d (u_cmpt, v_cmpt, MOM_dom, direction, stagger, complete, halo, clock) |
| pass_vector_3d does a halo update for a pair of three-dimensional arrays representing the compontents of a three-dimensional horizontal vector. More...
|
|
subroutine | pass_vector_2d (u_cmpt, v_cmpt, MOM_dom, direction, stagger, complete, halo, clock) |
| pass_vector_2d does a halo update for a pair of two-dimensional arrays representing the compontents of a two-dimensional horizontal vector. More...
|
|
◆ pass_vector_2d()
subroutine mom_domains::pass_vector::pass_vector_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, |
|
|
integer, intent(in), optional |
clock |
|
) |
| |
|
private |
pass_vector_2d does a halo update for a pair of two-dimensional arrays representing the compontents of a two-dimensional horizontal vector.
- 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. |
[in] | clock | The handle for a cpu time clock that should be started then stopped to time this routine. |
Definition at line 464 of file MOM_domains.F90.
464 real,
dimension(:,:),
intent(inout) :: u_cmpt
467 real,
dimension(:,:),
intent(inout) :: v_cmpt
470 type(MOM_domain_type),
intent(inout) :: MOM_dom
473 integer,
optional,
intent(in) :: direction
479 integer,
optional,
intent(in) :: stagger
482 logical,
optional,
intent(in) :: complete
485 integer,
optional,
intent(in) :: halo
487 integer,
optional,
intent(in) :: clock
491 integer :: stagger_local
493 logical :: block_til_complete
495 if (
present(clock))
then ;
if (clock>0)
call cpu_clock_begin(clock) ;
endif
497 stagger_local = cgrid_ne
498 if (
present(stagger)) stagger_local = stagger
501 if (
present(direction))
then ;
if (direction > 0) dirflag = direction ;
endif
502 block_til_complete = .true.
503 if (
present(complete)) block_til_complete = complete
505 if (
present(halo) .and. mom_dom%thin_halo_updates)
then
506 call mpp_update_domains(u_cmpt, v_cmpt, mom_dom%mpp_domain, flags=dirflag, &
507 gridtype=stagger_local, complete = block_til_complete, &
508 whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)
510 call mpp_update_domains(u_cmpt, v_cmpt, mom_dom%mpp_domain, flags=dirflag, &
511 gridtype=stagger_local, complete = block_til_complete)
514 if (
present(clock))
then ;
if (clock>0)
call cpu_clock_end(clock) ;
endif
◆ pass_vector_3d()
subroutine mom_domains::pass_vector::pass_vector_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, |
|
|
integer, intent(in), optional |
clock |
|
) |
| |
|
private |
pass_vector_3d does a halo update for a pair of three-dimensional arrays representing the compontents of a three-dimensional horizontal vector.
- 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. |
[in] | clock | The handle for a cpu time clock that should be started then stopped to time this routine. |
Definition at line 610 of file MOM_domains.F90.
610 real,
dimension(:,:,:),
intent(inout) :: u_cmpt
613 real,
dimension(:,:,:),
intent(inout) :: v_cmpt
616 type(MOM_domain_type),
intent(inout) :: MOM_dom
619 integer,
optional,
intent(in) :: direction
625 integer,
optional,
intent(in) :: stagger
628 logical,
optional,
intent(in) :: complete
631 integer,
optional,
intent(in) :: halo
633 integer,
optional,
intent(in) :: clock
637 integer :: stagger_local
639 logical :: block_til_complete
641 if (
present(clock))
then ;
if (clock>0)
call cpu_clock_begin(clock) ;
endif
643 stagger_local = cgrid_ne
644 if (
present(stagger)) stagger_local = stagger
647 if (
present(direction))
then ;
if (direction > 0) dirflag = direction ;
endif
648 block_til_complete = .true.
649 if (
present(complete)) block_til_complete = complete
651 if (
present(halo) .and. mom_dom%thin_halo_updates)
then
652 call mpp_update_domains(u_cmpt, v_cmpt, mom_dom%mpp_domain, flags=dirflag, &
653 gridtype=stagger_local, complete = block_til_complete, &
654 whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)
656 call mpp_update_domains(u_cmpt, v_cmpt, mom_dom%mpp_domain, flags=dirflag, &
657 gridtype=stagger_local, complete = block_til_complete)
660 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