read_s3r

(./IO_Functions/read_s3r.m)

Function Synopsis

[data,nnv,gname]=read_s3r(fname)

Help text

READ_S3R read a FEM output file of .s3r filetype.
   READ_S3R 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_S3R reads the ascii filetypes .s3r,
   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 three columns, the 
   first of which is the node number.  The second and third  
   columns are floating point numbers.  The filetype suffix
   ('.s3r') must be included in the input file name.    

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

             Otherwise, fname is the name of the file, relative or 
             absolute (fullpath), including the '.s3r' suffix; 
             This input is a string so it must be enclosed in 
             single quotes. The comment line is discarded.

  Output :   Call READ_S3R as:
             >> [data,nnv,gname]=read_s3r(fname);
             The domain name will be returned in "gname".
             The number of vertical nodes is returned in "nnv".
             The node counter, depth and value of the scalar field
             are returned in "data".

             If READ_S3R cannot locate the file, it exits, returning 
             a -1 instead of the data matrix.

   NOTES :   The .s3r filetype contains 3-D data; i.e., real-valued
             scalar data at each vertical node per horizontal node.

 Call as: [data,nnv,gname]=read_s3r(fname);

 Written by : Brian O. Blanton