\hypertarget{interfacemom__domains_1_1pass__vector__start}{}\section{mom\+\_\+domains\+::pass\+\_\+vector\+\_\+start Interface Reference} \label{interfacemom__domains_1_1pass__vector__start}\index{mom\_domains::pass\_vector\_start@{mom\_domains::pass\_vector\_start}} \subsection{Detailed Description} Initiate a halo update on a pair of arrays representing the two components of a vector. Definition at line 74 of file M\+O\+M\+\_\+domains.\+F90. \subsection*{Private functions} \begin{DoxyCompactItemize} \item integer function \mbox{\hyperlink{interfacemom__domains_1_1pass__vector__start_afcd13d423d6f7428a61cc14a31f6519b}{pass\+\_\+vector\+\_\+start\+\_\+3d}} (u\+\_\+cmpt, v\+\_\+cmpt, M\+O\+M\+\_\+dom, direction, stagger, complete, halo, clock) \begin{DoxyCompactList}\small\item\em pass\+\_\+vector\+\_\+start\+\_\+3d starts a halo update for a pair of three-\/dimensional arrays representing the compontents of a three-\/dimensional horizontal vector. \end{DoxyCompactList}\item integer function \mbox{\hyperlink{interfacemom__domains_1_1pass__vector__start_ae89f5b81804c86807a7a7e6e2de1e1bb}{pass\+\_\+vector\+\_\+start\+\_\+2d}} (u\+\_\+cmpt, v\+\_\+cmpt, M\+O\+M\+\_\+dom, direction, stagger, complete, halo, clock) \begin{DoxyCompactList}\small\item\em pass\+\_\+vector\+\_\+start\+\_\+2d starts 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} Initiate a halo update on a pair of arrays representing the two components of a vector. Definition at line 74 of file M\+O\+M\+\_\+domains.\+F90. \subsection{Functions and subroutines} \mbox{\Hypertarget{interfacemom__domains_1_1pass__vector__start_ae89f5b81804c86807a7a7e6e2de1e1bb}\label{interfacemom__domains_1_1pass__vector__start_ae89f5b81804c86807a7a7e6e2de1e1bb}} \index{mom\_domains::pass\_vector\_start@{mom\_domains::pass\_vector\_start}!pass\_vector\_start\_2d@{pass\_vector\_start\_2d}} \index{pass\_vector\_start\_2d@{pass\_vector\_start\_2d}!mom\_domains::pass\_vector\_start@{mom\_domains::pass\_vector\_start}} \subsubsection{\texorpdfstring{pass\_vector\_start\_2d()}{pass\_vector\_start\_2d()}} {\footnotesize\ttfamily integer function mom\+\_\+domains\+::pass\+\_\+vector\+\_\+start\+::pass\+\_\+vector\+\_\+start\+\_\+2d (\begin{DoxyParamCaption}\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[{logical, intent(in), optional}]{complete, }\item[{integer, intent(in), optional}]{halo, }\item[{integer, intent(in), optional}]{clock }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [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. \begin{DoxyParams}[1]{Parameters} \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 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. \\ \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} \begin{DoxyReturn}{Returns} The integer index for this update. \end{DoxyReturn} Definition at line 691 of file M\+O\+M\+\_\+domains.\+F90. \begin{DoxyCode}{0} \DoxyCodeLine{691 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{dimension(:,:)}, \textcolor{keywordtype}{intent(inout)} :: u\_cmpt\textcolor{comment}{ !< The nominal zonal (u) component of the vector}} \DoxyCodeLine{692 \textcolor{comment}{ !! pair which is having its halos points}} \DoxyCodeLine{693 \textcolor{comment}{ !! exchanged.}} \DoxyCodeLine{694 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{dimension(:,:)}, \textcolor{keywordtype}{intent(inout)} :: v\_cmpt\textcolor{comment}{ !< The nominal meridional (v) component of the}} \DoxyCodeLine{695 \textcolor{comment}{ !! vector pair which is having its halos points}} \DoxyCodeLine{696 \textcolor{comment}{ !! exchanged.}} \DoxyCodeLine{697 \textcolor{keywordtype}{type}(MOM\_domain\_type), \textcolor{keywordtype}{intent(inout)} :: MOM\_dom\textcolor{comment}{ !< The MOM\_domain\_type containing the mpp\_domain}} \DoxyCodeLine{698 \textcolor{comment}{ !! needed to determine where data should be}} \DoxyCodeLine{699 \textcolor{comment}{ !! sent.}} \DoxyCodeLine{700 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: direction\textcolor{comment}{ !< An optional integer indicating which}} \DoxyCodeLine{701 \textcolor{comment}{ !! directions the data should be sent. It is TO\_ALL or the sum of any of TO\_EAST, TO\_WEST,}} \DoxyCodeLine{702 \textcolor{comment}{ !! TO\_NORTH, and TO\_SOUTH, possibly plus SCALAR\_PAIR if these are paired non-directional}} \DoxyCodeLine{703 \textcolor{comment}{ !! scalars discretized at the typical vector component locations. For example, TO\_EAST sends}} \DoxyCodeLine{704 \textcolor{comment}{ !! the data to the processor to the east, so the halos on the western side are filled. TO\_ALL}} \DoxyCodeLine{705 \textcolor{comment}{ !! is the default if omitted.}} \DoxyCodeLine{706 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: stagger\textcolor{comment}{ !< An optional flag, which may be one of A\_GRID,}} \DoxyCodeLine{707 \textcolor{comment}{ !! BGRID\_NE, or CGRID\_NE, indicating where the two components of the vector are}} \DoxyCodeLine{708 \textcolor{comment}{ !! discretized. Omitting stagger is the same as setting it to CGRID\_NE.}} \DoxyCodeLine{709 \textcolor{keywordtype}{logical}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: complete\textcolor{comment}{ !< An optional argument indicating whether the}} \DoxyCodeLine{710 \textcolor{comment}{ !! halo updates should be completed before progress resumes.}} \DoxyCodeLine{711 \textcolor{comment}{ !! Omitting complete is the same as setting complete to .true.}} \DoxyCodeLine{712 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: halo\textcolor{comment}{ !< The size of the halo to update - the full}} \DoxyCodeLine{713 \textcolor{comment}{ !! halo by default.}} \DoxyCodeLine{714 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: clock\textcolor{comment}{ !< The handle for a cpu time clock that should be}} \DoxyCodeLine{715 \textcolor{comment}{ !! started then stopped to time this routine.}} \DoxyCodeLine{716 \textcolor{keywordtype}{integer} :: pass\_vector\_start\_2d\textcolor{comment}{ !< The integer index for this}} \DoxyCodeLine{717 \textcolor{comment}{ !! update.}} \DoxyCodeLine{718 } \DoxyCodeLine{719 \textcolor{comment}{! Local variables}} \DoxyCodeLine{720 \textcolor{keywordtype}{integer} :: stagger\_local} \DoxyCodeLine{721 \textcolor{keywordtype}{integer} :: dirflag} \DoxyCodeLine{722 } \DoxyCodeLine{723 \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{724 } \DoxyCodeLine{725 stagger\_local = cgrid\_ne \textcolor{comment}{! Default value for type of grid}} \DoxyCodeLine{726 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(stagger)) stagger\_local = stagger} \DoxyCodeLine{727 } \DoxyCodeLine{728 dirflag = to\_all \textcolor{comment}{! 60}} \DoxyCodeLine{729 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(direction)) \textcolor{keywordflow}{then} ; \textcolor{keywordflow}{if} (direction > 0) dirflag = direction ;\textcolor{keywordflow}{ endif}} \DoxyCodeLine{730 } \DoxyCodeLine{731 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(halo) .and. mom\_dom\%thin\_halo\_updates) \textcolor{keywordflow}{then}} \DoxyCodeLine{732 pass\_vector\_start\_2d = mpp\_start\_update\_domains(u\_cmpt, v\_cmpt, \&} \DoxyCodeLine{733 mom\_dom\%mpp\_domain, flags=dirflag, gridtype=stagger\_local, \&} \DoxyCodeLine{734 whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)} \DoxyCodeLine{735 \textcolor{keywordflow}{else}} \DoxyCodeLine{736 pass\_vector\_start\_2d = mpp\_start\_update\_domains(u\_cmpt, v\_cmpt, \&} \DoxyCodeLine{737 mom\_dom\%mpp\_domain, flags=dirflag, gridtype=stagger\_local)} \DoxyCodeLine{738 \textcolor{keywordflow}{ endif}} \DoxyCodeLine{739 } \DoxyCodeLine{740 \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{741 } \end{DoxyCode} \mbox{\Hypertarget{interfacemom__domains_1_1pass__vector__start_afcd13d423d6f7428a61cc14a31f6519b}\label{interfacemom__domains_1_1pass__vector__start_afcd13d423d6f7428a61cc14a31f6519b}} \index{mom\_domains::pass\_vector\_start@{mom\_domains::pass\_vector\_start}!pass\_vector\_start\_3d@{pass\_vector\_start\_3d}} \index{pass\_vector\_start\_3d@{pass\_vector\_start\_3d}!mom\_domains::pass\_vector\_start@{mom\_domains::pass\_vector\_start}} \subsubsection{\texorpdfstring{pass\_vector\_start\_3d()}{pass\_vector\_start\_3d()}} {\footnotesize\ttfamily integer function mom\+\_\+domains\+::pass\+\_\+vector\+\_\+start\+::pass\+\_\+vector\+\_\+start\+\_\+3d (\begin{DoxyParamCaption}\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[{logical, intent(in), optional}]{complete, }\item[{integer, intent(in), optional}]{halo, }\item[{integer, intent(in), optional}]{clock }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [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. \begin{DoxyParams}[1]{Parameters} \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 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. \\ \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} \begin{DoxyReturn}{Returns} The integer index for this update. \end{DoxyReturn} Definition at line 748 of file M\+O\+M\+\_\+domains.\+F90. \begin{DoxyCode}{0} \DoxyCodeLine{748 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{dimension(:,:,:)}, \textcolor{keywordtype}{intent(inout)} :: u\_cmpt\textcolor{comment}{ !< The nominal zonal (u) component of the vector}} \DoxyCodeLine{749 \textcolor{comment}{ !! pair which is having its halos points}} \DoxyCodeLine{750 \textcolor{comment}{ !! exchanged.}} \DoxyCodeLine{751 \textcolor{keywordtype}{ real}, \textcolor{keywordtype}{dimension(:,:,:)}, \textcolor{keywordtype}{intent(inout)} :: v\_cmpt\textcolor{comment}{ !< The nominal meridional (v) component of the}} \DoxyCodeLine{752 \textcolor{comment}{ !! vector pair which is having its halos points}} \DoxyCodeLine{753 \textcolor{comment}{ !! exchanged.}} \DoxyCodeLine{754 \textcolor{keywordtype}{type}(MOM\_domain\_type), \textcolor{keywordtype}{intent(inout)} :: MOM\_dom\textcolor{comment}{ !< The MOM\_domain\_type containing the mpp\_domain}} \DoxyCodeLine{755 \textcolor{comment}{ !! needed to determine where data should be}} \DoxyCodeLine{756 \textcolor{comment}{ !! sent.}} \DoxyCodeLine{757 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: direction\textcolor{comment}{ !< An optional integer indicating which}} \DoxyCodeLine{758 \textcolor{comment}{ !! directions the data should be sent. It is TO\_ALL or the sum of any of TO\_EAST, TO\_WEST,}} \DoxyCodeLine{759 \textcolor{comment}{ !! TO\_NORTH, and TO\_SOUTH, possibly plus SCALAR\_PAIR if these are paired non-directional}} \DoxyCodeLine{760 \textcolor{comment}{ !! scalars discretized at the typical vector component locations. For example, TO\_EAST sends}} \DoxyCodeLine{761 \textcolor{comment}{ !! the data to the processor to the east, so the halos on the western side are filled. TO\_ALL}} \DoxyCodeLine{762 \textcolor{comment}{ !! is the default if omitted.}} \DoxyCodeLine{763 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: stagger\textcolor{comment}{ !< An optional flag, which may be one of A\_GRID,}} \DoxyCodeLine{764 \textcolor{comment}{ !! BGRID\_NE, or CGRID\_NE, indicating where the two components of the vector are}} \DoxyCodeLine{765 \textcolor{comment}{ !! discretized. Omitting stagger is the same as setting it to CGRID\_NE.}} \DoxyCodeLine{766 \textcolor{keywordtype}{logical}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: complete\textcolor{comment}{ !< An optional argument indicating whether the}} \DoxyCodeLine{767 \textcolor{comment}{ !! halo updates should be completed before progress resumes.}} \DoxyCodeLine{768 \textcolor{comment}{ !! Omitting complete is the same as setting complete to .true.}} \DoxyCodeLine{769 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: halo\textcolor{comment}{ !< The size of the halo to update - the full}} \DoxyCodeLine{770 \textcolor{comment}{ !! halo by default.}} \DoxyCodeLine{771 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: clock\textcolor{comment}{ !< The handle for a cpu time clock that should be}} \DoxyCodeLine{772 \textcolor{comment}{ !! started then stopped to time this routine.}} \DoxyCodeLine{773 \textcolor{keywordtype}{integer} :: pass\_vector\_start\_3d\textcolor{comment}{ !< The integer index for this}} \DoxyCodeLine{774 \textcolor{comment}{ !! update.}} \DoxyCodeLine{775 \textcolor{comment}{! Local variables}} \DoxyCodeLine{776 \textcolor{keywordtype}{integer} :: stagger\_local} \DoxyCodeLine{777 \textcolor{keywordtype}{integer} :: dirflag} \DoxyCodeLine{778 } \DoxyCodeLine{779 \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{780 } \DoxyCodeLine{781 stagger\_local = cgrid\_ne \textcolor{comment}{! Default value for type of grid}} \DoxyCodeLine{782 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(stagger)) stagger\_local = stagger} \DoxyCodeLine{783 } \DoxyCodeLine{784 dirflag = to\_all \textcolor{comment}{! 60}} \DoxyCodeLine{785 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(direction)) \textcolor{keywordflow}{then} ; \textcolor{keywordflow}{if} (direction > 0) dirflag = direction ;\textcolor{keywordflow}{ endif}} \DoxyCodeLine{786 } \DoxyCodeLine{787 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(halo) .and. mom\_dom\%thin\_halo\_updates) \textcolor{keywordflow}{then}} \DoxyCodeLine{788 pass\_vector\_start\_3d = mpp\_start\_update\_domains(u\_cmpt, v\_cmpt, \&} \DoxyCodeLine{789 mom\_dom\%mpp\_domain, flags=dirflag, gridtype=stagger\_local, \&} \DoxyCodeLine{790 whalo=halo, ehalo=halo, shalo=halo, nhalo=halo)} \DoxyCodeLine{791 \textcolor{keywordflow}{else}} \DoxyCodeLine{792 pass\_vector\_start\_3d = mpp\_start\_update\_domains(u\_cmpt, v\_cmpt, \&} \DoxyCodeLine{793 mom\_dom\%mpp\_domain, flags=dirflag, gridtype=stagger\_local)} \DoxyCodeLine{794 \textcolor{keywordflow}{ endif}} \DoxyCodeLine{795 } \DoxyCodeLine{796 \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{797 } \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}