model/src/do_statevars_diags.F

C $Header: /u/gcmpack/MITgcm/model/src/do_statevars_diags.F,v 1.6 2005/01/31 19:45:14 jmc 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     myIter  :: Iteration number
C     myThid  :: Thread number for this instance of the routine.
      _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     bi,bj      :: tile indices
      INTEGER selectVars
      INTEGER bi, bj

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
        CALL DIAGNOSTICS_FILL_STATE(selectVars, myThid)

#ifdef ALLOW_PTRACERS
        IF ( (selectVars.EQ.1 .OR. selectVars.EQ.3)
     &      .AND. usePTRACERS ) THEN 
          CALL PTRACERS_DIAGNOSTICS_FILL(myThid)
        ENDIF
#endif

#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_FILL( 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_FILL( myTime,myIter, bi,bj, myThid )
         ENDDO
        ENDDO
       ENDIF
#endif /* ALLOW_LAND */

      ENDIf
#endif /* ALLOW_DIAGNOSTICS */

      RETURN
      END
1	jmc	1.7	C $Header: /u/gcmpack/MITgcm/model/src/do_statevars_diags.F,v 1.6 2005/01/31 19:45:14 jmc 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			C \| SUBROUTINE DO_STATEVARS_DIAGS
15			C \| o Controlling routine for state variables diagnostics
16			C ==========================================================
17	jmc	1.5	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			C myIter :: Iteration number
38			C myThid :: Thread number for this instance of the routine.
39	jmc	1.1	_RL myTime
40	jmc	1.5	INTEGER seqFlag
41	jmc	1.1	INTEGER myIter
42			INTEGER myThid
43			CEOP
44
45	jmc	1.5	#ifdef ALLOW_DIAGNOSTICS
46	jmc	1.1	C !LOCAL VARIABLES:
47	jmc	1.5	C == Local variables ==
48			C selectVars :: select which group of dianostics variables to fill-in
49			C = 1 :: fill-in diagnostics for tracer variables only
50			C = 2 :: fill-in diagnostics for momentum variables only
51			C = 3 :: fill-in diagnostics for momentum & tracer variables
52	jmc	1.6	C bi,bj :: tile indices
53	jmc	1.5	INTEGER selectVars
54	jmc	1.6	INTEGER bi, bj
55	jmc	1.1
56	jmc	1.5	C-- Fill-in Diagnostics pkg storage array (for state-variables)
57			IF ( usediagnostics ) THEN
58	jmc	1.1
59	jmc	1.5	C- select which group of state-var diagnostics to fill-in,
60			C depending on: where this S/R is called from (seqFlag)
61			C and stagger/synchronous TimeStep
62			selectVars = 0
63			IF ( staggerTimeStep ) THEN
64			IF ( seqFlag.EQ.0 ) selectVars = 2
65			IF ( seqFlag.EQ.1 ) selectVars = 1
66			ELSE
67			IF ( seqFlag.EQ.0 ) selectVars = 3
68			ENDIF
69			CALL DIAGNOSTICS_FILL_STATE(selectVars, myThid)
70	jmc	1.1
71	jmc	1.5	#ifdef ALLOW_PTRACERS
72			IF ( (selectVars.EQ.1 .OR. selectVars.EQ.3)
73			& .AND. usePTRACERS ) THEN
74			CALL PTRACERS_DIAGNOSTICS_FILL(myThid)
75	jmc	1.1	ENDIF
76	jmc	1.5	#endif
77	jmc	1.1
78	jmc	1.6	#ifdef ALLOW_THSICE
79			IF ( seqFlag.EQ.0 .AND. useThSIce ) THEN
80			DO bj=myByLo(myThid),myByHi(myThid)
81			DO bi=myBxLo(myThid),myBxHi(myThid)
82			CALL THSICE_DIAGNOSTICS_FILL( myTime,myIter, bi,bj, myThid )
83			ENDDO
84			ENDDO
85			ENDIF
86			#endif /* ALLOW_THSICE */
87
88	jmc	1.7	#ifdef ALLOW_LAND
89			IF ( seqFlag.EQ.0 .AND. useLand ) THEN
90			DO bj=myByLo(myThid),myByHi(myThid)
91			DO bi=myBxLo(myThid),myBxHi(myThid)
92			CALL LAND_DIAGNOSTICS_FILL( myTime,myIter, bi,bj, myThid )
93			ENDDO
94			ENDDO
95			ENDIF
96			#endif /* ALLOW_LAND */
97
98	jmc	1.1	ENDIf
99			#endif /* ALLOW_DIAGNOSTICS */
100
101			RETURN
102			END