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

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