read_vel

(./IO_Functions/read_vel.m)

Function Synopsis

[data,nnv,freq,gridname]=read_vel(fname);

Help text

READ_VEL read a FEM output file of .vel filetype.
   READ_VEL 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_VEL reads the FEM filetype .vel, 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 eight
   columns, the first of which is the node number.  The
   remaining columns are floating point.  

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

             Otherwise, fname is the name of the .vel file, relative 
             or absolute (fullpath), including the suffix '.vel'.
             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.  
             There are eight columns, the first of which is the node 
             number.  The remaining columns are floating point.
             The number of vertical nodes is returned in nnv, and
             the frequency is returned in freq. 

             Call READ_VEL as:
             >> [data,nnv,freq]=read_vel(fname);

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

   NOTES :   The .vel filetype contains 3-D data; i.e., complex-valued
             velocity data at each vertical node per horizontal node.
             The .vel file has phase in radians while the related .v3c 
             format has phase in degrees.

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

 Written by : Brian O. Blanton