pkg/pp81/PP81.h

08be60903a Mart*0001 #ifdef ALLOW_PP81
                0002
                0003 CBOP
                0004 C !ROUTINE: PP81.h
                0005
                0006 C !DESCRIPTION: \bv
016b84c482 Mart*0007 C     *==========================================================*
08be60903a Mart*0008 C     | PP81.h                                                   |
                0009 C     | o Basic header for Pacanowski and Philander (1981)       |
                0010 C     |   vertical mixing parameterization.                      |
                0011 C     |   Contains all PP81 field declarations.                  |
016b84c482 Mart*0012 C     *==========================================================*
08be60903a Mart*0013
                0014 C-----------------------------------------------------------------------
                0015 C
                0016 C Constants that can be set in data.pp
                0017 C     PPnRi - exponent of denominator of Eq(1) in PP81
                0018 C     PPviscMin, PPdiffMin   - minimum viscosity/diffusivity in
                0019 C                              surface layer.
                0020 C                              Only used if ALLOW_PP81MOD is defined
                0021 C     PPviscMax              - maximum allowed viscosity
016b84c482 Mart*0022 C     PPnu0, PPalpha         - further parameters
                0023 C     RiLimit                - minimum Richardson number,
08be60903a Mart*0024 C                              follows from PPviscMax
016b84c482 Mart*0025 C     PPdumpFreq             - analogue to dumpFreq (=default)
08be60903a Mart*0026 C     PPmixingMaps - if true, include PP diagnostic maps in STDOUT
                0027 C     PPwriteState - if true, write PP state to file
                0028 C
                0029 C Time varying parameters computed by subroutine pp_calc
                0030 C     PPviscAr - Vertical eddy viscosity coefficient         (m^2/s)
016b84c482 Mart*0031 C     PPdiffKr - Vertical diffusion coefficient for heat,
08be60903a Mart*0032 C                salt and tracers                            (m^2/s)
                0033 C
                0034 C-----------------------------------------------------------------------
                0035 C \ev
                0036 CEOP
                0037
                0038       INTEGER PPnRi
016b84c482 Mart*0039       COMMON /PP81_PARMS_I/
08be60903a Mart*0040      &     PPnRi
                0041       _RL    PPviscMin, PPdiffMin, PPviscMax
                0042       _RL    PPnu0, PPalpha, RiLimit
016b84c482 Mart*0043       _RL    PPdumpFreq
                0044       COMMON /PP81_PARMS_R/
                0045      &     PPviscMin, PPdiffMin, PPviscMax,
08be60903a Mart*0046      &     PPnu0, PPalpha, RiLimit,
016b84c482 Mart*0047      &     PPdumpFreq
08be60903a Mart*0048
                0049       _RL PPviscAr (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
                0050       _RL PPdiffKr (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
                0051       COMMON /PP_FIELDS/ PPviscAr, PPdiffKr
                0052
                0053       LOGICAL PP81isOn, PPmixingMaps, PPwriteState
                0054       COMMON /PP81_PARMS_L/
                0055      &     PP81isOn, PPmixingMaps, PPwriteState
                0056
                0057 #endif /* ALLOW_PP81 */