Home > utilities > ST_summary.m

ST_summary

PURPOSE ^

Print summary for stats of particle diameter d (m)

SYNOPSIS ^

function [] = ST_summary(d,varargin)

DESCRIPTION ^

 Print summary for stats of particle diameter d (m) 

 function [] = ST_summary(d,varargin)

 DESCRIPTION:
 Calculate settling velocity of particle diameter d (m) in m/s 

 INPUT:
    d: sediment grain size in m
    [optional] 'temperature' = temperature of the seawater in C [default=10]
    [optional] 'salinity'    = salinity of seawater in PSU      [default=35]
    [optional] 'sdens'       = sediment density in kg/m^3       [default=2650]

 OUTPUT:
      

 EXAMPLE USAGE
    ST_summary(.0005,'temperature',10,'salinity',35,'sdens',2650) 

 Author(s):  
    Geoff Cowles (University of Massachusetts Dartmouth)

 References
   

 Revision history
   
==============================================================================

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function [] = ST_summary(d,varargin)
0002 % Print summary for stats of particle diameter d (m)
0003 %
0004 % function [] = ST_summary(d,varargin)
0005 %
0006 % DESCRIPTION:
0007 % Calculate settling velocity of particle diameter d (m) in m/s
0008 %
0009 % INPUT:
0010 %    d: sediment grain size in m
0011 %    [optional] 'temperature' = temperature of the seawater in C [default=10]
0012 %    [optional] 'salinity'    = salinity of seawater in PSU      [default=35]
0013 %    [optional] 'sdens'       = sediment density in kg/m^3       [default=2650]
0014 %
0015 % OUTPUT:
0016 %
0017 %
0018 % EXAMPLE USAGE
0019 %    ST_summary(.0005,'temperature',10,'salinity',35,'sdens',2650)
0020 %
0021 % Author(s):
0022 %    Geoff Cowles (University of Massachusetts Dartmouth)
0023 %
0024 % References
0025 %
0026 %
0027 % Revision history
0028 %
0029 %==============================================================================
0030 
0031 subname = 'ST_summary';  
0032 %fprintf('\n')
0033 %fprintf(['begin : ' subname '\n'])
0034 
0035 % constants
0036 grav  = 9.8106;   %g
0037 T     = 10;       %T (C)
0038 S     = 35;       %S (PSU)
0039 sdens = 2650;     %sediment density in kg/m^3
0040 
0041 % parse arguments
0042 for i=1:2:length(varargin)-1
0043         keyword  = lower(varargin{i});
0044         if( ~ischar(keyword) )
0045                 error('incorrect usage of ST_wset')
0046         end;
0047 
0048         switch(keyword(1:3))
0049 
0050         case 'tem'
0051              T = varargin{i+1};
0052         case 'sal'
0053              S = varargin{i+1};
0054         case 'sde'
0055              sdens = varargin{i+1}; 
0056         otherwise
0057                 error(['Can''t understand value for:' keyword]);
0058         end; %switch keyword
0059 end;
0060 
0061 fprintf('       phi          class       d(mm)    Dstar    wset(mm/s)  taucr (Pa)  erate x1e-3(kg/(m^2-s))\n')
0062 
0063 phi         = ST_d2phi(d);
0064 phiclass    = ST_wentworth(phi);
0065 Dstar       = ST_Dstar(d);
0066 Wset        = ST_wset(d);
0067 Taucr       = ST_taucr(d);
0068 erate       = ST_erate(d);
0069 fprintf('%10d %20s %8.4f %8.2f %9.4f %8.3f %8.3f\n',phi,phiclass,d*1000,Dstar,Wset*1000,Taucr,1000*erate)
0070 
0071

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