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

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

Revision 495 (checked in by cbc, 12 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_s3r</H1>
6 <H2>(./IO_Functions/read_s3r.m)</H2>
7 <HR><H3>Function Synopsis</H3>
8 <pre>[data,nnv,gname]=read_s3r(fname)</pre>
9 <HR><H3>Help text</H3>
10 <pre>
11 READ_S3R read a FEM output file of .<A HREF = "../4.IO_Functions/s3r.html">s3r</A> filetype.
12    READ_S3R 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_S3R reads the ascii filetypes .<A HREF = "../4.IO_Functions/s3r.html">s3r</A>,
19    as detailed in &quot;Data File Standards for the Gulf of Maine
20    Project&quot; from the Numerical Methods Laboratory at Dartmouth
21    College.  (This document is located in the OPNML notebook
22    under External Documents.)  There are three columns, the
23    first of which is the node number.  The second and third 
24    columns are floating point numbers.  The filetype suffix
25    ('.<A HREF = "../4.IO_Functions/s3r.html">s3r</A>') must be included in the input file name.   
26
27    Input :   If fname is omitted, READ_S3R enables a file browser
28              with which the user can specify the .<A HREF = "../4.IO_Functions/s3r.html">s3r</A> file.
29
30              Otherwise, fname is the name of the file, relative or
31              absolute (fullpath), including the '.<A HREF = "../4.IO_Functions/s3r.html">s3r</A>' suffix;
32              This input is a string so it must be enclosed in
33              single quotes. The comment line is discarded.
34
35   Output :   Call READ_S3R as:
36              &gt;&gt; [data,nnv,gname]=read_s3r(fname);
37              The domain name will be returned in &quot;gname&quot;.
38              The number of vertical nodes is returned in &quot;nnv&quot;.
39              The node counter, depth and value of the scalar field
40              are returned in &quot;data&quot;.
41
42              If READ_S3R cannot locate the file, it exits, returning
43              a -1 instead of the data matrix.
44
45    NOTES :   The .<A HREF = "../4.IO_Functions/s3r.html">s3r</A> filetype contains 3-D data; i.e., real-valued
46              scalar data at each vertical node per horizontal node.
47
48  Call as: [data,nnv,gname]=read_s3r(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.