source: CPL/oasis3-mct_5.0/doc/doxygen/latex/interfacemod__oasis__mpi_1_1oasis__mpi__min.tex @ 6328

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

First import of oasis3-mct_5.0 (from oasis git server, branch OASIS3-MCT_5.0)
File size: 8.2 KB
Line 
1\hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__min}{}\section{mod\+\_\+oasis\+\_\+mpi\+:\+:oasis\+\_\+mpi\+\_\+min Interface Reference}
2\label{interfacemod__oasis__mpi_1_1oasis__mpi__min}\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min}}
3
4
5Generic overloaded interface into M\+PI min reduction. 
6
7
8\subsection*{Private Member Functions}
9\begin{DoxyCompactItemize}
10\item 
11subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__min_a1deee0fc506aeabafcf4a33866694934}{oasis\+\_\+mpi\+\_\+mini0} (lvec, gvec, comm, string, all)
12\begin{DoxyCompactList}\small\item\em Compute a global minimum for a scalar integer. \end{DoxyCompactList}\item 
13subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__min_a7f514ac7a5701f4a5ce8612d2e8bcb16}{oasis\+\_\+mpi\+\_\+mini1} (lvec, gvec, comm, string, all)
14\begin{DoxyCompactList}\small\item\em Compute an array of global minimums for an array of 1D integers. \end{DoxyCompactList}\item 
15subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__min_a18098e0abd7924b31d64e06c789aa0c4}{oasis\+\_\+mpi\+\_\+minr0} (lvec, gvec, comm, string, all)
16\begin{DoxyCompactList}\small\item\em Compute an global minimum for a scalar double. \end{DoxyCompactList}\item 
17subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__min_a62604730fbe7bf0dc21cf9fb9d83e981}{oasis\+\_\+mpi\+\_\+minr1} (lvec, gvec, comm, string, all)
18\begin{DoxyCompactList}\small\item\em Compute an array of global minimums for an array of 1D doubles. \end{DoxyCompactList}\end{DoxyCompactItemize}
19
20
21\subsection{Detailed Description}
22Generic overloaded interface into M\+PI min reduction.
23
24Definition at line 106 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
25
26
27
28\subsection{Member Function/\+Subroutine Documentation}
29\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__min_a1deee0fc506aeabafcf4a33866694934}\label{interfacemod__oasis__mpi_1_1oasis__mpi__min_a1deee0fc506aeabafcf4a33866694934}} 
30\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min}!oasis\+\_\+mpi\+\_\+mini0@{oasis\+\_\+mpi\+\_\+mini0}}
31\index{oasis\+\_\+mpi\+\_\+mini0@{oasis\+\_\+mpi\+\_\+mini0}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min}}
32\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+mini0()}{oasis\_mpi\_mini0()}}
33{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min\+::oasis\+\_\+mpi\+\_\+mini0 (\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 minimum 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 2019 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
55
56\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__min_a7f514ac7a5701f4a5ce8612d2e8bcb16}\label{interfacemod__oasis__mpi_1_1oasis__mpi__min_a7f514ac7a5701f4a5ce8612d2e8bcb16}} 
57\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min}!oasis\+\_\+mpi\+\_\+mini1@{oasis\+\_\+mpi\+\_\+mini1}}
58\index{oasis\+\_\+mpi\+\_\+mini1@{oasis\+\_\+mpi\+\_\+mini1}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min}}
59\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+mini1()}{oasis\_mpi\_mini1()}}
60{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min\+::oasis\+\_\+mpi\+\_\+mini1 (\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 minimums 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 2082 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
82
83\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__min_a18098e0abd7924b31d64e06c789aa0c4}\label{interfacemod__oasis__mpi_1_1oasis__mpi__min_a18098e0abd7924b31d64e06c789aa0c4}} 
84\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min}!oasis\+\_\+mpi\+\_\+minr0@{oasis\+\_\+mpi\+\_\+minr0}}
85\index{oasis\+\_\+mpi\+\_\+minr0@{oasis\+\_\+mpi\+\_\+minr0}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min}}
86\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+minr0()}{oasis\_mpi\_minr0()}}
87{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min\+::oasis\+\_\+mpi\+\_\+minr0 (\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 an global minimum 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 2145 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
109
110\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__min_a62604730fbe7bf0dc21cf9fb9d83e981}\label{interfacemod__oasis__mpi_1_1oasis__mpi__min_a62604730fbe7bf0dc21cf9fb9d83e981}} 
111\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min}!oasis\+\_\+mpi\+\_\+minr1@{oasis\+\_\+mpi\+\_\+minr1}}
112\index{oasis\+\_\+mpi\+\_\+minr1@{oasis\+\_\+mpi\+\_\+minr1}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min}}
113\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+minr1()}{oasis\_mpi\_minr1()}}
114{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+min\+::oasis\+\_\+mpi\+\_\+minr1 (\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 minimums 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 2208 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.