source: CONFIG_DEVT/IPSLCM6.5_work_ENSEMBLES/oasis3-mct/doc/doxygen/latex/interfacemod__oasis__mpi_1_1oasis__mpi__recv.tex @ 5725

Last change on this file since 5725 was 5725, checked in by aclsce, 3 years ago

Added new oasis3-MCT version to be used to handle ensembles simulations with XIOS.
File size: 9.6 KB
Line 
1\hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__recv}{}\section{mod\+\_\+oasis\+\_\+mpi\+:\+:oasis\+\_\+mpi\+\_\+recv Interface Reference}
2\label{interfacemod__oasis__mpi_1_1oasis__mpi__recv}\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv}}
3
4
5Generic overloaded interface into M\+PI receive. 
6
7
8\subsection*{Private Member Functions}
9\begin{DoxyCompactItemize}
10\item 
11subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a074c7ea11bb2513a57792afe292a9305}{oasis\+\_\+mpi\+\_\+recvi0} (lvec, pid, tag, comm, string)
12\begin{DoxyCompactList}\small\item\em Receive a scalar integer. \end{DoxyCompactList}\item 
13subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a7d8a63dcb97e7d155108fa6a26b1bfa4}{oasis\+\_\+mpi\+\_\+recvi1} (lvec, pid, tag, comm, string)
14\begin{DoxyCompactList}\small\item\em Receive an array of 1D integers. \end{DoxyCompactList}\item 
15subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a6c501c168ddca69b50972959025044ff}{oasis\+\_\+mpi\+\_\+recvr0} (lvec, pid, tag, comm, string)
16\begin{DoxyCompactList}\small\item\em Receive a scalar double. \end{DoxyCompactList}\item 
17subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a6706db7315d932b5ff3a1fff5c917ea8}{oasis\+\_\+mpi\+\_\+recvr1} (lvec, pid, tag, comm, string)
18\begin{DoxyCompactList}\small\item\em Receive an array of 1D doubles. \end{DoxyCompactList}\item 
19subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a8a3e3cd1cd642121fb4cd943a744af68}{oasis\+\_\+mpi\+\_\+recvr3} (array, pid, tag, comm, string)
20\begin{DoxyCompactList}\small\item\em Receive an array of 3D doubles. \end{DoxyCompactList}\end{DoxyCompactItemize}
21
22
23\subsection{Detailed Description}
24Generic overloaded interface into M\+PI receive.
25
26Definition at line 49 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
27
28
29
30\subsection{Member Function/\+Subroutine Documentation}
31\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a074c7ea11bb2513a57792afe292a9305}\label{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a074c7ea11bb2513a57792afe292a9305}} 
32\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv}!oasis\+\_\+mpi\+\_\+recvi0@{oasis\+\_\+mpi\+\_\+recvi0}}
33\index{oasis\+\_\+mpi\+\_\+recvi0@{oasis\+\_\+mpi\+\_\+recvi0}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv}}
34\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+recvi0()}{oasis\_mpi\_recvi0()}}
35{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv\+::oasis\+\_\+mpi\+\_\+recvi0 (\begin{DoxyParamCaption}\item[{integer(ip\+\_\+i4\+\_\+p), intent(out)}]{lvec,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{pid,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{tag,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{comm,  }\item[{character($\ast$), intent(in), optional}]{string }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
36
37
38
39Receive a scalar integer.
40
41
42\begin{DoxyParams}[1]{Parameters}
43\mbox{\tt out}  & {\em lvec} & receive values\\
44\hline
45\mbox{\tt in}  & {\em pid} & pid to recv from\\
46\hline
47\mbox{\tt in}  & {\em tag} & mpi tag\\
48\hline
49\mbox{\tt in}  & {\em comm} & mpi communicator\\
50\hline
51\mbox{\tt in}  & {\em string} & to identify caller \\
52\hline
53\end{DoxyParams}
54
55
56Definition at line 370 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
57
58\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a7d8a63dcb97e7d155108fa6a26b1bfa4}\label{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a7d8a63dcb97e7d155108fa6a26b1bfa4}} 
59\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv}!oasis\+\_\+mpi\+\_\+recvi1@{oasis\+\_\+mpi\+\_\+recvi1}}
60\index{oasis\+\_\+mpi\+\_\+recvi1@{oasis\+\_\+mpi\+\_\+recvi1}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv}}
61\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+recvi1()}{oasis\_mpi\_recvi1()}}
62{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv\+::oasis\+\_\+mpi\+\_\+recvi1 (\begin{DoxyParamCaption}\item[{integer(ip\+\_\+i4\+\_\+p), dimension(\+:), intent(out)}]{lvec,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{pid,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{tag,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{comm,  }\item[{character($\ast$), intent(in), optional}]{string }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
63
64
65
66Receive an array of 1D integers.
67
68
69\begin{DoxyParams}[1]{Parameters}
70\mbox{\tt out}  & {\em lvec} & receive values\\
71\hline
72\mbox{\tt in}  & {\em pid} & pid to recv from\\
73\hline
74\mbox{\tt in}  & {\em tag} & mpi tag\\
75\hline
76\mbox{\tt in}  & {\em comm} & mpi communicator\\
77\hline
78\mbox{\tt in}  & {\em string} & to identify caller \\
79\hline
80\end{DoxyParams}
81
82
83Definition at line 411 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
84
85\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a6c501c168ddca69b50972959025044ff}\label{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a6c501c168ddca69b50972959025044ff}} 
86\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv}!oasis\+\_\+mpi\+\_\+recvr0@{oasis\+\_\+mpi\+\_\+recvr0}}
87\index{oasis\+\_\+mpi\+\_\+recvr0@{oasis\+\_\+mpi\+\_\+recvr0}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv}}
88\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+recvr0()}{oasis\_mpi\_recvr0()}}
89{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv\+::oasis\+\_\+mpi\+\_\+recvr0 (\begin{DoxyParamCaption}\item[{real(ip\+\_\+double\+\_\+p), intent(out)}]{lvec,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{pid,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{tag,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{comm,  }\item[{character($\ast$), intent(in), optional}]{string }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
90
91
92
93Receive a scalar double.
94
95
96\begin{DoxyParams}[1]{Parameters}
97\mbox{\tt out}  & {\em lvec} & receive values\\
98\hline
99\mbox{\tt in}  & {\em pid} & pid to recv from\\
100\hline
101\mbox{\tt in}  & {\em tag} & mpi tag\\
102\hline
103\mbox{\tt in}  & {\em comm} & mpi communicator\\
104\hline
105\mbox{\tt in}  & {\em string} & to identify caller \\
106\hline
107\end{DoxyParams}
108
109
110Definition at line 452 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
111
112\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a6706db7315d932b5ff3a1fff5c917ea8}\label{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a6706db7315d932b5ff3a1fff5c917ea8}} 
113\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv}!oasis\+\_\+mpi\+\_\+recvr1@{oasis\+\_\+mpi\+\_\+recvr1}}
114\index{oasis\+\_\+mpi\+\_\+recvr1@{oasis\+\_\+mpi\+\_\+recvr1}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv}}
115\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+recvr1()}{oasis\_mpi\_recvr1()}}
116{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv\+::oasis\+\_\+mpi\+\_\+recvr1 (\begin{DoxyParamCaption}\item[{real(ip\+\_\+double\+\_\+p), dimension(\+:), intent(out)}]{lvec,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{pid,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{tag,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{comm,  }\item[{character($\ast$), intent(in), optional}]{string }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
117
118
119
120Receive an array of 1D doubles.
121
122
123\begin{DoxyParams}[1]{Parameters}
124\mbox{\tt out}  & {\em lvec} & receive values\\
125\hline
126\mbox{\tt in}  & {\em pid} & pid to recv from\\
127\hline
128\mbox{\tt in}  & {\em tag} & mpi tag\\
129\hline
130\mbox{\tt in}  & {\em comm} & mpi communicator\\
131\hline
132\mbox{\tt in}  & {\em string} & to identify caller \\
133\hline
134\end{DoxyParams}
135
136
137Definition at line 493 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
138
139\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a8a3e3cd1cd642121fb4cd943a744af68}\label{interfacemod__oasis__mpi_1_1oasis__mpi__recv_a8a3e3cd1cd642121fb4cd943a744af68}} 
140\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv}!oasis\+\_\+mpi\+\_\+recvr3@{oasis\+\_\+mpi\+\_\+recvr3}}
141\index{oasis\+\_\+mpi\+\_\+recvr3@{oasis\+\_\+mpi\+\_\+recvr3}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv}}
142\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+recvr3()}{oasis\_mpi\_recvr3()}}
143{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+recv\+::oasis\+\_\+mpi\+\_\+recvr3 (\begin{DoxyParamCaption}\item[{real(ip\+\_\+double\+\_\+p), dimension(\+:,\+:,\+:), intent(out)}]{array,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{pid,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{tag,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{comm,  }\item[{character($\ast$), intent(in), optional}]{string }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
144
145
146
147Receive an array of 3D doubles.
148
149
150\begin{DoxyParams}[1]{Parameters}
151\mbox{\tt out}  & {\em array} & receive values\\
152\hline
153\mbox{\tt in}  & {\em pid} & pid to recv from\\
154\hline
155\mbox{\tt in}  & {\em tag} & mpi tag\\
156\hline
157\mbox{\tt in}  & {\em comm} & mpi communicator\\
158\hline
159\mbox{\tt in}  & {\em string} & to identify caller \\
160\hline
161\end{DoxyParams}
162
163
164Definition at line 534 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
165
166
167
168The documentation for this interface was generated from the following file\+:\begin{DoxyCompactItemize}
169\item 
170/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.