\hypertarget{interfacemom__domains_1_1pass__vector__complete}{}\doxysection{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}} \doxysubsection{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. \doxysubsection*{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} \doxysubsection{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. \doxysubsection{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}} \doxysubsubsection{\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{\texttt{ 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{\texttt{ in,out}} & {\em u\+\_\+cmpt} & The nominal zonal (u) component of the vector pair which is having its halos points exchanged. \\ \hline \mbox{\texttt{ in,out}} & {\em v\+\_\+cmpt} & The nominal meridional (v) component of the vector pair which is having its halos points exchanged. \\ \hline \mbox{\texttt{ 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{\texttt{ 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{\texttt{ 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{\texttt{ in}} & {\em halo} & The size of the halo to update -\/ the full halo by default. \\ \hline \mbox{\texttt{ 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}{0} \DoxyCodeLine{804 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{intent(in)} :: id\_update\textcolor{comment}{ !< The integer id of this update which has been}} \DoxyCodeLine{805 \textcolor{comment}{ !! returned from a previous call to}} \DoxyCodeLine{806 \textcolor{comment}{ !! pass\_var\_start.}} \DoxyCodeLine{807 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{dimension(:,:)}, \textcolor{keywordtype}{intent(inout)} :: u\_cmpt\textcolor{comment}{ !< The nominal zonal (u) component of the vector}} \DoxyCodeLine{808 \textcolor{comment}{ !! pair which is having its halos points}} \DoxyCodeLine{809 \textcolor{comment}{ !! exchanged.}} \DoxyCodeLine{810 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{dimension(:,:)}, \textcolor{keywordtype}{intent(inout)} :: v\_cmpt\textcolor{comment}{ !< The nominal meridional (v) component of the}} \DoxyCodeLine{811 \textcolor{comment}{ !! vector pair which is having its halos points}} \DoxyCodeLine{812 \textcolor{comment}{ !! exchanged.}} \DoxyCodeLine{813 \textcolor{keywordtype}{type}(MOM\_domain\_type), \textcolor{keywordtype}{intent(inout)} :: MOM\_dom\textcolor{comment}{ !< The MOM\_domain\_type containing the mpp\_domain}} \DoxyCodeLine{814 \textcolor{comment}{ !! needed to determine where data should be}} \DoxyCodeLine{815 \textcolor{comment}{ !! sent.}} \DoxyCodeLine{816 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: direction\textcolor{comment}{ !< An optional integer indicating which}} \DoxyCodeLine{817 \textcolor{comment}{ !! directions the data should be sent. It is TO\_ALL or the sum of any of TO\_EAST, TO\_WEST,}} \DoxyCodeLine{818 \textcolor{comment}{ !! TO\_NORTH, and TO\_SOUTH, possibly plus SCALAR\_PAIR if these are paired non-\/directional}} \DoxyCodeLine{819 \textcolor{comment}{ !! scalars discretized at the typical vector component locations. For example, TO\_EAST sends}} \DoxyCodeLine{820 \textcolor{comment}{ !! the data to the processor to the east, so the halos on the western side are filled. TO\_ALL}} \DoxyCodeLine{821 \textcolor{comment}{ !! is the default if omitted.}} \DoxyCodeLine{822 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: stagger\textcolor{comment}{ !< An optional flag, which may be one of A\_GRID,}} \DoxyCodeLine{823 \textcolor{comment}{ !! BGRID\_NE, or CGRID\_NE, indicating where the two components of the vector are}} \DoxyCodeLine{824 \textcolor{comment}{ !! discretized. Omitting stagger is the same as setting it to CGRID\_NE.}} \DoxyCodeLine{825 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: halo\textcolor{comment}{ !< The size of the halo to update -\/ the full}} \DoxyCodeLine{826 \textcolor{comment}{ !! halo by default.}} \DoxyCodeLine{827 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: clock\textcolor{comment}{ !< The handle for a cpu time clock that should be}} \DoxyCodeLine{828 \textcolor{comment}{ !! started then stopped to time this routine.}} \DoxyCodeLine{829 \textcolor{comment}{! Local variables}} \DoxyCodeLine{830 \textcolor{keywordtype}{integer} :: stagger\_local} \DoxyCodeLine{831 \textcolor{keywordtype}{integer} :: dirflag} \DoxyCodeLine{832 } \DoxyCodeLine{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}} \DoxyCodeLine{834 } \DoxyCodeLine{835 stagger\_local = cgrid\_ne \textcolor{comment}{! Default value for type of grid}} \DoxyCodeLine{836 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(stagger)) stagger\_local = stagger} \DoxyCodeLine{837 } \DoxyCodeLine{838 dirflag = to\_all \textcolor{comment}{! 60}} \DoxyCodeLine{839 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(direction)) \textcolor{keywordflow}{then} ; \textcolor{keywordflow}{if} (direction > 0) dirflag = direction ;\textcolor{keywordflow}{ endif}} \DoxyCodeLine{840 } \DoxyCodeLine{841 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(halo) .and. mom\_dom\%thin\_halo\_updates) \textcolor{keywordflow}{then}} \DoxyCodeLine{842 \textcolor{keyword}{call }mpp\_complete\_update\_domains(id\_update, u\_cmpt, v\_cmpt, \&} \DoxyCodeLine{843 mom\_dom\%mpp\_domain, flags=dirflag, gridtype=stagger\_local, \&} \DoxyCodeLine{844 whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)} \DoxyCodeLine{845 \textcolor{keywordflow}{else}} \DoxyCodeLine{846 \textcolor{keyword}{call }mpp\_complete\_update\_domains(id\_update, u\_cmpt, v\_cmpt, \&} \DoxyCodeLine{847 mom\_dom\%mpp\_domain, flags=dirflag, gridtype=stagger\_local)} \DoxyCodeLine{848 \textcolor{keywordflow}{ endif}} \DoxyCodeLine{849 } \DoxyCodeLine{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}} \DoxyCodeLine{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}} \doxysubsubsection{\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{\texttt{ 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{\texttt{ in,out}} & {\em u\+\_\+cmpt} & The nominal zonal (u) component of the vector pair which is having its halos points exchanged. \\ \hline \mbox{\texttt{ in,out}} & {\em v\+\_\+cmpt} & The nominal meridional (v) component of the vector pair which is having its halos points exchanged. \\ \hline \mbox{\texttt{ 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{\texttt{ 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{\texttt{ 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{\texttt{ in}} & {\em halo} & The size of the halo to update -\/ the full halo by default. \\ \hline \mbox{\texttt{ 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}{0} \DoxyCodeLine{858 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{intent(in)} :: id\_update\textcolor{comment}{ !< The integer id of this update which has been}} \DoxyCodeLine{859 \textcolor{comment}{ !! returned from a previous call to}} \DoxyCodeLine{860 \textcolor{comment}{ !! pass\_var\_start.}} \DoxyCodeLine{861 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{dimension(:,:,:)}, \textcolor{keywordtype}{intent(inout)} :: u\_cmpt\textcolor{comment}{ !< The nominal zonal (u) component of the vector}} \DoxyCodeLine{862 \textcolor{comment}{ !! pair which is having its halos points}} \DoxyCodeLine{863 \textcolor{comment}{ !! exchanged.}} \DoxyCodeLine{864 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{dimension(:,:,:)}, \textcolor{keywordtype}{intent(inout)} :: v\_cmpt\textcolor{comment}{ !< The nominal meridional (v) component of the}} \DoxyCodeLine{865 \textcolor{comment}{ !! vector pair which is having its halos points}} \DoxyCodeLine{866 \textcolor{comment}{ !! exchanged.}} \DoxyCodeLine{867 \textcolor{keywordtype}{type}(MOM\_domain\_type), \textcolor{keywordtype}{intent(inout)} :: MOM\_dom\textcolor{comment}{ !< The MOM\_domain\_type containing the mpp\_domain}} \DoxyCodeLine{868 \textcolor{comment}{ !! needed to determine where data should be}} \DoxyCodeLine{869 \textcolor{comment}{ !! sent.}} \DoxyCodeLine{870 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: direction\textcolor{comment}{ !< An optional integer indicating which}} \DoxyCodeLine{871 \textcolor{comment}{ !! directions the data should be sent. It is TO\_ALL or the sum of any of TO\_EAST, TO\_WEST,}} \DoxyCodeLine{872 \textcolor{comment}{ !! TO\_NORTH, and TO\_SOUTH, possibly plus SCALAR\_PAIR if these are paired non-\/directional}} \DoxyCodeLine{873 \textcolor{comment}{ !! scalars discretized at the typical vector component locations. For example, TO\_EAST sends}} \DoxyCodeLine{874 \textcolor{comment}{ !! the data to the processor to the east, so the halos on the western side are filled. TO\_ALL}} \DoxyCodeLine{875 \textcolor{comment}{ !! is the default if omitted.}} \DoxyCodeLine{876 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: stagger\textcolor{comment}{ !< An optional flag, which may be one of A\_GRID,}} \DoxyCodeLine{877 \textcolor{comment}{ !! BGRID\_NE, or CGRID\_NE, indicating where the two components of the vector are}} \DoxyCodeLine{878 \textcolor{comment}{ !! discretized. Omitting stagger is the same as setting it to CGRID\_NE.}} \DoxyCodeLine{879 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: halo\textcolor{comment}{ !< The size of the halo to update -\/ the full}} \DoxyCodeLine{880 \textcolor{comment}{ !! halo by default.}} \DoxyCodeLine{881 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: clock\textcolor{comment}{ !< The handle for a cpu time clock that should be}} \DoxyCodeLine{882 \textcolor{comment}{ !! started then stopped to time this routine.}} \DoxyCodeLine{883 \textcolor{comment}{! Local variables}} \DoxyCodeLine{884 \textcolor{keywordtype}{integer} :: stagger\_local} \DoxyCodeLine{885 \textcolor{keywordtype}{integer} :: dirflag} \DoxyCodeLine{886 } \DoxyCodeLine{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}} \DoxyCodeLine{888 } \DoxyCodeLine{889 stagger\_local = cgrid\_ne \textcolor{comment}{! Default value for type of grid}} \DoxyCodeLine{890 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(stagger)) stagger\_local = stagger} \DoxyCodeLine{891 } \DoxyCodeLine{892 dirflag = to\_all \textcolor{comment}{! 60}} \DoxyCodeLine{893 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(direction)) \textcolor{keywordflow}{then} ; \textcolor{keywordflow}{if} (direction > 0) dirflag = direction ;\textcolor{keywordflow}{ endif}} \DoxyCodeLine{894 } \DoxyCodeLine{895 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(halo) .and. mom\_dom\%thin\_halo\_updates) \textcolor{keywordflow}{then}} \DoxyCodeLine{896 \textcolor{keyword}{call }mpp\_complete\_update\_domains(id\_update, u\_cmpt, v\_cmpt, \&} \DoxyCodeLine{897 mom\_dom\%mpp\_domain, flags=dirflag, gridtype=stagger\_local, \&} \DoxyCodeLine{898 whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)} \DoxyCodeLine{899 \textcolor{keywordflow}{else}} \DoxyCodeLine{900 \textcolor{keyword}{call }mpp\_complete\_update\_domains(id\_update, u\_cmpt, v\_cmpt, \&} \DoxyCodeLine{901 mom\_dom\%mpp\_domain, flags=dirflag, gridtype=stagger\_local)} \DoxyCodeLine{902 \textcolor{keywordflow}{ endif}} \DoxyCodeLine{903 } \DoxyCodeLine{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}} \DoxyCodeLine{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}