source: CPL/oasis3-mct_5.0/doc/doxygen/latex/namespacemod__oasis__getput__interface.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: 29.3 KB
Line 
1\hypertarget{namespacemod__oasis__getput__interface}{}\section{mod\+\_\+oasis\+\_\+getput\+\_\+interface Module Reference}
2\label{namespacemod__oasis__getput__interface}\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
3
4
5O\+A\+S\+IS send/receive (put/get) user interfaces. 
6
7
8\subsection*{Data Types}
9\begin{DoxyCompactItemize}
10\item 
11interface \hyperlink{interfacemod__oasis__getput__interface_1_1oasis__get}{oasis\+\_\+get}
12\begin{DoxyCompactList}\small\item\em Generic overloaded interface for data get (receive) \end{DoxyCompactList}\item 
13interface \hyperlink{interfacemod__oasis__getput__interface_1_1oasis__put}{oasis\+\_\+put}
14\begin{DoxyCompactList}\small\item\em Generic overloaded interface for data put (send) \end{DoxyCompactList}\end{DoxyCompactItemize}
15\subsection*{Functions/\+Subroutines}
16\begin{DoxyCompactItemize}
17\item 
18subroutine \hyperlink{namespacemod__oasis__getput__interface_af2487e50b549830a14e5517c0736f907}{oasis\+\_\+put\+\_\+r14} (var\+\_\+id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write\+\_\+restart)
19\begin{DoxyCompactList}\small\item\em Send 4 byte real 1D data. \end{DoxyCompactList}\item 
20subroutine \hyperlink{namespacemod__oasis__getput__interface_a70e218d2524977cbd4e6c010b6a222cc}{oasis\+\_\+put\+\_\+r18} (var\+\_\+id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write\+\_\+restart)
21\begin{DoxyCompactList}\small\item\em Send 4 byte real 1D data. \end{DoxyCompactList}\item 
22subroutine \hyperlink{namespacemod__oasis__getput__interface_a6b5add4ec9bd054279451a5bb52f7d32}{oasis\+\_\+put\+\_\+r24} (var\+\_\+id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write\+\_\+restart)
23\begin{DoxyCompactList}\small\item\em Send 4 byte real 2D data. \end{DoxyCompactList}\item 
24subroutine \hyperlink{namespacemod__oasis__getput__interface_acc31c8501b46f19ac866726af9baf017}{oasis\+\_\+put\+\_\+r34} (var\+\_\+id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write\+\_\+restart)
25\begin{DoxyCompactList}\small\item\em Send 4 byte real 2D bundled data. \end{DoxyCompactList}\item 
26subroutine \hyperlink{namespacemod__oasis__getput__interface_a73cdc18cf8e76acb003451e737fab7fe}{oasis\+\_\+put\+\_\+r28} (var\+\_\+id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write\+\_\+restart)
27\begin{DoxyCompactList}\small\item\em Send 8 byte real 2D data. \end{DoxyCompactList}\item 
28subroutine \hyperlink{namespacemod__oasis__getput__interface_a6e458b3434ebc22a8c0a6de7d2b6328f}{oasis\+\_\+put\+\_\+r38} (var\+\_\+id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write\+\_\+restart)
29\begin{DoxyCompactList}\small\item\em Send 8 byte real 2D bundled data. \end{DoxyCompactList}\item 
30subroutine \hyperlink{namespacemod__oasis__getput__interface_a13fcf0d2a7c31cfbbb24087d24c4f851}{oasis\+\_\+put\+\_\+worker} (var\+\_\+id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write\+\_\+restart, varnum)
31\begin{DoxyCompactList}\small\item\em Send worker routine puts 8 byte real 1D data. \end{DoxyCompactList}\item 
32subroutine \hyperlink{namespacemod__oasis__getput__interface_a49f5cde883b1f5210e58c709e944df7c}{oasis\+\_\+get\+\_\+r14} (var\+\_\+id, kstep, fld, kinfo)
33\begin{DoxyCompactList}\small\item\em Receive 4 byte real 1D data. \end{DoxyCompactList}\item 
34subroutine \hyperlink{namespacemod__oasis__getput__interface_a10fac7c611232bd788e32c0487ee5625}{oasis\+\_\+get\+\_\+r18} (var\+\_\+id, kstep, fld, kinfo)
35\begin{DoxyCompactList}\small\item\em Receive 8 byte real 1D data. \end{DoxyCompactList}\item 
36subroutine \hyperlink{namespacemod__oasis__getput__interface_ac28a61cf8ca51e358897bfffb43003b8}{oasis\+\_\+get\+\_\+r24} (var\+\_\+id, kstep, fld, kinfo)
37\begin{DoxyCompactList}\small\item\em Receive 4 byte real 2D data. \end{DoxyCompactList}\item 
38subroutine \hyperlink{namespacemod__oasis__getput__interface_a34b0221d424ce7f1597548f91407033f}{oasis\+\_\+get\+\_\+r34} (var\+\_\+id, kstep, fld, kinfo)
39\begin{DoxyCompactList}\small\item\em Receive 4 byte real 2D bundled data. \end{DoxyCompactList}\item 
40subroutine \hyperlink{namespacemod__oasis__getput__interface_a017bdff12b2f7c29e6e76b303d452d4b}{oasis\+\_\+get\+\_\+r28} (var\+\_\+id, kstep, fld, kinfo)
41\begin{DoxyCompactList}\small\item\em Receive 8 byte real 2D data. \end{DoxyCompactList}\item 
42subroutine \hyperlink{namespacemod__oasis__getput__interface_a3113b8b9e8d879a631b856a20b30c699}{oasis\+\_\+get\+\_\+r38} (var\+\_\+id, kstep, fld, kinfo)
43\begin{DoxyCompactList}\small\item\em Receive 8 byte real 2D bundled data. \end{DoxyCompactList}\item 
44subroutine \hyperlink{namespacemod__oasis__getput__interface_a7817d0a31632e3a6c9137e517e7acc3d}{oasis\+\_\+get\+\_\+worker} (var\+\_\+id, kstep, fld, kinfo, varnum)
45\begin{DoxyCompactList}\small\item\em Receive subroutine that actually does the work on 8 byte 1D data. \end{DoxyCompactList}\end{DoxyCompactItemize}
46\subsection*{Variables}
47\begin{DoxyCompactItemize}
48\item 
49integer(kind=ip\+\_\+i4\+\_\+p), dimension(mpi\+\_\+status\+\_\+size) \hyperlink{namespacemod__oasis__getput__interface_a2ceaaa5740216799f651b8dacb42b239}{istatus}
50\end{DoxyCompactItemize}
51
52
53\subsection{Detailed Description}
54O\+A\+S\+IS send/receive (put/get) user interfaces.
55
56\subsection{Function/\+Subroutine Documentation}
57\mbox{\Hypertarget{namespacemod__oasis__getput__interface_a49f5cde883b1f5210e58c709e944df7c}\label{namespacemod__oasis__getput__interface_a49f5cde883b1f5210e58c709e944df7c}} 
58\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!oasis\+\_\+get\+\_\+r14@{oasis\+\_\+get\+\_\+r14}}
59\index{oasis\+\_\+get\+\_\+r14@{oasis\+\_\+get\+\_\+r14}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
60\subsubsection{\texorpdfstring{oasis\+\_\+get\+\_\+r14()}{oasis\_get\_r14()}}
61{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+get\+\_\+r14 (\begin{DoxyParamCaption}\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{var\+\_\+id,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{kstep,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:), intent(inout)}]{fld,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(out)}]{kinfo }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
62
63
64
65Receive 4 byte real 1D data.
66
67
68\begin{DoxyParams}[1]{Parameters}
69\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
70\hline
71\mbox{\tt in}  & {\em kstep} & model time in seconds\\
72\hline
73\mbox{\tt in,out}  & {\em fld} & field data\\
74\hline
75\mbox{\tt out}  & {\em kinfo} & return code \\
76\hline
77\end{DoxyParams}
78
79
80Definition at line 807 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
81
82\mbox{\Hypertarget{namespacemod__oasis__getput__interface_a10fac7c611232bd788e32c0487ee5625}\label{namespacemod__oasis__getput__interface_a10fac7c611232bd788e32c0487ee5625}} 
83\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!oasis\+\_\+get\+\_\+r18@{oasis\+\_\+get\+\_\+r18}}
84\index{oasis\+\_\+get\+\_\+r18@{oasis\+\_\+get\+\_\+r18}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
85\subsubsection{\texorpdfstring{oasis\+\_\+get\+\_\+r18()}{oasis\_get\_r18()}}
86{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+get\+\_\+r18 (\begin{DoxyParamCaption}\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{var\+\_\+id,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{kstep,  }\item[{real(kind=ip\+\_\+r8\+\_\+p), dimension(\+:), intent(inout)}]{fld,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(out)}]{kinfo }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
87
88
89
90Receive 8 byte real 1D data.
91
92
93\begin{DoxyParams}[1]{Parameters}
94\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
95\hline
96\mbox{\tt in}  & {\em kstep} & model time in seconds\\
97\hline
98\mbox{\tt in,out}  & {\em fld} & field data\\
99\hline
100\mbox{\tt out}  & {\em kinfo} & return code \\
101\hline
102\end{DoxyParams}
103
104
105Definition at line 854 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
106
107\mbox{\Hypertarget{namespacemod__oasis__getput__interface_ac28a61cf8ca51e358897bfffb43003b8}\label{namespacemod__oasis__getput__interface_ac28a61cf8ca51e358897bfffb43003b8}} 
108\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!oasis\+\_\+get\+\_\+r24@{oasis\+\_\+get\+\_\+r24}}
109\index{oasis\+\_\+get\+\_\+r24@{oasis\+\_\+get\+\_\+r24}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
110\subsubsection{\texorpdfstring{oasis\+\_\+get\+\_\+r24()}{oasis\_get\_r24()}}
111{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+get\+\_\+r24 (\begin{DoxyParamCaption}\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{var\+\_\+id,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{kstep,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:,\+:), intent(inout)}]{fld,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(out)}]{kinfo }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
112
113
114
115Receive 4 byte real 2D data.
116
117
118\begin{DoxyParams}[1]{Parameters}
119\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
120\hline
121\mbox{\tt in}  & {\em kstep} & model time in seconds\\
122\hline
123\mbox{\tt in,out}  & {\em fld} & field data\\
124\hline
125\mbox{\tt out}  & {\em kinfo} & return code \\
126\hline
127\end{DoxyParams}
128
129
130Definition at line 890 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
131
132\mbox{\Hypertarget{namespacemod__oasis__getput__interface_a017bdff12b2f7c29e6e76b303d452d4b}\label{namespacemod__oasis__getput__interface_a017bdff12b2f7c29e6e76b303d452d4b}} 
133\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!oasis\+\_\+get\+\_\+r28@{oasis\+\_\+get\+\_\+r28}}
134\index{oasis\+\_\+get\+\_\+r28@{oasis\+\_\+get\+\_\+r28}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
135\subsubsection{\texorpdfstring{oasis\+\_\+get\+\_\+r28()}{oasis\_get\_r28()}}
136{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+get\+\_\+r28 (\begin{DoxyParamCaption}\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{var\+\_\+id,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{kstep,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:,\+:), intent(inout)}]{fld,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(out)}]{kinfo }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
137
138
139
140Receive 8 byte real 2D data.
141
142
143\begin{DoxyParams}[1]{Parameters}
144\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
145\hline
146\mbox{\tt in}  & {\em kstep} & model time in seconds\\
147\hline
148\mbox{\tt in,out}  & {\em fld} & field data\\
149\hline
150\mbox{\tt out}  & {\em kinfo} & return code \\
151\hline
152\end{DoxyParams}
153
154
155Definition at line 1025 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
156
157\mbox{\Hypertarget{namespacemod__oasis__getput__interface_a34b0221d424ce7f1597548f91407033f}\label{namespacemod__oasis__getput__interface_a34b0221d424ce7f1597548f91407033f}} 
158\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!oasis\+\_\+get\+\_\+r34@{oasis\+\_\+get\+\_\+r34}}
159\index{oasis\+\_\+get\+\_\+r34@{oasis\+\_\+get\+\_\+r34}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
160\subsubsection{\texorpdfstring{oasis\+\_\+get\+\_\+r34()}{oasis\_get\_r34()}}
161{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+get\+\_\+r34 (\begin{DoxyParamCaption}\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{var\+\_\+id,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{kstep,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:,\+:,\+:), intent(inout)}]{fld,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(out)}]{kinfo }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
162
163
164
165Receive 4 byte real 2D bundled data.
166
167
168\begin{DoxyParams}[1]{Parameters}
169\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
170\hline
171\mbox{\tt in}  & {\em kstep} & model time in seconds\\
172\hline
173\mbox{\tt in,out}  & {\em fld} & field data\\
174\hline
175\mbox{\tt out}  & {\em kinfo} & return code \\
176\hline
177\end{DoxyParams}
178
179
180Definition at line 963 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
181
182\mbox{\Hypertarget{namespacemod__oasis__getput__interface_a3113b8b9e8d879a631b856a20b30c699}\label{namespacemod__oasis__getput__interface_a3113b8b9e8d879a631b856a20b30c699}} 
183\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!oasis\+\_\+get\+\_\+r38@{oasis\+\_\+get\+\_\+r38}}
184\index{oasis\+\_\+get\+\_\+r38@{oasis\+\_\+get\+\_\+r38}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
185\subsubsection{\texorpdfstring{oasis\+\_\+get\+\_\+r38()}{oasis\_get\_r38()}}
186{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+get\+\_\+r38 (\begin{DoxyParamCaption}\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{var\+\_\+id,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{kstep,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:,\+:,\+:), intent(inout)}]{fld,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(out)}]{kinfo }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
187
188
189
190Receive 8 byte real 2D bundled data.
191
192
193\begin{DoxyParams}[1]{Parameters}
194\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
195\hline
196\mbox{\tt in}  & {\em kstep} & model time in seconds\\
197\hline
198\mbox{\tt in,out}  & {\em fld} & field data\\
199\hline
200\mbox{\tt out}  & {\em kinfo} & return code \\
201\hline
202\end{DoxyParams}
203
204
205Definition at line 1095 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
206
207\mbox{\Hypertarget{namespacemod__oasis__getput__interface_a7817d0a31632e3a6c9137e517e7acc3d}\label{namespacemod__oasis__getput__interface_a7817d0a31632e3a6c9137e517e7acc3d}} 
208\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!oasis\+\_\+get\+\_\+worker@{oasis\+\_\+get\+\_\+worker}}
209\index{oasis\+\_\+get\+\_\+worker@{oasis\+\_\+get\+\_\+worker}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
210\subsubsection{\texorpdfstring{oasis\+\_\+get\+\_\+worker()}{oasis\_get\_worker()}}
211{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+get\+\_\+worker (\begin{DoxyParamCaption}\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{var\+\_\+id,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{kstep,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:), intent(inout)}]{fld,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(out)}]{kinfo,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), optional}]{varnum }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
212
213
214
215Receive subroutine that actually does the work on 8 byte 1D data.
216
217
218\begin{DoxyParams}[1]{Parameters}
219\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
220\hline
221\mbox{\tt in}  & {\em kstep} & model time in seconds\\
222\hline
223\mbox{\tt in,out}  & {\em fld} & field data\\
224\hline
225\mbox{\tt out}  & {\em kinfo} & return code\\
226\hline
227 & {\em varnum} & variable num in bundled field \\
228\hline
229\end{DoxyParams}
230
231
232Definition at line 1154 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
233
234\mbox{\Hypertarget{namespacemod__oasis__getput__interface_af2487e50b549830a14e5517c0736f907}\label{namespacemod__oasis__getput__interface_af2487e50b549830a14e5517c0736f907}} 
235\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!oasis\+\_\+put\+\_\+r14@{oasis\+\_\+put\+\_\+r14}}
236\index{oasis\+\_\+put\+\_\+r14@{oasis\+\_\+put\+\_\+r14}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
237\subsubsection{\texorpdfstring{oasis\+\_\+put\+\_\+r14()}{oasis\_put\_r14()}}
238{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put\+\_\+r14 (\begin{DoxyParamCaption}\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{var\+\_\+id,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{kstep,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:)}]{fld1,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(out)}]{kinfo,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:), optional}]{fld2,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:), optional}]{fld3,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:), optional}]{fld4,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:), optional}]{fld5,  }\item[{logical, optional}]{write\+\_\+restart }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
239
240
241
242Send 4 byte real 1D data.
243
244
245\begin{DoxyParams}[1]{Parameters}
246\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
247\hline
248\mbox{\tt in}  & {\em kstep} & model time in seconds\\
249\hline
250 & {\em fld1} & field data\\
251\hline
252\mbox{\tt out}  & {\em kinfo} & return code\\
253\hline
254 & {\em fld2} & higher order field data\\
255\hline
256 & {\em fld3} & higher order field data\\
257\hline
258 & {\em fld4} & higher order field data\\
259\hline
260 & {\em fld5} & higher order field data\\
261\hline
262 & {\em write\+\_\+restart} & write restart now \\
263\hline
264\end{DoxyParams}
265
266
267Definition at line 58 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
268
269\mbox{\Hypertarget{namespacemod__oasis__getput__interface_a70e218d2524977cbd4e6c010b6a222cc}\label{namespacemod__oasis__getput__interface_a70e218d2524977cbd4e6c010b6a222cc}} 
270\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!oasis\+\_\+put\+\_\+r18@{oasis\+\_\+put\+\_\+r18}}
271\index{oasis\+\_\+put\+\_\+r18@{oasis\+\_\+put\+\_\+r18}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
272\subsubsection{\texorpdfstring{oasis\+\_\+put\+\_\+r18()}{oasis\_put\_r18()}}
273{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put\+\_\+r18 (\begin{DoxyParamCaption}\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{var\+\_\+id,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{kstep,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:)}]{fld1,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(out)}]{kinfo,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:), optional}]{fld2,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:), optional}]{fld3,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:), optional}]{fld4,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:), optional}]{fld5,  }\item[{logical, optional}]{write\+\_\+restart }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
274
275
276
277Send 4 byte real 1D data.
278
279
280\begin{DoxyParams}[1]{Parameters}
281\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
282\hline
283\mbox{\tt in}  & {\em kstep} & model time in seconds\\
284\hline
285 & {\em fld1} & field data\\
286\hline
287\mbox{\tt out}  & {\em kinfo} & return code\\
288\hline
289 & {\em fld2} & higher order field data\\
290\hline
291 & {\em fld3} & higher order field data\\
292\hline
293 & {\em fld4} & higher order field data\\
294\hline
295 & {\em fld5} & higher order field data\\
296\hline
297 & {\em write\+\_\+restart} & write restart now \\
298\hline
299\end{DoxyParams}
300
301
302Definition at line 124 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
303
304\mbox{\Hypertarget{namespacemod__oasis__getput__interface_a6b5add4ec9bd054279451a5bb52f7d32}\label{namespacemod__oasis__getput__interface_a6b5add4ec9bd054279451a5bb52f7d32}} 
305\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!oasis\+\_\+put\+\_\+r24@{oasis\+\_\+put\+\_\+r24}}
306\index{oasis\+\_\+put\+\_\+r24@{oasis\+\_\+put\+\_\+r24}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
307\subsubsection{\texorpdfstring{oasis\+\_\+put\+\_\+r24()}{oasis\_put\_r24()}}
308{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put\+\_\+r24 (\begin{DoxyParamCaption}\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{var\+\_\+id,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{kstep,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:,\+:)}]{fld1,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(out)}]{kinfo,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:,\+:), optional}]{fld2,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:,\+:), optional}]{fld3,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:,\+:), optional}]{fld4,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:,\+:), optional}]{fld5,  }\item[{logical, optional}]{write\+\_\+restart }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
309
310
311
312Send 4 byte real 2D data.
313
314
315\begin{DoxyParams}[1]{Parameters}
316\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
317\hline
318\mbox{\tt in}  & {\em kstep} & model time in seconds\\
319\hline
320 & {\em fld1} & field data\\
321\hline
322\mbox{\tt out}  & {\em kinfo} & return code\\
323\hline
324 & {\em fld2} & higher order field data\\
325\hline
326 & {\em fld3} & higher order field data\\
327\hline
328 & {\em fld4} & higher order field data\\
329\hline
330 & {\em fld5} & higher order field data\\
331\hline
332 & {\em write\+\_\+restart} & write restart now \\
333\hline
334\end{DoxyParams}
335
336
337Definition at line 190 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
338
339\mbox{\Hypertarget{namespacemod__oasis__getput__interface_a73cdc18cf8e76acb003451e737fab7fe}\label{namespacemod__oasis__getput__interface_a73cdc18cf8e76acb003451e737fab7fe}} 
340\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!oasis\+\_\+put\+\_\+r28@{oasis\+\_\+put\+\_\+r28}}
341\index{oasis\+\_\+put\+\_\+r28@{oasis\+\_\+put\+\_\+r28}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
342\subsubsection{\texorpdfstring{oasis\+\_\+put\+\_\+r28()}{oasis\_put\_r28()}}
343{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put\+\_\+r28 (\begin{DoxyParamCaption}\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{var\+\_\+id,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{kstep,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:,\+:)}]{fld1,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(out)}]{kinfo,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:,\+:), optional}]{fld2,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:,\+:), optional}]{fld3,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:,\+:), optional}]{fld4,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:,\+:), optional}]{fld5,  }\item[{logical, optional}]{write\+\_\+restart }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
344
345
346
347Send 8 byte real 2D data.
348
349
350\begin{DoxyParams}[1]{Parameters}
351\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
352\hline
353\mbox{\tt in}  & {\em kstep} & model time in seconds\\
354\hline
355 & {\em fld1} & field data\\
356\hline
357\mbox{\tt out}  & {\em kinfo} & return code\\
358\hline
359 & {\em fld2} & higher order field data\\
360\hline
361 & {\em fld3} & higher order field data\\
362\hline
363 & {\em fld4} & higher order field data\\
364\hline
365 & {\em fld5} & higher order field data\\
366\hline
367 & {\em write\+\_\+restart} & write restart now \\
368\hline
369\end{DoxyParams}
370
371
372Definition at line 420 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
373
374\mbox{\Hypertarget{namespacemod__oasis__getput__interface_acc31c8501b46f19ac866726af9baf017}\label{namespacemod__oasis__getput__interface_acc31c8501b46f19ac866726af9baf017}} 
375\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!oasis\+\_\+put\+\_\+r34@{oasis\+\_\+put\+\_\+r34}}
376\index{oasis\+\_\+put\+\_\+r34@{oasis\+\_\+put\+\_\+r34}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
377\subsubsection{\texorpdfstring{oasis\+\_\+put\+\_\+r34()}{oasis\_put\_r34()}}
378{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put\+\_\+r34 (\begin{DoxyParamCaption}\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{var\+\_\+id,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{kstep,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:,\+:,\+:)}]{fld1,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(out)}]{kinfo,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:,\+:,\+:), optional}]{fld2,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:,\+:,\+:), optional}]{fld3,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:,\+:,\+:), optional}]{fld4,  }\item[{real(kind=ip\+\_\+single\+\_\+p), dimension(\+:,\+:,\+:), optional}]{fld5,  }\item[{logical, optional}]{write\+\_\+restart }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
379
380
381
382Send 4 byte real 2D bundled data.
383
384
385\begin{DoxyParams}[1]{Parameters}
386\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
387\hline
388\mbox{\tt in}  & {\em kstep} & model time in seconds\\
389\hline
390 & {\em fld1} & field data\\
391\hline
392\mbox{\tt out}  & {\em kinfo} & return code\\
393\hline
394 & {\em fld2} & higher order field data\\
395\hline
396 & {\em fld3} & higher order field data\\
397\hline
398 & {\em fld4} & higher order field data\\
399\hline
400 & {\em fld5} & higher order field data\\
401\hline
402 & {\em write\+\_\+restart} & write restart now \\
403\hline
404\end{DoxyParams}
405
406
407Definition at line 314 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
408
409\mbox{\Hypertarget{namespacemod__oasis__getput__interface_a6e458b3434ebc22a8c0a6de7d2b6328f}\label{namespacemod__oasis__getput__interface_a6e458b3434ebc22a8c0a6de7d2b6328f}} 
410\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!oasis\+\_\+put\+\_\+r38@{oasis\+\_\+put\+\_\+r38}}
411\index{oasis\+\_\+put\+\_\+r38@{oasis\+\_\+put\+\_\+r38}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
412\subsubsection{\texorpdfstring{oasis\+\_\+put\+\_\+r38()}{oasis\_put\_r38()}}
413{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put\+\_\+r38 (\begin{DoxyParamCaption}\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{var\+\_\+id,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{kstep,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:,\+:,\+:)}]{fld1,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(out)}]{kinfo,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:,\+:,\+:), optional}]{fld2,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:,\+:,\+:), optional}]{fld3,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:,\+:,\+:), optional}]{fld4,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:,\+:,\+:), optional}]{fld5,  }\item[{logical, optional}]{write\+\_\+restart }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
414
415
416
417Send 8 byte real 2D bundled data.
418
419
420\begin{DoxyParams}[1]{Parameters}
421\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
422\hline
423\mbox{\tt in}  & {\em kstep} & model time in seconds\\
424\hline
425 & {\em fld1} & field data\\
426\hline
427\mbox{\tt out}  & {\em kinfo} & return code\\
428\hline
429 & {\em fld2} & higher order field data\\
430\hline
431 & {\em fld3} & higher order field data\\
432\hline
433 & {\em fld4} & higher order field data\\
434\hline
435 & {\em fld5} & higher order field data\\
436\hline
437 & {\em write\+\_\+restart} & write restart now \\
438\hline
439\end{DoxyParams}
440
441
442Definition at line 543 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
443
444\mbox{\Hypertarget{namespacemod__oasis__getput__interface_a13fcf0d2a7c31cfbbb24087d24c4f851}\label{namespacemod__oasis__getput__interface_a13fcf0d2a7c31cfbbb24087d24c4f851}} 
445\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!oasis\+\_\+put\+\_\+worker@{oasis\+\_\+put\+\_\+worker}}
446\index{oasis\+\_\+put\+\_\+worker@{oasis\+\_\+put\+\_\+worker}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
447\subsubsection{\texorpdfstring{oasis\+\_\+put\+\_\+worker()}{oasis\_put\_worker()}}
448{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put\+\_\+worker (\begin{DoxyParamCaption}\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{var\+\_\+id,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(in)}]{kstep,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:)}]{fld1,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), intent(out)}]{kinfo,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:), optional}]{fld2,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:), optional}]{fld3,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:), optional}]{fld4,  }\item[{real(kind=ip\+\_\+double\+\_\+p), dimension(\+:), optional}]{fld5,  }\item[{logical, optional}]{write\+\_\+restart,  }\item[{integer(kind=ip\+\_\+i4\+\_\+p), optional}]{varnum }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
449
450
451
452Send worker routine puts 8 byte real 1D data.
453
454
455\begin{DoxyParams}[1]{Parameters}
456\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
457\hline
458\mbox{\tt in}  & {\em kstep} & model time in seconds\\
459\hline
460 & {\em fld1} & field data\\
461\hline
462\mbox{\tt out}  & {\em kinfo} & return code\\
463\hline
464 & {\em fld2} & higher order field data\\
465\hline
466 & {\em fld3} & higher order field data\\
467\hline
468 & {\em fld4} & higher order field data\\
469\hline
470 & {\em fld5} & higher order field data\\
471\hline
472 & {\em write\+\_\+restart} & write restart now\\
473\hline
474 & {\em varnum} & varnum in bundled field \\
475\hline
476\end{DoxyParams}
477
478
479Definition at line 648 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
480
481
482
483\subsection{Variable Documentation}
484\mbox{\Hypertarget{namespacemod__oasis__getput__interface_a2ceaaa5740216799f651b8dacb42b239}\label{namespacemod__oasis__getput__interface_a2ceaaa5740216799f651b8dacb42b239}} 
485\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}!istatus@{istatus}}
486\index{istatus@{istatus}!mod\+\_\+oasis\+\_\+getput\+\_\+interface@{mod\+\_\+oasis\+\_\+getput\+\_\+interface}}
487\subsubsection{\texorpdfstring{istatus}{istatus}}
488{\footnotesize\ttfamily integer(kind=ip\+\_\+i4\+\_\+p), dimension(mpi\+\_\+status\+\_\+size) mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::istatus\hspace{0.3cm}{\ttfamily [private]}}
489
490
491
492Definition at line 23 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
493
Note: See TracBrowser for help on using the repository browser.