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

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

Moved oasis-mct_5.0 in oasis3-mct/branches directory.

File size: 9.6 KB
Line 
1\hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__send}{}\section{mod\+\_\+oasis\+\_\+mpi\+:\+:oasis\+\_\+mpi\+\_\+send Interface Reference}
2\label{interfacemod__oasis__mpi_1_1oasis__mpi__send}\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send}}
3
4
5Generic overloaded interface into M\+PI send. 
6
7
8\subsection*{Private Member Functions}
9\begin{DoxyCompactItemize}
10\item 
11subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__send_a5b7f0e4f7dc45d398bf564a324dc71c7}{oasis\+\_\+mpi\+\_\+sendi0} (lvec, pid, tag, comm, string)
12\begin{DoxyCompactList}\small\item\em Send a scalar integer. \end{DoxyCompactList}\item 
13subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__send_af94ce9cce54b9860809fc63d59674e5b}{oasis\+\_\+mpi\+\_\+sendi1} (lvec, pid, tag, comm, string)
14\begin{DoxyCompactList}\small\item\em Send an array of 1D integers. \end{DoxyCompactList}\item 
15subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__send_aefceb49505c9c2e1431ad2666657910d}{oasis\+\_\+mpi\+\_\+sendr0} (lvec, pid, tag, comm, string)
16\begin{DoxyCompactList}\small\item\em Send a scalar double. \end{DoxyCompactList}\item 
17subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__send_adf9edd2b024a94a75db93e68318f6eff}{oasis\+\_\+mpi\+\_\+sendr1} (lvec, pid, tag, comm, string)
18\begin{DoxyCompactList}\small\item\em Send an array of 1D doubles. \end{DoxyCompactList}\item 
19subroutine \hyperlink{interfacemod__oasis__mpi_1_1oasis__mpi__send_ad712319885937ce4c29b7bb8e66614cf}{oasis\+\_\+mpi\+\_\+sendr3} (array, pid, tag, comm, string)
20\begin{DoxyCompactList}\small\item\em Send an array of 3D doubles. \end{DoxyCompactList}\end{DoxyCompactItemize}
21
22
23\subsection{Detailed Description}
24Generic overloaded interface into M\+PI send.
25
26Definition at line 40 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
27
28
29
30\subsection{Member Function/\+Subroutine Documentation}
31\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__send_a5b7f0e4f7dc45d398bf564a324dc71c7}\label{interfacemod__oasis__mpi_1_1oasis__mpi__send_a5b7f0e4f7dc45d398bf564a324dc71c7}} 
32\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send}!oasis\+\_\+mpi\+\_\+sendi0@{oasis\+\_\+mpi\+\_\+sendi0}}
33\index{oasis\+\_\+mpi\+\_\+sendi0@{oasis\+\_\+mpi\+\_\+sendi0}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send}}
34\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sendi0()}{oasis\_mpi\_sendi0()}}
35{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send\+::oasis\+\_\+mpi\+\_\+sendi0 (\begin{DoxyParamCaption}\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{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
39Send a scalar integer.
40
41
42\begin{DoxyParams}[1]{Parameters}
43\mbox{\tt in}  & {\em lvec} & send value\\
44\hline
45\mbox{\tt in}  & {\em pid} & pid to send to\\
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 170 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
57
58\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__send_af94ce9cce54b9860809fc63d59674e5b}\label{interfacemod__oasis__mpi_1_1oasis__mpi__send_af94ce9cce54b9860809fc63d59674e5b}} 
59\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send}!oasis\+\_\+mpi\+\_\+sendi1@{oasis\+\_\+mpi\+\_\+sendi1}}
60\index{oasis\+\_\+mpi\+\_\+sendi1@{oasis\+\_\+mpi\+\_\+sendi1}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send}}
61\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sendi1()}{oasis\_mpi\_sendi1()}}
62{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send\+::oasis\+\_\+mpi\+\_\+sendi1 (\begin{DoxyParamCaption}\item[{integer(ip\+\_\+i4\+\_\+p), dimension(\+:), intent(in)}]{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
66Send an array of 1D integers.
67
68
69\begin{DoxyParams}[1]{Parameters}
70\mbox{\tt in}  & {\em lvec} & send values\\
71\hline
72\mbox{\tt in}  & {\em pid} & pid to send to\\
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 210 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
84
85\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__send_aefceb49505c9c2e1431ad2666657910d}\label{interfacemod__oasis__mpi_1_1oasis__mpi__send_aefceb49505c9c2e1431ad2666657910d}} 
86\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send}!oasis\+\_\+mpi\+\_\+sendr0@{oasis\+\_\+mpi\+\_\+sendr0}}
87\index{oasis\+\_\+mpi\+\_\+sendr0@{oasis\+\_\+mpi\+\_\+sendr0}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send}}
88\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sendr0()}{oasis\_mpi\_sendr0()}}
89{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send\+::oasis\+\_\+mpi\+\_\+sendr0 (\begin{DoxyParamCaption}\item[{real(ip\+\_\+double\+\_\+p), intent(in)}]{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
93Send a scalar double.
94
95
96\begin{DoxyParams}[1]{Parameters}
97\mbox{\tt in}  & {\em lvec} & send values\\
98\hline
99\mbox{\tt in}  & {\em pid} & pid to send to\\
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 250 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
111
112\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__send_adf9edd2b024a94a75db93e68318f6eff}\label{interfacemod__oasis__mpi_1_1oasis__mpi__send_adf9edd2b024a94a75db93e68318f6eff}} 
113\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send}!oasis\+\_\+mpi\+\_\+sendr1@{oasis\+\_\+mpi\+\_\+sendr1}}
114\index{oasis\+\_\+mpi\+\_\+sendr1@{oasis\+\_\+mpi\+\_\+sendr1}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send}}
115\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sendr1()}{oasis\_mpi\_sendr1()}}
116{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send\+::oasis\+\_\+mpi\+\_\+sendr1 (\begin{DoxyParamCaption}\item[{real(ip\+\_\+double\+\_\+p), dimension(\+:), intent(in)}]{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
120Send an array of 1D doubles.
121
122
123\begin{DoxyParams}[1]{Parameters}
124\mbox{\tt in}  & {\em lvec} & send values\\
125\hline
126\mbox{\tt in}  & {\em pid} & pid to send to\\
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 290 of file mod\+\_\+oasis\+\_\+mpi.\+F90.
138
139\mbox{\Hypertarget{interfacemod__oasis__mpi_1_1oasis__mpi__send_ad712319885937ce4c29b7bb8e66614cf}\label{interfacemod__oasis__mpi_1_1oasis__mpi__send_ad712319885937ce4c29b7bb8e66614cf}} 
140\index{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send}!oasis\+\_\+mpi\+\_\+sendr3@{oasis\+\_\+mpi\+\_\+sendr3}}
141\index{oasis\+\_\+mpi\+\_\+sendr3@{oasis\+\_\+mpi\+\_\+sendr3}!mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send@{mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send}}
142\subsubsection{\texorpdfstring{oasis\+\_\+mpi\+\_\+sendr3()}{oasis\_mpi\_sendr3()}}
143{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+mpi\+::oasis\+\_\+mpi\+\_\+send\+::oasis\+\_\+mpi\+\_\+sendr3 (\begin{DoxyParamCaption}\item[{real(ip\+\_\+double\+\_\+p), dimension(\+:,\+:,\+:), intent(in)}]{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
147Send an array of 3D doubles.
148
149
150\begin{DoxyParams}[1]{Parameters}
151\mbox{\tt in}  & {\em array} & send values\\
152\hline
153\mbox{\tt in}  & {\em pid} & pid to send to\\
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 330 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.