Initiate a halo update on a pair of arrays representing the two components of a vector.
Definition at line 69 of file MOM_domains.F90.
|
integer function | pass_vector_start_3d (u_cmpt, v_cmpt, MOM_dom, direction, stagger, complete, halo, clock) |
| pass_vector_start_3d starts a halo update for a pair of three-dimensional arrays representing the compontents of a three-dimensional horizontal vector. More...
|
|
integer function | pass_vector_start_2d (u_cmpt, v_cmpt, MOM_dom, direction, stagger, complete, halo, clock) |
| pass_vector_start_2d starts a halo update for a pair of two-dimensional arrays representing the compontents of a two-dimensional horizontal vector. More...
|
|
◆ 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, |
|
|
integer, intent(in), optional |
clock |
|
) |
| |
|
private |
pass_vector_start_2d starts 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. |
- Returns
- The integer index for this update.
Definition at line 668 of file MOM_domains.F90.
668 real,
dimension(:,:),
intent(inout) :: u_cmpt
671 real,
dimension(:,:),
intent(inout) :: v_cmpt
674 type(MOM_domain_type),
intent(inout) :: MOM_dom
677 integer,
optional,
intent(in) :: direction
683 integer,
optional,
intent(in) :: stagger
686 logical,
optional,
intent(in) :: complete
689 integer,
optional,
intent(in) :: halo
691 integer,
optional,
intent(in) :: clock
693 integer :: pass_vector_start_2d
697 integer :: stagger_local
700 if (
present(clock))
then ;
if (clock>0)
call cpu_clock_begin(clock) ;
endif
702 stagger_local = cgrid_ne
703 if (
present(stagger)) stagger_local = stagger
706 if (
present(direction))
then ;
if (direction > 0) dirflag = direction ;
endif
708 if (
present(halo) .and. mom_dom%thin_halo_updates)
then
709 pass_vector_start_2d = mpp_start_update_domains(u_cmpt, v_cmpt, &
710 mom_dom%mpp_domain, flags=dirflag, gridtype=stagger_local, &
711 whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)
713 pass_vector_start_2d = mpp_start_update_domains(u_cmpt, v_cmpt, &
714 mom_dom%mpp_domain, flags=dirflag, gridtype=stagger_local)
717 if (
present(clock))
then ;
if (clock>0)
call cpu_clock_end(clock) ;
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, |
|
|
integer, intent(in), optional |
clock |
|
) |
| |
|
private |
pass_vector_start_3d starts 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. |
- Returns
- The integer index for this update.
Definition at line 725 of file MOM_domains.F90.
725 real,
dimension(:,:,:),
intent(inout) :: u_cmpt
728 real,
dimension(:,:,:),
intent(inout) :: v_cmpt
731 type(MOM_domain_type),
intent(inout) :: MOM_dom
734 integer,
optional,
intent(in) :: direction
740 integer,
optional,
intent(in) :: stagger
743 logical,
optional,
intent(in) :: complete
746 integer,
optional,
intent(in) :: halo
748 integer,
optional,
intent(in) :: clock
750 integer :: pass_vector_start_3d
753 integer :: stagger_local
756 if (
present(clock))
then ;
if (clock>0)
call cpu_clock_begin(clock) ;
endif
758 stagger_local = cgrid_ne
759 if (
present(stagger)) stagger_local = stagger
762 if (
present(direction))
then ;
if (direction > 0) dirflag = direction ;
endif
764 if (
present(halo) .and. mom_dom%thin_halo_updates)
then
765 pass_vector_start_3d = mpp_start_update_domains(u_cmpt, v_cmpt, &
766 mom_dom%mpp_domain, flags=dirflag, gridtype=stagger_local, &
767 whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)
769 pass_vector_start_3d = mpp_start_update_domains(u_cmpt, v_cmpt, &
770 mom_dom%mpp_domain, flags=dirflag, gridtype=stagger_local)
773 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