1 |
C $Header: /u/gcmpack/MITgcm/pkg/kpp/kpp_diagnostics_init.F,v 1.8 2010/04/02 19:27:14 jmc Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#include "KPP_OPTIONS.h" |
5 |
|
6 |
CBOP |
7 |
C !ROUTINE: KPP_DIAGNOSTICS_INIT |
8 |
C !INTERFACE: |
9 |
SUBROUTINE KPP_DIAGNOSTICS_INIT( myThid ) |
10 |
|
11 |
C !DESCRIPTION: \bv |
12 |
C *==========================================================* |
13 |
C | SUBROUTINE KPP_DIAGNOSTICS_INIT |
14 |
C | o Routine to initialize list of all available diagnostics |
15 |
C | for KPP package |
16 |
C *==========================================================* |
17 |
C \ev |
18 |
C !USES: |
19 |
IMPLICIT NONE |
20 |
|
21 |
C === Global variables === |
22 |
#include "EEPARAMS.h" |
23 |
#include "SIZE.h" |
24 |
#ifdef ALLOW_GENERIC_ADVDIFF |
25 |
# include "GAD.h" |
26 |
#endif |
27 |
|
28 |
C !INPUT/OUTPUT PARAMETERS: |
29 |
C === Routine arguments === |
30 |
C myThid :: my Thread Id number |
31 |
INTEGER myThid |
32 |
CEOP |
33 |
|
34 |
#ifdef ALLOW_DIAGNOSTICS |
35 |
C !LOCAL VARIABLES: |
36 |
C === Local variables === |
37 |
C diagNum :: diagnostics number in the (long) list of available diag. |
38 |
C diagMate :: diag. mate number in the (long) list of available diag. |
39 |
C diagName :: local short name (8c) of a diagnostics |
40 |
C diagCode :: local parser field with characteristics of the diagnostics |
41 |
C cf head of S/R DIAGNOSTICS_INIT_EARLY or DIAGNOSTICS_MAIN_INIT |
42 |
C diagUnits :: local string (16c): physical units of a diagnostic field |
43 |
C diagTitle :: local string (80c): description of field in diagnostic |
44 |
INTEGER diagNum |
45 |
c INTEGER diagMate |
46 |
CHARACTER*4 diagSufx |
47 |
CHARACTER*8 diagName |
48 |
CHARACTER*16 diagCode |
49 |
CHARACTER*16 diagUnits |
50 |
CHARACTER*(80) diagTitle |
51 |
#ifdef ALLOW_GENERIC_ADVDIFF |
52 |
CHARACTER*4 GAD_DIAG_SUFX |
53 |
EXTERNAL GAD_DIAG_SUFX |
54 |
#endif |
55 |
|
56 |
|
57 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
58 |
|
59 |
diagName = 'KPPviscA' |
60 |
diagTitle = 'KPP vertical eddy viscosity coefficient' |
61 |
diagUnits = 'm^2/s ' |
62 |
diagCode = 'SM P LR ' |
63 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
64 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
65 |
|
66 |
diagName = 'KPPdiffS' |
67 |
diagTitle = 'Vertical diffusion coefficient for salt & tracers' |
68 |
diagUnits = 'm^2/s ' |
69 |
diagCode = 'SM P LR ' |
70 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
71 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
72 |
|
73 |
diagName = 'KPPdiffT' |
74 |
diagTitle = 'Vertical diffusion coefficient for heat' |
75 |
diagUnits = 'm^2/s ' |
76 |
diagCode = 'SM P LR ' |
77 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
78 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
79 |
|
80 |
diagName = 'KPPghatK' |
81 |
diagTitle = 'ratio of KPP non-local (salt) flux' |
82 |
& //' relative to surface-flux' |
83 |
diagUnits = '0-1 ' |
84 |
diagCode = 'SM P LR ' |
85 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
86 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
87 |
|
88 |
diagName = 'KPPhbl ' |
89 |
diagTitle = 'KPP boundary layer depth, bulk Ri criterion' |
90 |
diagUnits = 'm ' |
91 |
diagCode = 'SM P 1 ' |
92 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
93 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
94 |
|
95 |
diagName = 'KPPfrac ' |
96 |
diagTitle = 'Short-wave flux fraction penetrating mixing layer' |
97 |
diagUnits = ' ' |
98 |
diagCode = 'SM P 1 ' |
99 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
100 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
101 |
|
102 |
diagName = 'KPPdbsfc' |
103 |
diagTitle = 'Buoyancy difference with respect to surface' |
104 |
diagUnits = 'm/s^2 ' |
105 |
diagCode = 'SM P UR ' |
106 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
107 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
108 |
|
109 |
diagName = 'KPPbfsfc' |
110 |
diagTitle = 'Bo+radiation absorbed to d=hbf*hbl + plume' |
111 |
diagUnits = 'm^2/s^3 ' |
112 |
diagCode = 'SM P UR ' |
113 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
114 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
115 |
|
116 |
diagName = 'KPPRi ' |
117 |
diagTitle = 'Bulk Richardson number' |
118 |
diagUnits = 'non-dimensional ' |
119 |
diagCode = 'SM P UR ' |
120 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
121 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
122 |
|
123 |
diagName = 'KPPbo ' |
124 |
diagTitle = 'Surface turbulent buoyancy forcing' |
125 |
diagUnits = 'm^2/s^3 ' |
126 |
diagCode = 'SM P 1 ' |
127 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
128 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
129 |
|
130 |
diagName = 'KPPbosol' |
131 |
diagTitle = 'surface radiative buoyancy forcing' |
132 |
diagUnits = 'm^2/s^3 ' |
133 |
diagCode = 'SM P 1 ' |
134 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
135 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
136 |
|
137 |
diagName = 'KPPdbloc' |
138 |
diagTitle = 'Local delta buoyancy across interfaces' |
139 |
diagUnits = 'm/s^2 ' |
140 |
diagCode = 'SM P UR ' |
141 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
142 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
143 |
|
144 |
#ifndef EXCLUDE_KPP_DOUBLEDIFF |
145 |
diagName = 'KPPnuddt' |
146 |
diagTitle = 'Vertical double diffusion coefficient for heat' |
147 |
diagUnits = 'm^2/s ' |
148 |
diagCode = 'SM P UR ' |
149 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
150 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
151 |
|
152 |
diagName = 'KPPnudds' |
153 |
diagTitle = 'Vertical double diffusion coefficient for salt' |
154 |
diagUnits = 'm^2/s ' |
155 |
diagCode = 'SM P UR ' |
156 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
157 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
158 |
#endif /* ndef EXCLUDE_KPP_DOUBLEDIFF */ |
159 |
|
160 |
diagSufx = 'aaaa' |
161 |
#ifdef ALLOW_GENERIC_ADVDIFF |
162 |
diagSufx = GAD_DIAG_SUFX( GAD_TEMPERATURE, myThid ) |
163 |
#endif |
164 |
diagName = 'KPPg'//diagSufx |
165 |
diagTitle = 'KPP non-local Flux of Pot.Temperature' |
166 |
diagUnits = 'degC.m^3/s ' |
167 |
diagCode = 'WM LR ' |
168 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
169 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
170 |
|
171 |
#ifdef ALLOW_GENERIC_ADVDIFF |
172 |
diagSufx = GAD_DIAG_SUFX( GAD_SALINITY, myThid ) |
173 |
#endif |
174 |
diagName = 'KPPg'//diagSufx |
175 |
diagTitle = 'KPP non-local Flux of Salinity' |
176 |
diagUnits = 'psu.m^3/s ' |
177 |
diagCode = 'WM LR ' |
178 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
179 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
180 |
|
181 |
#ifdef ALLOW_SALT_PLUME |
182 |
diagName = 'KPPpfrac' |
183 |
diagTitle = 'Salt plume flux fraction penetrating mixing layer' |
184 |
diagUnits = ' ' |
185 |
diagCode = 'SM P 1 ' |
186 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
187 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
188 |
|
189 |
diagName = 'KPPboplm' |
190 |
diagTitle = 'Surface haline buoyancy forcing' |
191 |
diagUnits = 'm^2/s^3 ' |
192 |
diagCode = 'SM P 1 ' |
193 |
CALL DIAGNOSTICS_ADDTOLIST( diagNum, |
194 |
I diagName, diagCode, diagUnits, diagTitle, 0, myThid ) |
195 |
#endif /* ALLOW_SALT_PLUME */ |
196 |
|
197 |
#endif /* ALLOW_DIAGNOSTICS */ |
198 |
|
199 |
RETURN |
200 |
END |