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

root/gliderproc/trunk/MATLAB/opnml/html/4.IO_Functions/read_s2r.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_s2r</H1>
6 <H2>(./IO_Functions/read_s2r.m)</H2>
7 <HR><H3>Function Synopsis</H3>
8 <pre>[data,gridname]=read_s2r(fname)</pre>
9 <HR><H3>Help text</H3>
10 <pre>
11 READ_S2R read a FEM output file of <A HREF = "../4.IO_Functions/s2r.html">s2r</A> filetype.
12    READ_S2R 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_S2R reads the FEM filetype <A HREF = "../4.IO_Functions/s2r.html">s2r</A>, 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 two
23    columns, the first of which is the node number.  The
24    second column is floating point. 
25
26    Input :   If fname is omitted, READ_S2R enables a file browser
27              with which the user can specify the .<A HREF = "../4.IO_Functions/s2r.html">s2r</A> file.
28
29              Otherwise, fname is the name of the <A HREF = "../4.IO_Functions/s2r.html">s2r</A> file, relative
30              or absolute (fullpath), including the suffix '<A HREF = "../4.IO_Functions/s2r.html">s2r</A>'.
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              The domain name is returned in gname
36
37              Call READ_S2R as:
38              &gt;&gt; [data,gname]=read_s2r(fname);
39
40              If READ_S2R cannot locate the file, it exits, returning
41              a -1 instead of the data matrix.
42
43  Call as: &gt;&gt; [data,gname]=read_s2r(fname);
44
45  Written by : Brian O. Blanton
46
47 </pre>
48 <HR>
49 Produced by <A HREF="http://www.nd.edu/Courses/kantor/matlab/mat2html">mat2html</A> on Tue Feb  2 16:15:45 EST 1999
50 <BR>
51 Cross-Directory links are: OFF<BR>
52 </BODY>
Note: See TracBrowser for help on using the browser.