source: CPL/oasis3-mct/branches/OASIS3-MCT_5.0_branch/doc/doxygen/latex/namespacemod__oasis__io.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: 22.6 KB
Line 
1\hypertarget{namespacemod__oasis__io}{}\section{mod\+\_\+oasis\+\_\+io Module Reference}
2\label{namespacemod__oasis__io}\index{mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}}
3
4
5Provides reusable IO routines for O\+A\+S\+IS. 
6
7
8\subsection*{Functions/\+Subroutines}
9\begin{DoxyCompactItemize}
10\item 
11logical function, public \hyperlink{namespacemod__oasis__io_a4d0f5cb29eabc798e857127c8c174d85}{oasis\+\_\+io\+\_\+varexists} (filename, fldname)
12\begin{DoxyCompactList}\small\item\em Checks whether the var fldname is in the file. \end{DoxyCompactList}\item 
13subroutine, public \hyperlink{namespacemod__oasis__io_a6c14bebb7b216218e25f599e3469ae0c}{oasis\+\_\+io\+\_\+read\+\_\+avfld} (filename, av, gsmap, mpicom, avfld, filefld, fldtype)
14\begin{DoxyCompactList}\small\item\em Reads single field from a file into an attribute Vector. \end{DoxyCompactList}\item 
15subroutine, public \hyperlink{namespacemod__oasis__io_ad8a48d6c36e3fac637a8191c20e514f2}{oasis\+\_\+io\+\_\+write\+\_\+avfile} (rstfile, av, gsmap, mpicom, nx, ny, nampre)
16\begin{DoxyCompactList}\small\item\em Writes all fields from an attribute vector to a file. \end{DoxyCompactList}\item 
17subroutine, public \hyperlink{namespacemod__oasis__io_a65e17e4a065e8e4dea33754fb9c1d32c}{oasis\+\_\+io\+\_\+read\+\_\+avfile} (rstfile, av, gsmap, mpicom, abort, nampre, didread)
18\begin{DoxyCompactList}\small\item\em Reads all fields for an attribute vector from a file. \end{DoxyCompactList}\item 
19subroutine, public \hyperlink{namespacemod__oasis__io_a8b604f89345d74c74c6bc3b4760b2e29}{oasis\+\_\+io\+\_\+read\+\_\+array} (rstfile, mpicom, iarray, ivarname, rarray, rvarname, abort)
20\begin{DoxyCompactList}\small\item\em Reads an integer or real field from a file into an array. \end{DoxyCompactList}\item 
21subroutine, public \hyperlink{namespacemod__oasis__io_a9ac8ce0ba3223fb59f7f003b50b229cf}{oasis\+\_\+io\+\_\+write\+\_\+array} (rstfile, mpicom, iarray, ivarname, rarray, rvarname)
22\begin{DoxyCompactList}\small\item\em Writes a real or integer array to a file. \end{DoxyCompactList}\item 
23subroutine, public \hyperlink{namespacemod__oasis__io_a42b325557a774b08d4cba24f387f8b01}{oasis\+\_\+io\+\_\+write\+\_\+avfbf} (av, gsmap, mpicom, nx, ny, msec, f\+\_\+string, filename)
24\begin{DoxyCompactList}\small\item\em Write each field in an attribute vector to an individual files. \end{DoxyCompactList}\item 
25subroutine, public \hyperlink{namespacemod__oasis__io_ac4a465a698824fb473074bfbd3d92f79}{oasis\+\_\+io\+\_\+read\+\_\+avfbf} (av, gsmap, mpicom, msec, f\+\_\+string, filename)
26\begin{DoxyCompactList}\small\item\em Read each field in an attribute vector from individual files. \end{DoxyCompactList}\item 
27subroutine, public \hyperlink{namespacemod__oasis__io_af080505b4678a5c68916a700f54ac6e6}{oasis\+\_\+io\+\_\+read\+\_\+field\+\_\+fromroot} (filename, fldname, ifld2, fld2, fld3, nx, ny, nz)
28\begin{DoxyCompactList}\small\item\em Read a field on the root task from a file into an array. \end{DoxyCompactList}\item 
29subroutine, public \hyperlink{namespacemod__oasis__io_a18912324646473cf8fedd7138cc59a79}{oasis\+\_\+io\+\_\+write\+\_\+2dgridfld\+\_\+fromroot} (filename, fldname, fld, nx, ny)
30\begin{DoxyCompactList}\small\item\em Write a real array named field from the root task to a file. \end{DoxyCompactList}\item 
31subroutine, public \hyperlink{namespacemod__oasis__io_a432ecb26e0e2d8387c1601ea6cc68668}{oasis\+\_\+io\+\_\+write\+\_\+2dgridint\+\_\+fromroot} (filename, fldname, fld, nx, ny)
32\begin{DoxyCompactList}\small\item\em Write an integer array named field from the root task to a file. \end{DoxyCompactList}\item 
33subroutine, public \hyperlink{namespacemod__oasis__io_aa967e930e5d6199bbc6ec9a4f3c7069e}{oasis\+\_\+io\+\_\+write\+\_\+3dgridfld\+\_\+fromroot} (filename, fldname, fld, nx, ny, nc)
34\begin{DoxyCompactList}\small\item\em Write a 3d real array named field from the root task to a file. \end{DoxyCompactList}\end{DoxyCompactItemize}
35
36
37\subsection{Detailed Description}
38Provides reusable IO routines for O\+A\+S\+IS.
39
40\subsection{Function/\+Subroutine Documentation}
41\mbox{\Hypertarget{namespacemod__oasis__io_a8b604f89345d74c74c6bc3b4760b2e29}\label{namespacemod__oasis__io_a8b604f89345d74c74c6bc3b4760b2e29}} 
42\index{mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}!oasis\+\_\+io\+\_\+read\+\_\+array@{oasis\+\_\+io\+\_\+read\+\_\+array}}
43\index{oasis\+\_\+io\+\_\+read\+\_\+array@{oasis\+\_\+io\+\_\+read\+\_\+array}!mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}}
44\subsubsection{\texorpdfstring{oasis\+\_\+io\+\_\+read\+\_\+array()}{oasis\_io\_read\_array()}}
45{\footnotesize\ttfamily subroutine, public mod\+\_\+oasis\+\_\+io\+::oasis\+\_\+io\+\_\+read\+\_\+array (\begin{DoxyParamCaption}\item[{character(len=$\ast$), intent(in)}]{rstfile,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{mpicom,  }\item[{integer(ip\+\_\+i4\+\_\+p), dimension(\+:), intent(inout), optional}]{iarray,  }\item[{character(len=$\ast$), intent(in), optional}]{ivarname,  }\item[{real(ip\+\_\+double\+\_\+p), dimension(\+:), intent(inout), optional}]{rarray,  }\item[{character(len=$\ast$), intent(in), optional}]{rvarname,  }\item[{logical, intent(in), optional}]{abort }\end{DoxyParamCaption})}
46
47
48
49Reads an integer or real field from a file into an array.
50
51
52\begin{DoxyParams}[1]{Parameters}
53\mbox{\tt in}  & {\em rstfile} & filename\\
54\hline
55\mbox{\tt in}  & {\em mpicom} & mpi comm\\
56\hline
57\mbox{\tt in,out}  & {\em iarray} & integer data on root\\
58\hline
59\mbox{\tt in}  & {\em ivarname} & integer variable name on file\\
60\hline
61\mbox{\tt in,out}  & {\em rarray} & real data on root\\
62\hline
63\mbox{\tt in}  & {\em rvarname} & real variable name on file\\
64\hline
65\mbox{\tt in}  & {\em abort} & abort on error flag, default is true \\
66\hline
67\end{DoxyParams}
68
69
70Definition at line 565 of file mod\+\_\+oasis\+\_\+io.\+F90.
71
72\mbox{\Hypertarget{namespacemod__oasis__io_ac4a465a698824fb473074bfbd3d92f79}\label{namespacemod__oasis__io_ac4a465a698824fb473074bfbd3d92f79}} 
73\index{mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}!oasis\+\_\+io\+\_\+read\+\_\+avfbf@{oasis\+\_\+io\+\_\+read\+\_\+avfbf}}
74\index{oasis\+\_\+io\+\_\+read\+\_\+avfbf@{oasis\+\_\+io\+\_\+read\+\_\+avfbf}!mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}}
75\subsubsection{\texorpdfstring{oasis\+\_\+io\+\_\+read\+\_\+avfbf()}{oasis\_io\_read\_avfbf()}}
76{\footnotesize\ttfamily subroutine, public mod\+\_\+oasis\+\_\+io\+::oasis\+\_\+io\+\_\+read\+\_\+avfbf (\begin{DoxyParamCaption}\item[{type(mct\+\_\+avect), intent(inout)}]{av,  }\item[{type(mct\+\_\+gsmap), intent(in)}]{gsmap,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{mpicom,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in), optional}]{msec,  }\item[{character(len=$\ast$), intent(in), optional}]{f\+\_\+string,  }\item[{character(len=$\ast$), intent(in), optional}]{filename }\end{DoxyParamCaption})}
77
78
79
80Read each field in an attribute vector from individual files.
81
82
83\begin{DoxyParams}[1]{Parameters}
84\mbox{\tt in,out}  & {\em av} & avect\\
85\hline
86\mbox{\tt in}  & {\em gsmap} & gsmap decomp\\
87\hline
88\mbox{\tt in}  & {\em mpicom} & mpi comm\\
89\hline
90\mbox{\tt in}  & {\em msec} & optional time info in seconds\\
91\hline
92\mbox{\tt in}  & {\em f\+\_\+string} & optional f\+\_\+string to append to filename\\
93\hline
94\mbox{\tt in}  & {\em filename} & optional input filename \\
95\hline
96\end{DoxyParams}
97
98
99Definition at line 1091 of file mod\+\_\+oasis\+\_\+io.\+F90.
100
101\mbox{\Hypertarget{namespacemod__oasis__io_a65e17e4a065e8e4dea33754fb9c1d32c}\label{namespacemod__oasis__io_a65e17e4a065e8e4dea33754fb9c1d32c}} 
102\index{mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}!oasis\+\_\+io\+\_\+read\+\_\+avfile@{oasis\+\_\+io\+\_\+read\+\_\+avfile}}
103\index{oasis\+\_\+io\+\_\+read\+\_\+avfile@{oasis\+\_\+io\+\_\+read\+\_\+avfile}!mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}}
104\subsubsection{\texorpdfstring{oasis\+\_\+io\+\_\+read\+\_\+avfile()}{oasis\_io\_read\_avfile()}}
105{\footnotesize\ttfamily subroutine, public mod\+\_\+oasis\+\_\+io\+::oasis\+\_\+io\+\_\+read\+\_\+avfile (\begin{DoxyParamCaption}\item[{character(len=$\ast$), intent(in)}]{rstfile,  }\item[{type(mct\+\_\+avect), intent(inout)}]{av,  }\item[{type(mct\+\_\+gsmap), intent(in)}]{gsmap,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{mpicom,  }\item[{logical, intent(in), optional}]{abort,  }\item[{character(len=$\ast$), intent(in), optional}]{nampre,  }\item[{logical, intent(out), optional}]{didread }\end{DoxyParamCaption})}
106
107
108
109Reads all fields for an attribute vector from a file.
110
111
112\begin{DoxyParams}[1]{Parameters}
113\mbox{\tt in}  & {\em rstfile} & filename\\
114\hline
115\mbox{\tt in,out}  & {\em av} & avect\\
116\hline
117\mbox{\tt in}  & {\em gsmap} & gsmap decomp\\
118\hline
119\mbox{\tt in}  & {\em mpicom} & mpi comm\\
120\hline
121\mbox{\tt in}  & {\em abort} & abort on error flag, default is true\\
122\hline
123\mbox{\tt in}  & {\em nampre} & name prepend string for fields on file\\
124\hline
125\mbox{\tt out}  & {\em didread} & flag indicating that read was successful \\
126\hline
127\end{DoxyParams}
128
129
130Definition at line 406 of file mod\+\_\+oasis\+\_\+io.\+F90.
131
132\mbox{\Hypertarget{namespacemod__oasis__io_a6c14bebb7b216218e25f599e3469ae0c}\label{namespacemod__oasis__io_a6c14bebb7b216218e25f599e3469ae0c}} 
133\index{mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}!oasis\+\_\+io\+\_\+read\+\_\+avfld@{oasis\+\_\+io\+\_\+read\+\_\+avfld}}
134\index{oasis\+\_\+io\+\_\+read\+\_\+avfld@{oasis\+\_\+io\+\_\+read\+\_\+avfld}!mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}}
135\subsubsection{\texorpdfstring{oasis\+\_\+io\+\_\+read\+\_\+avfld()}{oasis\_io\_read\_avfld()}}
136{\footnotesize\ttfamily subroutine, public mod\+\_\+oasis\+\_\+io\+::oasis\+\_\+io\+\_\+read\+\_\+avfld (\begin{DoxyParamCaption}\item[{character(len=$\ast$), intent(in)}]{filename,  }\item[{type(mct\+\_\+avect), intent(inout)}]{av,  }\item[{type(mct\+\_\+gsmap), intent(in)}]{gsmap,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{mpicom,  }\item[{character(len=$\ast$), intent(in)}]{avfld,  }\item[{character(len=$\ast$), intent(in)}]{filefld,  }\item[{character(len=$\ast$), intent(in), optional}]{fldtype }\end{DoxyParamCaption})}
137
138
139
140Reads single field from a file into an attribute Vector.
141
142
143\begin{DoxyParams}[1]{Parameters}
144\mbox{\tt in}  & {\em filename} & file name\\
145\hline
146\mbox{\tt in,out}  & {\em av} & avect\\
147\hline
148\mbox{\tt in}  & {\em gsmap} & gsmap decomp\\
149\hline
150\mbox{\tt in}  & {\em mpicom} & mpi comm\\
151\hline
152\mbox{\tt in}  & {\em avfld} & av field name\\
153\hline
154\mbox{\tt in}  & {\em filefld} & file field name\\
155\hline
156\mbox{\tt in}  & {\em fldtype} & kind \\
157\hline
158\end{DoxyParams}
159
160
161Definition at line 78 of file mod\+\_\+oasis\+\_\+io.\+F90.
162
163\mbox{\Hypertarget{namespacemod__oasis__io_af080505b4678a5c68916a700f54ac6e6}\label{namespacemod__oasis__io_af080505b4678a5c68916a700f54ac6e6}} 
164\index{mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}!oasis\+\_\+io\+\_\+read\+\_\+field\+\_\+fromroot@{oasis\+\_\+io\+\_\+read\+\_\+field\+\_\+fromroot}}
165\index{oasis\+\_\+io\+\_\+read\+\_\+field\+\_\+fromroot@{oasis\+\_\+io\+\_\+read\+\_\+field\+\_\+fromroot}!mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}}
166\subsubsection{\texorpdfstring{oasis\+\_\+io\+\_\+read\+\_\+field\+\_\+fromroot()}{oasis\_io\_read\_field\_fromroot()}}
167{\footnotesize\ttfamily subroutine, public mod\+\_\+oasis\+\_\+io\+::oasis\+\_\+io\+\_\+read\+\_\+field\+\_\+fromroot (\begin{DoxyParamCaption}\item[{character(len=$\ast$), intent(in)}]{filename,  }\item[{character(len=$\ast$), intent(in)}]{fldname,  }\item[{integer(ip\+\_\+i4\+\_\+p), dimension(\+:,\+:), intent(inout), optional}]{ifld2,  }\item[{real(ip\+\_\+realwp\+\_\+p), dimension(\+:,\+:), intent(inout), optional}]{fld2,  }\item[{real(ip\+\_\+realwp\+\_\+p), dimension(\+:,\+:,\+:), intent(inout), optional}]{fld3,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(inout), optional}]{nx,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(inout), optional}]{ny,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(inout), optional}]{nz }\end{DoxyParamCaption})}
168
169
170
171Read a field on the root task from a file into an array.
172
173
174\begin{DoxyParams}[1]{Parameters}
175\mbox{\tt in}  & {\em filename} & file name\\
176\hline
177\mbox{\tt in}  & {\em fldname} & field name\\
178\hline
179\mbox{\tt in,out}  & {\em ifld2} & 2d integer array\\
180\hline
181\mbox{\tt in,out}  & {\em fld2} & 2d real array\\
182\hline
183\mbox{\tt in,out}  & {\em fld3} & 3d real array\\
184\hline
185\mbox{\tt in,out}  & {\em nx} & global nx size\\
186\hline
187\mbox{\tt in,out}  & {\em ny} & global ny size\\
188\hline
189\mbox{\tt in,out}  & {\em nz} & global nz size \\
190\hline
191\end{DoxyParams}
192
193
194Definition at line 1254 of file mod\+\_\+oasis\+\_\+io.\+F90.
195
196\mbox{\Hypertarget{namespacemod__oasis__io_a4d0f5cb29eabc798e857127c8c174d85}\label{namespacemod__oasis__io_a4d0f5cb29eabc798e857127c8c174d85}} 
197\index{mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}!oasis\+\_\+io\+\_\+varexists@{oasis\+\_\+io\+\_\+varexists}}
198\index{oasis\+\_\+io\+\_\+varexists@{oasis\+\_\+io\+\_\+varexists}!mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}}
199\subsubsection{\texorpdfstring{oasis\+\_\+io\+\_\+varexists()}{oasis\_io\_varexists()}}
200{\footnotesize\ttfamily logical function, public mod\+\_\+oasis\+\_\+io\+::oasis\+\_\+io\+\_\+varexists (\begin{DoxyParamCaption}\item[{character(len=$\ast$), intent(in)}]{filename,  }\item[{character(len=$\ast$), intent(in)}]{fldname }\end{DoxyParamCaption})}
201
202
203
204Checks whether the var fldname is in the file.
205
206
207
208Definition at line 42 of file mod\+\_\+oasis\+\_\+io.\+F90.
209
210\mbox{\Hypertarget{namespacemod__oasis__io_a18912324646473cf8fedd7138cc59a79}\label{namespacemod__oasis__io_a18912324646473cf8fedd7138cc59a79}} 
211\index{mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}!oasis\+\_\+io\+\_\+write\+\_\+2dgridfld\+\_\+fromroot@{oasis\+\_\+io\+\_\+write\+\_\+2dgridfld\+\_\+fromroot}}
212\index{oasis\+\_\+io\+\_\+write\+\_\+2dgridfld\+\_\+fromroot@{oasis\+\_\+io\+\_\+write\+\_\+2dgridfld\+\_\+fromroot}!mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}}
213\subsubsection{\texorpdfstring{oasis\+\_\+io\+\_\+write\+\_\+2dgridfld\+\_\+fromroot()}{oasis\_io\_write\_2dgridfld\_fromroot()}}
214{\footnotesize\ttfamily subroutine, public mod\+\_\+oasis\+\_\+io\+::oasis\+\_\+io\+\_\+write\+\_\+2dgridfld\+\_\+fromroot (\begin{DoxyParamCaption}\item[{character(len=$\ast$), intent(in)}]{filename,  }\item[{character(len=$\ast$), intent(in)}]{fldname,  }\item[{real(ip\+\_\+realwp\+\_\+p), dimension(\+:,\+:), intent(in)}]{fld,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{nx,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{ny }\end{DoxyParamCaption})}
215
216
217
218Write a real array named field from the root task to a file.
219
220
221\begin{DoxyParams}[1]{Parameters}
222\mbox{\tt in}  & {\em filename} & file name\\
223\hline
224\mbox{\tt in}  & {\em fldname} & field name\\
225\hline
226\mbox{\tt in}  & {\em fld} & 2d real field\\
227\hline
228\mbox{\tt in}  & {\em nx} & 2d global nx size\\
229\hline
230\mbox{\tt in}  & {\em ny} & 2d global ny size \\
231\hline
232\end{DoxyParams}
233
234
235Definition at line 1397 of file mod\+\_\+oasis\+\_\+io.\+F90.
236
237\mbox{\Hypertarget{namespacemod__oasis__io_a432ecb26e0e2d8387c1601ea6cc68668}\label{namespacemod__oasis__io_a432ecb26e0e2d8387c1601ea6cc68668}} 
238\index{mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}!oasis\+\_\+io\+\_\+write\+\_\+2dgridint\+\_\+fromroot@{oasis\+\_\+io\+\_\+write\+\_\+2dgridint\+\_\+fromroot}}
239\index{oasis\+\_\+io\+\_\+write\+\_\+2dgridint\+\_\+fromroot@{oasis\+\_\+io\+\_\+write\+\_\+2dgridint\+\_\+fromroot}!mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}}
240\subsubsection{\texorpdfstring{oasis\+\_\+io\+\_\+write\+\_\+2dgridint\+\_\+fromroot()}{oasis\_io\_write\_2dgridint\_fromroot()}}
241{\footnotesize\ttfamily subroutine, public mod\+\_\+oasis\+\_\+io\+::oasis\+\_\+io\+\_\+write\+\_\+2dgridint\+\_\+fromroot (\begin{DoxyParamCaption}\item[{character(len=$\ast$), intent(in)}]{filename,  }\item[{character(len=$\ast$), intent(in)}]{fldname,  }\item[{integer(ip\+\_\+i4\+\_\+p), dimension(\+:,\+:), intent(in)}]{fld,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{nx,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{ny }\end{DoxyParamCaption})}
242
243
244
245Write an integer array named field from the root task to a file.
246
247
248\begin{DoxyParams}[1]{Parameters}
249\mbox{\tt in}  & {\em filename} & file name\\
250\hline
251\mbox{\tt in}  & {\em fldname} & field name\\
252\hline
253\mbox{\tt in}  & {\em fld} & integer field\\
254\hline
255\mbox{\tt in}  & {\em nx} & 2d global nx size\\
256\hline
257\mbox{\tt in}  & {\em ny} & 2d global ny size \\
258\hline
259\end{DoxyParams}
260
261
262Definition at line 1500 of file mod\+\_\+oasis\+\_\+io.\+F90.
263
264\mbox{\Hypertarget{namespacemod__oasis__io_aa967e930e5d6199bbc6ec9a4f3c7069e}\label{namespacemod__oasis__io_aa967e930e5d6199bbc6ec9a4f3c7069e}} 
265\index{mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}!oasis\+\_\+io\+\_\+write\+\_\+3dgridfld\+\_\+fromroot@{oasis\+\_\+io\+\_\+write\+\_\+3dgridfld\+\_\+fromroot}}
266\index{oasis\+\_\+io\+\_\+write\+\_\+3dgridfld\+\_\+fromroot@{oasis\+\_\+io\+\_\+write\+\_\+3dgridfld\+\_\+fromroot}!mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}}
267\subsubsection{\texorpdfstring{oasis\+\_\+io\+\_\+write\+\_\+3dgridfld\+\_\+fromroot()}{oasis\_io\_write\_3dgridfld\_fromroot()}}
268{\footnotesize\ttfamily subroutine, public mod\+\_\+oasis\+\_\+io\+::oasis\+\_\+io\+\_\+write\+\_\+3dgridfld\+\_\+fromroot (\begin{DoxyParamCaption}\item[{character(len=$\ast$), intent(in)}]{filename,  }\item[{character(len=$\ast$), intent(in)}]{fldname,  }\item[{real(ip\+\_\+realwp\+\_\+p), dimension(\+:,\+:,\+:), intent(in)}]{fld,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{nx,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{ny,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{nc }\end{DoxyParamCaption})}
269
270
271
272Write a 3d real array named field from the root task to a file.
273
274
275\begin{DoxyParams}[1]{Parameters}
276\mbox{\tt in}  & {\em filename} & file name\\
277\hline
278\mbox{\tt in}  & {\em fldname} & field name\\
279\hline
280\mbox{\tt in}  & {\em fld} & 3d real array\\
281\hline
282\mbox{\tt in}  & {\em nx} & 3d global nx size\\
283\hline
284\mbox{\tt in}  & {\em ny} & 3d global ny size\\
285\hline
286\mbox{\tt in}  & {\em nc} & 3d global nz size or nc size for corners \\
287\hline
288\end{DoxyParams}
289
290
291Definition at line 1603 of file mod\+\_\+oasis\+\_\+io.\+F90.
292
293\mbox{\Hypertarget{namespacemod__oasis__io_a9ac8ce0ba3223fb59f7f003b50b229cf}\label{namespacemod__oasis__io_a9ac8ce0ba3223fb59f7f003b50b229cf}} 
294\index{mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}!oasis\+\_\+io\+\_\+write\+\_\+array@{oasis\+\_\+io\+\_\+write\+\_\+array}}
295\index{oasis\+\_\+io\+\_\+write\+\_\+array@{oasis\+\_\+io\+\_\+write\+\_\+array}!mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}}
296\subsubsection{\texorpdfstring{oasis\+\_\+io\+\_\+write\+\_\+array()}{oasis\_io\_write\_array()}}
297{\footnotesize\ttfamily subroutine, public mod\+\_\+oasis\+\_\+io\+::oasis\+\_\+io\+\_\+write\+\_\+array (\begin{DoxyParamCaption}\item[{character(len=$\ast$), intent(in)}]{rstfile,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{mpicom,  }\item[{integer(ip\+\_\+i4\+\_\+p), dimension(\+:), intent(in), optional}]{iarray,  }\item[{character(len=$\ast$), intent(in), optional}]{ivarname,  }\item[{real(ip\+\_\+double\+\_\+p), dimension(\+:), intent(in), optional}]{rarray,  }\item[{character(len=$\ast$), intent(in), optional}]{rvarname }\end{DoxyParamCaption})}
298
299
300
301Writes a real or integer array to a file.
302
303
304\begin{DoxyParams}[1]{Parameters}
305\mbox{\tt in}  & {\em rstfile} & filename\\
306\hline
307\mbox{\tt in}  & {\em mpicom} & mpi comm\\
308\hline
309\mbox{\tt in}  & {\em iarray} & integer data on root\\
310\hline
311\mbox{\tt in}  & {\em ivarname} & integer variable name on file\\
312\hline
313\mbox{\tt in}  & {\em rarray} & real data on root\\
314\hline
315\mbox{\tt in}  & {\em rvarname} & real variable name on file \\
316\hline
317\end{DoxyParams}
318
319
320Definition at line 730 of file mod\+\_\+oasis\+\_\+io.\+F90.
321
322\mbox{\Hypertarget{namespacemod__oasis__io_a42b325557a774b08d4cba24f387f8b01}\label{namespacemod__oasis__io_a42b325557a774b08d4cba24f387f8b01}} 
323\index{mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}!oasis\+\_\+io\+\_\+write\+\_\+avfbf@{oasis\+\_\+io\+\_\+write\+\_\+avfbf}}
324\index{oasis\+\_\+io\+\_\+write\+\_\+avfbf@{oasis\+\_\+io\+\_\+write\+\_\+avfbf}!mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}}
325\subsubsection{\texorpdfstring{oasis\+\_\+io\+\_\+write\+\_\+avfbf()}{oasis\_io\_write\_avfbf()}}
326{\footnotesize\ttfamily subroutine, public mod\+\_\+oasis\+\_\+io\+::oasis\+\_\+io\+\_\+write\+\_\+avfbf (\begin{DoxyParamCaption}\item[{type(mct\+\_\+avect), intent(in)}]{av,  }\item[{type(mct\+\_\+gsmap), intent(in)}]{gsmap,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{mpicom,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{nx,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{ny,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in), optional}]{msec,  }\item[{character(len=$\ast$), intent(in), optional}]{f\+\_\+string,  }\item[{character(len=$\ast$), intent(in), optional}]{filename }\end{DoxyParamCaption})}
327
328
329
330Write each field in an attribute vector to an individual files.
331
332
333\begin{DoxyParams}[1]{Parameters}
334\mbox{\tt in}  & {\em av} & avect\\
335\hline
336\mbox{\tt in}  & {\em gsmap} & gsmap decomp\\
337\hline
338\mbox{\tt in}  & {\em mpicom} & mpi comm\\
339\hline
340\mbox{\tt in}  & {\em nx} & 2d global nx size\\
341\hline
342\mbox{\tt in}  & {\em ny} & 2d global ny size\\
343\hline
344\mbox{\tt in}  & {\em msec} & optional time info in seconds\\
345\hline
346\mbox{\tt in}  & {\em f\+\_\+string} & optional f\+\_\+string to append to filename\\
347\hline
348\mbox{\tt in}  & {\em filename} & optional output filename \\
349\hline
350\end{DoxyParams}
351
352
353Definition at line 877 of file mod\+\_\+oasis\+\_\+io.\+F90.
354
355\mbox{\Hypertarget{namespacemod__oasis__io_ad8a48d6c36e3fac637a8191c20e514f2}\label{namespacemod__oasis__io_ad8a48d6c36e3fac637a8191c20e514f2}} 
356\index{mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}!oasis\+\_\+io\+\_\+write\+\_\+avfile@{oasis\+\_\+io\+\_\+write\+\_\+avfile}}
357\index{oasis\+\_\+io\+\_\+write\+\_\+avfile@{oasis\+\_\+io\+\_\+write\+\_\+avfile}!mod\+\_\+oasis\+\_\+io@{mod\+\_\+oasis\+\_\+io}}
358\subsubsection{\texorpdfstring{oasis\+\_\+io\+\_\+write\+\_\+avfile()}{oasis\_io\_write\_avfile()}}
359{\footnotesize\ttfamily subroutine, public mod\+\_\+oasis\+\_\+io\+::oasis\+\_\+io\+\_\+write\+\_\+avfile (\begin{DoxyParamCaption}\item[{character(len=$\ast$), intent(in)}]{rstfile,  }\item[{type(mct\+\_\+avect), intent(in)}]{av,  }\item[{type(mct\+\_\+gsmap), intent(in)}]{gsmap,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{mpicom,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{nx,  }\item[{integer(ip\+\_\+i4\+\_\+p), intent(in)}]{ny,  }\item[{character(len=$\ast$), intent(in), optional}]{nampre }\end{DoxyParamCaption})}
360
361
362
363Writes all fields from an attribute vector to a file.
364
365
366\begin{DoxyParams}[1]{Parameters}
367\mbox{\tt in}  & {\em rstfile} & filename\\
368\hline
369\mbox{\tt in}  & {\em av} & avect\\
370\hline
371\mbox{\tt in}  & {\em gsmap} & gsmap decomp\\
372\hline
373\mbox{\tt in}  & {\em mpicom} & mpi comm\\
374\hline
375\mbox{\tt in}  & {\em nx} & 2d global nx size\\
376\hline
377\mbox{\tt in}  & {\em ny} & 2d global ny size\\
378\hline
379\mbox{\tt in}  & {\em nampre} & field name prepend string on file \\
380\hline
381\end{DoxyParams}
382
383
384Definition at line 230 of file mod\+\_\+oasis\+\_\+io.\+F90.
385
Note: See TracBrowser for help on using the repository browser.