source: CPL/oasis3-mct/branches/OASIS3-MCT_5.0_branch/doc/doxygen/latex/interfacemod__oasis__mpi_1_1oasis__mpi__max.tex @ 6331

Last change on this file since 6331 was 6331, checked in by aclsce, 17 months ago

Moved oasis-mct_5.0 in oasis3-mct/branches directory.
File size: 8.2 KB
Line 
1\hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__max}{}\section{mod\+\_\+oasis\+\_\+mpi\+:\+:oasis\+\_\+mpi\+\_\+max Interface Reference}
2\label{interfacemod__oasis__mpi_1_1oasis__mpi__max}\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max}}
3
4
5Generic overloaded interface into M\+PI max reduction. 
6
7
8\subsection*{Private Member Functions}
9\begin{DoxyCompactItemize}
10\item 
11subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__max_a713608b4fe433467df0eaa3bdf84ec11}{oasis\+\_\+mpi\+\_\+maxi0} (lvec, gvec, comm, string, all)
12\begin{DoxyCompactList}\small\item\em Compute a global maximum for a scalar integer. \end{DoxyCompactList}\item 
13subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__max_a3b47b877c66859e93a366d76769e7c16}{oasis\+\_\+mpi\+\_\+maxi1} (lvec, gvec, comm, string, all)
14\begin{DoxyCompactList}\small\item\em Compute an array of global maximums for an array of 1D integers. \end{DoxyCompactList}\item 
15subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__max_abe9d60c763e34813e83ad556b5ae679a}{oasis\+\_\+mpi\+\_\+maxr0} (lvec, gvec, comm, string, all)
16\begin{DoxyCompactList}\small\item\em Compute a global maximum for a scalar double. \end{DoxyCompactList}\item 
17subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__max_a4bd1cea5e9e55f3795538b1a44bdb6e4}{oasis\+\_\+mpi\+\_\+maxr1} (lvec, gvec, comm, string, all)
18\begin{DoxyCompactList}\small\item\em Compute an array of global maximums for an array of 1D doubles. \end{DoxyCompactList}\end{DoxyCompactItemize}
19
20
21\subsection{Detailed Description}
22Generic overloaded interface into M\+PI max reduction.
23
24Definition at line 114 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
25
26
27
28\subsection{Member Function/\+Subroutine Documentation}
29\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__max_a713608b4fe433467df0eaa3bdf84ec11}\label{interfacemod__oasis__mpi_1_1oasis__mpi__max_a713608b4fe433467df0eaa3bdf84ec11}} 
30\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max}!oasis\+\_\+mpi\+\_\+maxi0@{oasis\+\_\+mpi\+\_\+maxi0}}
31\index{oasis\+\_\+mpi\+\_\+maxi0@{oasis\+\_\+mpi\+\_\+maxi0}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max}}
32\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+maxi0()}{oasis\_mpi\_maxi0()}}
33{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max\+::oasis\+\_\+mpi\+\_\+maxi0 (\begin{DoxyParamCaption}\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{lvec,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(out)}]{gvec,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{comm,  }\item[{character($\ast$), intent(in), optional}]{string,  }\item[{logical, intent(in), optional}]{all }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
34
35
36
37Compute a global maximum for a scalar integer.
38
39
40\begin{DoxyParams}[1]{Parameters}
41\mbox{\tt in}  & {\em lvec} & local values\\
42\hline
43\mbox{\tt out}  & {\em gvec} & global values\\
44\hline
45\mbox{\tt in}  & {\em comm} & mpi communicator\\
46\hline
47\mbox{\tt in}  & {\em string} & to identify caller\\
48\hline
49\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
50\hline
51\end{DoxyParams}
52
53
54Definition at line 2271 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
55
56\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__max_a3b47b877c66859e93a366d76769e7c16}\label{interfacemod__oasis__mpi_1_1oasis__mpi__max_a3b47b877c66859e93a366d76769e7c16}} 
57\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max}!oasis\+\_\+mpi\+\_\+maxi1@{oasis\+\_\+mpi\+\_\+maxi1}}
58\index{oasis\+\_\+mpi\+\_\+maxi1@{oasis\+\_\+mpi\+\_\+maxi1}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max}}
59\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+maxi1()}{oasis\_mpi\_maxi1()}}
60{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max\+::oasis\+\_\+mpi\+\_\+maxi1 (\begin{DoxyParamCaption}\item[{integer(ip\+\_\+i4\+\_\+p), dimension(\+:), intent(in)}]{lvec,  }\item[{integer(ip\+\_\+i4\+\_\+p), dimension(\+:), intent(out)}]{gvec,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{comm,  }\item[{character($\ast$), intent(in), optional}]{string,  }\item[{logical, intent(in), optional}]{all }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
61
62
63
64Compute an array of global maximums for an array of 1D integers.
65
66
67\begin{DoxyParams}[1]{Parameters}
68\mbox{\tt in}  & {\em lvec} & local values\\
69\hline
70\mbox{\tt out}  & {\em gvec} & global values\\
71\hline
72\mbox{\tt in}  & {\em comm} & mpi communicator\\
73\hline
74\mbox{\tt in}  & {\em string} & to identify caller\\
75\hline
76\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
77\hline
78\end{DoxyParams}
79
80
81Definition at line 2334 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
82
83\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__max_abe9d60c763e34813e83ad556b5ae679a}\label{interfacemod__oasis__mpi_1_1oasis__mpi__max_abe9d60c763e34813e83ad556b5ae679a}} 
84\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max}!oasis\+\_\+mpi\+\_\+maxr0@{oasis\+\_\+mpi\+\_\+maxr0}}
85\index{oasis\+\_\+mpi\+\_\+maxr0@{oasis\+\_\+mpi\+\_\+maxr0}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max}}
86\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+maxr0()}{oasis\_mpi\_maxr0()}}
87{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max\+::oasis\+\_\+mpi\+\_\+maxr0 (\begin{DoxyParamCaption}\item[{real(ip\+\_\+double\+\_\+p), intent(in)}]{lvec,  }\item[{real(ip\+\_\+double\+\_\+p), intent(out)}]{gvec,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{comm,  }\item[{character($\ast$), intent(in), optional}]{string,  }\item[{logical, intent(in), optional}]{all }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
88
89
90
91Compute a global maximum for a scalar double.
92
93
94\begin{DoxyParams}[1]{Parameters}
95\mbox{\tt in}  & {\em lvec} & local values\\
96\hline
97\mbox{\tt out}  & {\em gvec} & global values\\
98\hline
99\mbox{\tt in}  & {\em comm} & mpi communicator\\
100\hline
101\mbox{\tt in}  & {\em string} & to identify caller\\
102\hline
103\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
104\hline
105\end{DoxyParams}
106
107
108Definition at line 2397 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
109
110\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__max_a4bd1cea5e9e55f3795538b1a44bdb6e4}\label{interfacemod__oasis__mpi_1_1oasis__mpi__max_a4bd1cea5e9e55f3795538b1a44bdb6e4}} 
111\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max}!oasis\+\_\+mpi\+\_\+maxr1@{oasis\+\_\+mpi\+\_\+maxr1}}
112\index{oasis\+\_\+mpi\+\_\+maxr1@{oasis\+\_\+mpi\+\_\+maxr1}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max}}
113\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+maxr1()}{oasis\_mpi\_maxr1()}}
114{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+max\+::oasis\+\_\+mpi\+\_\+maxr1 (\begin{DoxyParamCaption}\item[{real(ip\+\_\+double\+\_\+p), dimension(\+:), intent(in)}]{lvec,  }\item[{real(ip\+\_\+double\+\_\+p), dimension(\+:), intent(out)}]{gvec,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{comm,  }\item[{character($\ast$), intent(in), optional}]{string,  }\item[{logical, intent(in), optional}]{all }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
115
116
117
118Compute an array of global maximums for an array of 1D doubles.
119
120
121\begin{DoxyParams}[1]{Parameters}
122\mbox{\tt in}  & {\em lvec} & local values\\
123\hline
124\mbox{\tt out}  & {\em gvec} & global values\\
125\hline
126\mbox{\tt in}  & {\em comm} & mpi communicator\\
127\hline
128\mbox{\tt in}  & {\em string} & to identify caller\\
129\hline
130\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
131\hline
132\end{DoxyParams}
133
134
135Definition at line 2460 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
136
137
138
139The documentation for this interface was generated from the following file\+:\begin{DoxyCompactItemize}
140\item 
141/home/globc2/tcraig/oasis3-\/mct.\+trunk/lib/psmile/src/\hyperlink{mod__oasis__mpi_8_f90}{mod\+\_\+oasis\+\_\+mpi.\+F90}\end{DoxyCompactItemize}
Note: See TracBrowser for help on using the repository browser.