Module Mean Flow

INTERFACE:

   module meanflow

DESCRIPTION:

This module provides all variables necessary for the meanflow calculation and also makes the proper initialisations.

USES:

   IMPLICIT NONE
   Default all is private.
   private

PUBLIC MEMBER FUNCTIONS:

   public init_meanflow, clean_meanflow

PUBLIC DATA MEMBERS:

   logical, public                              :: grid_ready=.false.
 
   coordinate z, layer thicknesses
   REALTYPE, public, dimension(:), allocatable  :: ga,z,h,ho
 
   the velocity components
   REALTYPE, public, dimension(:), allocatable  :: u,v,w
 
   velocity at old time step
   REALTYPE, public, dimension(:), allocatable  :: uo,vo
 
   potential temperature, salinity
   REALTYPE, public, dimension(:), allocatable  :: T,S,rho
 
   boyancy frequency squared
   (total, from temperature only, from salinity only)
   REALTYPE, public, dimension(:), allocatable  :: NN,NNT,NNS
 
   shear-frequency squared
   (total, from u only, from v only)
   REALTYPE, public, dimension(:), allocatable  :: SS,SSU,SSV
 
   buoyancy, short-wave radiation,
   extra production of tke by see-grass etc
   REALTYPE, public, dimension(:), allocatable  :: buoy,rad,xP
 
   a dummy array
   (most often used for diffusivities)
   REALTYPE, public, dimension(:), allocatable  :: avh
 
   grid-related vertical velocity
   REALTYPE, public, dimension(:), allocatable  :: w_grid
 
   extra friction terms due to e.g. seagrass
   REALTYPE, public, dimension(:), allocatable  :: fric,drag
 
   shading in the water column
   REALTYPE, public, dimension(:), allocatable  :: bioshade
 
  ifdef EXTRA_OUTPUT
 
   dummies for testing
   REALTYPE, public, dimension(:), allocatable   :: mean1,mean2,mean3,mean4,mean5
 
  endif
 
   the 'meanflow' namelist
   REALTYPE, public                    :: h0b=0.05
   REALTYPE, public                    :: z0s_min=0.02
   logical,  public                    :: charnock=.false.
   REALTYPE, public                    :: charnock_val=1400.
   REALTYPE, public                    :: ddu=0.
   REALTYPE, public                    :: ddl=0.
   integer,  public                    :: grid_method=1
   REALTYPE, public                    :: c1ad=0.8
   REALTYPE, public                    :: c2ad=0.0
   REALTYPE, public                    :: c3ad=0.1
   REALTYPE, public                    :: c4ad=0.1
   REALTYPE, public                    :: Tgrid=3600.
   REALTYPE, public                    :: NNnorm=0.2
   REALTYPE, public                    :: SSnorm=0.2
   REALTYPE, public                    :: dsurf=10.0
   REALTYPE, public                    :: dtgrid=5.
   character(LEN=PATH_MAX), public     :: grid_file='grid.dat'
   REALTYPE, public                    :: gravity=9.81
   REALTYPE, public                    :: rho_0=1027.
   REALTYPE, public                    :: cp=3985.
   REALTYPE, public                    :: avmolu=1.3e-6
   REALTYPE, public                    :: avmolT=1.4e-7
   REALTYPE, public                    :: avmolS=1.1e-9
   integer,  public                    :: MaxItz0b=10
   logical,  public                    :: no_shear=.false.
 
   the roughness lengths
   REALTYPE, public                    :: z0b,z0s,za
 
   the coriolis parameter
   REALTYPE, public                    :: cori
 
   the friction velocities
   REALTYPE, public                    :: u_taub,u_taus
 
   other stuff
   integer,  public                    :: eq_state_method
   REALTYPE, public                    :: depth0=0.
   REALTYPE, public                    :: depth
   REALTYPE, public                    :: obs_heat_content=0.
   REALTYPE, public                    :: calc_heat_content=0.

DEFINED PARAMETERS:

   REALTYPE, public, parameter         :: pi=3.141592654

REVISION HISTORY:

   Original author(s): Karsten Bolding & Hans Burchard
   $Log: meanflow.F90,v $
   Revision 1.16  2007-01-03 21:45:20  hb
   LaTeX bug fix in documentation
   Revision 1.15  2006-11-27 15:26:37  kbk
   initialise grid depending on grid_ready
   Revision 1.14  2006-11-27 08:44:33  kbk
   de-allocate ga
   Revision 1.13  2006-11-24 15:13:41  kbk
   de-allocate memory and close open files
   Revision 1.12  2006-11-20 17:26:15  kbk
   [Cc]harnok -> [Cc]harnock - A. Jenkins
   Revision 1.11  2005/06/27 13:44:07  kbk
   modified + removed traling blanks
   Revision 1.10  2004/01/27 08:33:20  lars
   omega-value bug fix
   Revision 1.9  2004/01/12 15:21:09  lars
   added za for sediment-induced bottom roughness
   Revision 1.8  2003/07/23 12:33:21  hb
   fixed bioshade init and use
   Revision 1.6  2003/04/05 07:01:16  kbk
   moved bioshade variable to meanflow - to compile properly
   Revision 1.5  2003/03/28 09:20:35  kbk
   added new copyright to files
   Revision 1.4  2003/03/28 08:15:01  kbk
   removed tabs
   Revision 1.3  2003/03/10 08:50:06  gotm
   Improved documentation and cleaned up code
   Revision 1.2  2001/11/18 15:58:02  gotm
   Vertical grid can now be read from file
   Revision 1.1.1.1  2001/02/12 15:55:57  gotm
   initial import into CVS