source: CPL/oasis3-mct_5.0/doc/doxygen/latex/interfacemod__oasis__getput__interface_1_1oasis__put.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: 15.2 KB
Line 
1\hypertarget{interfacemod__oasis__getput__interface_1_1oasis__put}{}\section{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+:\+:oasis\+\_\+put Interface Reference}
2\label{interfacemod__oasis__getput__interface_1_1oasis__put}\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put@{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put}}
3
4
5Generic overloaded interface for data put (send) 
6
7
8\subsection*{Private Member Functions}
9\begin{DoxyCompactItemize}
10\item 
11subroutine \hyperlink{interfacemod__oasis__getput__interface_1_1oasis__put_a5daa7fd6bfab2e09ba23d815d6120da1}{oasis\+\_\+put\+\_\+r14} (var\+\_\+id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write\+\_\+restart)
12\begin{DoxyCompactList}\small\item\em Send 4 byte real 1D data. \end{DoxyCompactList}\item 
13subroutine \hyperlink{interfacemod__oasis__getput__interface_1_1oasis__put_a0d2dc5120c55ca753bc5e6a1a22c0890}{oasis\+\_\+put\+\_\+r24} (var\+\_\+id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write\+\_\+restart)
14\begin{DoxyCompactList}\small\item\em Send 4 byte real 2D data. \end{DoxyCompactList}\item 
15subroutine \hyperlink{interfacemod__oasis__getput__interface_1_1oasis__put_a58fd29713950ff380f847bbb88cdca2b}{oasis\+\_\+put\+\_\+r34} (var\+\_\+id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write\+\_\+restart)
16\begin{DoxyCompactList}\small\item\em Send 4 byte real 2D bundled data. \end{DoxyCompactList}\item 
17subroutine \hyperlink{interfacemod__oasis__getput__interface_1_1oasis__put_a1c434d693016ff43967eff96ee313dda}{oasis\+\_\+put\+\_\+r18} (var\+\_\+id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write\+\_\+restart)
18\begin{DoxyCompactList}\small\item\em Send 4 byte real 1D data. \end{DoxyCompactList}\item 
19subroutine \hyperlink{interfacemod__oasis__getput__interface_1_1oasis__put_a9130f78702c3d05291301efd3eb812c6}{oasis\+\_\+put\+\_\+r28} (var\+\_\+id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write\+\_\+restart)
20\begin{DoxyCompactList}\small\item\em Send 8 byte real 2D data. \end{DoxyCompactList}\item 
21subroutine \hyperlink{interfacemod__oasis__getput__interface_1_1oasis__put_a9040582c4598a3f4c6df1be95ee8913e}{oasis\+\_\+put\+\_\+r38} (var\+\_\+id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write\+\_\+restart)
22\begin{DoxyCompactList}\small\item\em Send 8 byte real 2D bundled data. \end{DoxyCompactList}\end{DoxyCompactItemize}
23
24
25\subsection{Detailed Description}
26Generic overloaded interface for data put (send)
27
28Definition at line 26 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
29
30
31
32\subsection{Member Function/\+Subroutine Documentation}
33\mbox{\Hypertarget{interfacemod__oasis__getput__interface_1_1oasis__put_a5daa7fd6bfab2e09ba23d815d6120da1}\label{interfacemod__oasis__getput__interface_1_1oasis__put_a5daa7fd6bfab2e09ba23d815d6120da1}} 
34\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put@{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put}!oasis\+\_\+put\+\_\+r14@{oasis\+\_\+put\+\_\+r14}}
35\index{oasis\+\_\+put\+\_\+r14@{oasis\+\_\+put\+\_\+r14}!mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put@{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put}}
36\subsubsection{\texorpdfstring{oasis\+\_\+put\+\_\+r14()}{oasis\_put\_r14()}}
37{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put\+::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]}}
38
39
40
41Send 4 byte real 1D data.
42
43
44\begin{DoxyParams}[1]{Parameters}
45\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
46\hline
47\mbox{\tt in}  & {\em kstep} & model time in seconds\\
48\hline
49 & {\em fld1} & field data\\
50\hline
51\mbox{\tt out}  & {\em kinfo} & return code\\
52\hline
53 & {\em fld2} & higher order field data\\
54\hline
55 & {\em fld3} & higher order field data\\
56\hline
57 & {\em fld4} & higher order field data\\
58\hline
59 & {\em fld5} & higher order field data\\
60\hline
61 & {\em write\+\_\+restart} & write restart now \\
62\hline
63\end{DoxyParams}
64
65
66Definition at line 58 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
67
68\mbox{\Hypertarget{interfacemod__oasis__getput__interface_1_1oasis__put_a1c434d693016ff43967eff96ee313dda}\label{interfacemod__oasis__getput__interface_1_1oasis__put_a1c434d693016ff43967eff96ee313dda}} 
69\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put@{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put}!oasis\+\_\+put\+\_\+r18@{oasis\+\_\+put\+\_\+r18}}
70\index{oasis\+\_\+put\+\_\+r18@{oasis\+\_\+put\+\_\+r18}!mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put@{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put}}
71\subsubsection{\texorpdfstring{oasis\+\_\+put\+\_\+r18()}{oasis\_put\_r18()}}
72{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put\+::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]}}
73
74
75
76Send 4 byte real 1D data.
77
78
79\begin{DoxyParams}[1]{Parameters}
80\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
81\hline
82\mbox{\tt in}  & {\em kstep} & model time in seconds\\
83\hline
84 & {\em fld1} & field data\\
85\hline
86\mbox{\tt out}  & {\em kinfo} & return code\\
87\hline
88 & {\em fld2} & higher order field data\\
89\hline
90 & {\em fld3} & higher order field data\\
91\hline
92 & {\em fld4} & higher order field data\\
93\hline
94 & {\em fld5} & higher order field data\\
95\hline
96 & {\em write\+\_\+restart} & write restart now \\
97\hline
98\end{DoxyParams}
99
100
101Definition at line 124 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
102
103\mbox{\Hypertarget{interfacemod__oasis__getput__interface_1_1oasis__put_a0d2dc5120c55ca753bc5e6a1a22c0890}\label{interfacemod__oasis__getput__interface_1_1oasis__put_a0d2dc5120c55ca753bc5e6a1a22c0890}} 
104\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put@{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put}!oasis\+\_\+put\+\_\+r24@{oasis\+\_\+put\+\_\+r24}}
105\index{oasis\+\_\+put\+\_\+r24@{oasis\+\_\+put\+\_\+r24}!mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put@{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put}}
106\subsubsection{\texorpdfstring{oasis\+\_\+put\+\_\+r24()}{oasis\_put\_r24()}}
107{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put\+::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]}}
108
109
110
111Send 4 byte real 2D data.
112
113
114\begin{DoxyParams}[1]{Parameters}
115\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
116\hline
117\mbox{\tt in}  & {\em kstep} & model time in seconds\\
118\hline
119 & {\em fld1} & field data\\
120\hline
121\mbox{\tt out}  & {\em kinfo} & return code\\
122\hline
123 & {\em fld2} & higher order field data\\
124\hline
125 & {\em fld3} & higher order field data\\
126\hline
127 & {\em fld4} & higher order field data\\
128\hline
129 & {\em fld5} & higher order field data\\
130\hline
131 & {\em write\+\_\+restart} & write restart now \\
132\hline
133\end{DoxyParams}
134
135
136Definition at line 190 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
137
138\mbox{\Hypertarget{interfacemod__oasis__getput__interface_1_1oasis__put_a9130f78702c3d05291301efd3eb812c6}\label{interfacemod__oasis__getput__interface_1_1oasis__put_a9130f78702c3d05291301efd3eb812c6}} 
139\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put@{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put}!oasis\+\_\+put\+\_\+r28@{oasis\+\_\+put\+\_\+r28}}
140\index{oasis\+\_\+put\+\_\+r28@{oasis\+\_\+put\+\_\+r28}!mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put@{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put}}
141\subsubsection{\texorpdfstring{oasis\+\_\+put\+\_\+r28()}{oasis\_put\_r28()}}
142{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put\+::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]}}
143
144
145
146Send 8 byte real 2D data.
147
148
149\begin{DoxyParams}[1]{Parameters}
150\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
151\hline
152\mbox{\tt in}  & {\em kstep} & model time in seconds\\
153\hline
154 & {\em fld1} & field data\\
155\hline
156\mbox{\tt out}  & {\em kinfo} & return code\\
157\hline
158 & {\em fld2} & higher order field data\\
159\hline
160 & {\em fld3} & higher order field data\\
161\hline
162 & {\em fld4} & higher order field data\\
163\hline
164 & {\em fld5} & higher order field data\\
165\hline
166 & {\em write\+\_\+restart} & write restart now \\
167\hline
168\end{DoxyParams}
169
170
171Definition at line 420 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
172
173\mbox{\Hypertarget{interfacemod__oasis__getput__interface_1_1oasis__put_a58fd29713950ff380f847bbb88cdca2b}\label{interfacemod__oasis__getput__interface_1_1oasis__put_a58fd29713950ff380f847bbb88cdca2b}} 
174\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put@{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put}!oasis\+\_\+put\+\_\+r34@{oasis\+\_\+put\+\_\+r34}}
175\index{oasis\+\_\+put\+\_\+r34@{oasis\+\_\+put\+\_\+r34}!mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put@{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put}}
176\subsubsection{\texorpdfstring{oasis\+\_\+put\+\_\+r34()}{oasis\_put\_r34()}}
177{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put\+::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]}}
178
179
180
181Send 4 byte real 2D bundled data.
182
183
184\begin{DoxyParams}[1]{Parameters}
185\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
186\hline
187\mbox{\tt in}  & {\em kstep} & model time in seconds\\
188\hline
189 & {\em fld1} & field data\\
190\hline
191\mbox{\tt out}  & {\em kinfo} & return code\\
192\hline
193 & {\em fld2} & higher order field data\\
194\hline
195 & {\em fld3} & higher order field data\\
196\hline
197 & {\em fld4} & higher order field data\\
198\hline
199 & {\em fld5} & higher order field data\\
200\hline
201 & {\em write\+\_\+restart} & write restart now \\
202\hline
203\end{DoxyParams}
204
205
206Definition at line 314 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
207
208\mbox{\Hypertarget{interfacemod__oasis__getput__interface_1_1oasis__put_a9040582c4598a3f4c6df1be95ee8913e}\label{interfacemod__oasis__getput__interface_1_1oasis__put_a9040582c4598a3f4c6df1be95ee8913e}} 
209\index{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put@{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put}!oasis\+\_\+put\+\_\+r38@{oasis\+\_\+put\+\_\+r38}}
210\index{oasis\+\_\+put\+\_\+r38@{oasis\+\_\+put\+\_\+r38}!mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put@{mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put}}
211\subsubsection{\texorpdfstring{oasis\+\_\+put\+\_\+r38()}{oasis\_put\_r38()}}
212{\footnotesize\ttfamily subroutine mod\+\_\+oasis\+\_\+getput\+\_\+interface\+::oasis\+\_\+put\+::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]}}
213
214
215
216Send 8 byte real 2D bundled data.
217
218
219\begin{DoxyParams}[1]{Parameters}
220\mbox{\tt in}  & {\em var\+\_\+id} & variable id\\
221\hline
222\mbox{\tt in}  & {\em kstep} & model time in seconds\\
223\hline
224 & {\em fld1} & field data\\
225\hline
226\mbox{\tt out}  & {\em kinfo} & return code\\
227\hline
228 & {\em fld2} & higher order field data\\
229\hline
230 & {\em fld3} & higher order field data\\
231\hline
232 & {\em fld4} & higher order field data\\
233\hline
234 & {\em fld5} & higher order field data\\
235\hline
236 & {\em write\+\_\+restart} & write restart now \\
237\hline
238\end{DoxyParams}
239
240
241Definition at line 543 of file mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90.
242
243
244
245The documentation for this interface was generated from the following file\+:\begin{DoxyCompactItemize}
246\item 
247/home/globc2/tcraig/oasis3-\/mct.\+trunk/lib/psmile/src/\hyperlink{mod__oasis__getput__interface_8_f90}{mod\+\_\+oasis\+\_\+getput\+\_\+interface.\+F90}\end{DoxyCompactItemize}
Note: See TracBrowser for help on using the repository browser.