atnguyen/code_21Dec2012_saltplume/salt_plume_diagnostics_init.F

C $Header: /u/gcmpack/MITgcm_contrib/atnguyen/code_21Dec2012_saltplume/salt_plume_diagnostics_init.F,v 1.1 2014/04/20 09:00:36 atn Exp $
C $Name:  $

#include "SALT_PLUME_OPTIONS.h"

CBOP 0
C     !ROUTINE: SALT_PLUME_DIAGNOSTICS_INIT
C     !INTERFACE:
      SUBROUTINE SALT_PLUME_DIAGNOSTICS_INIT( myThid )

C     !DESCRIPTION:
C     Initialize list of all available diagnostics

C     !USES:
      IMPLICIT NONE
#include "EEPARAMS.h"

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

#ifdef ALLOW_SALT_PLUME
#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

      diagName  = 'PLUMEKB '
      diagTitle = 'fractional plume: [0-1] (unitless)'
      diagUnits = '                '
      diagCode  = 'SM      MR      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I       diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'oceSPtnd'
      diagTitle = 'salt tendency due to salt plume flux' 
     &          //' >0 increases salinity'
      diagUnits = 'g/m^2/s         '
      diagCode  = 'SM      MR      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I       diagName, diagCode, diagUnits, diagTitle, 0, myThid )

#ifdef SALT_PLUME_VOLUME
      diagName  = 'oceEPtnd'
      diagTitle = 'Energy tendency associated with salt plume flux'
     &          //' >0 increases temperature'
      diagUnits = 'W/m^2           '
      diagCode  = 'SM      MR      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I       diagName, diagCode, diagUnits, diagTitle, 0, myThid )
c
      diagName  = 'SPkbottm'
      diagTitle = ''
     &          //' range [1:Nr] '
      diagUnits = 'unitless        '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I       diagName, diagCode, diagUnits, diagTitle, 0, myThid )
c
      diagName  = 'SPbrineS'
      diagTitle = 'Salinity of brine as fxn of input SPalpha'
      diagUnits = 'psu             '
      diagCode  = 'SM      U1      '
c
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I       diagName, diagCode, diagUnits, diagTitle, 0, myThid )
      diagName  = 'SPVsuf2k'
      diagTitle = 'salt plume volume flux from surface INTO lev k'
     &          //' >0 increases volume(k)'
      diagUnits = 'm/s             '
      diagCode  = 'SM      MR      '
c
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I       diagName, diagCode, diagUnits, diagTitle, 0, myThid )
      diagName  = 'SPVp2k  '
      diagTitle = 'vol flux from k+1 INTO k due to SPVsuf2k'
     &          //' >0 increases volume(k)'
      diagUnits = 'm/s             '
      diagCode  = 'SM      MR      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I       diagName, diagCode, diagUnits, diagTitle, 0, myThid )
c
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I       diagName, diagCode, diagUnits, diagTitle, 0, myThid )
      diagName  = 'SPVk2m  '
      diagTitle = 'vol flux LEAVING k to k-1 due to SPVsuf2k&SPVp2k'
     &          //' <0 decreases volume(k)'
      diagUnits = 'm/s             '
      diagCode  = 'SM      MR      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I       diagName, diagCode, diagUnits, diagTitle, 0, myThid )
#endif /* SALT_PLUME_VOLUME */

      diagName  = 'oceSPflx'
      diagTitle = 'net surface Salt flux rejected into the ocean during'
     &          //' freezing, (+=down),'
c    &          //' >0 increases salinity'
      diagUnits = 'g/m^2/s         '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I       diagName, diagCode, diagUnits, diagTitle, 0, myThid )

      diagName  = 'oceSPDep'
      diagTitle = 'Salt plume depth based on density criterion (>0)'
      diagUnits = 'm               '
      diagCode  = 'SM      U1      '
      CALL DIAGNOSTICS_ADDTOLIST( diagNum,
     I       diagName, diagCode, diagUnits, diagTitle, 0, myThid )

#endif /* ALLOW_DIAGNOSTICS */
#endif /* ALLOW_SALT_PLUME */

      RETURN
      END
1	atn	1.2	C $Header: /u/gcmpack/MITgcm_contrib/atnguyen/code_21Dec2012_saltplume/salt_plume_diagnostics_init.F,v 1.1 2014/04/20 09:00:36 atn Exp $
2	atn	1.1	C $Name: $
3
4			#include "SALT_PLUME_OPTIONS.h"
5
6			CBOP 0
7			C !ROUTINE: SALT_PLUME_DIAGNOSTICS_INIT
8			C !INTERFACE:
9			SUBROUTINE SALT_PLUME_DIAGNOSTICS_INIT( myThid )
10
11			C !DESCRIPTION:
12			C Initialize list of all available diagnostics
13
14			C !USES:
15			IMPLICIT NONE
16			#include "EEPARAMS.h"
17
18			C !INPUT/OUTPUT PARAMETERS:
19			C myThid :: my Thread Id number
20			INTEGER myThid
21			CEOP
22
23			#ifdef ALLOW_SALT_PLUME
24			#ifdef ALLOW_DIAGNOSTICS
25
26			C !LOCAL VARIABLES:
27			C === Local variables ===
28			C diagNum :: diagnostics number in the (long) list of available diag.
29			C diagName :: local short name (8c) of a diagnostics
30			C diagCode :: local parser field with characteristics of the diagnostics
31			C cf head of S/R DIAGNOSTICS_INIT_EARLY or DIAGNOSTICS_MAIN_INIT
32			C diagUnits :: local string (16c): physical units of a diagnostic field
33			C diagTitle :: local string (80c): description of field in diagnostic
34			INTEGER diagNum
35			CHARACTER*8 diagName
36			CHARACTER*16 diagCode
37			CHARACTER*16 diagUnits
38			CHARACTER*(80) diagTitle
39
40			diagName = 'PLUMEKB '
41			diagTitle = 'fractional plume: [0-1] (unitless)'
42			diagUnits = ' '
43			diagCode = 'SM MR '
44			CALL DIAGNOSTICS_ADDTOLIST( diagNum,
45			I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
46
47			diagName = 'oceSPtnd'
48			diagTitle = 'salt tendency due to salt plume flux'
49			& //' >0 increases salinity'
50			diagUnits = 'g/m^2/s '
51			diagCode = 'SM MR '
52			CALL DIAGNOSTICS_ADDTOLIST( diagNum,
53			I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
54
55			#ifdef SALT_PLUME_VOLUME
56			diagName = 'oceEPtnd'
57			diagTitle = 'Energy tendency associated with salt plume flux'
58			& //' >0 increases temperature'
59			diagUnits = 'W/m^2 '
60			diagCode = 'SM MR '
61			CALL DIAGNOSTICS_ADDTOLIST( diagNum,
62			I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
63	atn	1.2	c
64			diagName = 'SPkbottm'
65			diagTitle = ''
66			& //' range [1:Nr] '
67			diagUnits = 'unitless '
68			diagCode = 'SM U1 '
69			CALL DIAGNOSTICS_ADDTOLIST( diagNum,
70			I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
71			c
72			diagName = 'SPbrineS'
73			diagTitle = 'Salinity of brine as fxn of input SPalpha'
74			diagUnits = 'psu '
75			diagCode = 'SM U1 '
76			c
77			CALL DIAGNOSTICS_ADDTOLIST( diagNum,
78			I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
79			diagName = 'SPVsuf2k'
80			diagTitle = 'salt plume volume flux from surface INTO lev k'
81			& //' >0 increases volume(k)'
82			diagUnits = 'm/s '
83			diagCode = 'SM MR '
84			c
85			CALL DIAGNOSTICS_ADDTOLIST( diagNum,
86			I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
87			diagName = 'SPVp2k '
88			diagTitle = 'vol flux from k+1 INTO k due to SPVsuf2k'
89			& //' >0 increases volume(k)'
90			diagUnits = 'm/s '
91			diagCode = 'SM MR '
92			CALL DIAGNOSTICS_ADDTOLIST( diagNum,
93			I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
94			c
95			CALL DIAGNOSTICS_ADDTOLIST( diagNum,
96			I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
97			diagName = 'SPVk2m '
98			diagTitle = 'vol flux LEAVING k to k-1 due to SPVsuf2k&SPVp2k'
99			& //' <0 decreases volume(k)'
100			diagUnits = 'm/s '
101			diagCode = 'SM MR '
102			CALL DIAGNOSTICS_ADDTOLIST( diagNum,
103			I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
104	atn	1.1	#endif /* SALT_PLUME_VOLUME */
105
106			diagName = 'oceSPflx'
107			diagTitle = 'net surface Salt flux rejected into the ocean during'
108			& //' freezing, (+=down),'
109			c & //' >0 increases salinity'
110			diagUnits = 'g/m^2/s '
111			diagCode = 'SM U1 '
112			CALL DIAGNOSTICS_ADDTOLIST( diagNum,
113			I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
114
115			diagName = 'oceSPDep'
116			diagTitle = 'Salt plume depth based on density criterion (>0)'
117			diagUnits = 'm '
118			diagCode = 'SM U1 '
119			CALL DIAGNOSTICS_ADDTOLIST( diagNum,
120			I diagName, diagCode, diagUnits, diagTitle, 0, myThid )
121
122			#endif /* ALLOW_DIAGNOSTICS */
123			#endif /* ALLOW_SALT_PLUME */
124
125			RETURN
126			END