diags/src/write_time_averages.F

#include "CPP_EEOPTIONS.h"

      SUBROUTINE WRITE_TIME_AVERAGES(myCurrentTime, myIter, myThid)
C     /==========================================================\
C     | SUBROUTINE WRITE_TIME_AVERAGES                           |
C     |                                                          |
C     \==========================================================/

C     == Global variables ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "AVER.h"
#include "DYNVARS.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     myCurrentTime - Current time of simulation ( s )
      INTEGER myThid
      INTEGER myIter
      REAL    myCurrentTime
      INTEGER prevPrec

C     == Local variables ==
C     suff - Hold suffix part of a filename
C     TimeAve - total time over average
      CHARACTER*(MAX_LEN_FNAM) suff
      REAL DDTT
      INTEGER bi,bj,k
      INTEGER beginIOErrCount
      INTEGER endIOErrCount
      CHARACTER*(MAX_LEN_MBUF) msgBuf
 
C     Final Time Averages and Dump Files if needed
      IF ( myIter.NE.nIter0 .AND. 
     & DIFFERENT_MULTIPLE(taveFreq,myCurrentTime,
     &                    myCurrentTime-deltaTClock)
     &   ) THEN

       WRITE(suff,'(I10.10)') myIter

C      Normalize by integrated time
       DO bj = myByLo(myThid), myByHi(myThid)
        DO bi = myBxLo(myThid), myBxHi(myThid)
         DO k=1,Nr
          CALL TIMEAVER_FINAL_XYZ(thetatave,timeave,bi,bj,K,myThid)
          CALL TIMEAVER_FINAL_XYZ(salttave,timeave,bi,bj,K,myThid)
          CALL TIMEAVER_FINAL_XYZ(uVeltave,timeave,bi,bj,K,myThid)
          CALL TIMEAVER_FINAL_XYZ(vVeltave,timeave,bi,bj,K,myThid)
          CALL TIMEAVER_FINAL_XYZ(uttave,timeave,bi,bj,K,myThid)
          CALL TIMEAVER_FINAL_XYZ(vttave,timeave,bi,bj,K,myThid)
          CALL TIMEAVER_FINAL_XYZ(k13tave,intertimeave,bi,bj,K,myThid)
          CALL TIMEAVER_FINAL_XYZ(k23tave,intertimeave,bi,bj,K,myThid)
          CALL TIMEAVER_FINAL_XYZ(wVeltave,intertimeave,bi,bj,K,myThid)
         ENDDO
         CALL TIMEAVER_FINAL_XY(KapGMtave,intertimeave,bi,bj,myThid)
        ENDDO
       ENDDO

C      Write to files
       _BARRIER
       _BEGIN_MASTER( myThid )

C--     Set IO "context" for writing state
        CALL DFILE_SET_RW
        CALL DFILE_SET_CONT_ON_ERROR
C--     Read IO error counter
        beginIOErrCount = IO_ERRCOUNT(myThid)
        prevPrec = writeBinaryPrec
        writeBinaryPrec = precFloat32
        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('UTtave.',suff,uttave,myIter,myThid)
        CALL WRITE_FLD_XYZ_RL('VTtave.',suff,vttave,myIter,myThid)
        CALL WRITE_FLD_XYZ_RL('K13tave.',suff,k13tave,myIter,myThid)
        CALL WRITE_FLD_XYZ_RL('K23tave.',suff,k23tave,myIter,myThid)
        CALL WRITE_FLD_XYZ_RL('WTtave.',suff,wVeltave,myIter,myThid)
        CALL WRITE_FLD_XY_RL('KapGMtave.',suff,KapGMtave,myIter,myThid)
        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)
         DO k=1,Nr

C      Reset the averages to zero
          CALL TIMEAVER_INI_XYZ(thetatave, bi,bj,K,myThid)
          CALL TIMEAVER_INI_XYZ(salttave, bi,bj,K,myThid)
          CALL TIMEAVER_INI_XYZ(uVeltave, bi,bj,K,myThid)
          CALL TIMEAVER_INI_XYZ(vVeltave, bi,bj,K,myThid)
          CALL TIMEAVER_INI_XYZ(uttave, bi,bj,K,myThid)
          CALL TIMEAVER_INI_XYZ(vttave, bi,bj,K,myThid)
          CALL TIMEAVER_INI_XYZ(k13tave, bi,bj,K,myThid)
          CALL TIMEAVER_INI_XYZ(k23tave, bi,bj,K,myThid)
          CALL TIMEAVER_INI_XYZ(wVeltave, bi,bj,K,myThid)
          IF (K.EQ.1) CALL TIMEAVER_INI_XY(KapGMtave, bi,bj,myThid)
          TimeAve(k,bi,bj)=0.
          InterTimeAve(k,bi,bj)=0.

C      Time Averages of single fields
          DDTT=0.5*deltaTclock
          CALL TIMEAVER_1FLD_XYZ(theta, thetatave, DDTT, bi,bj,K,myThid)
          CALL TIMEAVER_1FLD_XYZ(salt,  salttave,  DDTT, bi,bj,K,myThid)
          CALL TIMEAVER_1FLD_XYZ(uVel,  uVeltave,  DDTT, bi,bj,K,myThid)
          CALL TIMEAVER_1FLD_XYZ(vVel,  vVeltave,  DDTT, bi,bj,K,myThid)

C      Time Averages of "double" fields
          CALL TIMEAVER_2FLD_XYZ(theta, uVel, uttave, 1, DDTT, 
     &         bi,bj,K,myThid)
          CALL TIMEAVER_2FLD_XYZ(theta, vVel, vttave, 2, DDTT, 
     &         bi,bj,K,myThid)

C      Keep record of how much time has been integrated over
          TimeAve(k,bi,bj)=TimeAve(k,bi,bj)+DDTT

         ENDDO
        ENDDO
       ENDDO

      ENDIF
 
      RETURN
      END
1	adcroft	1.1	#include "CPP_EEOPTIONS.h"
2
3			SUBROUTINE WRITE_TIME_AVERAGES(myCurrentTime, myIter, myThid)
4			C /==========================================================\
5			C \| SUBROUTINE WRITE_TIME_AVERAGES \|
6			C \| \|
7			C \==========================================================/
8
9			C == Global variables ===
10			#include "SIZE.h"
11			#include "EEPARAMS.h"
12			#include "PARAMS.h"
13			#include "AVER.h"
14			#include "DYNVARS.h"
15
16			LOGICAL DIFFERENT_MULTIPLE
17			EXTERNAL DIFFERENT_MULTIPLE
18	adcroft	1.2	INTEGER IO_ERRCOUNT
19			EXTERNAL IO_ERRCOUNT
20	adcroft	1.1
21			C == Routine arguments ==
22			C myThid - Thread number for this instance of the routine.
23			C myIter - Iteration number
24			C myCurrentTime - Current time of simulation ( s )
25			INTEGER myThid
26			INTEGER myIter
27			REAL myCurrentTime
28			INTEGER prevPrec
29
30			C == Local variables ==
31			C suff - Hold suffix part of a filename
32			C TimeAve - total time over average
33			CHARACTER*(MAX_LEN_FNAM) suff
34			REAL DDTT
35			INTEGER bi,bj,k
36	adcroft	1.2	INTEGER beginIOErrCount
37			INTEGER endIOErrCount
38			CHARACTER*(MAX_LEN_MBUF) msgBuf
39	adcroft	1.1
40			C Final Time Averages and Dump Files if needed
41			IF ( myIter.NE.nIter0 .AND.
42	cnh	1.5	& DIFFERENT_MULTIPLE(taveFreq,myCurrentTime,
43			& myCurrentTime-deltaTClock)
44	adcroft	1.1	& ) THEN
45
46			WRITE(suff,'(I10.10)') myIter
47
48			C Normalize by integrated time
49			DO bj = myByLo(myThid), myByHi(myThid)
50			DO bi = myBxLo(myThid), myBxHi(myThid)
51	cnh	1.4	DO k=1,Nr
52	adcroft	1.1	CALL TIMEAVER_FINAL_XYZ(thetatave,timeave,bi,bj,K,myThid)
53			CALL TIMEAVER_FINAL_XYZ(salttave,timeave,bi,bj,K,myThid)
54			CALL TIMEAVER_FINAL_XYZ(uVeltave,timeave,bi,bj,K,myThid)
55			CALL TIMEAVER_FINAL_XYZ(vVeltave,timeave,bi,bj,K,myThid)
56			CALL TIMEAVER_FINAL_XYZ(uttave,timeave,bi,bj,K,myThid)
57			CALL TIMEAVER_FINAL_XYZ(vttave,timeave,bi,bj,K,myThid)
58			CALL TIMEAVER_FINAL_XYZ(k13tave,intertimeave,bi,bj,K,myThid)
59			CALL TIMEAVER_FINAL_XYZ(k23tave,intertimeave,bi,bj,K,myThid)
60			CALL TIMEAVER_FINAL_XYZ(wVeltave,intertimeave,bi,bj,K,myThid)
61			ENDDO
62	adcroft	1.3	CALL TIMEAVER_FINAL_XY(KapGMtave,intertimeave,bi,bj,myThid)
63	adcroft	1.1	ENDDO
64			ENDDO
65
66			C Write to files
67			_BARRIER
68			_BEGIN_MASTER( myThid )
69	adcroft	1.2
70			C-- Set IO "context" for writing state
71			CALL DFILE_SET_RW
72			CALL DFILE_SET_CONT_ON_ERROR
73			C-- Read IO error counter
74			beginIOErrCount = IO_ERRCOUNT(myThid)
75	adcroft	1.1	prevPrec = writeBinaryPrec
76			writeBinaryPrec = precFloat32
77			CALL WRITE_FLD_XYZ_RL('Ttave.',suff,thetatave,myIter,myThid)
78			CALL WRITE_FLD_XYZ_RL('Stave.',suff,salttave,myIter,myThid)
79			CALL WRITE_FLD_XYZ_RL('uVeltave.',suff,uVeltave,myIter,myThid)
80			CALL WRITE_FLD_XYZ_RL('vVeltave.',suff,vVeltave,myIter,myThid)
81			CALL WRITE_FLD_XYZ_RL('UTtave.',suff,uttave,myIter,myThid)
82			CALL WRITE_FLD_XYZ_RL('VTtave.',suff,vttave,myIter,myThid)
83			CALL WRITE_FLD_XYZ_RL('K13tave.',suff,k13tave,myIter,myThid)
84			CALL WRITE_FLD_XYZ_RL('K23tave.',suff,k23tave,myIter,myThid)
85			CALL WRITE_FLD_XYZ_RL('WTtave.',suff,wVeltave,myIter,myThid)
86	adcroft	1.3	CALL WRITE_FLD_XY_RL('KapGMtave.',suff,KapGMtave,myIter,myThid)
87	adcroft	1.1	writeBinaryPrec = prevPrec
88	adcroft	1.2	C-- Reread IO error counter
89			endIOErrCount = IO_ERRCOUNT(myThid)
90
91			C-- Check for IO errors
92			IF ( endIOErrCount .NE. beginIOErrCount ) THEN
93			WRITE(msgBuf,'(A)') 'S/R WRITE_TIME_AVERAGES'
94			CALL PRINT_ERROR( msgBuf, 1 )
95			WRITE(msgBuf,'(A)') 'Error writing out data'
96			CALL PRINT_ERROR( msgBuf, 1 )
97			WRITE(msgBuf,'(A,I10)') 'Timestep ',myIter
98			CALL PRINT_ERROR( msgBuf, 1 )
99			ELSE
100	cnh	1.5	WRITE(msgBuf,'(A,I10)')
101			& '// Time-average data written, t-step', myIter
102			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
103			& SQUEEZE_RIGHT, 1 )
104	adcroft	1.2	WRITE(msgBuf,'(A)') ' '
105	cnh	1.5	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
106			& SQUEEZE_RIGHT, 1 )
107	adcroft	1.2	ENDIF
108
109	adcroft	1.1	_END_MASTER( myThid )
110			_BARRIER
111
112			DO bj = myByLo(myThid), myByHi(myThid)
113			DO bi = myBxLo(myThid), myBxHi(myThid)
114	cnh	1.4	DO k=1,Nr
115	adcroft	1.1
116			C Reset the averages to zero
117			CALL TIMEAVER_INI_XYZ(thetatave, bi,bj,K,myThid)
118			CALL TIMEAVER_INI_XYZ(salttave, bi,bj,K,myThid)
119			CALL TIMEAVER_INI_XYZ(uVeltave, bi,bj,K,myThid)
120			CALL TIMEAVER_INI_XYZ(vVeltave, bi,bj,K,myThid)
121			CALL TIMEAVER_INI_XYZ(uttave, bi,bj,K,myThid)
122			CALL TIMEAVER_INI_XYZ(vttave, bi,bj,K,myThid)
123			CALL TIMEAVER_INI_XYZ(k13tave, bi,bj,K,myThid)
124			CALL TIMEAVER_INI_XYZ(k23tave, bi,bj,K,myThid)
125			CALL TIMEAVER_INI_XYZ(wVeltave, bi,bj,K,myThid)
126	adcroft	1.3	IF (K.EQ.1) CALL TIMEAVER_INI_XY(KapGMtave, bi,bj,myThid)
127	adcroft	1.1	TimeAve(k,bi,bj)=0.
128			InterTimeAve(k,bi,bj)=0.
129
130			C Time Averages of single fields
131			DDTT=0.5*deltaTclock
132			CALL TIMEAVER_1FLD_XYZ(theta, thetatave, DDTT, bi,bj,K,myThid)
133			CALL TIMEAVER_1FLD_XYZ(salt, salttave, DDTT, bi,bj,K,myThid)
134			CALL TIMEAVER_1FLD_XYZ(uVel, uVeltave, DDTT, bi,bj,K,myThid)
135			CALL TIMEAVER_1FLD_XYZ(vVel, vVeltave, DDTT, bi,bj,K,myThid)
136
137			C Time Averages of "double" fields
138	cnh	1.5	CALL TIMEAVER_2FLD_XYZ(theta, uVel, uttave, 1, DDTT,
139			& bi,bj,K,myThid)
140			CALL TIMEAVER_2FLD_XYZ(theta, vVel, vttave, 2, DDTT,
141			& bi,bj,K,myThid)
142	adcroft	1.1
143			C Keep record of how much time has been integrated over
144			TimeAve(k,bi,bj)=TimeAve(k,bi,bj)+DDTT
145
146			ENDDO
147			ENDDO
148			ENDDO
149
150			ENDIF
151
152			RETURN
153			END