pkg/timeave/timeave_statv_write.F

C $Header: /u/u3/gcmpack/MITgcm/pkg/timeave/timeave_statv_write.F,v 1.11 2003/10/24 05:29:36 edhill Exp $
C $Name:  $
#include "TIMEAVE_OPTIONS.h"

      SUBROUTINE TIMEAVE_STATV_WRITE(myTime, myIter, myThid)
C     /==========================================================\
C     | SUBROUTINE TIMEAVE_STATV_WRITE                           |
C     | o At the end of average period, write the time-average   |
C     |   state-variables on file ; then reset for next period   |
C     \==========================================================/
      IMPLICIT NONE

C     == Global variables ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "DYNVARS.h"
#include "GRID.h"
#include "TIMEAVE_STATV.h"

      LOGICAL  DIFFERENT_MULTIPLE
      EXTERNAL DIFFERENT_MULTIPLE
      INTEGER  IO_ERRCOUNT
      EXTERNAL IO_ERRCOUNT

C     == Routine arguments ==
C     myThid - Thread number for this instance of the routine.
C     myIter - Iteration number
C     myTime - Current time of simulation ( s )
      INTEGER myThid
      INTEGER myIter
      _RL     myTime

#ifdef ALLOW_TIMEAVE 

C     == Local variables ==
C     suff - Hold suffix part of a filename
C     TimeAve - total time over average
C     useVariableK   = T when vertical diffusion is not constant
      LOGICAL useVariableK
      INTEGER prevPrec
      CHARACTER*(MAX_LEN_FNAM) suff
      INTEGER bi,bj,k
      INTEGER beginIOErrCount
      INTEGER endIOErrCount
      CHARACTER*(MAX_LEN_MBUF) msgBuf
 
C-    Final Time Averages and Dump Files if needed
      IF(DIFFERENT_MULTIPLE(taveFreq,myTime,myTime-deltaTClock) )THEN

       useVariableK = useKPP .OR. useGMredi .OR. ivdc_kappa.NE.0.
       WRITE(suff,'(I10.10)') myIter

       DO bj = myByLo(myThid), myByHi(myThid)
        DO bi = myBxLo(myThid), myBxHi(myThid)
C-     Normalize by integrated time
          CALL TIMEAVE_NORMALIZ(etatave,  TimeAve_half,1 ,bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(thetatave,TimeAve_half,Nr,bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(salttave, TimeAve_half,Nr,bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(uVeltave, TimeAve_half,Nr,bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(vVeltave, TimeAve_half,Nr,bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(wVeltave, TimeAve_half,Nr,bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(Eta2tave, TimeAve_half,1 ,bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(TTtave,   TimeAve_half,Nr,bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(UUtave,   TimeAve_half,Nr,bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(VVtave,   TimeAve_half,Nr,bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(UVtave,   TimeAve_half,Nr,bi,bj,myThid)
c         CALL TIMEAVE_NORMALIZ(KEtave,   TimeAve_half,Nr,bi,bj,myThid)
#ifdef NONLIN_FRSURF
C-     Normalize by integrated time
          CALL TIMEAVE_NORMALIZ(hUtave,   TimeAve_half,Nr,bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(hVtave,   TimeAve_half,Nr,bi,bj,myThid)
c         CALL TIMEAVE_NORMALIZ(hFacCtave,TimeAve_half,Nr,bi,bj,myThid)
c         CALL TIMEAVE_NORMALIZ(hFacWtave,TimeAve_half,Nr,bi,bj,myThid)
c         CALL TIMEAVE_NORMALIZ(hFacStave,TimeAve_half,Nr,bi,bj,myThid)
#endif /* NONLIN_FRSURF */ 
          CALL TIMEAVE_NORMALIZ(UTtave,   TimeAve_half,Nr,bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(VTtave,   TimeAve_half,Nr,bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(WTtave,   TimeAve_half,Nr,bi,bj,myThid)

          CALL TIMEAVE_NORMALIZ(TdiffRtave,TimeAve_full,Nr,
     &                            bi,bj,myThid)
#ifdef ALLOW_MOM_VECINV
          CALL TIMEAVE_NORMALIZ(uZetatave,TimeAve_full,Nr,bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(vZetatave,TimeAve_full,Nr,bi,bj,myThid)
#endif
          CALL TIMEAVE_NORMALIZ(phiHydtave,TimeAve_full,Nr,
     &                            bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(phiHydLowtave,TimeAve_full,1,
     &                            bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(phiHydLow2Tave,TimeAve_full,1,
     &                            bi,bj,myThid)
          CALL TIMEAVE_NORMALIZ(ConvectCountTave,TimeAve_full,Nr,
     &                            bi,bj,myThid)
        ENDDO
       ENDDO

C      Write to files
       _BARRIER
       _BEGIN_MASTER( myThid )

C--     Set IO "context" for writing state
#ifdef USE_DFILE
       CALL DFILE_SET_RW
       CALL DFILE_SET_CONT_ON_ERROR
#endif
C--    Read IO error counter
       beginIOErrCount = IO_ERRCOUNT(myThid)
c      prevPrec = writeBinaryPrec
c      writeBinaryPrec = precFloat32
       CALL WRITE_FLD_XY_RL('ETAtave.',suff,etatave,myIter,myThid)
       CALL WRITE_FLD_XY_RL('Eta2tave.',suff,Eta2tave,myIter,myThid)

       CALL WRITE_FLD_XYZ_RL('Ttave.',suff,thetatave,myIter,myThid)
       CALL WRITE_FLD_XYZ_RL('Stave.',suff,salttave,myIter,myThid)
       CALL WRITE_FLD_XYZ_RL('uVeltave.',suff,uVeltave,myIter,myThid)
       CALL WRITE_FLD_XYZ_RL('vVeltave.',suff,vVeltave,myIter,myThid)
       CALL WRITE_FLD_XYZ_RL('wVeltave.',suff,wVeltave,myIter,myThid)
       CALL WRITE_FLD_XYZ_RL('TTtave.',suff,TTtave,myIter,myThid)
       CALL WRITE_FLD_XYZ_RL('UUtave.',suff,UUtave,myIter,myThid)
       CALL WRITE_FLD_XYZ_RL('VVtave.',suff,VVtave,myIter,myThid)
       CALL WRITE_FLD_XYZ_RL('UVtave.',suff,UVtave,myIter,myThid)
c      CALL WRITE_FLD_XYZ_RL('KEtave.',suff,KEtave,myIter,myThid)
       CALL WRITE_FLD_XYZ_RL('UTtave.',suff,UTtave,myIter,myThid)
       CALL WRITE_FLD_XYZ_RL('VTtave.',suff,VTtave,myIter,myThid)
       CALL WRITE_FLD_XYZ_RL('WTtave.',suff,WTtave,myIter,myThid)

       IF (useVariableK)
     & CALL WRITE_FLD_XYZ_RL('Tdiftave.',suff,TdiffRtave,myIter,myThid)
#ifdef ALLOW_MOM_VECINV
       IF (vectorInvariantMomentum) THEN
         CALL WRITE_FLD_XYZ_RL('uZtave.',suff,uZetatave,myIter,myThid)
         CALL WRITE_FLD_XYZ_RL('vZtave.',suff,vZetatave,myIter,myThid)
       ENDIF
#endif
       CALL WRITE_FLD_XYZ_RL('PhHytave.',suff,phiHydtave,myIter,myThid)
       IF ( buoyancyRelation .NE. 'ATMOSPHERIC' ) THEN
       CALL WRITE_FLD_XY_RL('PHLtave.',suff,phiHydLowtave,
     &      myIter,myThid)
       CALL WRITE_FLD_XY_RL('PHL2tave.',suff,phiHydLow2tave,
     &      myIter,myThid)
       CALL WRITE_FLD_XYZ_RL('Convtave.',suff,ConvectCountTave,
     &                       myIter,myThid)
       ENDIF

#ifdef NONLIN_FRSURF
       CALL WRITE_FLD_XYZ_RL('hUtave.',suff,hUtave,myIter,myThid)
       CALL WRITE_FLD_XYZ_RL('hVtave.',suff,hVtave,myIter,myThid)
c      CALL WRITE_FLD_XYZ_RL('hFacCtave.',suff,hFacCtave,myIter,myThid)
c      CALL WRITE_FLD_XYZ_RL('hFacWtave.',suff,hFacWtave,myIter,myThid)
c      CALL WRITE_FLD_XYZ_RL('hFacStave.',suff,hFacStave,myIter,myThid)
#endif /* NONLIN_FRSURF */ 

c      writeBinaryPrec = prevPrec
C--    Reread IO error counter
       endIOErrCount = IO_ERRCOUNT(myThid)

C--    Check for IO errors
       IF ( endIOErrCount .NE. beginIOErrCount ) THEN
         WRITE(msgBuf,'(A)')  'S/R WRITE_TIME_AVERAGES'
         CALL PRINT_ERROR( msgBuf, 1 )
         WRITE(msgBuf,'(A)')  'Error writing out data'
         CALL PRINT_ERROR( msgBuf, 1 )
         WRITE(msgBuf,'(A,I10)') 'Timestep ',myIter
         CALL PRINT_ERROR( msgBuf, 1 )
       ELSE
         WRITE(msgBuf,'(A,I10)')  
     &    '// Time-average data written, t-step', myIter
         CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, 
     &    SQUEEZE_RIGHT, 1 )
         WRITE(msgBuf,'(A)')  ' '
         CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, 
     &    SQUEEZE_RIGHT, 1 )
       ENDIF

       _END_MASTER( myThid )
       _BARRIER

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

C-- Like before the 1rst iteration,
C  ==> call TIMEAVE_STATVARS with myIter=nIter0 :
C    1) Reset the averages to zero ;
C    2) Start to cumulate state-variables with Half time step.

         CALL TIMEAVE_STATVARS(myTime, nIter0, bi, bj, myThid)

        ENDDO
       ENDDO

      ENDIF
 
#endif /* ALLOW_TIMEAVE */

      RETURN
      END
1	edhill	1.12	C $Header: /u/u3/gcmpack/MITgcm/pkg/timeave/timeave_statv_write.F,v 1.11 2003/10/24 05:29:36 edhill Exp $
2	jmc	1.1	C $Name: $
3	edhill	1.9	#include "TIMEAVE_OPTIONS.h"
4	jmc	1.1
5			SUBROUTINE TIMEAVE_STATV_WRITE(myTime, myIter, myThid)
6			C /==========================================================\
7			C \| SUBROUTINE TIMEAVE_STATV_WRITE \|
8			C \| o At the end of average period, write the time-average \|
9			C \| state-variables on file ; then reset for next period \|
10			C \==========================================================/
11			IMPLICIT NONE
12
13			C == Global variables ===
14			#include "SIZE.h"
15			#include "EEPARAMS.h"
16			#include "PARAMS.h"
17			#include "DYNVARS.h"
18	jmc	1.3	#include "GRID.h"
19	jmc	1.1	#include "TIMEAVE_STATV.h"
20
21			LOGICAL DIFFERENT_MULTIPLE
22			EXTERNAL DIFFERENT_MULTIPLE
23			INTEGER IO_ERRCOUNT
24			EXTERNAL IO_ERRCOUNT
25
26			C == Routine arguments ==
27			C myThid - Thread number for this instance of the routine.
28			C myIter - Iteration number
29			C myTime - Current time of simulation ( s )
30			INTEGER myThid
31			INTEGER myIter
32			_RL myTime
33
34	jmc	1.3	#ifdef ALLOW_TIMEAVE
35
36	jmc	1.1	C == Local variables ==
37			C suff - Hold suffix part of a filename
38			C TimeAve - total time over average
39	jmc	1.7	C useVariableK = T when vertical diffusion is not constant
40			LOGICAL useVariableK
41	jmc	1.1	INTEGER prevPrec
42			CHARACTER*(MAX_LEN_FNAM) suff
43			INTEGER bi,bj,k
44			INTEGER beginIOErrCount
45			INTEGER endIOErrCount
46			CHARACTER*(MAX_LEN_MBUF) msgBuf
47
48			C- Final Time Averages and Dump Files if needed
49	jmc	1.3	IF(DIFFERENT_MULTIPLE(taveFreq,myTime,myTime-deltaTClock) )THEN
50	jmc	1.1
51	jmc	1.7	useVariableK = useKPP .OR. useGMredi .OR. ivdc_kappa.NE.0.
52	jmc	1.1	WRITE(suff,'(I10.10)') myIter
53
54			DO bj = myByLo(myThid), myByHi(myThid)
55			DO bi = myBxLo(myThid), myBxHi(myThid)
56	jmc	1.3	C- Normalize by integrated time
57			CALL TIMEAVE_NORMALIZ(etatave, TimeAve_half,1 ,bi,bj,myThid)
58	jmc	1.1	CALL TIMEAVE_NORMALIZ(thetatave,TimeAve_half,Nr,bi,bj,myThid)
59			CALL TIMEAVE_NORMALIZ(salttave, TimeAve_half,Nr,bi,bj,myThid)
60			CALL TIMEAVE_NORMALIZ(uVeltave, TimeAve_half,Nr,bi,bj,myThid)
61			CALL TIMEAVE_NORMALIZ(vVeltave, TimeAve_half,Nr,bi,bj,myThid)
62	jmc	1.5	CALL TIMEAVE_NORMALIZ(wVeltave, TimeAve_half,Nr,bi,bj,myThid)
63	jmc	1.3	CALL TIMEAVE_NORMALIZ(Eta2tave, TimeAve_half,1 ,bi,bj,myThid)
64	adcroft	1.2	CALL TIMEAVE_NORMALIZ(TTtave, TimeAve_half,Nr,bi,bj,myThid)
65			CALL TIMEAVE_NORMALIZ(UUtave, TimeAve_half,Nr,bi,bj,myThid)
66			CALL TIMEAVE_NORMALIZ(VVtave, TimeAve_half,Nr,bi,bj,myThid)
67	jmc	1.6	CALL TIMEAVE_NORMALIZ(UVtave, TimeAve_half,Nr,bi,bj,myThid)
68	jmc	1.3	c CALL TIMEAVE_NORMALIZ(KEtave, TimeAve_half,Nr,bi,bj,myThid)
69			#ifdef NONLIN_FRSURF
70			C- Normalize by integrated time
71			CALL TIMEAVE_NORMALIZ(hUtave, TimeAve_half,Nr,bi,bj,myThid)
72			CALL TIMEAVE_NORMALIZ(hVtave, TimeAve_half,Nr,bi,bj,myThid)
73			c CALL TIMEAVE_NORMALIZ(hFacCtave,TimeAve_half,Nr,bi,bj,myThid)
74			c CALL TIMEAVE_NORMALIZ(hFacWtave,TimeAve_half,Nr,bi,bj,myThid)
75			c CALL TIMEAVE_NORMALIZ(hFacStave,TimeAve_half,Nr,bi,bj,myThid)
76			#endif /* NONLIN_FRSURF */
77			CALL TIMEAVE_NORMALIZ(UTtave, TimeAve_half,Nr,bi,bj,myThid)
78			CALL TIMEAVE_NORMALIZ(VTtave, TimeAve_half,Nr,bi,bj,myThid)
79	jmc	1.5	CALL TIMEAVE_NORMALIZ(WTtave, TimeAve_half,Nr,bi,bj,myThid)
80	jmc	1.1
81	jmc	1.6	CALL TIMEAVE_NORMALIZ(TdiffRtave,TimeAve_full,Nr,
82			& bi,bj,myThid)
83	edhill	1.12	#ifdef ALLOW_MOM_VECINV
84	jmc	1.8	CALL TIMEAVE_NORMALIZ(uZetatave,TimeAve_full,Nr,bi,bj,myThid)
85			CALL TIMEAVE_NORMALIZ(vZetatave,TimeAve_full,Nr,bi,bj,myThid)
86			#endif
87	jmc	1.1	CALL TIMEAVE_NORMALIZ(phiHydtave,TimeAve_full,Nr,
88			& bi,bj,myThid)
89	mlosch	1.4	CALL TIMEAVE_NORMALIZ(phiHydLowtave,TimeAve_full,1,
90			& bi,bj,myThid)
91			CALL TIMEAVE_NORMALIZ(phiHydLow2Tave,TimeAve_full,1,
92			& bi,bj,myThid)
93	jmc	1.1	CALL TIMEAVE_NORMALIZ(ConvectCountTave,TimeAve_full,Nr,
94			& bi,bj,myThid)
95			ENDDO
96			ENDDO
97
98			C Write to files
99			_BARRIER
100			_BEGIN_MASTER( myThid )
101
102			C-- Set IO "context" for writing state
103			#ifdef USE_DFILE
104	jmc	1.3	CALL DFILE_SET_RW
105			CALL DFILE_SET_CONT_ON_ERROR
106	jmc	1.1	#endif
107	jmc	1.3	C-- Read IO error counter
108			beginIOErrCount = IO_ERRCOUNT(myThid)
109			c prevPrec = writeBinaryPrec
110			c writeBinaryPrec = precFloat32
111	edhill	1.11	CALL WRITE_FLD_XY_RL('ETAtave.',suff,etatave,myIter,myThid)
112			CALL WRITE_FLD_XY_RL('Eta2tave.',suff,Eta2tave,myIter,myThid)
113	jmc	1.3
114			CALL WRITE_FLD_XYZ_RL('Ttave.',suff,thetatave,myIter,myThid)
115			CALL WRITE_FLD_XYZ_RL('Stave.',suff,salttave,myIter,myThid)
116			CALL WRITE_FLD_XYZ_RL('uVeltave.',suff,uVeltave,myIter,myThid)
117			CALL WRITE_FLD_XYZ_RL('vVeltave.',suff,vVeltave,myIter,myThid)
118			CALL WRITE_FLD_XYZ_RL('wVeltave.',suff,wVeltave,myIter,myThid)
119			CALL WRITE_FLD_XYZ_RL('TTtave.',suff,TTtave,myIter,myThid)
120			CALL WRITE_FLD_XYZ_RL('UUtave.',suff,UUtave,myIter,myThid)
121			CALL WRITE_FLD_XYZ_RL('VVtave.',suff,VVtave,myIter,myThid)
122	jmc	1.6	CALL WRITE_FLD_XYZ_RL('UVtave.',suff,UVtave,myIter,myThid)
123	jmc	1.3	c CALL WRITE_FLD_XYZ_RL('KEtave.',suff,KEtave,myIter,myThid)
124			CALL WRITE_FLD_XYZ_RL('UTtave.',suff,UTtave,myIter,myThid)
125			CALL WRITE_FLD_XYZ_RL('VTtave.',suff,VTtave,myIter,myThid)
126			CALL WRITE_FLD_XYZ_RL('WTtave.',suff,WTtave,myIter,myThid)
127	jmc	1.5
128	jmc	1.7	IF (useVariableK)
129			& CALL WRITE_FLD_XYZ_RL('Tdiftave.',suff,TdiffRtave,myIter,myThid)
130	edhill	1.12	#ifdef ALLOW_MOM_VECINV
131	jmc	1.8	IF (vectorInvariantMomentum) THEN
132			CALL WRITE_FLD_XYZ_RL('uZtave.',suff,uZetatave,myIter,myThid)
133			CALL WRITE_FLD_XYZ_RL('vZtave.',suff,vZetatave,myIter,myThid)
134			ENDIF
135			#endif
136	jmc	1.3	CALL WRITE_FLD_XYZ_RL('PhHytave.',suff,phiHydtave,myIter,myThid)
137	jmc	1.5	IF ( buoyancyRelation .NE. 'ATMOSPHERIC' ) THEN
138			CALL WRITE_FLD_XY_RL('PHLtave.',suff,phiHydLowtave,
139			& myIter,myThid)
140			CALL WRITE_FLD_XY_RL('PHL2tave.',suff,phiHydLow2tave,
141			& myIter,myThid)
142	jmc	1.3	CALL WRITE_FLD_XYZ_RL('Convtave.',suff,ConvectCountTave,
143			& myIter,myThid)
144	jmc	1.5	ENDIF
145
146	jmc	1.3	#ifdef NONLIN_FRSURF
147			CALL WRITE_FLD_XYZ_RL('hUtave.',suff,hUtave,myIter,myThid)
148			CALL WRITE_FLD_XYZ_RL('hVtave.',suff,hVtave,myIter,myThid)
149			c CALL WRITE_FLD_XYZ_RL('hFacCtave.',suff,hFacCtave,myIter,myThid)
150			c CALL WRITE_FLD_XYZ_RL('hFacWtave.',suff,hFacWtave,myIter,myThid)
151			c CALL WRITE_FLD_XYZ_RL('hFacStave.',suff,hFacStave,myIter,myThid)
152			#endif /* NONLIN_FRSURF */
153
154			c writeBinaryPrec = prevPrec
155			C-- Reread IO error counter
156			endIOErrCount = IO_ERRCOUNT(myThid)
157	jmc	1.1
158	jmc	1.3	C-- Check for IO errors
159			IF ( endIOErrCount .NE. beginIOErrCount ) THEN
160	jmc	1.1	WRITE(msgBuf,'(A)') 'S/R WRITE_TIME_AVERAGES'
161			CALL PRINT_ERROR( msgBuf, 1 )
162			WRITE(msgBuf,'(A)') 'Error writing out data'
163			CALL PRINT_ERROR( msgBuf, 1 )
164			WRITE(msgBuf,'(A,I10)') 'Timestep ',myIter
165			CALL PRINT_ERROR( msgBuf, 1 )
166	jmc	1.3	ELSE
167	jmc	1.1	WRITE(msgBuf,'(A,I10)')
168			& '// Time-average data written, t-step', myIter
169			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
170			& SQUEEZE_RIGHT, 1 )
171			WRITE(msgBuf,'(A)') ' '
172			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
173			& SQUEEZE_RIGHT, 1 )
174	jmc	1.3	ENDIF
175	jmc	1.1
176			_END_MASTER( myThid )
177			_BARRIER
178
179			DO bj = myByLo(myThid), myByHi(myThid)
180			DO bi = myBxLo(myThid), myBxHi(myThid)
181
182	jmc	1.3	C-- Like before the 1rst iteration,
183			C ==> call TIMEAVE_STATVARS with myIter=nIter0 :
184			C 1) Reset the averages to zero ;
185			C 2) Start to cumulate state-variables with Half time step.
186
187			CALL TIMEAVE_STATVARS(myTime, nIter0, bi, bj, myThid)
188	jmc	1.1
189			ENDDO
190			ENDDO
191
192			ENDIF
193
194	jmc	1.3	#endif /* ALLOW_TIMEAVE */
195
196	jmc	1.1	RETURN
197			END