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

root/gliderproc/trunk/MATLAB/opnml/html/4.IO_Functions/read_vel.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_vel</H1>
6 <H2>(./IO_Functions/read_vel.m)</H2>
7 <HR><H3>Function Synopsis</H3>
8 <pre>[data,nnv,freq,gridname]=read_vel(fname);</pre>
9 <HR><H3>Help text</H3>
10 <pre>
11 READ_VEL read a FEM output file of .vel filetype.
12    READ_VEL 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_VEL reads the FEM filetype .vel, as detailed in
19    &quot;Data File Standards for the Gulf of Maine Project&quot;
20    from the Numerical Methods Laboratory at Dartmouth
21    College.  (This document is located in the OPNML
22    notebook under External Documents.)  There are eight
23    columns, the first of which is the node number.  The
24    remaining columns are floating point. 
25
26    Input :   If fname is omitted, READ_VEL enables a file browser
27              with which the user can specify the .vel file.
28
29              Otherwise, fname is the name of the .vel file, relative
30              or absolute (fullpath), including the suffix '.vel'.
31              This input is a string so it must be enclosed in single
32              quotes. The header lines are discarded.
33
34   Output :   The data part is returned in the variable data. 
35              There are eight columns, the first of which is the node
36              number.  The remaining columns are floating point.
37              The number of vertical nodes is returned in nnv, and
38              the frequency is returned in freq.
39
40              Call READ_VEL as:
41              &gt;&gt; [data,nnv,freq]=read_vel(fname);
42
43              If READ_VEL cannot locate the file, it exits, returning
44              a -1 instead of the data matrix.
45
46    NOTES :   The .vel filetype contains 3-D data; i.e., complex-valued
47              velocity data at each vertical node per horizontal node.
48              The .vel file has phase in radians while the related .<A HREF = "../4.IO_Functions/v3c.html">v3c</A>
49              format has phase in degrees.
50
51  Call as: [data,nnv,freq,gridname]=read_vel(fname);
52
53  Written by : Brian O. Blanton
54
55 </pre>
56 <HR>
57 Produced by <A HREF="http://www.nd.edu/Courses/kantor/matlab/mat2html">mat2html</A> on Tue Feb  2 16:15:45 EST 1999
58 <BR>
59 Cross-Directory links are: OFF<BR>
60 </BODY>
Note: See TracBrowser for help on using the browser.