model/src/do_statevars_diags.F

C $Header: /u/gcmpack/MITgcm/model/src/do_statevars_diags.F,v 1.3 2004/12/03 00:24:58 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, myIter, myThid )
C     !DESCRIPTION: \bv
C     *==========================================================*
C     | SUBROUTINE DO_STATEVARS_DIAGS                                
C     | o Controlling routine for state variables diagnostics
C     *==========================================================*
C     | Computing statistics of the model state (state-variables) 
C     | is done at this level (after updating the halo region),
C     | as opposed to other diagnostic calls (fluxes, tendencies)
C     | that remain within the computation sequence.  
C     | Note: IO are not supposed to be done at this level 
C     |       but later (in DO_THE_MODEL_IO)
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     myIter - Iteration number
C     myThid - Thread number for this instance of the routine.
      _RL     myTime
      INTEGER myIter
      INTEGER myThid

CEOP

C     !LOCAL VARIABLES:
C     == Local variables
      INTEGER bi,bj

#ifdef ALLOW_TIMEAVE
C--   Fill-in TimeAve pkg diagnostics (for state-variables)

      DO bj=myByLo(myThid),myByHi(myThid)
       DO bi=myBxLo(myThid),myBxHi(myThid)

        IF ( taveFreq.GT.0. ) THEN
          CALL TIMEAVE_STATVARS(myTime, myIter, bi, bj, myThid)
# ifdef ALLOW_PTRACERS
          IF ( usePTRACERS ) THEN       
           CALL PTRACERS_STATVARS(myTime, myIter, bi, bj, myThid)
          ENDIF 
# endif /* ALLOW_PTRACERS */
        ENDIF

C--    End of bi,bj loop
       ENDDO
      ENDDO
#endif /* ALLOW_TIMEAVE */

#ifdef ALLOW_DIAGNOSTICS
C--   Fill-in Diagnostics pkg storage array (for state-variables)

      IF ( usediagnostics ) THEN
        CALL DIAGNOSTICS_FILL_STATE(myThid)
# ifdef ALLOW_PTRACERS
       IF (usePTRACERS) THEN
        CALL PTRACERS_DIAGNOSTICS_FILL(myThid)
       ENDIF
# endif
      ENDIf

#endif /* ALLOW_DIAGNOSTICS */

      RETURN
      END
1	C $Header: /u/gcmpack/MITgcm/model/src/do_statevars_diags.F,v 1.3 2004/12/03 00:24:58 jmc Exp $
2	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	SUBROUTINE DO_STATEVARS_DIAGS( myTime, myIter, myThid )
12	C !DESCRIPTION: \bv
13	C ==========================================================
14	C \| SUBROUTINE DO_STATEVARS_DIAGS
15	C \| o Controlling routine for state variables diagnostics
16	C ==========================================================
17	C \| Computing statistics of the model state (state-variables)
18	C \| is done at this level (after updating the halo region),
19	C \| as opposed to other diagnostic calls (fluxes, tendencies)
20	C \| that remain within the computation sequence.
21	C \| Note: IO are not supposed to be done at this level
22	C \| but later (in DO_THE_MODEL_IO)
23	C ==========================================================
24	C \ev
25
26	C !USES:
27	IMPLICIT NONE
28	C == Global variables ===
29	#include "SIZE.h"
30	#include "EEPARAMS.h"
31	#include "PARAMS.h"
32
33	C !INPUT/OUTPUT PARAMETERS:
34	C == Routine arguments ==
35	C myTime - Current time of simulation ( s )
36	C myIter - Iteration number
37	C myThid - Thread number for this instance of the routine.
38	_RL myTime
39	INTEGER myIter
40	INTEGER myThid
41
42	CEOP
43
44	C !LOCAL VARIABLES:
45	C == Local variables
46	INTEGER bi,bj
47
48	#ifdef ALLOW_TIMEAVE
49	C-- Fill-in TimeAve pkg diagnostics (for state-variables)
50
51	DO bj=myByLo(myThid),myByHi(myThid)
52	DO bi=myBxLo(myThid),myBxHi(myThid)
53
54	IF ( taveFreq.GT.0. ) THEN
55	CALL TIMEAVE_STATVARS(myTime, myIter, bi, bj, myThid)
56	# ifdef ALLOW_PTRACERS
57	IF ( usePTRACERS ) THEN
58	CALL PTRACERS_STATVARS(myTime, myIter, bi, bj, myThid)
59	ENDIF
60	# endif /* ALLOW_PTRACERS */
61	ENDIF
62
63	C-- End of bi,bj loop
64	ENDDO
65	ENDDO
66	#endif /* ALLOW_TIMEAVE */
67
68	#ifdef ALLOW_DIAGNOSTICS
69	C-- Fill-in Diagnostics pkg storage array (for state-variables)
70
71	IF ( usediagnostics ) THEN
72	CALL DIAGNOSTICS_FILL_STATE(myThid)
73	# ifdef ALLOW_PTRACERS
74	IF (usePTRACERS) THEN
75	CALL PTRACERS_DIAGNOSTICS_FILL(myThid)
76	ENDIF
77	# endif
78	ENDIf
79
80	#endif /* ALLOW_DIAGNOSTICS */
81
82	RETURN
83	END