source: CPL/oasis3-mct/branches/OASIS3-MCT_5.0_branch/doc/doxygen/latex/interfacemod__oasis__mpi_1_1oasis__mpi__sum.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: 23.7 KB
Line 
1\hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__sum}{}\section{mod\+\_\+oasis\+\_\+mpi\+:\+:oasis\+\_\+mpi\+\_\+sum Interface Reference}
2\label{interfacemod__oasis__mpi_1_1oasis__mpi__sum}\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}}
3
4
5Generic overloaded interface into M\+PI sum reduction. 
6
7
8\subsection*{Private Member Functions}
9\begin{DoxyCompactItemize}
10\item 
11subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__sum_ace0332192a77ef918fa53fa5087386cc}{oasis\+\_\+mpi\+\_\+sumi0} (lvec, gvec, comm, string, all)
12\begin{DoxyCompactList}\small\item\em Compute a global Sum for a scalar integer. \end{DoxyCompactList}\item 
13subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a98942ad26b72d6ff96fd8631ec70a5ce}{oasis\+\_\+mpi\+\_\+sumi1} (lvec, gvec, comm, string, all)
14\begin{DoxyCompactList}\small\item\em Compute a 1D array of global sums for an array of 1D integers. \end{DoxyCompactList}\item 
15subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a8d3b0d2544f1f360d83076b3d6dfe9e9}{oasis\+\_\+mpi\+\_\+sumb0} (lvec, gvec, comm, string, all)
16\begin{DoxyCompactList}\small\item\em Compute a global sum for a scalar 8 byte integer. \end{DoxyCompactList}\item 
17subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__sum_af53d904fe38089eb567660f0d4f89fb0}{oasis\+\_\+mpi\+\_\+sumb1} (lvec, gvec, comm, string, all)
18\begin{DoxyCompactList}\small\item\em Compute a 1D array of global sums for an array of 1D 8 byte integers. \end{DoxyCompactList}\item 
19subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__sum_abffb7172c344ad2577ac229168327fcd}{oasis\+\_\+mpi\+\_\+sumq0} (lvec, gvec, comm, string, all)
20\begin{DoxyCompactList}\small\item\em Compute a global sum for a scalar quad. \end{DoxyCompactList}\item 
21subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a96b845cbd75c4613df6fee8ac5c65d71}{oasis\+\_\+mpi\+\_\+sumq1} (lvec, gvec, comm, string, all)
22\begin{DoxyCompactList}\small\item\em Compute a 1D array of global sums for an array of 1D quads. \end{DoxyCompactList}\item 
23subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a030add8b5e1875ca3f80319d47c687a3}{oasis\+\_\+mpi\+\_\+sumq2} (lvec, gvec, comm, string, all)
24\begin{DoxyCompactList}\small\item\em Compute a 2D array of global sums for an array of 2D quads. \end{DoxyCompactList}\item 
25subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a95ded5a769c74998a3fe47b080aeb17e}{oasis\+\_\+mpi\+\_\+sumq3} (lvec, gvec, comm, string, all)
26\begin{DoxyCompactList}\small\item\em Compute a 3D array of global sums for an array of 3D quads. \end{DoxyCompactList}\item 
27subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__sum_aef927bb26681ca81b005940fad26d27f}{oasis\+\_\+mpi\+\_\+sumr0} (lvec, gvec, comm, string, all)
28\begin{DoxyCompactList}\small\item\em Compute a global sum for a scalar double. \end{DoxyCompactList}\item 
29subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a509c6561bf7677ca44df5727ec7af8bf}{oasis\+\_\+mpi\+\_\+sumr1} (lvec, gvec, comm, string, all)
30\begin{DoxyCompactList}\small\item\em Compute a 1D array of global sums for an array of 1D doubles. \end{DoxyCompactList}\item 
31subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a45b443ca4b94c71ad7be5e6b653d8b1f}{oasis\+\_\+mpi\+\_\+sumr2} (lvec, gvec, comm, string, all)
32\begin{DoxyCompactList}\small\item\em Compute a 2D array of global sums for an array of 2D doubles. \end{DoxyCompactList}\item 
33subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a31d24332ccc66502fcb78e5f69d19c45}{oasis\+\_\+mpi\+\_\+sumr3} (lvec, gvec, comm, string, all)
34\begin{DoxyCompactList}\small\item\em Compute a 3D array of global sums for an array of 3D doubles. \end{DoxyCompactList}\end{DoxyCompactItemize}
35
36
37\subsection{Detailed Description}
38Generic overloaded interface into M\+PI sum reduction.
39
40Definition at line 88 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
41
42
43
44\subsection{Member Function/\+Subroutine Documentation}
45\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a8d3b0d2544f1f360d83076b3d6dfe9e9}\label{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a8d3b0d2544f1f360d83076b3d6dfe9e9}} 
46\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}!oasis\+\_\+mpi\+\_\+sumb0@{oasis\+\_\+mpi\+\_\+sumb0}}
47\index{oasis\+\_\+mpi\+\_\+sumb0@{oasis\+\_\+mpi\+\_\+sumb0}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}}
48\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sumb0()}{oasis\_mpi\_sumb0()}}
49{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum\+::oasis\+\_\+mpi\+\_\+sumb0 (\begin{DoxyParamCaption}\item[{integer(ip\+\_\+i8\+\_\+p), intent(in)}]{lvec,  }\item[{integer(ip\+\_\+i8\+\_\+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]}}
50
51
52
53Compute a global sum for a scalar 8 byte integer.
54
55
56\begin{DoxyParams}[1]{Parameters}
57\mbox{\tt in}  & {\em lvec} & local values\\
58\hline
59\mbox{\tt out}  & {\em gvec} & global values\\
60\hline
61\mbox{\tt in}  & {\em comm} & mpi communicator\\
62\hline
63\mbox{\tt in}  & {\em string} & to identify caller\\
64\hline
65\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
66\hline
67\end{DoxyParams}
68
69
70Definition at line 1364 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
71
72\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__sum_af53d904fe38089eb567660f0d4f89fb0}\label{interfacemod__oasis__mpi_1_1oasis__mpi__sum_af53d904fe38089eb567660f0d4f89fb0}} 
73\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}!oasis\+\_\+mpi\+\_\+sumb1@{oasis\+\_\+mpi\+\_\+sumb1}}
74\index{oasis\+\_\+mpi\+\_\+sumb1@{oasis\+\_\+mpi\+\_\+sumb1}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}}
75\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sumb1()}{oasis\_mpi\_sumb1()}}
76{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum\+::oasis\+\_\+mpi\+\_\+sumb1 (\begin{DoxyParamCaption}\item[{integer(ip\+\_\+i8\+\_\+p), dimension(\+:), intent(in)}]{lvec,  }\item[{integer(ip\+\_\+i8\+\_\+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]}}
77
78
79
80Compute a 1D array of global sums for an array of 1D 8 byte integers.
81
82This sums an array of local integers to an array of summed integers. This does not reduce the array to a scalar.
83
84
85\begin{DoxyParams}[1]{Parameters}
86\mbox{\tt in}  & {\em lvec} & local values\\
87\hline
88\mbox{\tt out}  & {\em gvec} & global values\\
89\hline
90\mbox{\tt in}  & {\em comm} & mpi communicator\\
91\hline
92\mbox{\tt in}  & {\em string} & to identify caller\\
93\hline
94\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
95\hline
96\end{DoxyParams}
97
98
99Definition at line 1430 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
100
101\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__sum_ace0332192a77ef918fa53fa5087386cc}\label{interfacemod__oasis__mpi_1_1oasis__mpi__sum_ace0332192a77ef918fa53fa5087386cc}} 
102\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}!oasis\+\_\+mpi\+\_\+sumi0@{oasis\+\_\+mpi\+\_\+sumi0}}
103\index{oasis\+\_\+mpi\+\_\+sumi0@{oasis\+\_\+mpi\+\_\+sumi0}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}}
104\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sumi0()}{oasis\_mpi\_sumi0()}}
105{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum\+::oasis\+\_\+mpi\+\_\+sumi0 (\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]}}
106
107
108
109Compute a global Sum for a scalar integer.
110
111
112\begin{DoxyParams}[1]{Parameters}
113\mbox{\tt in}  & {\em lvec} & local values\\
114\hline
115\mbox{\tt out}  & {\em gvec} & global values\\
116\hline
117\mbox{\tt in}  & {\em comm} & mpi communicator\\
118\hline
119\mbox{\tt in}  & {\em string} & to identify caller\\
120\hline
121\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
122\hline
123\end{DoxyParams}
124
125
126Definition at line 1235 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
127
128\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a98942ad26b72d6ff96fd8631ec70a5ce}\label{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a98942ad26b72d6ff96fd8631ec70a5ce}} 
129\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}!oasis\+\_\+mpi\+\_\+sumi1@{oasis\+\_\+mpi\+\_\+sumi1}}
130\index{oasis\+\_\+mpi\+\_\+sumi1@{oasis\+\_\+mpi\+\_\+sumi1}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}}
131\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sumi1()}{oasis\_mpi\_sumi1()}}
132{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum\+::oasis\+\_\+mpi\+\_\+sumi1 (\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]}}
133
134
135
136Compute a 1D array of global sums for an array of 1D integers.
137
138This sums an array of local integers to an array of summed integers. This does not reduce the array to a scalar.
139
140
141\begin{DoxyParams}[1]{Parameters}
142\mbox{\tt in}  & {\em lvec} & local values\\
143\hline
144\mbox{\tt out}  & {\em gvec} & global values\\
145\hline
146\mbox{\tt in}  & {\em comm} & mpi communicator\\
147\hline
148\mbox{\tt in}  & {\em string} & to identify caller\\
149\hline
150\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
151\hline
152\end{DoxyParams}
153
154
155Definition at line 1301 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
156
157\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__sum_abffb7172c344ad2577ac229168327fcd}\label{interfacemod__oasis__mpi_1_1oasis__mpi__sum_abffb7172c344ad2577ac229168327fcd}} 
158\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}!oasis\+\_\+mpi\+\_\+sumq0@{oasis\+\_\+mpi\+\_\+sumq0}}
159\index{oasis\+\_\+mpi\+\_\+sumq0@{oasis\+\_\+mpi\+\_\+sumq0}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}}
160\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sumq0()}{oasis\_mpi\_sumq0()}}
161{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum\+::oasis\+\_\+mpi\+\_\+sumq0 (\begin{DoxyParamCaption}\item[{real(ip\+\_\+quad\+\_\+p), intent(in)}]{lvec,  }\item[{real(ip\+\_\+quad\+\_\+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]}}
162
163
164
165Compute a global sum for a scalar quad.
166
167
168\begin{DoxyParams}[1]{Parameters}
169\mbox{\tt in}  & {\em lvec} & local values\\
170\hline
171\mbox{\tt out}  & {\em gvec} & global values\\
172\hline
173\mbox{\tt in}  & {\em comm} & mpi communicator\\
174\hline
175\mbox{\tt in}  & {\em string} & to identify caller\\
176\hline
177\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
178\hline
179\end{DoxyParams}
180
181
182Definition at line 1756 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
183
184\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a96b845cbd75c4613df6fee8ac5c65d71}\label{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a96b845cbd75c4613df6fee8ac5c65d71}} 
185\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}!oasis\+\_\+mpi\+\_\+sumq1@{oasis\+\_\+mpi\+\_\+sumq1}}
186\index{oasis\+\_\+mpi\+\_\+sumq1@{oasis\+\_\+mpi\+\_\+sumq1}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}}
187\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sumq1()}{oasis\_mpi\_sumq1()}}
188{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum\+::oasis\+\_\+mpi\+\_\+sumq1 (\begin{DoxyParamCaption}\item[{real(ip\+\_\+quad\+\_\+p), dimension(\+:), intent(in)}]{lvec,  }\item[{real(ip\+\_\+quad\+\_\+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]}}
189
190
191
192Compute a 1D array of global sums for an array of 1D quads.
193
194This sums an array of local quads to an array of summed quads. This does not reduce the array to a scalar.
195
196
197\begin{DoxyParams}[1]{Parameters}
198\mbox{\tt in}  & {\em lvec} & local values\\
199\hline
200\mbox{\tt out}  & {\em gvec} & global values\\
201\hline
202\mbox{\tt in}  & {\em comm} & mpi communicator\\
203\hline
204\mbox{\tt in}  & {\em string} & to identify caller\\
205\hline
206\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
207\hline
208\end{DoxyParams}
209
210
211Definition at line 1822 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
212
213\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a030add8b5e1875ca3f80319d47c687a3}\label{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a030add8b5e1875ca3f80319d47c687a3}} 
214\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}!oasis\+\_\+mpi\+\_\+sumq2@{oasis\+\_\+mpi\+\_\+sumq2}}
215\index{oasis\+\_\+mpi\+\_\+sumq2@{oasis\+\_\+mpi\+\_\+sumq2}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}}
216\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sumq2()}{oasis\_mpi\_sumq2()}}
217{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum\+::oasis\+\_\+mpi\+\_\+sumq2 (\begin{DoxyParamCaption}\item[{real(ip\+\_\+quad\+\_\+p), dimension(\+:,\+:), intent(in)}]{lvec,  }\item[{real(ip\+\_\+quad\+\_\+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]}}
218
219
220
221Compute a 2D array of global sums for an array of 2D quads.
222
223This sums an array of local quads to an array of summed quads. This does not reduce the array to a scalar.
224
225
226\begin{DoxyParams}[1]{Parameters}
227\mbox{\tt in}  & {\em lvec} & local values\\
228\hline
229\mbox{\tt out}  & {\em gvec} & global values\\
230\hline
231\mbox{\tt in}  & {\em comm} & mpi communicator\\
232\hline
233\mbox{\tt in}  & {\em string} & to identify caller\\
234\hline
235\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
236\hline
237\end{DoxyParams}
238
239
240Definition at line 1888 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
241
242\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a95ded5a769c74998a3fe47b080aeb17e}\label{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a95ded5a769c74998a3fe47b080aeb17e}} 
243\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}!oasis\+\_\+mpi\+\_\+sumq3@{oasis\+\_\+mpi\+\_\+sumq3}}
244\index{oasis\+\_\+mpi\+\_\+sumq3@{oasis\+\_\+mpi\+\_\+sumq3}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}}
245\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sumq3()}{oasis\_mpi\_sumq3()}}
246{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum\+::oasis\+\_\+mpi\+\_\+sumq3 (\begin{DoxyParamCaption}\item[{real(ip\+\_\+quad\+\_\+p), dimension(\+:,\+:,\+:), intent(in)}]{lvec,  }\item[{real(ip\+\_\+quad\+\_\+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]}}
247
248
249
250Compute a 3D array of global sums for an array of 3D quads.
251
252This sums an array of local quads to an array of summed quads. This does not reduce the array to a scalar.
253
254
255\begin{DoxyParams}[1]{Parameters}
256\mbox{\tt in}  & {\em lvec} & local values\\
257\hline
258\mbox{\tt out}  & {\em gvec} & global values\\
259\hline
260\mbox{\tt in}  & {\em comm} & mpi communicator\\
261\hline
262\mbox{\tt in}  & {\em string} & to identify caller\\
263\hline
264\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
265\hline
266\end{DoxyParams}
267
268
269Definition at line 1954 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
270
271\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__sum_aef927bb26681ca81b005940fad26d27f}\label{interfacemod__oasis__mpi_1_1oasis__mpi__sum_aef927bb26681ca81b005940fad26d27f}} 
272\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}!oasis\+\_\+mpi\+\_\+sumr0@{oasis\+\_\+mpi\+\_\+sumr0}}
273\index{oasis\+\_\+mpi\+\_\+sumr0@{oasis\+\_\+mpi\+\_\+sumr0}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}}
274\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sumr0()}{oasis\_mpi\_sumr0()}}
275{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum\+::oasis\+\_\+mpi\+\_\+sumr0 (\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]}}
276
277
278
279Compute a global sum for a scalar double.
280
281
282\begin{DoxyParams}[1]{Parameters}
283\mbox{\tt in}  & {\em lvec} & local values\\
284\hline
285\mbox{\tt out}  & {\em gvec} & global values\\
286\hline
287\mbox{\tt in}  & {\em comm} & mpi communicator\\
288\hline
289\mbox{\tt in}  & {\em string} & to identify caller\\
290\hline
291\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
292\hline
293\end{DoxyParams}
294
295
296Definition at line 1493 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
297
298\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a509c6561bf7677ca44df5727ec7af8bf}\label{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a509c6561bf7677ca44df5727ec7af8bf}} 
299\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}!oasis\+\_\+mpi\+\_\+sumr1@{oasis\+\_\+mpi\+\_\+sumr1}}
300\index{oasis\+\_\+mpi\+\_\+sumr1@{oasis\+\_\+mpi\+\_\+sumr1}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}}
301\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sumr1()}{oasis\_mpi\_sumr1()}}
302{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum\+::oasis\+\_\+mpi\+\_\+sumr1 (\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]}}
303
304
305
306Compute a 1D array of global sums for an array of 1D doubles.
307
308This sums an array of local doubles to an array of summed doubles. This does not reduce the array to a scalar.
309
310
311\begin{DoxyParams}[1]{Parameters}
312\mbox{\tt in}  & {\em lvec} & local values\\
313\hline
314\mbox{\tt out}  & {\em gvec} & global values\\
315\hline
316\mbox{\tt in}  & {\em comm} & mpi communicator\\
317\hline
318\mbox{\tt in}  & {\em string} & to identify caller\\
319\hline
320\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
321\hline
322\end{DoxyParams}
323
324
325Definition at line 1559 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
326
327\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a45b443ca4b94c71ad7be5e6b653d8b1f}\label{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a45b443ca4b94c71ad7be5e6b653d8b1f}} 
328\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}!oasis\+\_\+mpi\+\_\+sumr2@{oasis\+\_\+mpi\+\_\+sumr2}}
329\index{oasis\+\_\+mpi\+\_\+sumr2@{oasis\+\_\+mpi\+\_\+sumr2}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}}
330\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sumr2()}{oasis\_mpi\_sumr2()}}
331{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum\+::oasis\+\_\+mpi\+\_\+sumr2 (\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]}}
332
333
334
335Compute a 2D array of global sums for an array of 2D doubles.
336
337This sums an array of local doubles to an array of summed doubles. This does not reduce the array to a scalar.
338
339
340\begin{DoxyParams}[1]{Parameters}
341\mbox{\tt in}  & {\em lvec} & local values\\
342\hline
343\mbox{\tt out}  & {\em gvec} & global values\\
344\hline
345\mbox{\tt in}  & {\em comm} & mpi communicator\\
346\hline
347\mbox{\tt in}  & {\em string} & to identify caller\\
348\hline
349\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
350\hline
351\end{DoxyParams}
352
353
354Definition at line 1625 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
355
356\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a31d24332ccc66502fcb78e5f69d19c45}\label{interfacemod__oasis__mpi_1_1oasis__mpi__sum_a31d24332ccc66502fcb78e5f69d19c45}} 
357\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}!oasis\+\_\+mpi\+\_\+sumr3@{oasis\+\_\+mpi\+\_\+sumr3}}
358\index{oasis\+\_\+mpi\+\_\+sumr3@{oasis\+\_\+mpi\+\_\+sumr3}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum}}
359\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sumr3()}{oasis\_mpi\_sumr3()}}
360{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+sum\+::oasis\+\_\+mpi\+\_\+sumr3 (\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]}}
361
362
363
364Compute a 3D array of global sums for an array of 3D doubles.
365
366This sums an array of local doubles to an array of summed doubles. This does not reduce the array to a scalar.
367
368
369\begin{DoxyParams}[1]{Parameters}
370\mbox{\tt in}  & {\em lvec} & local values\\
371\hline
372\mbox{\tt out}  & {\em gvec} & global values\\
373\hline
374\mbox{\tt in}  & {\em comm} & mpi communicator\\
375\hline
376\mbox{\tt in}  & {\em string} & to identify caller\\
377\hline
378\mbox{\tt in}  & {\em all} & if true call allreduce, otherwise reduce to task 0 \\
379\hline
380\end{DoxyParams}
381
382
383Definition at line 1691 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
384
385
386
387The documentation for this interface was generated from the following file\+:\begin{DoxyCompactItemize}
388\item 
389/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.