pkg/exf/exf_diagnostics_init.F

C $Header: /u/gcmpack/MITgcm/pkg/exf/exf_diagnostics_init.F,v 1.11 2017/01/11 03:45:34 gforget Exp $
C $Name:  $

#include "EXF_OPTIONS.h"

CBOP
C     !ROUTINE: EXF_DIAGNOSTICS_INIT
C     !INTERFACE:
      SUBROUTINE EXF_DIAGNOSTICS_INIT( myThid )

C     !DESCRIPTION: \bv
C     *==========================================================*
C     | SUBROUTINE EXF_DIAGNOSTICS_INIT
C     | o Routine to initialize list of all available diagnostics
C     |   for EXF package
C     *==========================================================*
C     \ev
C     !USES:
      IMPLICIT NONE

C     === Global variables ===
#include "EEPARAMS.h"
#include "EXF_PARAM.h"

C     !INPUT/OUTPUT PARAMETERS:
C     === Routine arguments ===
C     myThid ::  my Thread Id number
      INTEGER myThid
CEOP

#ifdef ALLOW_DIAGNOSTICS
C     !LOCAL VARIABLES:
C     === Local variables ===
C     diagNum   :: diagnostics number in the (long) list of available diag.
C     diagName  :: local short name (8c) of a diagnostics
C     diagCode  :: local parser field with characteristics of the diagnostics
C              cf head of S/R DIAGNOSTICS_INIT_EARLY or DIAGNOSTICS_MAIN_INIT
C     diagUnits :: local string (16c): physical units of a diagnostic field
C     diagTitle :: local string (80c): description of field in diagnostic
      INTEGER       diagNum
      CHARACTER*8   diagName
      CHARACTER*16  diagCode
      CHARACTER*16  diagUnits
      CHARACTER*(80) diagTitle

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|

      diagName  = 'EXFhs   '
      diagTitle = 'Sensible heat flux into ocean, >0 increases theta'
      diagUnits = 'W/m^2           '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I     diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFhl   '
      diagTitle = 'Latent heat flux into ocean, >0 increases theta'
      diagUnits = 'W/m^2           '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I     diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFlwnet'
      diagTitle = 'Net upward longwave radiation, >0 decreases theta'
      diagUnits = 'W/m^2           '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I     diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFswnet'
      diagTitle = 'Net upward shortwave radiation, >0 decreases theta'
      diagUnits = 'W/m^2           '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I     diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFlwdn '
      diagTitle = 'Downward longwave radiation, >0 increases theta'
      diagUnits = 'W/m^2           '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I     diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFswdn '
      diagTitle = 'Downward shortwave radiation, >0 increases theta'
      diagUnits = 'W/m^2           '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I     diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFqnet '
      diagTitle = 'Net upward heat flux (turb+rad), >0 decreases theta'
      diagUnits = 'W/m^2           '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I     diagName, diagCode, diagUnits, diagTitle, 0, myThid )

C--   surface fluxes:
      diagName  = 'EXFtaux '
      diagTitle = 'zonal surface wind stress, >0 increases uVel    '
      diagUnits = 'N/m^2           '
      IF ( stressIsOnCgrid ) THEN
       diagCode = 'UU      U1      '
      ELSE
       diagCode = 'UM      U1      '
      ENDIF
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I     diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFtauy '
      diagTitle = 'meridional surface wind stress, >0 increases vVel'
      diagUnits = 'N/m^2           '
      IF ( stressIsOnCgrid ) THEN
       diagCode = 'VV      U1      '
      ELSE
       diagCode = 'VM      U1      '
      ENDIF
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I     diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFuwind'
      diagTitle = 'zonal 10-m wind speed, >0 eastward'
      diagUnits = 'm/s             '
      diagCode  = 'UM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I     diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFvwind'
      diagTitle = 'meridional 10-m wind speed, >0 northward'
      diagUnits = 'm/s             '
      diagCode  = 'VM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFwspee'
      diagTitle = '10-m wind speed modulus ( >= 0 )'
      diagUnits = 'm/s             '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFatemp'
      diagTitle = 'surface (2-m) air temperature'
      diagUnits = 'degK            '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFaqh  '
      diagTitle = 'surface (2-m) specific humidity'
      diagUnits = 'kg/kg           '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFevap '
      diagTitle = 'evaporation, > 0 increases salinity'
      diagUnits = 'm/s             '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFpreci'
      diagTitle = 'precipitation, > 0 decreases salinity'
      diagUnits = 'm/s             '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFsnow '
      diagTitle = 'snow precipitation, > 0 decreases salinity'
      diagUnits = 'm/s             '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFempmr'
      diagTitle = 'net upward freshwater flux, > 0 increases salinity'
      diagUnits = 'm/s             '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFpress'
      diagTitle = 'atmospheric pressure field'
      diagUnits = 'N/m^2           '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFroff '
      diagTitle = 'river runoff, > 0 decreases salinity'
      diagUnits = 'm/s             '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFroft '
      diagTitle = 'river runoff temperature'
      diagUnits = 'deg C           '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'EXFsalfx'
      diagTitle = 'upward salt flux, > 0 decreases salinity'
      diagUnits = 'psu.kg/m^2/s    '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

#endif /* ALLOW_DIAGNOSTICS */

      RETURN
      END
1	C $Header: /u/gcmpack/MITgcm/pkg/exf/exf_diagnostics_init.F,v 1.11 2017/01/11 03:45:34 gforget Exp $
2	C $Name: $
3
4	#include "EXF_OPTIONS.h"
5
6	CBOP
7	C !ROUTINE: EXF_DIAGNOSTICS_INIT
8	C !INTERFACE:
9	SUBROUTINE EXF_DIAGNOSTICS_INIT( myThid )
10
11	C !DESCRIPTION: \bv
12	C ==========================================================
13	C \| SUBROUTINE EXF_DIAGNOSTICS_INIT
14	C \| o Routine to initialize list of all available diagnostics
15	C \| for EXF package
16	C ==========================================================
17	C \ev
18	C !USES:
19	IMPLICIT NONE
20
21	C === Global variables ===
22	#include "EEPARAMS.h"
23	#include "EXF_PARAM.h"
24
25	C !INPUT/OUTPUT PARAMETERS:
26	C === Routine arguments ===
27	C myThid :: my Thread Id number
28	INTEGER myThid
29	CEOP
30
31	#ifdef ALLOW_DIAGNOSTICS
32	C !LOCAL VARIABLES:
33	C === Local variables ===
34	C diagNum :: diagnostics number in the (long) list of available diag.
35	C diagName :: local short name (8c) of a diagnostics
36	C diagCode :: local parser field with characteristics of the diagnostics
37	C cf head of S/R DIAGNOSTICS_INIT_EARLY or DIAGNOSTICS_MAIN_INIT
38	C diagUnits :: local string (16c): physical units of a diagnostic field
39	C diagTitle :: local string (80c): description of field in diagnostic
40	INTEGER diagNum
41	CHARACTER*8 diagName
42	CHARACTER*16 diagCode
43	CHARACTER*16 diagUnits
44	CHARACTER*(80) diagTitle
45
46	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
47
48	diagName = 'EXFhs '
49	diagTitle = 'Sensible heat flux into ocean, >0 increases theta'
50	diagUnits = 'W/m^2 '
51	diagCode = 'SM U1 '
52	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
53	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
54
55	diagName = 'EXFhl '
56	diagTitle = 'Latent heat flux into ocean, >0 increases theta'
57	diagUnits = 'W/m^2 '
58	diagCode = 'SM U1 '
59	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
60	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
61
62	diagName = 'EXFlwnet'
63	diagTitle = 'Net upward longwave radiation, >0 decreases theta'
64	diagUnits = 'W/m^2 '
65	diagCode = 'SM U1 '
66	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
67	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
68
69	diagName = 'EXFswnet'
70	diagTitle = 'Net upward shortwave radiation, >0 decreases theta'
71	diagUnits = 'W/m^2 '
72	diagCode = 'SM U1 '
73	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
74	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
75
76	diagName = 'EXFlwdn '
77	diagTitle = 'Downward longwave radiation, >0 increases theta'
78	diagUnits = 'W/m^2 '
79	diagCode = 'SM U1 '
80	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
81	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
82
83	diagName = 'EXFswdn '
84	diagTitle = 'Downward shortwave radiation, >0 increases theta'
85	diagUnits = 'W/m^2 '
86	diagCode = 'SM U1 '
87	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
88	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
89
90	diagName = 'EXFqnet '
91	diagTitle = 'Net upward heat flux (turb+rad), >0 decreases theta'
92	diagUnits = 'W/m^2 '
93	diagCode = 'SM U1 '
94	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
95	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
96
97	C-- surface fluxes:
98	diagName = 'EXFtaux '
99	diagTitle = 'zonal surface wind stress, >0 increases uVel '
100	diagUnits = 'N/m^2 '
101	IF ( stressIsOnCgrid ) THEN
102	diagCode = 'UU U1 '
103	ELSE
104	diagCode = 'UM U1 '
105	ENDIF
106	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
107	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
108
109	diagName = 'EXFtauy '
110	diagTitle = 'meridional surface wind stress, >0 increases vVel'
111	diagUnits = 'N/m^2 '
112	IF ( stressIsOnCgrid ) THEN
113	diagCode = 'VV U1 '
114	ELSE
115	diagCode = 'VM U1 '
116	ENDIF
117	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
118	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
119
120	diagName = 'EXFuwind'
121	diagTitle = 'zonal 10-m wind speed, >0 eastward'
122	diagUnits = 'm/s '
123	diagCode = 'UM U1 '
124	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
125	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
126
127	diagName = 'EXFvwind'
128	diagTitle = 'meridional 10-m wind speed, >0 northward'
129	diagUnits = 'm/s '
130	diagCode = 'VM U1 '
131	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
132	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
133
134	diagName = 'EXFwspee'
135	diagTitle = '10-m wind speed modulus ( >= 0 )'
136	diagUnits = 'm/s '
137	diagCode = 'SM U1 '
138	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
139	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
140
141	diagName = 'EXFatemp'
142	diagTitle = 'surface (2-m) air temperature'
143	diagUnits = 'degK '
144	diagCode = 'SM U1 '
145	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
146	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
147
148	diagName = 'EXFaqh '
149	diagTitle = 'surface (2-m) specific humidity'
150	diagUnits = 'kg/kg '
151	diagCode = 'SM U1 '
152	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
153	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
154
155	diagName = 'EXFevap '
156	diagTitle = 'evaporation, > 0 increases salinity'
157	diagUnits = 'm/s '
158	diagCode = 'SM U1 '
159	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
160	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
161
162	diagName = 'EXFpreci'
163	diagTitle = 'precipitation, > 0 decreases salinity'
164	diagUnits = 'm/s '
165	diagCode = 'SM U1 '
166	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
167	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
168
169	diagName = 'EXFsnow '
170	diagTitle = 'snow precipitation, > 0 decreases salinity'
171	diagUnits = 'm/s '
172	diagCode = 'SM U1 '
173	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
174	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
175
176	diagName = 'EXFempmr'
177	diagTitle = 'net upward freshwater flux, > 0 increases salinity'
178	diagUnits = 'm/s '
179	diagCode = 'SM U1 '
180	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
181	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
182
183	diagName = 'EXFpress'
184	diagTitle = 'atmospheric pressure field'
185	diagUnits = 'N/m^2 '
186	diagCode = 'SM U1 '
187	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
188	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
189
190	diagName = 'EXFroff '
191	diagTitle = 'river runoff, > 0 decreases salinity'
192	diagUnits = 'm/s '
193	diagCode = 'SM U1 '
194	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
195	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
196
197	diagName = 'EXFroft '
198	diagTitle = 'river runoff temperature'
199	diagUnits = 'deg C '
200	diagCode = 'SM U1 '
201	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
202	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
203
204	diagName = 'EXFsalfx'
205	diagTitle = 'upward salt flux, > 0 decreases salinity'
206	diagUnits = 'psu.kg/m^2/s '
207	diagCode = 'SM U1 '
208	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
209	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
210
211	#endif /* ALLOW_DIAGNOSTICS */
212
213	RETURN
214	END