model/src/do_statevars_diags.F

C $Header: /u/gcmpack/MITgcm/model/src/do_statevars_diags.F,v 1.17 2012/03/02 01:45:22 dimitri Exp $
C $Name:  $

#include "PACKAGES_CONFIG.h"
#include "CPP_OPTIONS.h"


CBOP
C     !ROUTINE: DO_STATEVARS_DIAGS
C     !INTERFACE:
      SUBROUTINE DO_STATEVARS_DIAGS( myTime, seqFlag, myIter, myThid )
C     !DESCRIPTION: \bv
C     *==========================================================*
C     | SUBROUTINE DO_STATEVARS_DIAGS
C     | o Controlling routine for state variables diagnostics
C     *==========================================================*
C     | Computing diagnostics of the model state (state-variables)
C     | is done at this level ;
C     | by contrast, other diagnostics (fluxes, tendencies)
C     | remain within the computation sequence.
C     *==========================================================*
C     \ev

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

C     !INPUT/OUTPUT PARAMETERS:
C     == Routine arguments ==
C     myTime  :: Current time of simulation ( s )
C     seqFlag :: flag that indicate where this S/R is called from:
C             :: =0 called from the beginning of forward_step
C             :: =1 called from the middle of forward_step
C             :: =2 called from the end of forward_step
C     myIter  :: Iteration number
C     myThid  :: my Thread Id number
      _RL     myTime
      INTEGER seqFlag
      INTEGER myIter
      INTEGER myThid
CEOP

#ifdef ALLOW_DIAGNOSTICS
C     !LOCAL VARIABLES:
C     == Local variables ==
C     selectVars :: select which group of dianostics variables to fill-in
C            = 1 :: fill-in diagnostics for tracer   variables only
C            = 2 :: fill-in diagnostics for momentum variables only
C            = 3 :: fill-in diagnostics for momentum & tracer variables
C            = 4 :: fill-in state variable tendency diagnostics the second time
C     bi,bj      :: tile indices
      INTEGER selectVars
#if defined(ALLOW_THSICE) || defined(ALLOW_LAND)
      INTEGER bi, bj
#endif

C--   Fill-in Diagnostics pkg storage array (for state-variables)
      IF ( usediagnostics ) THEN

C-    select which group of state-var diagnostics to fill-in,
C      depending on: where this S/R is called from (seqFlag)
C                    and stagger/synchronous TimeStep
        selectVars = 0
        IF ( staggerTimeStep ) THEN
          IF ( seqFlag.EQ.0 ) selectVars = 2
          IF ( seqFlag.EQ.1 ) selectVars = 1
        ELSE
          IF ( seqFlag.EQ.0 ) selectVars = 3
        ENDIF
        IF ( seqFlag.EQ.2 ) selectVars = 4
        CALL DIAGNOSTICS_FILL_STATE( selectVars, myIter, myThid )

#ifdef ALLOW_GENERIC_ADVDIFF
        IF ( seqFlag.EQ.0 .AND. useGAD ) THEN
          CALL GAD_DIAGNOSTICS_STATE( myTime, myIter, myThid )
        ENDIF
#endif /* ALLOW_GENERIC_ADVDIFF */

#ifdef ALLOW_PTRACERS
        IF ( (selectVars.EQ.1 .OR. selectVars.EQ.3)
     &      .AND. usePTRACERS ) THEN
          CALL PTRACERS_DIAGNOSTICS_STATE( myTime, myIter, myThid )
        ENDIF
#endif /* ALLOW_PTRACERS */

#ifdef ALLOW_GMREDI
       IF ( seqFlag.EQ.2 .AND. useGMRedi ) THEN
         CALL GMREDI_DIAGNOSTICS_IMPL( myTime, myIter, myThid )
       ENDIF
#endif /* ALLOW_GMREDI */

#ifdef ALLOW_BBL
       IF ( seqFlag.EQ.0 .AND. useBBL ) THEN
         CALL BBL_DIAGNOSTICS_STATE( myTime, myIter, myThid )
       ENDIF
#endif /* ALLOW_BBL */

#ifdef ALLOW_FRAZIL
       IF ( seqFlag.EQ.0 .AND. useFRAZIL ) THEN
        CALL FRAZIL_DIAGNOSTICS_STATE( myTime, myIter, myThid )
       ENDIF
#endif /* ALLOW_FRAZIL */

#ifdef ALLOW_SEAICE
       IF ( seqFlag.EQ.0 .AND. useSEAICE ) THEN
        CALL SEAICE_DIAGNOSTICS_STATE( myTime, myIter, myThid )
       ENDIF
#endif /* ALLOW_SEAICE */

#ifdef ALLOW_THSICE
       IF ( seqFlag.EQ.0 .AND. useThSIce ) THEN
        DO bj=myByLo(myThid),myByHi(myThid)
         DO bi=myBxLo(myThid),myBxHi(myThid)
          CALL THSICE_DIAGNOSTICS_STATE( myTime,myIter,bi,bj,myThid )
         ENDDO
        ENDDO
       ENDIF
#endif /* ALLOW_THSICE */

#ifdef ALLOW_LAND
       IF ( seqFlag.EQ.0 .AND. useLand ) THEN
        DO bj=myByLo(myThid),myByHi(myThid)
         DO bi=myBxLo(myThid),myBxHi(myThid)
          CALL LAND_DIAGNOSTICS_STATE( myTime,myIter, bi,bj, myThid )
         ENDDO
        ENDDO
       ENDIF
#endif /* ALLOW_LAND */

#ifdef ALLOW_MYPACKAGE
       IF ( seqFlag.EQ.0 .AND. useMYPACKAGE ) THEN
         CALL MYPACKAGE_DIAGNOSTICS_STATE( myTime, myIter, myThid )
       ENDIF
#endif /* ALLOW_MYPACKAGE */

      ENDIf
#endif /* ALLOW_DIAGNOSTICS */

      RETURN
      END
1	jmc	1.18	C $Header: /u/gcmpack/MITgcm/model/src/do_statevars_diags.F,v 1.17 2012/03/02 01:45:22 dimitri Exp $
2	jmc	1.1	C $Name: $
3
4			#include "PACKAGES_CONFIG.h"
5			#include "CPP_OPTIONS.h"
6
7
8			CBOP
9			C !ROUTINE: DO_STATEVARS_DIAGS
10			C !INTERFACE:
11	jmc	1.5	SUBROUTINE DO_STATEVARS_DIAGS( myTime, seqFlag, myIter, myThid )
12	jmc	1.1	C !DESCRIPTION: \bv
13			C ==========================================================
14	jmc	1.10	C \| SUBROUTINE DO_STATEVARS_DIAGS
15	jmc	1.1	C \| o Controlling routine for state variables diagnostics
16			C ==========================================================
17	jmc	1.10	C \| Computing diagnostics of the model state (state-variables)
18			C \| is done at this level ;
19			C \| by contrast, other diagnostics (fluxes, tendencies)
20			C \| remain within the computation sequence.
21	jmc	1.1	C ==========================================================
22			C \ev
23
24			C !USES:
25			IMPLICIT NONE
26			C == Global variables ===
27			#include "SIZE.h"
28			#include "EEPARAMS.h"
29			#include "PARAMS.h"
30
31			C !INPUT/OUTPUT PARAMETERS:
32			C == Routine arguments ==
33	jmc	1.5	C myTime :: Current time of simulation ( s )
34			C seqFlag :: flag that indicate where this S/R is called from:
35			C :: =0 called from the beginning of forward_step
36			C :: =1 called from the middle of forward_step
37	molod	1.8	C :: =2 called from the end of forward_step
38	jmc	1.5	C myIter :: Iteration number
39	jmc	1.16	C myThid :: my Thread Id number
40	jmc	1.1	_RL myTime
41	jmc	1.5	INTEGER seqFlag
42	jmc	1.1	INTEGER myIter
43			INTEGER myThid
44			CEOP
45
46	jmc	1.5	#ifdef ALLOW_DIAGNOSTICS
47	jmc	1.1	C !LOCAL VARIABLES:
48	jmc	1.5	C == Local variables ==
49			C selectVars :: select which group of dianostics variables to fill-in
50			C = 1 :: fill-in diagnostics for tracer variables only
51			C = 2 :: fill-in diagnostics for momentum variables only
52			C = 3 :: fill-in diagnostics for momentum & tracer variables
53	jmc	1.10	C = 4 :: fill-in state variable tendency diagnostics the second time
54	jmc	1.6	C bi,bj :: tile indices
55	jmc	1.5	INTEGER selectVars
56	jmc	1.11	#if defined(ALLOW_THSICE) \|\| defined(ALLOW_LAND)
57	jmc	1.6	INTEGER bi, bj
58	jmc	1.11	#endif
59	jmc	1.1
60	jmc	1.5	C-- Fill-in Diagnostics pkg storage array (for state-variables)
61			IF ( usediagnostics ) THEN
62	jmc	1.1
63	jmc	1.10	C- select which group of state-var diagnostics to fill-in,
64			C depending on: where this S/R is called from (seqFlag)
65	jmc	1.5	C and stagger/synchronous TimeStep
66			selectVars = 0
67	jmc	1.10	IF ( staggerTimeStep ) THEN
68	jmc	1.5	IF ( seqFlag.EQ.0 ) selectVars = 2
69			IF ( seqFlag.EQ.1 ) selectVars = 1
70			ELSE
71			IF ( seqFlag.EQ.0 ) selectVars = 3
72			ENDIF
73	molod	1.8	IF ( seqFlag.EQ.2 ) selectVars = 4
74	jmc	1.16	CALL DIAGNOSTICS_FILL_STATE( selectVars, myIter, myThid )
75	jmc	1.1
76	jmc	1.13	#ifdef ALLOW_GENERIC_ADVDIFF
77			IF ( seqFlag.EQ.0 .AND. useGAD ) THEN
78			CALL GAD_DIAGNOSTICS_STATE( myTime, myIter, myThid )
79			ENDIF
80			#endif /* ALLOW_GENERIC_ADVDIFF */
81
82	jmc	1.5	#ifdef ALLOW_PTRACERS
83			IF ( (selectVars.EQ.1 .OR. selectVars.EQ.3)
84	jmc	1.10	& .AND. usePTRACERS ) THEN
85	jahn	1.14	CALL PTRACERS_DIAGNOSTICS_STATE( myTime, myIter, myThid )
86	jmc	1.1	ENDIF
87	jmc	1.16	#endif /* ALLOW_PTRACERS */
88	jmc	1.1
89	jmc	1.18	#ifdef ALLOW_GMREDI
90			IF ( seqFlag.EQ.2 .AND. useGMRedi ) THEN
91			CALL GMREDI_DIAGNOSTICS_IMPL( myTime, myIter, myThid )
92			ENDIF
93			#endif /* ALLOW_GMREDI */
94
95	dimitri	1.15	#ifdef ALLOW_BBL
96			IF ( seqFlag.EQ.0 .AND. useBBL ) THEN
97			CALL BBL_DIAGNOSTICS_STATE( myTime, myIter, myThid )
98			ENDIF
99	jmc	1.16	#endif /* ALLOW_BBL */
100	dimitri	1.15
101	dimitri	1.17	#ifdef ALLOW_FRAZIL
102			IF ( seqFlag.EQ.0 .AND. useFRAZIL ) THEN
103			CALL FRAZIL_DIAGNOSTICS_STATE( myTime, myIter, myThid )
104			ENDIF
105			#endif /* ALLOW_FRAZIL */
106
107	mlosch	1.9	#ifdef ALLOW_SEAICE
108			IF ( seqFlag.EQ.0 .AND. useSEAICE ) THEN
109	jmc	1.10	CALL SEAICE_DIAGNOSTICS_STATE( myTime, myIter, myThid )
110	mlosch	1.9	ENDIF
111			#endif /* ALLOW_SEAICE */
112
113	jmc	1.6	#ifdef ALLOW_THSICE
114			IF ( seqFlag.EQ.0 .AND. useThSIce ) THEN
115			DO bj=myByLo(myThid),myByHi(myThid)
116			DO bi=myBxLo(myThid),myBxHi(myThid)
117	jmc	1.10	CALL THSICE_DIAGNOSTICS_STATE( myTime,myIter,bi,bj,myThid )
118	jmc	1.6	ENDDO
119			ENDDO
120			ENDIF
121			#endif /* ALLOW_THSICE */
122
123	jmc	1.7	#ifdef ALLOW_LAND
124			IF ( seqFlag.EQ.0 .AND. useLand ) THEN
125			DO bj=myByLo(myThid),myByHi(myThid)
126			DO bi=myBxLo(myThid),myBxHi(myThid)
127	jmc	1.10	CALL LAND_DIAGNOSTICS_STATE( myTime,myIter, bi,bj, myThid )
128	jmc	1.7	ENDDO
129			ENDDO
130			ENDIF
131			#endif /* ALLOW_LAND */
132
133	jmc	1.12	#ifdef ALLOW_MYPACKAGE
134			IF ( seqFlag.EQ.0 .AND. useMYPACKAGE ) THEN
135			CALL MYPACKAGE_DIAGNOSTICS_STATE( myTime, myIter, myThid )
136			ENDIF
137			#endif /* ALLOW_MYPACKAGE */
138
139	jmc	1.1	ENDIf
140			#endif /* ALLOW_DIAGNOSTICS */
141
142			RETURN
143			END