\hypertarget{interfacemom__domains_1_1pass__vector__complete}{}\section{mom\+\_\+domains\+:\+:pass\+\_\+vector\+\_\+complete Interface Reference}
\label{interfacemom__domains_1_1pass__vector__complete}\index{mom\+\_\+domains\+::pass\+\_\+vector\+\_\+complete@{mom\+\_\+domains\+::pass\+\_\+vector\+\_\+complete}}


\subsection{Detailed Description}
Complete a halo update on a pair of arrays representing the two components of a vector. 

Definition at line 79 of file M\+O\+M\+\_\+domains.\+F90.

\subsection*{Private functions}
\begin{DoxyCompactItemize}
\item 
subroutine \mbox{\hyperlink{interfacemom__domains_1_1pass__vector__complete_ace963dbcaf7ddcaa1134b91580af6c0b}{pass\+\_\+vector\+\_\+complete\+\_\+3d}} (id\+\_\+update, u\+\_\+cmpt, v\+\_\+cmpt, M\+O\+M\+\_\+dom, direction, stagger, halo, clock)
\begin{DoxyCompactList}\small\item\em pass\+\_\+vector\+\_\+complete\+\_\+3d completes a halo update for a pair of three-\/dimensional arrays representing the compontents of a three-\/dimensional horizontal vector. \end{DoxyCompactList}\item 
subroutine \mbox{\hyperlink{interfacemom__domains_1_1pass__vector__complete_a615742515d7e32e4325fbbfdf1f54efe}{pass\+\_\+vector\+\_\+complete\+\_\+2d}} (id\+\_\+update, u\+\_\+cmpt, v\+\_\+cmpt, M\+O\+M\+\_\+dom, direction, stagger, halo, clock)
\begin{DoxyCompactList}\small\item\em pass\+\_\+vector\+\_\+complete\+\_\+2d completes a halo update for a pair of two-\/dimensional arrays representing the compontents of a two-\/dimensional horizontal vector. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Complete a halo update on a pair of arrays representing the two components of a vector. 

Definition at line 79 of file M\+O\+M\+\_\+domains.\+F90.



\subsection{Functions and subroutines}
\mbox{\Hypertarget{interfacemom__domains_1_1pass__vector__complete_a615742515d7e32e4325fbbfdf1f54efe}\label{interfacemom__domains_1_1pass__vector__complete_a615742515d7e32e4325fbbfdf1f54efe}} 
\index{mom\+\_\+domains\+::pass\+\_\+vector\+\_\+complete@{mom\+\_\+domains\+::pass\+\_\+vector\+\_\+complete}!pass\+\_\+vector\+\_\+complete\+\_\+2d@{pass\+\_\+vector\+\_\+complete\+\_\+2d}}
\index{pass\+\_\+vector\+\_\+complete\+\_\+2d@{pass\+\_\+vector\+\_\+complete\+\_\+2d}!mom\+\_\+domains\+::pass\+\_\+vector\+\_\+complete@{mom\+\_\+domains\+::pass\+\_\+vector\+\_\+complete}}
\subsubsection{\texorpdfstring{pass\+\_\+vector\+\_\+complete\+\_\+2d()}{pass\_vector\_complete\_2d()}}
{\footnotesize\ttfamily subroutine mom\+\_\+domains\+::pass\+\_\+vector\+\_\+complete\+::pass\+\_\+vector\+\_\+complete\+\_\+2d (\begin{DoxyParamCaption}\item[{integer, intent(in)}]{id\+\_\+update,  }\item[{real, dimension(\+:,\+:), intent(inout)}]{u\+\_\+cmpt,  }\item[{real, dimension(\+:,\+:), intent(inout)}]{v\+\_\+cmpt,  }\item[{type(\mbox{\hyperlink{structmom__domains_1_1mom__domain__type}{mom\+\_\+domain\+\_\+type}}), intent(inout)}]{M\+O\+M\+\_\+dom,  }\item[{integer, intent(in), optional}]{direction,  }\item[{integer, intent(in), optional}]{stagger,  }\item[{integer, intent(in), optional}]{halo,  }\item[{integer, intent(in), optional}]{clock }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}



pass\+\_\+vector\+\_\+complete\+\_\+2d completes a halo update for a pair of two-\/dimensional arrays representing the compontents of a two-\/dimensional horizontal vector. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em id\+\_\+update} & The integer id of this update which has been returned from a previous call to \mbox{\hyperlink{interfacemom__domains_1_1pass__var__start}{pass\+\_\+var\+\_\+start}}.\\
\hline
\mbox{\tt in,out}  & {\em u\+\_\+cmpt} & The nominal zonal (u) component of the vector pair which is having its halos points exchanged.\\
\hline
\mbox{\tt in,out}  & {\em v\+\_\+cmpt} & The nominal meridional (v) component of the vector pair which is having its halos points exchanged.\\
\hline
\mbox{\tt in,out}  & {\em mom\+\_\+dom} & The M\+O\+M\+\_\+domain\+\_\+type containing the mpp\+\_\+domain needed to determine where data should be sent.\\
\hline
\mbox{\tt in}  & {\em direction} & An optional integer indicating which directions the data should be sent. It is T\+O\+\_\+\+A\+LL or the sum of any of T\+O\+\_\+\+E\+A\+ST, T\+O\+\_\+\+W\+E\+ST, T\+O\+\_\+\+N\+O\+R\+TH, and T\+O\+\_\+\+S\+O\+U\+TH, possibly plus S\+C\+A\+L\+A\+R\+\_\+\+P\+A\+IR if these are paired non-\/directional scalars discretized at the typical vector component locations. For example, T\+O\+\_\+\+E\+A\+ST sends the data to the processor to the east, so the halos on the western side are filled. T\+O\+\_\+\+A\+LL is the default if omitted.\\
\hline
\mbox{\tt in}  & {\em stagger} & An optional flag, which may be one of A\+\_\+\+G\+R\+ID, B\+G\+R\+I\+D\+\_\+\+NE, or C\+G\+R\+I\+D\+\_\+\+NE, indicating where the two components of the vector are discretized. Omitting stagger is the same as setting it to C\+G\+R\+I\+D\+\_\+\+NE.\\
\hline
\mbox{\tt in}  & {\em halo} & The size of the halo to update -\/ the full halo by default.\\
\hline
\mbox{\tt in}  & {\em clock} & The handle for a cpu time clock that should be started then stopped to time this routine. \\
\hline
\end{DoxyParams}


Definition at line 804 of file M\+O\+M\+\_\+domains.\+F90.


\begin{DoxyCode}
804   \textcolor{keywordtype}{integer},                \textcolor{keywordtype}{intent(in)}    :: id\_update\textcolor{comment}{ !< The integer id of this update which has been}
805 \textcolor{comment}{                                                    !! returned from a previous call to}
806 \textcolor{comment}{                                                    !! pass\_var\_start.}
807   \textcolor{keywordtype}{real}, \textcolor{keywordtype}{dimension(:,:)},   \textcolor{keywordtype}{intent(inout)} :: u\_cmpt\textcolor{comment}{   !< The nominal zonal (u) component of the vector}
808 \textcolor{comment}{                                                    !! pair which is having its halos points}
809 \textcolor{comment}{                                                    !! exchanged.}
810   \textcolor{keywordtype}{real}, \textcolor{keywordtype}{dimension(:,:)},   \textcolor{keywordtype}{intent(inout)} :: v\_cmpt\textcolor{comment}{   !< The nominal meridional (v) component of the}
811 \textcolor{comment}{                                                    !! vector pair which is having its halos points}
812 \textcolor{comment}{                                                    !! exchanged.}
813   \textcolor{keywordtype}{type}(MOM\_domain\_type),  \textcolor{keywordtype}{intent(inout)} :: MOM\_dom\textcolor{comment}{  !< The MOM\_domain\_type containing the mpp\_domain}
814 \textcolor{comment}{                                                    !! needed to determine where data should be}
815 \textcolor{comment}{                                                    !! sent.}
816   \textcolor{keywordtype}{integer},      \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)}    :: direction\textcolor{comment}{ !< An optional integer indicating which}
817 \textcolor{comment}{      !! directions the data should be sent.  It is TO\_ALL or the sum of any of TO\_EAST, TO\_WEST,}
818 \textcolor{comment}{      !! TO\_NORTH, and TO\_SOUTH, possibly plus SCALAR\_PAIR if these are paired non-directional}
819 \textcolor{comment}{      !! scalars discretized at the typical vector component locations.  For example, TO\_EAST sends}
820 \textcolor{comment}{      !! the data to the processor to the east, so the halos on the western side are filled. TO\_ALL}
821 \textcolor{comment}{      !! is the default if omitted.}
822   \textcolor{keywordtype}{integer},      \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)}    :: stagger\textcolor{comment}{  !< An optional flag, which may be one of A\_GRID,}
823 \textcolor{comment}{                     !! BGRID\_NE, or CGRID\_NE, indicating where the two components of the vector are}
824 \textcolor{comment}{                     !! discretized. Omitting stagger is the same as setting it to CGRID\_NE.}
825   \textcolor{keywordtype}{integer},      \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)}    :: halo\textcolor{comment}{     !< The size of the halo to update - the full}
826 \textcolor{comment}{                                                    !! halo by default.}
827   \textcolor{keywordtype}{integer},      \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)}    :: clock\textcolor{comment}{    !< The handle for a cpu time clock that should be}
828 \textcolor{comment}{                                                    !! started then stopped to time this routine.}
829   \textcolor{comment}{! Local variables}
830   \textcolor{keywordtype}{integer} :: stagger\_local
831   \textcolor{keywordtype}{integer} :: dirflag
832 
833   \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(clock)) \textcolor{keywordflow}{then} ; \textcolor{keywordflow}{if} (clock>0) \textcolor{keyword}{call }cpu\_clock\_begin(clock) ;\textcolor{keywordflow}{ endif}
834 
835   stagger\_local = cgrid\_ne \textcolor{comment}{! Default value for type of grid}
836   \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(stagger)) stagger\_local = stagger
837 
838   dirflag = to\_all \textcolor{comment}{! 60}
839   \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(direction)) \textcolor{keywordflow}{then} ; \textcolor{keywordflow}{if} (direction > 0) dirflag = direction ;\textcolor{keywordflow}{ endif}
840 
841   \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(halo) .and. mom\_dom%thin\_halo\_updates) \textcolor{keywordflow}{then}
842     \textcolor{keyword}{call }mpp\_complete\_update\_domains(id\_update, u\_cmpt, v\_cmpt, &
843              mom\_dom%mpp\_domain, flags=dirflag, gridtype=stagger\_local, &
844              whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)
845   \textcolor{keywordflow}{else}
846     \textcolor{keyword}{call }mpp\_complete\_update\_domains(id\_update, u\_cmpt, v\_cmpt, &
847              mom\_dom%mpp\_domain, flags=dirflag, gridtype=stagger\_local)
848 \textcolor{keywordflow}{  endif}
849 
850   \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(clock)) \textcolor{keywordflow}{then} ; \textcolor{keywordflow}{if} (clock>0) \textcolor{keyword}{call }cpu\_clock\_end(clock) ;\textcolor{keywordflow}{ endif}
851 
\end{DoxyCode}
\mbox{\Hypertarget{interfacemom__domains_1_1pass__vector__complete_ace963dbcaf7ddcaa1134b91580af6c0b}\label{interfacemom__domains_1_1pass__vector__complete_ace963dbcaf7ddcaa1134b91580af6c0b}} 
\index{mom\+\_\+domains\+::pass\+\_\+vector\+\_\+complete@{mom\+\_\+domains\+::pass\+\_\+vector\+\_\+complete}!pass\+\_\+vector\+\_\+complete\+\_\+3d@{pass\+\_\+vector\+\_\+complete\+\_\+3d}}
\index{pass\+\_\+vector\+\_\+complete\+\_\+3d@{pass\+\_\+vector\+\_\+complete\+\_\+3d}!mom\+\_\+domains\+::pass\+\_\+vector\+\_\+complete@{mom\+\_\+domains\+::pass\+\_\+vector\+\_\+complete}}
\subsubsection{\texorpdfstring{pass\+\_\+vector\+\_\+complete\+\_\+3d()}{pass\_vector\_complete\_3d()}}
{\footnotesize\ttfamily subroutine mom\+\_\+domains\+::pass\+\_\+vector\+\_\+complete\+::pass\+\_\+vector\+\_\+complete\+\_\+3d (\begin{DoxyParamCaption}\item[{integer, intent(in)}]{id\+\_\+update,  }\item[{real, dimension(\+:,\+:,\+:), intent(inout)}]{u\+\_\+cmpt,  }\item[{real, dimension(\+:,\+:,\+:), intent(inout)}]{v\+\_\+cmpt,  }\item[{type(\mbox{\hyperlink{structmom__domains_1_1mom__domain__type}{mom\+\_\+domain\+\_\+type}}), intent(inout)}]{M\+O\+M\+\_\+dom,  }\item[{integer, intent(in), optional}]{direction,  }\item[{integer, intent(in), optional}]{stagger,  }\item[{integer, intent(in), optional}]{halo,  }\item[{integer, intent(in), optional}]{clock }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}



pass\+\_\+vector\+\_\+complete\+\_\+3d completes a halo update for a pair of three-\/dimensional arrays representing the compontents of a three-\/dimensional horizontal vector. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em id\+\_\+update} & The integer id of this update which has been returned from a previous call to \mbox{\hyperlink{interfacemom__domains_1_1pass__var__start}{pass\+\_\+var\+\_\+start}}.\\
\hline
\mbox{\tt in,out}  & {\em u\+\_\+cmpt} & The nominal zonal (u) component of the vector pair which is having its halos points exchanged.\\
\hline
\mbox{\tt in,out}  & {\em v\+\_\+cmpt} & The nominal meridional (v) component of the vector pair which is having its halos points exchanged.\\
\hline
\mbox{\tt in,out}  & {\em mom\+\_\+dom} & The M\+O\+M\+\_\+domain\+\_\+type containing the mpp\+\_\+domain needed to determine where data should be sent.\\
\hline
\mbox{\tt in}  & {\em direction} & An optional integer indicating which directions the data should be sent. It is T\+O\+\_\+\+A\+LL or the sum of any of T\+O\+\_\+\+E\+A\+ST, T\+O\+\_\+\+W\+E\+ST, T\+O\+\_\+\+N\+O\+R\+TH, and T\+O\+\_\+\+S\+O\+U\+TH, possibly plus S\+C\+A\+L\+A\+R\+\_\+\+P\+A\+IR if these are paired non-\/directional scalars discretized at the typical vector component locations. For example, T\+O\+\_\+\+E\+A\+ST sends the data to the processor to the east, so the halos on the western side are filled. T\+O\+\_\+\+A\+LL is the default if omitted.\\
\hline
\mbox{\tt in}  & {\em stagger} & An optional flag, which may be one of A\+\_\+\+G\+R\+ID, B\+G\+R\+I\+D\+\_\+\+NE, or C\+G\+R\+I\+D\+\_\+\+NE, indicating where the two components of the vector are discretized. Omitting stagger is the same as setting it to C\+G\+R\+I\+D\+\_\+\+NE.\\
\hline
\mbox{\tt in}  & {\em halo} & The size of the halo to update -\/ the full halo by default.\\
\hline
\mbox{\tt in}  & {\em clock} & The handle for a cpu time clock that should be started then stopped to time this routine. \\
\hline
\end{DoxyParams}


Definition at line 858 of file M\+O\+M\+\_\+domains.\+F90.


\begin{DoxyCode}
858   \textcolor{keywordtype}{integer},                \textcolor{keywordtype}{intent(in)}    :: id\_update\textcolor{comment}{ !< The integer id of this update which has been}
859 \textcolor{comment}{                                                    !! returned from a previous call to}
860 \textcolor{comment}{                                                    !! pass\_var\_start.}
861   \textcolor{keywordtype}{real}, \textcolor{keywordtype}{dimension(:,:,:)}, \textcolor{keywordtype}{intent(inout)} :: u\_cmpt\textcolor{comment}{   !< The nominal zonal (u) component of the vector}
862 \textcolor{comment}{                                                    !! pair which is having its halos points}
863 \textcolor{comment}{                                                    !! exchanged.}
864   \textcolor{keywordtype}{real}, \textcolor{keywordtype}{dimension(:,:,:)}, \textcolor{keywordtype}{intent(inout)} :: v\_cmpt\textcolor{comment}{   !< The nominal meridional (v) component of the}
865 \textcolor{comment}{                                                    !! vector pair which is having its halos points}
866 \textcolor{comment}{                                                    !! exchanged.}
867   \textcolor{keywordtype}{type}(MOM\_domain\_type),  \textcolor{keywordtype}{intent(inout)} :: MOM\_dom\textcolor{comment}{  !< The MOM\_domain\_type containing the mpp\_domain}
868 \textcolor{comment}{                                                    !! needed to determine where data should be}
869 \textcolor{comment}{                                                    !! sent.}
870   \textcolor{keywordtype}{integer},      \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)}    :: direction\textcolor{comment}{ !< An optional integer indicating which}
871 \textcolor{comment}{      !! directions the data should be sent.  It is TO\_ALL or the sum of any of TO\_EAST, TO\_WEST,}
872 \textcolor{comment}{      !! TO\_NORTH, and TO\_SOUTH, possibly plus SCALAR\_PAIR if these are paired non-directional}
873 \textcolor{comment}{      !! scalars discretized at the typical vector component locations.  For example, TO\_EAST sends}
874 \textcolor{comment}{      !! the data to the processor to the east, so the halos on the western side are filled. TO\_ALL}
875 \textcolor{comment}{      !! is the default if omitted.}
876   \textcolor{keywordtype}{integer},      \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)}    :: stagger\textcolor{comment}{  !< An optional flag, which may be one of A\_GRID,}
877 \textcolor{comment}{                     !! BGRID\_NE, or CGRID\_NE, indicating where the two components of the vector are}
878 \textcolor{comment}{                     !! discretized. Omitting stagger is the same as setting it to CGRID\_NE.}
879   \textcolor{keywordtype}{integer},      \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)}    :: halo\textcolor{comment}{     !< The size of the halo to update - the full}
880 \textcolor{comment}{                                                    !! halo by default.}
881   \textcolor{keywordtype}{integer},      \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)}    :: clock\textcolor{comment}{    !< The handle for a cpu time clock that should be}
882 \textcolor{comment}{                                                    !! started then stopped to time this routine.}
883   \textcolor{comment}{! Local variables}
884   \textcolor{keywordtype}{integer} :: stagger\_local
885   \textcolor{keywordtype}{integer} :: dirflag
886 
887   \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(clock)) \textcolor{keywordflow}{then} ; \textcolor{keywordflow}{if} (clock>0) \textcolor{keyword}{call }cpu\_clock\_begin(clock) ;\textcolor{keywordflow}{ endif}
888 
889   stagger\_local = cgrid\_ne \textcolor{comment}{! Default value for type of grid}
890   \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(stagger)) stagger\_local = stagger
891 
892   dirflag = to\_all \textcolor{comment}{! 60}
893   \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(direction)) \textcolor{keywordflow}{then} ; \textcolor{keywordflow}{if} (direction > 0) dirflag = direction ;\textcolor{keywordflow}{ endif}
894 
895   \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(halo) .and. mom\_dom%thin\_halo\_updates) \textcolor{keywordflow}{then}
896     \textcolor{keyword}{call }mpp\_complete\_update\_domains(id\_update, u\_cmpt, v\_cmpt, &
897              mom\_dom%mpp\_domain, flags=dirflag, gridtype=stagger\_local, &
898                    whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)
899   \textcolor{keywordflow}{else}
900     \textcolor{keyword}{call }mpp\_complete\_update\_domains(id\_update, u\_cmpt, v\_cmpt, &
901              mom\_dom%mpp\_domain, flags=dirflag, gridtype=stagger\_local)
902 \textcolor{keywordflow}{  endif}
903 
904   \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(clock)) \textcolor{keywordflow}{then} ; \textcolor{keywordflow}{if} (clock>0) \textcolor{keyword}{call }cpu\_clock\_end(clock) ;\textcolor{keywordflow}{ endif}
905 
\end{DoxyCode}


The documentation for this interface was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
/home/cermak/src/\+M\+O\+M6.\+devrob/src/framework/M\+O\+M\+\_\+domains.\+F90\end{DoxyCompactItemize}
