pkg/gmredi/gmredi_diagnostics_init.F

C $Header: /u/gcmpack/MITgcm/pkg/gmredi/gmredi_diagnostics_init.F,v 1.2 2005/12/08 03:29:31 jmc Exp $
C $Name:  $

#include "GMREDI_OPTIONS.h"

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

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

C     === Global variables ===
#include "EEPARAMS.h"
c #include "SIZE.h"
c #include "PARAMS.h"
c #include "GMREDI.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-|--+----|

c     IF ( useDiagnotics ) THEN

        diagName  = 'GM_VisbK'
        diagTitle = 
     &     'Mixing coefficient from Visbeck etal parameterization'
        diagUnits = 'm^2/s           '
        diagCode  = 'SM P    M1      '
        CALL DIAGNOSTICS_ADD2LIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, myThid )

        diagName  = 'GM_Kux  '
        diagTitle = 'K_11 element (U.point, X.dir) of GM-Redi tensor'
        diagUnits = 'm^2/s           '
        WRITE(diagCode,'(A,I3.3,A)') 'UU P ',diagNum+2,'MR      '
        CALL DIAGNOSTICS_ADD2LIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, myThid )

        diagName  = 'GM_Kvy  '
        diagTitle = 'K_22 element (V.point, Y.dir) of GM-Redi tensor'
        diagUnits = 'm^2/s           '
        WRITE(diagCode,'(A,I3.3,A)') 'VV P ', diagNum ,'MR      '
        CALL DIAGNOSTICS_ADD2LIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, myThid )

        diagName  = 'GM_Kuz  '
        diagTitle = 'K_13 element (U.point, Z.dir) of GM-Redi tensor'
        diagUnits = 'm^2/s           '
        WRITE(diagCode,'(A,I3.3,A)') 'UU   ',diagNum+2,'MR      '
        CALL DIAGNOSTICS_ADD2LIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, myThid )

        diagName  = 'GM_Kvz  '
        diagTitle = 'K_23 element (V.point, Z.dir) of GM-Redi tensor'
        diagUnits = 'm^2/s           '
        WRITE(diagCode,'(A,I3.3,A)') 'VV   ', diagNum ,'MR      '
        CALL DIAGNOSTICS_ADD2LIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, myThid )

        diagName  = 'GM_Kwx  '
        diagTitle = 'K_31 element (W.point, X.dir) of GM-Redi tensor'
        diagUnits = 'm^2/s           '
        WRITE(diagCode,'(A,I3.3,A)') 'UM   ',diagNum+2,'LR      '
        CALL DIAGNOSTICS_ADD2LIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, myThid )

        diagName  = 'GM_Kwy  '
        diagTitle = 'K_32 element (W.point, Y.dir) of GM-Redi tensor'
        diagUnits = 'm^2/s           '
        WRITE(diagCode,'(A,I3.3,A)') 'VM   ', diagNum ,'LR      '
        CALL DIAGNOSTICS_ADD2LIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, myThid )

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

        diagName  = 'GM_PsiX '
        diagTitle = 'GM Bolus transport stream-function : X component'
        diagUnits = 'm^2/s           '
        WRITE(diagCode,'(A,I3.3,A)') 'UU   ',diagNum+2,'LR      '
        CALL DIAGNOSTICS_ADD2LIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, myThid )

        diagName  = 'GM_PsiY '
        diagTitle = 'GM Bolus transport stream-function : Y component'
        diagUnits = 'm^2/s           '
        WRITE(diagCode,'(A,I3.3,A)') 'VV   ', diagNum ,'LR      '
        CALL DIAGNOSTICS_ADD2LIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, myThid )

        diagName  = 'GM_KuzTz'
        diagTitle = 'Redi Off-diagonal Tempetature flux: X component'
        diagUnits = 'degC.m^3/s      '
        WRITE(diagCode,'(A,I3.3,A)') 'UU   ',diagNum+2,'MR      '
        CALL DIAGNOSTICS_ADD2LIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, myThid )

        diagName  = 'GM_KvzTz'
        diagTitle = 'Redi Off-diagonal Tempetature flux: Y component'
        diagUnits = 'degC.m^3/s      '
        WRITE(diagCode,'(A,I3.3,A)') 'VV   ', diagNum ,'MR      '
        CALL DIAGNOSTICS_ADD2LIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, myThid )

#ifdef ALLOW_TAU_EDDY
        diagName  = 'GMEdTauX'
        diagTitle = 'eddy-induced stress X-comp. estimated from Kwx'
        diagUnits = 'N/m^2           '
        WRITE(diagCode,'(A,I3.3,A)') 'UM   ',diagNum+2,'LR      '
        CALL DIAGNOSTICS_ADD2LIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, myThid )

        diagName  = 'GMEdTauY'
        diagTitle = 'eddy-induced stress Y-comp. estimated from Kwy'
        diagUnits = 'N/m^2           '
        WRITE(diagCode,'(A,I3.3,A)') 'VM   ',diagNum+2,'LR      '
        CALL DIAGNOSTICS_ADD2LIST( diagNum,
     I          diagName, diagCode, diagUnits, diagTitle, myThid )
#endif

c     ENDIF

#endif /* ALLOW_DIAGNOSTICS */

      RETURN
      END
1	heimbach	1.3	C $Header: /u/gcmpack/MITgcm/pkg/gmredi/gmredi_diagnostics_init.F,v 1.2 2005/12/08 03:29:31 jmc Exp $
2	jmc	1.1	C $Name: $
3
4			#include "GMREDI_OPTIONS.h"
5
6			CBOP
7			C !ROUTINE: GMREDI_DIAGNOSTICS_INIT
8			C !INTERFACE:
9			SUBROUTINE GMREDI_DIAGNOSTICS_INIT( myThid )
10
11			C !DESCRIPTION: \bv
12			C ==========================================================
13			C \| SUBROUTINE GMREDI_DIAGNOSTICS_INIT
14			C \| o Routine to initialize list of all available diagnostics
15			C \| for GM/Redi package
16			C ==========================================================
17			C \ev
18			C !USES:
19			IMPLICIT NONE
20
21			C === Global variables ===
22			#include "EEPARAMS.h"
23			c #include "SIZE.h"
24			c #include "PARAMS.h"
25			c #include "GMREDI.h"
26
27			C !INPUT/OUTPUT PARAMETERS:
28			C === Routine arguments ===
29			C myThid :: my Thread Id number
30			INTEGER myThid
31			CEOP
32
33			#ifdef ALLOW_DIAGNOSTICS
34			C !LOCAL VARIABLES:
35			C === Local variables ===
36			C diagNum :: diagnostics number in the (long) list of available diag.
37			C diagName :: local short name (8c) of a diagnostics
38			C diagCode :: local parser field with characteristics of the diagnostics
39			C cf head of S/R DIAGNOSTICS_INIT_EARLY or DIAGNOSTICS_MAIN_INIT
40			C diagUnits :: local string (16c): physical units of a diagnostic field
41			C diagTitle :: local string (80c): description of field in diagnostic
42			INTEGER diagNum
43			CHARACTER*8 diagName
44			CHARACTER*16 diagCode
45			CHARACTER*16 diagUnits
46			CHARACTER*(80) diagTitle
47
48			C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
49
50			c IF ( useDiagnotics ) THEN
51
52			diagName = 'GM_VisbK'
53			diagTitle =
54			& 'Mixing coefficient from Visbeck etal parameterization'
55			diagUnits = 'm^2/s '
56			diagCode = 'SM P M1 '
57			CALL DIAGNOSTICS_ADD2LIST( diagNum,
58			I diagName, diagCode, diagUnits, diagTitle, myThid )
59
60			diagName = 'GM_Kux '
61			diagTitle = 'K_11 element (U.point, X.dir) of GM-Redi tensor'
62			diagUnits = 'm^2/s '
63			WRITE(diagCode,'(A,I3.3,A)') 'UU P ',diagNum+2,'MR '
64			CALL DIAGNOSTICS_ADD2LIST( diagNum,
65			I diagName, diagCode, diagUnits, diagTitle, myThid )
66
67			diagName = 'GM_Kvy '
68			diagTitle = 'K_22 element (V.point, Y.dir) of GM-Redi tensor'
69			diagUnits = 'm^2/s '
70			WRITE(diagCode,'(A,I3.3,A)') 'VV P ', diagNum ,'MR '
71			CALL DIAGNOSTICS_ADD2LIST( diagNum,
72			I diagName, diagCode, diagUnits, diagTitle, myThid )
73
74			diagName = 'GM_Kuz '
75			diagTitle = 'K_13 element (U.point, Z.dir) of GM-Redi tensor'
76			diagUnits = 'm^2/s '
77			WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR '
78			CALL DIAGNOSTICS_ADD2LIST( diagNum,
79			I diagName, diagCode, diagUnits, diagTitle, myThid )
80
81			diagName = 'GM_Kvz '
82			diagTitle = 'K_23 element (V.point, Z.dir) of GM-Redi tensor'
83			diagUnits = 'm^2/s '
84			WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum ,'MR '
85			CALL DIAGNOSTICS_ADD2LIST( diagNum,
86			I diagName, diagCode, diagUnits, diagTitle, myThid )
87
88			diagName = 'GM_Kwx '
89			diagTitle = 'K_31 element (W.point, X.dir) of GM-Redi tensor'
90			diagUnits = 'm^2/s '
91			WRITE(diagCode,'(A,I3.3,A)') 'UM ',diagNum+2,'LR '
92			CALL DIAGNOSTICS_ADD2LIST( diagNum,
93			I diagName, diagCode, diagUnits, diagTitle, myThid )
94
95			diagName = 'GM_Kwy '
96			diagTitle = 'K_32 element (W.point, Y.dir) of GM-Redi tensor'
97			diagUnits = 'm^2/s '
98			WRITE(diagCode,'(A,I3.3,A)') 'VM ', diagNum ,'LR '
99			CALL DIAGNOSTICS_ADD2LIST( diagNum,
100			I diagName, diagCode, diagUnits, diagTitle, myThid )
101
102			diagName = 'GM_Kwz '
103			diagTitle = 'K_33 element (W.point, Z.dir) of GM-Redi tensor'
104			diagUnits = 'm^2/s '
105			diagCode = 'WM P LR '
106			CALL DIAGNOSTICS_ADD2LIST( diagNum,
107			I diagName, diagCode, diagUnits, diagTitle, myThid )
108
109			diagName = 'GM_PsiX '
110			diagTitle = 'GM Bolus transport stream-function : X component'
111			diagUnits = 'm^2/s '
112			WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'LR '
113			CALL DIAGNOSTICS_ADD2LIST( diagNum,
114			I diagName, diagCode, diagUnits, diagTitle, myThid )
115
116			diagName = 'GM_PsiY '
117			diagTitle = 'GM Bolus transport stream-function : Y component'
118			diagUnits = 'm^2/s '
119			WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum ,'LR '
120			CALL DIAGNOSTICS_ADD2LIST( diagNum,
121			I diagName, diagCode, diagUnits, diagTitle, myThid )
122
123	jmc	1.2	diagName = 'GM_KuzTz'
124			diagTitle = 'Redi Off-diagonal Tempetature flux: X component'
125			diagUnits = 'degC.m^3/s '
126			WRITE(diagCode,'(A,I3.3,A)') 'UU ',diagNum+2,'MR '
127			CALL DIAGNOSTICS_ADD2LIST( diagNum,
128			I diagName, diagCode, diagUnits, diagTitle, myThid )
129
130			diagName = 'GM_KvzTz'
131			diagTitle = 'Redi Off-diagonal Tempetature flux: Y component'
132			diagUnits = 'degC.m^3/s '
133			WRITE(diagCode,'(A,I3.3,A)') 'VV ', diagNum ,'MR '
134			CALL DIAGNOSTICS_ADD2LIST( diagNum,
135			I diagName, diagCode, diagUnits, diagTitle, myThid )
136
137	heimbach	1.3	#ifdef ALLOW_TAU_EDDY
138			diagName = 'GMEdTauX'
139			diagTitle = 'eddy-induced stress X-comp. estimated from Kwx'
140			diagUnits = 'N/m^2 '
141			WRITE(diagCode,'(A,I3.3,A)') 'UM ',diagNum+2,'LR '
142			CALL DIAGNOSTICS_ADD2LIST( diagNum,
143			I diagName, diagCode, diagUnits, diagTitle, myThid )
144
145			diagName = 'GMEdTauY'
146			diagTitle = 'eddy-induced stress Y-comp. estimated from Kwy'
147			diagUnits = 'N/m^2 '
148			WRITE(diagCode,'(A,I3.3,A)') 'VM ',diagNum+2,'LR '
149			CALL DIAGNOSTICS_ADD2LIST( diagNum,
150			I diagName, diagCode, diagUnits, diagTitle, myThid )
151			#endif
152
153	jmc	1.1	c ENDIF
154
155			#endif /* ALLOW_DIAGNOSTICS */
156
157			RETURN
158			END