Fortran: Module Interface Mean Flow (Source File: meanflow.F90)

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
 #ifdef _PRINTSTATE_
    public print_state_meanflow
 #endif

PUBLIC DATA MEMBERS:

    logical, public                              :: grid_ready
    logical, public                              :: init_buoyancy
 
    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
    REALTYPE, public                    :: z0s_min
    logical,  public                    :: charnock
    REALTYPE, public                    :: charnock_val
    REALTYPE, public                    :: ddu
    REALTYPE, public                    :: ddl
    integer,  public                    :: grid_method
    REALTYPE, public                    :: c1ad
    REALTYPE, public                    :: c2ad
    REALTYPE, public                    :: c3ad
    REALTYPE, public                    :: c4ad
    REALTYPE, public                    :: Tgrid
    REALTYPE, public                    :: NNnorm
    REALTYPE, public                    :: SSnorm
    REALTYPE, public                    :: dsurf
    REALTYPE, public                    :: dtgrid
    character(LEN=PATH_MAX), public     :: grid_file
    REALTYPE, public                    :: gravity
    REALTYPE, public                    :: rho_0
    REALTYPE, public                    :: cp
    REALTYPE, public                    :: avmolu
    REALTYPE, public                    :: avmolT
    REALTYPE, public                    :: avmolS
    integer,  public                    :: MaxItz0b
    logical,  public                    :: no_shear
 
    the roughness lengths
    REALTYPE, public                    :: z0b,z0s,za
 
    the coriolis parameter
    REALTYPE, public                    :: cori
 
    the friction velocities
    REALTYPE, public                    :: u_taub,u_taus
 
    bottom stress
    REALTYPE, public                    :: taub
 
    other stuff
    REALTYPE, public                    :: depth0
    REALTYPE, public                    :: depth
    REALTYPE, public                    :: runtimeu, runtimev

DEFINED PARAMETERS:

    REALTYPE, public, parameter         :: pi=3.141592654

REVISION HISTORY:

    Original author(s): Karsten Bolding & Hans Burchard
    $Log: meanflow.F90,v $
    Revision 1.17  2010-09-17 12:53:48  jorn
    extensive code clean-up to ensure proper initialization and clean-up of all variables
    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