read_s3c

(./IO_Functions/read_s3c.m)

Function Synopsis

[data,freq,nnv]=read_s3c(fname)

Help text

READ_S3C read a FEM output file of s3c filetype.

 [data,freq,nnv]=read_s3c(fname)

             READ_S3C is part of a suite of OPNML I/O functions  
             to read specific filetypes pertaining to FEM model  
             input and output.   These functions allow the user to
             get these data files into MATLAB without copying the
             files and removing the header info by hand.

             READ_S3C reads the FEM filetype s3c, as 
             detailed in "Data File Standards for the Gulf of Maine
             Project" from the Numerical Methods Laboratory at 
             Dartmouth College.  (This document is located in the OPNML
             notebook under External Documents.)  There are four
             columns, the first of which is the node number.  The
             remaining columns are floating point.  

   Input :   If fname is omitted, READ_S3C enables a file browser
             with which the user can specify the .s3c file.

             Otherwise, fname is the name of the s3c file, relative 
             or absolute (fullpath), including the suffix 's3c'.
             This input is a string so it must be enclosed in single 
             quotes. The header lines are discarded.
  Output :   The data part is returned in the variable data. 

             Call READ_S3C as:
             >> [data,freq,nnv]=read_s3c(fname);
             s3c filetypes contain both the frequency and the number 
             of vertical nodes as header info, which will be returned 
             to the user.

             If READ_S3C cannot locate the file, it exits, returning 
             a -1 instead of the data matrix.
             
   NOTES :   The .s3c filetype contains 3-D data; i.e., complex-valued
             scalar data at each vertical node per horizontal node.

 Call as: [data,freq,nnv]=read_s3c(fname);

 Written by : Brian O. Blanton