NCCOOS Trac Projects: Top | Web | Platforms | Processing | Viz | Sprints | Sandbox | (Wind)

root/gliderproc/trunk/MATLAB/opnml/html/4.IO_Functions/read_v3r.html

Revision 495 (checked in by cbc, 11 years ago)

Initial import of Stark code.

Line 
1 <TITLE>/</TITLE>
2 <BODY>
3 <A HREF = "index.html">[Index for ./IO_Functions]</A>
4 <A HREF = "../index.html">[Return to Master Index]</A>
5 <H1>read_v3r</H1>
6 <H2>(./IO_Functions/read_v3r.m)</H2>
7 <HR><H3>Function Synopsis</H3>
8 <pre>[data,nnv,gname]=read_v3r(fname)</pre>
9 <HR><H3>Help text</H3>
10 <pre>
11 READ_V3R read a FEM output file of .<A HREF = "../4.IO_Functions/v3r.html">v3r</A> filetype.
12    READ_V3R is part of a suite of OPNML I/O functions 
13    to read specific filetypes pertaining to FEM model 
14    input and output.   These functions allow the user to
15    get these data files into MATLAB without copying the
16    files and removing the header info by hand.
17
18    READ_V3R reads the FEM filetype .<A HREF = "../4.IO_Functions/v3r.html">v3r</A>, as
19    detailed in &quot;Data File Standards for the Gulf of Maine
20    Project&quot; from the Numerical Methods Laboratory at
21    Dartmouth College.  There are five
22    columns, the first of which is the node number.  The
23    remaining columns are floating point.  The filetype
24    suffix ('.<A HREF = "../4.IO_Functions/v3r.html">v3r</A>') must be included in the input file name.
25
26    Input :   If fname is omitted, READ_V3R enables a file browser
27              with which the user can specify the .<A HREF = "../4.IO_Functions/v3r.html">v3r</A> file.
28
29              Otherwise, fname is the name of the file, relative or
30              absolute (fullpath), including the suffix '.<A HREF = "../4.IO_Functions/v3r.html">v3r</A>'.
31              This input is a string so it must be enclosed in single
32              quotes. The comment line is discarded.
33
34   Output :   Call READ_V3R as:
35              &gt;&gt; [data,nnv,gname]=read_v3r(fname);
36              The domain name will be returned in &quot;gname&quot;.
37              The number of vertical nodes is returned in &quot;nnv&quot;.
38              The node counter, depth and amplitudes  of the u,
39              v, and w components of the vector field are returned
40              in &quot;data&quot;.
41
42              If READ_V3R cannot locate the file, it exits, returning
43              a -1 instead of the data matrix.
44
45    NOTES :   The <A HREF = "../4.IO_Functions/v3r.html">v3r</A> filetype contains 3-D data; i.e., real-valued
46              velocity data at each vertical node per horizontal node.
47              
48  Call as: [data,nnv,gname]=read_v3r(fname);
49
50  Written by : Brian O. Blanton
51
52 </pre>
53 <HR>
54 Produced by <A HREF="http://www.nd.edu/Courses/kantor/matlab/mat2html">mat2html</A> on Tue Feb  2 16:15:45 EST 1999
55 <BR>
56 Cross-Directory links are: OFF<BR>
57 </BODY>
Note: See TracBrowser for help on using the browser.