read_v3r

(./IO_Functions/read_v3r.m)

Function Synopsis

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

Help text

READ_V3R read a FEM output file of .v3r filetype.
   READ_V3R 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_V3R reads the FEM filetype .v3r, as 
   detailed in "Data File Standards for the Gulf of Maine
   Project" from the Numerical Methods Laboratory at 
   Dartmouth College.  There are five
   columns, the first of which is the node number.  The
   remaining columns are floating point.  The filetype 
   suffix ('.v3r') must be included in the input file name. 

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

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

  Output :   Call READ_V3R as:
             >> [data,nnv,gname]=read_v3r(fname);
             The domain name will be returned in "gname".
             The number of vertical nodes is returned in "nnv".
             The node counter, depth and amplitudes  of the u,
             v, and w components of the vector field are returned 
             in "data".

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

   NOTES :   The v3r filetype contains 3-D data; i.e., real-valued
             velocity data at each vertical node per horizontal node.
             
 Call as: [data,nnv,gname]=read_v3r(fname);

 Written by : Brian O. Blanton