\hypertarget{interfacemom__domains_1_1pass__var__complete}{}\section{mom\+\_\+domains\+:\+:pass\+\_\+var\+\_\+complete Interface Reference} \label{interfacemom__domains_1_1pass__var__complete}\index{mom\+\_\+domains\+::pass\+\_\+var\+\_\+complete@{mom\+\_\+domains\+::pass\+\_\+var\+\_\+complete}} \subsection{Detailed Description} Complete a non-\/blocking halo update on an array. Definition at line 69 of file M\+O\+M\+\_\+domains.\+F90. \subsection*{Private functions} \begin{DoxyCompactItemize} \item subroutine \hyperlink{interfacemom__domains_1_1pass__var__complete_ae3647bb846a98d1928467a3eb155d054}{pass\+\_\+var\+\_\+complete\+\_\+3d} (id\+\_\+update, array, M\+O\+M\+\_\+dom, sideflag, position, halo, clock) \begin{DoxyCompactList}\small\item\em pass\+\_\+var\+\_\+complete\+\_\+3d completes a halo update for a three-\/dimensional array. \end{DoxyCompactList}\item subroutine \hyperlink{interfacemom__domains_1_1pass__var__complete_a75f20cc7edab74d4f7188db023d253aa}{pass\+\_\+var\+\_\+complete\+\_\+2d} (id\+\_\+update, array, M\+O\+M\+\_\+dom, sideflag, position, halo, clock) \begin{DoxyCompactList}\small\item\em pass\+\_\+var\+\_\+complete\+\_\+2d completes a halo update for a two-\/dimensional array. \end{DoxyCompactList}\end{DoxyCompactItemize} \subsection{Detailed Description} Complete a non-\/blocking halo update on an array. Definition at line 69 of file M\+O\+M\+\_\+domains.\+F90. \subsection{Functions and subroutines} \mbox{\Hypertarget{interfacemom__domains_1_1pass__var__complete_a75f20cc7edab74d4f7188db023d253aa}\label{interfacemom__domains_1_1pass__var__complete_a75f20cc7edab74d4f7188db023d253aa}} \index{mom\+\_\+domains\+::pass\+\_\+var\+\_\+complete@{mom\+\_\+domains\+::pass\+\_\+var\+\_\+complete}!pass\+\_\+var\+\_\+complete\+\_\+2d@{pass\+\_\+var\+\_\+complete\+\_\+2d}} \index{pass\+\_\+var\+\_\+complete\+\_\+2d@{pass\+\_\+var\+\_\+complete\+\_\+2d}!mom\+\_\+domains\+::pass\+\_\+var\+\_\+complete@{mom\+\_\+domains\+::pass\+\_\+var\+\_\+complete}} \subsubsection{\texorpdfstring{pass\+\_\+var\+\_\+complete\+\_\+2d()}{pass\_var\_complete\_2d()}} {\footnotesize\ttfamily subroutine mom\+\_\+domains\+::pass\+\_\+var\+\_\+complete\+::pass\+\_\+var\+\_\+complete\+\_\+2d (\begin{DoxyParamCaption}\item[{integer, intent(in)}]{id\+\_\+update, }\item[{real, dimension(\+:,\+:), intent(inout)}]{array, }\item[{type(\hyperlink{structmom__domains_1_1mom__domain__type}{mom\+\_\+domain\+\_\+type}), intent(inout)}]{M\+O\+M\+\_\+dom, }\item[{integer, intent(in), optional}]{sideflag, }\item[{integer, intent(in), optional}]{position, }\item[{integer, intent(in), optional}]{halo, }\item[{integer, intent(in), optional}]{clock }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} pass\+\_\+var\+\_\+complete\+\_\+2d completes a halo update for a two-\/dimensional array. \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 \hyperlink{interfacemom__domains_1_1pass__var__start}{pass\+\_\+var\+\_\+start}.\\ \hline \mbox{\tt in,out} & {\em array} & The array 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 sideflag} & 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. 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 sideflag is omitted.\\ \hline \mbox{\tt in} & {\em position} & An optional argument indicating the position. This is C\+E\+N\+T\+ER by default and is often C\+O\+R\+N\+ER, but could also be E\+A\+S\+T\+\_\+\+F\+A\+CE or N\+O\+R\+T\+H\+\_\+\+F\+A\+CE.\\ \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 400 of file M\+O\+M\+\_\+domains.\+F90. \begin{DoxyCode} 400 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{intent(in)} :: id\_update\textcolor{comment}{ !< The integer id of this update which has} 401 \textcolor{comment}{ !! been returned from a previous call to} 402 \textcolor{comment}{ !! pass\_var\_start.} 403 \textcolor{keywordtype}{real}, \textcolor{keywordtype}{dimension(:,:)}, \textcolor{keywordtype}{intent(inout)} :: array\textcolor{comment}{ !< The array which is having its halos points} 404 \textcolor{comment}{ !! exchanged.} 405 \textcolor{keywordtype}{type}(mom\_domain\_type), \textcolor{keywordtype}{intent(inout)} :: mom\_dom\textcolor{comment}{ !< The MOM\_domain\_type containing the mpp\_domain} 406 \textcolor{comment}{ !! needed to determine where data should be} 407 \textcolor{comment}{ !! sent.} 408 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: sideflag\textcolor{comment}{ !< An optional integer indicating which} 409 \textcolor{comment}{ !! directions the data should be sent. It is TO\_ALL or the sum of any of TO\_EAST, TO\_WEST,} 410 \textcolor{comment}{ !! TO\_NORTH, and TO\_SOUTH. For example, TO\_EAST sends the data to the processor to the east,} 411 \textcolor{comment}{ !! so the halos on the western side are filled. TO\_ALL is the default if sideflag is omitted.} 412 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: position\textcolor{comment}{ !< An optional argument indicating the position.} 413 \textcolor{comment}{ !! This is CENTER by default and is often CORNER,} 414 \textcolor{comment}{ !! but could also be EAST\_FACE or NORTH\_FACE.} 415 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: halo\textcolor{comment}{ !< The size of the halo to update - the full} 416 \textcolor{comment}{ !! halo by default.} 417 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: clock\textcolor{comment}{ !< The handle for a cpu time clock that should be} 418 \textcolor{comment}{ !! started then stopped to time this routine.} 419 420 \textcolor{keywordtype}{integer} :: dirflag 421 422 \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} 423 424 dirflag = to\_all \textcolor{comment}{! 60} 425 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(sideflag)) \textcolor{keywordflow}{then} ; \textcolor{keywordflow}{if} (sideflag > 0) dirflag = sideflag ;\textcolor{keywordflow}{ endif} 426 427 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(halo) .and. mom\_dom%thin\_halo\_updates) \textcolor{keywordflow}{then} 428 \textcolor{keyword}{call }mpp\_complete\_update\_domains(id\_update, array, mom\_dom%mpp\_domain, & 429 flags=dirflag, position=position, & 430 whalo=halo, ehalo=halo, shalo=halo, nhalo=halo) 431 \textcolor{keywordflow}{else} 432 \textcolor{keyword}{call }mpp\_complete\_update\_domains(id\_update, array, mom\_dom%mpp\_domain, & 433 flags=dirflag, position=position) 434 \textcolor{keywordflow}{ endif} 435 436 \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} 437 \end{DoxyCode} \mbox{\Hypertarget{interfacemom__domains_1_1pass__var__complete_ae3647bb846a98d1928467a3eb155d054}\label{interfacemom__domains_1_1pass__var__complete_ae3647bb846a98d1928467a3eb155d054}} \index{mom\+\_\+domains\+::pass\+\_\+var\+\_\+complete@{mom\+\_\+domains\+::pass\+\_\+var\+\_\+complete}!pass\+\_\+var\+\_\+complete\+\_\+3d@{pass\+\_\+var\+\_\+complete\+\_\+3d}} \index{pass\+\_\+var\+\_\+complete\+\_\+3d@{pass\+\_\+var\+\_\+complete\+\_\+3d}!mom\+\_\+domains\+::pass\+\_\+var\+\_\+complete@{mom\+\_\+domains\+::pass\+\_\+var\+\_\+complete}} \subsubsection{\texorpdfstring{pass\+\_\+var\+\_\+complete\+\_\+3d()}{pass\_var\_complete\_3d()}} {\footnotesize\ttfamily subroutine mom\+\_\+domains\+::pass\+\_\+var\+\_\+complete\+::pass\+\_\+var\+\_\+complete\+\_\+3d (\begin{DoxyParamCaption}\item[{integer, intent(in)}]{id\+\_\+update, }\item[{real, dimension(\+:,\+:,\+:), intent(inout)}]{array, }\item[{type(\hyperlink{structmom__domains_1_1mom__domain__type}{mom\+\_\+domain\+\_\+type}), intent(inout)}]{M\+O\+M\+\_\+dom, }\item[{integer, intent(in), optional}]{sideflag, }\item[{integer, intent(in), optional}]{position, }\item[{integer, intent(in), optional}]{halo, }\item[{integer, intent(in), optional}]{clock }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}} pass\+\_\+var\+\_\+complete\+\_\+3d completes a halo update for a three-\/dimensional array. \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 \hyperlink{interfacemom__domains_1_1pass__var__start}{pass\+\_\+var\+\_\+start}.\\ \hline \mbox{\tt in,out} & {\em array} & The array 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 sideflag} & 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. 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 sideflag is omitted.\\ \hline \mbox{\tt in} & {\em position} & An optional argument indicating the position. This is C\+E\+N\+T\+ER by default and is often C\+O\+R\+N\+ER, but could also be E\+A\+S\+T\+\_\+\+F\+A\+CE or N\+O\+R\+T\+H\+\_\+\+F\+A\+CE.\\ \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 443 of file M\+O\+M\+\_\+domains.\+F90. \begin{DoxyCode} 443 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{intent(in)} :: id\_update\textcolor{comment}{ !< The integer id of this update which has} 444 \textcolor{comment}{ !! been returned from a previous call to} 445 \textcolor{comment}{ !! pass\_var\_start.} 446 \textcolor{keywordtype}{real}, \textcolor{keywordtype}{dimension(:,:,:)}, \textcolor{keywordtype}{intent(inout)} :: array\textcolor{comment}{ !< The array which is having its halos points} 447 \textcolor{comment}{ !! exchanged.} 448 \textcolor{keywordtype}{type}(mom\_domain\_type), \textcolor{keywordtype}{intent(inout)} :: mom\_dom\textcolor{comment}{ !< The MOM\_domain\_type containing the mpp\_domain} 449 \textcolor{comment}{ !! needed to determine where data should be} 450 \textcolor{comment}{ !! sent.} 451 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: sideflag\textcolor{comment}{ !< An optional integer indicating which} 452 \textcolor{comment}{ !! directions the data should be sent. It is TO\_ALL or the sum of any of TO\_EAST, TO\_WEST,} 453 \textcolor{comment}{ !! TO\_NORTH, and TO\_SOUTH. For example, TO\_EAST sends the data to the processor to the east,} 454 \textcolor{comment}{ !! so the halos on the western side are filled. TO\_ALL is the default if sideflag is omitted.} 455 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: position\textcolor{comment}{ !< An optional argument indicating the position.} 456 \textcolor{comment}{ !! This is CENTER by default and is often CORNER,} 457 \textcolor{comment}{ !! but could also be EAST\_FACE or NORTH\_FACE.} 458 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: halo\textcolor{comment}{ !< The size of the halo to update - the full} 459 \textcolor{comment}{ !! halo by default.} 460 \textcolor{keywordtype}{integer}, \textcolor{keywordtype}{optional}, \textcolor{keywordtype}{intent(in)} :: clock\textcolor{comment}{ !< The handle for a cpu time clock that should be} 461 \textcolor{comment}{ !! started then stopped to time this routine.} 462 463 \textcolor{keywordtype}{integer} :: dirflag 464 465 \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} 466 467 dirflag = to\_all \textcolor{comment}{! 60} 468 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(sideflag)) \textcolor{keywordflow}{then} ; \textcolor{keywordflow}{if} (sideflag > 0) dirflag = sideflag ;\textcolor{keywordflow}{ endif} 469 470 \textcolor{keywordflow}{if} (\textcolor{keyword}{present}(halo) .and. mom\_dom%thin\_halo\_updates) \textcolor{keywordflow}{then} 471 \textcolor{keyword}{call }mpp\_complete\_update\_domains(id\_update, array, mom\_dom%mpp\_domain, & 472 flags=dirflag, position=position, & 473 whalo=halo, ehalo=halo, shalo=halo, nhalo=halo) 474 \textcolor{keywordflow}{else} 475 \textcolor{keyword}{call }mpp\_complete\_update\_domains(id\_update, array, mom\_dom%mpp\_domain, & 476 flags=dirflag, position=position) 477 \textcolor{keywordflow}{ endif} 478 479 \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} 480 \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}