pkg/diagnostics/diagnostics_init_early.F

C $Header: /u/gcmpack/MITgcm/pkg/diagnostics/diagnostics_init_early.F,v 1.14 2008/11/15 19:51:41 jmc Exp $
C $Name:  $

#include "DIAG_OPTIONS.h"

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP 0
C     !ROUTINE: DIAGNOSTICS_INIT_EARLY

C     !INTERFACE:
      SUBROUTINE DIAGNOSTICS_INIT_EARLY( myThid )

C     !DESCRIPTION:
C     Initialize available diagnostics list: set the following attributes:
C     name (=cdiag), parsing code (=gdiag), units (=udiag), and title (=tdiag)
C     Note: 1) diagnostics defined here are not presently filled. To use
C           one of them, one just needs to add a call to S/R DIAGNOSTICS_FILL
C           with the diagnostic name 'SDIAG...' or 'UDIAG...'
C           2) GDIAG is defined as character*16 and can be to character*1
C           parse(16) with the following codes currently defined:

C     \begin{center}
C       \begin{tabular}[h]{|c|c|}\hline
C         \textbf{Positions}  &  \textbf{Characters}
C         &  \textbf{Meanings} \\\hline
C         parse(1)  &  S  &  scalar \\
C                   &  U  &  vector component in X direction \\
C                   &  V  &  vector component in Y direction \\
C                   &  W  &  vector component in vertical direction \\
C         parse(2)  &  U  &  C-grid U-Point  \\
C                   &  V  &  C-grid V-Point  \\
C                   &  M  &  C-grid Mass Point  \\
C                   &  Z  &  C-grid Corner Point  \\
C         parse(3)  &     &  Used for Level Integrated output: cumulate levels \\
C                   &  r  &  same but cumulate product by model level thickness \\
C                   &  R  &  same but cumulate product by hFac & level thickness \\
C         parse(4)  &  P  &  positive definite  \\
C         parse(5 ) &  C  &  with counter array  \\
C                   &  D  &  disable an array for output  \\
C         parse(6--8) & '123'  & retired, formerly: 3-digit mate number \\
C         parse(9)  &  U  &  model-level plus 1/2  \\
C                   &  M  &  model-level middle  \\
C                   &  L  &  model-level minus 1/2  \\
C         parse(10) &  0  &  levels = 0  \\
C                   &  1  &  levels = 1  \\
C                   &  R  &  levels = Nr  \\
C                   &  L  &  levels = MAX(Nr,NrPhys)  \\
C                   &  M  &  levels = MAX(Nr,NrPhys) - 1  \\
C                   &  G  &  levels = Ground_level Number \\
C                   &  I  &  levels = sea-Ice_level Number \\
C       \end{tabular}
C     \end{center}

C     !USES:
      IMPLICIT NONE
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "DIAGNOSTICS_SIZE.h"
#include "DIAGNOSTICS.h"

C     !INPUT PARAMETERS:
      INTEGER myThid
CEOP

C     !LOCAL VARIABLES:
      INTEGER n

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

      _BEGIN_MASTER( myThid )

      DO n=1,ndiagMax
        kdiag(n) = 0
        hdiag(n) = 0
        cdiag(n) = '        '
        gdiag(n) = '                '
        udiag(n) = '                '
        tdiag(n) = ' '
      ENDDO

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
C     For each output variable,
C     specify Name (cdiag, 8c), Descriptions (tdiag, *c), Units (udiag, 16c)
C         and parsing code (location on C grid, 2D/3D, ...) (gdiag, 16c)
C----------------------------------------------------------------------
      cdiag( 1) = 'SDIAG1  '
      tdiag( 1) = 'User-Defined   Surface   Diagnostic  #1 '
      udiag( 1) = 'user-defined    '
      gdiag( 1) = 'SM      L1      '

      cdiag( 2) = 'SDIAG2  '
      tdiag( 2) = 'User-Defined   Surface   Diagnostic  #2 '
      udiag( 2) = 'user-defined    '
      gdiag( 2) = 'SM      L1      '

      cdiag( 3) = 'SDIAG3  '
      tdiag( 3) = 'User-Defined   Surface   Diagnostic  #3 '
      udiag( 3) = 'user-defined    '
      gdiag( 3) = 'SM      L1      '

      cdiag( 4) = 'SDIAG4  '
      tdiag( 4) = 'User-Defined   Surface   Diagnostic  #4 '
      udiag( 4) = 'user-defined    '
      gdiag( 4) = 'SM      L1      '

      cdiag( 5) = 'SDIAG5  '
      tdiag( 5) = 'User-Defined   Surface   Diagnostic  #5 '
      udiag( 5) = 'user-defined    '
      gdiag( 5) = 'SM      L1      '

      cdiag( 6) = 'SDIAG6  '
      tdiag( 6) = 'User-Defined   Surface   Diagnostic  #6 '
      udiag( 6) = 'user-defined    '
      gdiag( 6) = 'SM      L1      '

      cdiag( 7) = 'SDIAG7  '
      tdiag( 7) = 'User-Defined U.pt Surface Diagnostic #7 '
      udiag( 7) = 'user-defined    '
      gdiag( 7) = 'SU      L1      '

      cdiag( 8) = 'SDIAG8  '
      tdiag( 8) = 'User-Defined V.pt Surface Diagnostic #8 '
      udiag( 8) = 'user-defined    '
      gdiag( 8) = 'SV      L1      '

      cdiag( 9) = 'SDIAG9  '
      tdiag( 9) = 'User-Defined U.vector Surface Diag.  #9 '
      udiag( 9) = 'user-defined    '
      gdiag( 9) = 'UU      L1      '
      hdiag( 9) =  10

      cdiag(10) = 'SDIAG10 '
      tdiag(10) = 'User-Defined V.vector Surface Diag. #10 '
      udiag(10) = 'user-defined    '
      gdiag(10) = 'VV      L1      '
      hdiag(10) =  9

      cdiag(11) = 'UDIAG1  '
      tdiag(11) = 'User-Defined Model-Level Diagnostic  #1 '
      udiag(11) = 'user-defined    '
      gdiag(11) = 'SM      MR      '

      cdiag(12) = 'UDIAG2  '
      tdiag(12) = 'User-Defined Model-Level Diagnostic  #2 '
      udiag(12) = 'user-defined    '
      gdiag(12) = 'SM      MR      '

      cdiag(13) = 'UDIAG3  '
      tdiag(13) = 'User-Defined Model-Level Diagnostic  #3 '
      udiag(13) = 'user-defined    '
      gdiag(13) = 'SMR     MR      '

      cdiag(14) = 'UDIAG4  '
      tdiag(14) = 'User-Defined Model-Level Diagnostic  #4 '
      udiag(14) = 'user-defined    '
      gdiag(14) = 'SMR     MR      '

      cdiag(15) = 'UDIAG5  '
      tdiag(15) = 'User-Defined U.pt Model-Level Diag.  #5 '
      udiag(15) = 'user-defined    '
      gdiag(15) = 'SU      MR      '

      cdiag(16) = 'UDIAG6  '
      tdiag(16) = 'User-Defined V.pt Model-Level Diag.  #6 '
      udiag(16) = 'user-defined    '
      gdiag(16) = 'SV      MR      '

      cdiag(17) = 'UDIAG7  '
      tdiag(17) = 'User-Defined U.vector Model-Lev Diag.#7 '
      udiag(17) = 'user-defined    '
      gdiag(17) = 'UUR     MR      '
      hdiag(17) =  18

      cdiag(18) = 'UDIAG8  '
      tdiag(18) = 'User-Defined V.vector Model-Lev Diag.#8 '
      udiag(18) = 'user-defined    '
      gdiag(18) = 'VVR     MR      '
      hdiag(18) =  17

      cdiag(19) = 'UDIAG9  '
      tdiag(19) = 'User-Defined Phys-Level  Diagnostic  #9 '
      udiag(19) = 'user-defined    '
      gdiag(19) = 'SM      ML      '

      cdiag(20) = 'UDIAG10 '
      tdiag(20) = 'User-Defined Phys-Level  Diagnostic #10 '
      udiag(20) = 'user-defined    '
      gdiag(20) = 'SM      ML      '

      cdiag(21) = 'SDIAGC  '
      tdiag(21) = 'User-Defined Counted Surface Diagnostic '
      udiag(21) = 'user-defined    '
      gdiag(21) = 'SM  C   L1      '
      hdiag(21) =  22

      cdiag(22) = 'SDIAGCC '
      tdiag(22) = 'User-Defined Surface Diagnostic Counter '
      udiag(22) = 'count           '
      gdiag(22) = 'SM      L1      '

C-    set the total number of available diagnostics
      ndiagt = 22

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

      _END_MASTER( myThid )
      _BARRIER

      RETURN
      END
1	jmc	1.15	C $Header: /u/gcmpack/MITgcm/pkg/diagnostics/diagnostics_init_early.F,v 1.14 2008/11/15 19:51:41 jmc Exp $
2	jmc	1.1	C $Name: $
3
4			#include "DIAG_OPTIONS.h"
5
6			C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
7			CBOP 0
8			C !ROUTINE: DIAGNOSTICS_INIT_EARLY
9
10			C !INTERFACE:
11			SUBROUTINE DIAGNOSTICS_INIT_EARLY( myThid )
12
13			C !DESCRIPTION:
14			C Initialize available diagnostics list: set the following attributes:
15			C name (=cdiag), parsing code (=gdiag), units (=udiag), and title (=tdiag)
16	jmc	1.11	C Note: 1) diagnostics defined here are not presently filled. To use
17			C one of them, one just needs to add a call to S/R DIAGNOSTICS_FILL
18			C with the diagnostic name 'SDIAG...' or 'UDIAG...'
19	jmc	1.1	C 2) GDIAG is defined as character16 and can be to character1
20			C parse(16) with the following codes currently defined:
21
22			C \begin{center}
23			C \begin{tabular}[h]{\|c\|c\|}\hline
24			C \textbf{Positions} & \textbf{Characters}
25			C & \textbf{Meanings} \\\hline
26			C parse(1) & S & scalar \\
27	jmc	1.3	C & U & vector component in X direction \\
28			C & V & vector component in Y direction \\
29			C & W & vector component in vertical direction \\
30	jmc	1.1	C parse(2) & U & C-grid U-Point \\
31			C & V & C-grid V-Point \\
32			C & M & C-grid Mass Point \\
33			C & Z & C-grid Corner Point \\
34	jmc	1.15	C parse(3) & & Used for Level Integrated output: cumulate levels \\
35			C & r & same but cumulate product by model level thickness \\
36			C & R & same but cumulate product by hFac & level thickness \\
37	jmc	1.1	C parse(4) & P & positive definite \\
38			C parse(5 ) & C & with counter array \\
39			C & D & disable an array for output \\
40	jmc	1.15	C parse(6--8) & '123' & retired, formerly: 3-digit mate number \\
41	jmc	1.1	C parse(9) & U & model-level plus 1/2 \\
42			C & M & model-level middle \\
43			C & L & model-level minus 1/2 \\
44			C parse(10) & 0 & levels = 0 \\
45			C & 1 & levels = 1 \\
46			C & R & levels = Nr \\
47			C & L & levels = MAX(Nr,NrPhys) \\
48			C & M & levels = MAX(Nr,NrPhys) - 1 \\
49	jmc	1.7	C & G & levels = Ground_level Number \\
50			C & I & levels = sea-Ice_level Number \\
51	jmc	1.1	C \end{tabular}
52			C \end{center}
53
54			C !USES:
55	jmc	1.12	IMPLICIT NONE
56	jmc	1.1	#include "SIZE.h"
57			#include "EEPARAMS.h"
58			#include "PARAMS.h"
59			#include "DIAGNOSTICS_SIZE.h"
60			#include "DIAGNOSTICS.h"
61
62			C !INPUT PARAMETERS:
63	jmc	1.12	INTEGER myThid
64	jmc	1.1	CEOP
65
66	jmc	1.12	C !LOCAL VARIABLES:
67			INTEGER n
68	jmc	1.1
69	jmc	1.12	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
70
71			_BEGIN_MASTER( myThid )
72
73			DO n=1,ndiagMax
74	jmc	1.1	kdiag(n) = 0
75	jmc	1.13	hdiag(n) = 0
76	jmc	1.1	cdiag(n) = ' '
77			gdiag(n) = ' '
78			udiag(n) = ' '
79			tdiag(n) = ' '
80	jmc	1.12	ENDDO
81	jmc	1.1
82			C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
83			C For each output variable,
84	jmc	1.11	C specify Name (cdiag, 8c), Descriptions (tdiag, *c), Units (udiag, 16c)
85	jmc	1.1	C and parsing code (location on C grid, 2D/3D, ...) (gdiag, 16c)
86			C----------------------------------------------------------------------
87	jmc	1.15	cdiag( 1) = 'SDIAG1 '
88			tdiag( 1) = 'User-Defined Surface Diagnostic #1 '
89			udiag( 1) = 'user-defined '
90			gdiag( 1) = 'SM L1 '
91
92			cdiag( 2) = 'SDIAG2 '
93			tdiag( 2) = 'User-Defined Surface Diagnostic #2 '
94			udiag( 2) = 'user-defined '
95			gdiag( 2) = 'SM L1 '
96	molod	1.10
97			cdiag( 3) = 'SDIAG3 '
98	jmc	1.15	tdiag( 3) = 'User-Defined Surface Diagnostic #3 '
99	molod	1.10	udiag( 3) = 'user-defined '
100			gdiag( 3) = 'SM L1 '
101
102			cdiag( 4) = 'SDIAG4 '
103	jmc	1.15	tdiag( 4) = 'User-Defined Surface Diagnostic #4 '
104	molod	1.10	udiag( 4) = 'user-defined '
105			gdiag( 4) = 'SM L1 '
106
107			cdiag( 5) = 'SDIAG5 '
108	jmc	1.15	tdiag( 5) = 'User-Defined Surface Diagnostic #5 '
109	molod	1.10	udiag( 5) = 'user-defined '
110			gdiag( 5) = 'SM L1 '
111
112			cdiag( 6) = 'SDIAG6 '
113	jmc	1.15	tdiag( 6) = 'User-Defined Surface Diagnostic #6 '
114	molod	1.10	udiag( 6) = 'user-defined '
115			gdiag( 6) = 'SM L1 '
116
117			cdiag( 7) = 'SDIAG7 '
118	jmc	1.15	tdiag( 7) = 'User-Defined U.pt Surface Diagnostic #7 '
119	molod	1.10	udiag( 7) = 'user-defined '
120	jmc	1.15	gdiag( 7) = 'SU L1 '
121	molod	1.10
122			cdiag( 8) = 'SDIAG8 '
123	jmc	1.15	tdiag( 8) = 'User-Defined V.pt Surface Diagnostic #8 '
124	molod	1.10	udiag( 8) = 'user-defined '
125	jmc	1.15	gdiag( 8) = 'SV L1 '
126	molod	1.10
127			cdiag( 9) = 'SDIAG9 '
128	jmc	1.15	tdiag( 9) = 'User-Defined U.vector Surface Diag. #9 '
129	molod	1.10	udiag( 9) = 'user-defined '
130	jmc	1.15	gdiag( 9) = 'UU L1 '
131			hdiag( 9) = 10
132	molod	1.10
133			cdiag(10) = 'SDIAG10 '
134	jmc	1.15	tdiag(10) = 'User-Defined V.vector Surface Diag. #10 '
135	molod	1.10	udiag(10) = 'user-defined '
136	jmc	1.15	gdiag(10) = 'VV L1 '
137			hdiag(10) = 9
138	molod	1.10
139	jmc	1.14	cdiag(11) = 'UDIAG1 '
140	jmc	1.15	tdiag(11) = 'User-Defined Model-Level Diagnostic #1 '
141	jmc	1.14	udiag(11) = 'user-defined '
142			gdiag(11) = 'SM MR '
143
144			cdiag(12) = 'UDIAG2 '
145	jmc	1.15	tdiag(12) = 'User-Defined Model-Level Diagnostic #2 '
146	jmc	1.14	udiag(12) = 'user-defined '
147			gdiag(12) = 'SM MR '
148	molod	1.10
149			cdiag(13) = 'UDIAG3 '
150	jmc	1.15	tdiag(13) = 'User-Defined Model-Level Diagnostic #3 '
151	molod	1.10	udiag(13) = 'user-defined '
152	jmc	1.15	gdiag(13) = 'SMR MR '
153	molod	1.10
154			cdiag(14) = 'UDIAG4 '
155	jmc	1.15	tdiag(14) = 'User-Defined Model-Level Diagnostic #4 '
156	molod	1.10	udiag(14) = 'user-defined '
157	jmc	1.15	gdiag(14) = 'SMR MR '
158	molod	1.10
159			cdiag(15) = 'UDIAG5 '
160	jmc	1.15	tdiag(15) = 'User-Defined U.pt Model-Level Diag. #5 '
161	molod	1.10	udiag(15) = 'user-defined '
162	jmc	1.15	gdiag(15) = 'SU MR '
163	molod	1.10
164			cdiag(16) = 'UDIAG6 '
165	jmc	1.15	tdiag(16) = 'User-Defined V.pt Model-Level Diag. #6 '
166	molod	1.10	udiag(16) = 'user-defined '
167	jmc	1.15	gdiag(16) = 'SV MR '
168	molod	1.10
169			cdiag(17) = 'UDIAG7 '
170	jmc	1.15	tdiag(17) = 'User-Defined U.vector Model-Lev Diag.#7 '
171	molod	1.10	udiag(17) = 'user-defined '
172	jmc	1.15	gdiag(17) = 'UUR MR '
173			hdiag(17) = 18
174	molod	1.10
175			cdiag(18) = 'UDIAG8 '
176	jmc	1.15	tdiag(18) = 'User-Defined V.vector Model-Lev Diag.#8 '
177	molod	1.10	udiag(18) = 'user-defined '
178	jmc	1.15	gdiag(18) = 'VVR MR '
179			hdiag(18) = 17
180	molod	1.10
181			cdiag(19) = 'UDIAG9 '
182	jmc	1.15	tdiag(19) = 'User-Defined Phys-Level Diagnostic #9 '
183	molod	1.10	udiag(19) = 'user-defined '
184			gdiag(19) = 'SM ML '
185
186			cdiag(20) = 'UDIAG10 '
187	jmc	1.15	tdiag(20) = 'User-Defined Phys-Level Diagnostic #10 '
188	molod	1.10	udiag(20) = 'user-defined '
189			gdiag(20) = 'SM ML '
190
191			cdiag(21) = 'SDIAGC '
192	jmc	1.14	tdiag(21) = 'User-Defined Counted Surface Diagnostic '
193	molod	1.10	udiag(21) = 'user-defined '
194	jmc	1.13	gdiag(21) = 'SM C L1 '
195			hdiag(21) = 22
196	molod	1.10
197			cdiag(22) = 'SDIAGCC '
198	jmc	1.14	tdiag(22) = 'User-Defined Surface Diagnostic Counter '
199	molod	1.10	udiag(22) = 'count '
200	jmc	1.13	gdiag(22) = 'SM L1 '
201	molod	1.9
202	jmc	1.12	C- set the total number of available diagnostics
203	molod	1.10	ndiagt = 22
204	jmc	1.1
205	jmc	1.12	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
206
207			_END_MASTER( myThid )
208			_BARRIER
209	jmc	1.1
210			RETURN
211			END