pkg/longstep/longstep_diagnostics_init.F

C $Header: /u/gcmpack/MITgcm/pkg/longstep/longstep_diagnostics_init.F,v 1.1 2009/06/26 23:10:10 jahn Exp $
C $Name:  $

#include "LONGSTEP_OPTIONS.h"

CBOP
C     !ROUTINE: LONGSTEP_DIAGNOSTICS_INIT
C     !INTERFACE:
      SUBROUTINE LONGSTEP_DIAGNOSTICS_INIT( myThid )
C     !DESCRIPTION:
C     Routine to initialize longstep diagnostics

C     !USES:
      IMPLICIT NONE
C     === Global variables ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "LONGSTEP_PARAMS.h"

C     !INPUT/OUTPUT PARAMETERS:
C     === Routine arguments ===
C     myThid -  Number of this instance of LONGSTEP_DIAGNOSTICS_INIT
      INTEGER myThid
CEOP

#ifdef ALLOW_DIAGNOSTICS
C     !LOCAL VARIABLES:
C     === Local variables ===
C     msgBuf      - Informational/error message buffer
c     CHARACTER*(MAX_LEN_MBUF) msgBuf

      INTEGER       diagNum
      INTEGER       diagMate
      CHARACTER*8   diagName
      CHARACTER*16  diagCode
      CHARACTER*16  diagUnits
      CHARACTER*(80) diagTitle

C--   Add diagnostics to the (long) list

      diagName  = 'LSwVel  '
      diagTitle = 'Vertical Component of Velocity (m/s)'
      diagUnits = 'm/s             '
      diagCode  = 'WM      LR      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'LSuVel  '
      diagTitle = 'Zonal Component of Velocity (m/s)'
      diagUnits = 'm/s             '
      diagCode  = 'UUR     MR      '
      diagMate  = diagNum + 2
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I   diagName, diagCode, diagUnits, diagTitle, diagMate, myThid )

      diagName  = 'LSvVel  '
      diagTitle = 'Meridional Component of Velocity (m/s)'
      diagUnits = 'm/s             '
      diagCode  = 'VVR     MR      '
      diagMate  = diagNum
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I   diagName, diagCode, diagUnits, diagTitle, diagMate, myThid )

      diagName  = 'LStheta '
      diagTitle = 'Potential Temperature'
      diagUnits = 'degC            '
      diagCode  = 'SMR     MR      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'LSsalt  '
      diagTitle = 'Salinity'
      diagUnits = 'psu             '
      diagCode  = 'SMR     MR      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      IF ( ivdc_kappa .NE. 0. _d 0 ) THEN
        diagName  = 'LScnvAdj'
        diagTitle = 'Convective Adjustment Index [0-1] '
        diagUnits = 'fraction        '
        diagCode  = 'SM      LR      '
        CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )
      ENDIF

#ifdef SHORTWAVE_HEATING
      diagName  = 'LSqsw   '
      diagTitle = 'net Short-Wave radiation (+=up)'
      diagUnits = 'W/m^2           '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, 0, myThid )
#endif

#ifdef ALLOW_GMREDI
      IF ( useGMRedi ) THEN
       diagName  = 'LSkwx   '
       diagTitle = 'K_31 element (W.point, X.dir) of GM-Redi tensor'
       diagUnits = 'm^2/s           '
       diagCode  = 'UM      LR      '
       diagMate  = diagNum + 2
       CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I    diagName, diagCode, diagUnits, diagTitle, diagMate, myThid )

       diagName  = 'LSkwy   '
       diagTitle = 'K_32 element (W.point, Y.dir) of GM-Redi tensor'
       diagUnits = 'm^2/s           '
       diagCode  = 'VM      LR      '
       diagMate  = diagNum
       CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I    diagName, diagCode, diagUnits, diagTitle, diagMate, myThid )

       diagName  = 'LSkwz   '
       diagTitle = 'K_33 element (W.point, Z.dir) of GM-Redi tensor'
       diagUnits = 'm^2/s           '
       diagCode  = 'WM P    LR      '
       CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I       diagName, diagCode, diagUnits, diagTitle, 0, myThid )
      ENDIF
#endif

#ifdef ALLOW_KPP
      IF ( useKPP ) THEN
       diagName  = 'LSKPPdfS'
       diagTitle = 'Vertical diffusion coefficient for salt & tracers'
       diagUnits = 'm^2/s           '
       diagCode  = 'SM P    LR      '
       CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I       diagName, diagCode, diagUnits, diagTitle, 0, myThid )

       diagName  = 'LSKPPght'
       diagTitle = 'Nonlocal transport coefficient'
       diagUnits = 's/m^2           '
       diagCode  = 'SM P    LR      '
       CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I       diagName, diagCode, diagUnits, diagTitle, 0, myThid )
      ENDIF
#endif /* ALLOW_KPP */

#endif /* ALLOW_DIAGNOSTICS */

      RETURN
      END

1	C $Header: /u/gcmpack/MITgcm/pkg/longstep/longstep_diagnostics_init.F,v 1.1 2009/06/26 23:10:10 jahn Exp $
2	C $Name: $
3
4	#include "LONGSTEP_OPTIONS.h"
5
6	CBOP
7	C !ROUTINE: LONGSTEP_DIAGNOSTICS_INIT
8	C !INTERFACE:
9	SUBROUTINE LONGSTEP_DIAGNOSTICS_INIT( myThid )
10	C !DESCRIPTION:
11	C Routine to initialize longstep diagnostics
12
13	C !USES:
14	IMPLICIT NONE
15	C === Global variables ===
16	#include "SIZE.h"
17	#include "EEPARAMS.h"
18	#include "PARAMS.h"
19	#include "LONGSTEP_PARAMS.h"
20
21	C !INPUT/OUTPUT PARAMETERS:
22	C === Routine arguments ===
23	C myThid - Number of this instance of LONGSTEP_DIAGNOSTICS_INIT
24	INTEGER myThid
25	CEOP
26
27	#ifdef ALLOW_DIAGNOSTICS
28	C !LOCAL VARIABLES:
29	C === Local variables ===
30	C msgBuf - Informational/error message buffer
31	c CHARACTER*(MAX_LEN_MBUF) msgBuf
32
33	INTEGER diagNum
34	INTEGER diagMate
35	CHARACTER*8 diagName
36	CHARACTER*16 diagCode
37	CHARACTER*16 diagUnits
38	CHARACTER*(80) diagTitle
39
40	C-- Add diagnostics to the (long) list
41
42	diagName = 'LSwVel '
43	diagTitle = 'Vertical Component of Velocity (m/s)'
44	diagUnits = 'm/s '
45	diagCode = 'WM LR '
46	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
47	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
48
49	diagName = 'LSuVel '
50	diagTitle = 'Zonal Component of Velocity (m/s)'
51	diagUnits = 'm/s '
52	diagCode = 'UUR MR '
53	diagMate = diagNum + 2
54	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
55	I diagName, diagCode, diagUnits, diagTitle, diagMate, myThid )
56
57	diagName = 'LSvVel '
58	diagTitle = 'Meridional Component of Velocity (m/s)'
59	diagUnits = 'm/s '
60	diagCode = 'VVR MR '
61	diagMate = diagNum
62	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
63	I diagName, diagCode, diagUnits, diagTitle, diagMate, myThid )
64
65	diagName = 'LStheta '
66	diagTitle = 'Potential Temperature'
67	diagUnits = 'degC '
68	diagCode = 'SMR MR '
69	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
70	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
71
72	diagName = 'LSsalt '
73	diagTitle = 'Salinity'
74	diagUnits = 'psu '
75	diagCode = 'SMR MR '
76	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
77	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
78
79	IF ( ivdc_kappa .NE. 0. _d 0 ) THEN
80	diagName = 'LScnvAdj'
81	diagTitle = 'Convective Adjustment Index [0-1] '
82	diagUnits = 'fraction '
83	diagCode = 'SM LR '
84	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
85	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
86	ENDIF
87
88	#ifdef SHORTWAVE_HEATING
89	diagName = 'LSqsw '
90	diagTitle = 'net Short-Wave radiation (+=up)'
91	diagUnits = 'W/m^2 '
92	diagCode = 'SM U1 '
93	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
94	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
95	#endif
96
97	#ifdef ALLOW_GMREDI
98	IF ( useGMRedi ) THEN
99	diagName = 'LSkwx '
100	diagTitle = 'K_31 element (W.point, X.dir) of GM-Redi tensor'
101	diagUnits = 'm^2/s '
102	diagCode = 'UM LR '
103	diagMate = diagNum + 2
104	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
105	I diagName, diagCode, diagUnits, diagTitle, diagMate, myThid )
106
107	diagName = 'LSkwy '
108	diagTitle = 'K_32 element (W.point, Y.dir) of GM-Redi tensor'
109	diagUnits = 'm^2/s '
110	diagCode = 'VM LR '
111	diagMate = diagNum
112	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
113	I diagName, diagCode, diagUnits, diagTitle, diagMate, myThid )
114
115	diagName = 'LSkwz '
116	diagTitle = 'K_33 element (W.point, Z.dir) of GM-Redi tensor'
117	diagUnits = 'm^2/s '
118	diagCode = 'WM P LR '
119	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
120	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
121	ENDIF
122	#endif
123
124	#ifdef ALLOW_KPP
125	IF ( useKPP ) THEN
126	diagName = 'LSKPPdfS'
127	diagTitle = 'Vertical diffusion coefficient for salt & tracers'
128	diagUnits = 'm^2/s '
129	diagCode = 'SM P LR '
130	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
131	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
132
133	diagName = 'LSKPPght'
134	diagTitle = 'Nonlocal transport coefficient'
135	diagUnits = 's/m^2 '
136	diagCode = 'SM P LR '
137	CALL DIAGNOSTICS_ADDTOLIST( diagNum,
138	I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
139	ENDIF
140	#endif /* ALLOW_KPP */
141
142	#endif /* ALLOW_DIAGNOSTICS */
143
144	RETURN
145	END
146