Home > fvcom_prepro > set_elevtide.m

set_elevtide

PURPOSE ^

Setup surface elevation tides on the open boundary and dump an

SYNOPSIS ^

function set_elevtide(Mobj,JulianTime,SurfaceElevation,ElevationFile,MyTitle)

DESCRIPTION ^

 Setup surface elevation tides on the open boundary and dump an
 elevation time series file.

 function set_elevtide(Mobj,JulianTime,SurfaceElevation,ElevationFile,MyTitle)

 DESCRIPTION:
    Setup surface elevation tides on the open boundary and dump a NetCDF
    file.

 INPUT
    Mobj          = Matlab mesh object
    JulianTime    = Array of time steps in Julian Time (NOT Modified
    Julian Time)
    ElevationFile = Output file name
    MyTitle       = Title in resulting NetCDF file.

 OUTPUT:

 EXAMPLE USAGE
    set_elevtide(Mobj,JulianTime,SurfaceElevation,ElevationFile,MyTitle)

 Author(s):
    Pierre Cazenave (Plymouth Marine Laboratory)

 Revision history
    2012-08-08 First version.

==============================================================================

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function set_elevtide(Mobj,JulianTime,SurfaceElevation,ElevationFile,MyTitle)
0002 
0003 % Setup surface elevation tides on the open boundary and dump an
0004 % elevation time series file.
0005 %
0006 % function set_elevtide(Mobj,JulianTime,SurfaceElevation,ElevationFile,MyTitle)
0007 %
0008 % DESCRIPTION:
0009 %    Setup surface elevation tides on the open boundary and dump a NetCDF
0010 %    file.
0011 %
0012 % INPUT
0013 %    Mobj          = Matlab mesh object
0014 %    JulianTime    = Array of time steps in Julian Time (NOT Modified
0015 %    Julian Time)
0016 %    ElevationFile = Output file name
0017 %    MyTitle       = Title in resulting NetCDF file.
0018 %
0019 % OUTPUT:
0020 %
0021 % EXAMPLE USAGE
0022 %    set_elevtide(Mobj,JulianTime,SurfaceElevation,ElevationFile,MyTitle)
0023 %
0024 % Author(s):
0025 %    Pierre Cazenave (Plymouth Marine Laboratory)
0026 %
0027 % Revision history
0028 %    2012-08-08 First version.
0029 %
0030 %==============================================================================
0031 subname = 'set_spectide';
0032 global ftbverbose;
0033 if(ftbverbose);
0034   fprintf('\n')
0035   fprintf(['begin : ' subname '\n'])
0036 end;
0037 
0038 cnt = 0;
0039 ObcNodes = nan(1,sum(Mobj.nObcNodes));
0040 for ob=1:Mobj.nObs
0041     nObcs = Mobj.nObcNodes(ob);
0042     for j=1:nObcs
0043         cnt = cnt + 1;
0044         ObcNodes(cnt) = Mobj.obc_nodes(ob,j);  % set the open boundary nodes
0045     end
0046 end
0047 
0048 %------------------------------------------------------------------------------
0049 % Dump a surface elevation tide file in NetCDF
0050 %------------------------------------------------------------------------------
0051 write_FVCOM_elevtide(ObcNodes,JulianTime,SurfaceElevation,ElevationFile,MyTitle)
0052 
0053 if(ftbverbose); fprintf(['end   : ' subname '\n']); end

Generated on Wed 20-Feb-2019 16:06:01 by m2html © 2005