/[MITgcm]/MITgcm/model/src/write_state.F
ViewVC logotype

Diff of /MITgcm/model/src/write_state.F

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.33 by edhill, Thu Feb 26 22:31:58 2004 UTC revision 1.42 by edhill, Fri Sep 10 12:19:30 2004 UTC
# Line 6  C $Name$ Line 6  C $Name$
6    
7  #undef  MULTIPLE_RECORD_STATE_FILES  #undef  MULTIPLE_RECORD_STATE_FILES
8    
9    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
10  CBOP  CBOP
11  C     !ROUTINE: WRITE_STATE  C     !ROUTINE: WRITE_STATE
12    
13  C     !INTERFACE:  C     !INTERFACE:
14        SUBROUTINE WRITE_STATE ( myTime, myIter, myThid )        SUBROUTINE WRITE_STATE ( myTime, myIter, myThid )
15  C     !DESCRIPTION: \bv  
16  C     *==========================================================*  C     !DESCRIPTION:
17  C     | SUBROUTINE WRITE_STATE                                      C     This is the controlling routine for writing mid-level IO.  It
18  C     | o Controlling routine for IO to dump model state.          C     includes code for diagnosing W and RHO for output.
19  C     *==========================================================*  
20  C     | Write model state files for post-processing. This file    C     The CPP flag (MULTIPLE_RECORD_STATE_FILES) is #define/#undefed
21  C     | includes code for diagnosing W and RHO for output.        C     here since it is specific to this routine and very user-preference
22  C     | File write_state.F: Routines to handle mid-level I/O  C     specific. If #undefed (default) the state files are written as in
23  C     | interface.  C     all versions prior to checkpoint32, where a file is created per
24  C     | o WRITE_STATE - Write out model state.  C     variable, per time and per tile. This *has* to be the default
25  C     | The following CPP flag (MULTIPLE_RECORD_STATE_FILES) is  C     because most users use this mode and all utilities and scripts
26  C     | #define/#undefed here since it is specific to this routine  C     (diagnostic) assume this form.  It is also robust, as explained
27  C     | and very user-preference specific.  C     below.
28  C     |  C    
29  C     | If #undefed (default) the state files are written as in all versions  C     If #defined, subsequent snap-shots are written as records in the
30  C     | prior to checkpoint32, where a file is created per variable, per time  C     same file (no iteration number in filenames). The main advantage
31  C     | and per tile. This *has* to be the default because most users use this  C     is fewer files.  The disadvantages are that:
32  C     | mode and all utilities and scripts (diagnostic) assume this form.  C       (1) it breaks a lot of diagnostic scripts,
33  C     | It is also robust, as explained below.  C       (2) for large or long problems this creates huge files,
34  C     |  C       (3) its an unexpected, unsolicited change in behaviour which
35  C     | If #defined, subsequent snap-shots are written as records in the  C           came as a surprise (in c32) and is an inconvenience to
36  C     | same file (no iteration number in filenames).  C           several users
37  C     | Advantages: - fewer files  C       (4) it can not accomodate changing the frequency of output
38  C     |       - for small problems, is easy to copy the output around  C           after a pickup (this is trivial in previous method but
39  C     | Disadvantages:  C           needs new code and parameters in this new method)
40  C     |       - breaks a lot of diagnostic scripts  C
41  C     |       - for large or long problems this creates huge files  C      Known Bugs include:
42  C     |       - is an unexpected, unsolicited change in behaviour which came  C       (1) if the length of integration is not exactly an integer
43  C     |         as a surprise (in c32) and inconvenience to several users  C           times the output frequency then the last record written
44  C     |       - can not accomodate changing the frequency of output  C           (at end of integration) overwrites a previously written
45  C     |         after a pickup (this is trivial in previous method  C           record corresponding to an earier time. *BE WARNED*
 C     |         but needs new code and parameters in this new method)  
 C     | Known Bugs:  
 C     |       - if the length of integration is not exactly an integer  
 C     |         times the output frequency then the last record written  
 C     |         (at end of integration) overwrites a previously written  
 C     |         record corresponding to an earier time. *BE WARNED*  
 C     *==========================================================*  
 C     \ev  
46    
47  C     !USES:  C     !USES:
48        IMPLICIT NONE        IMPLICIT NONE
 C     == Global variables ===  
49  #include "SIZE.h"  #include "SIZE.h"
50  #include "EEPARAMS.h"  #include "EEPARAMS.h"
51  #include "PARAMS.h"  #include "PARAMS.h"
52    #ifdef ALLOW_MNC
53    #include "MNC_PARAMS.h"
54    #endif
55  #include "DYNVARS.h"  #include "DYNVARS.h"
56  #include "GRID.h"  #include "GRID.h"
57  #include "EOS.h"  #include "EOS.h"
# Line 68  C     == Global variables === Line 64  C     == Global variables ===
64        EXTERNAL IO_ERRCOUNT        EXTERNAL IO_ERRCOUNT
65    
66  C     !INPUT/OUTPUT PARAMETERS:  C     !INPUT/OUTPUT PARAMETERS:
 C     == Routine arguments ==  
67  C     myThid - Thread number for this instance of the routine.  C     myThid - Thread number for this instance of the routine.
68  C     myIter - Iteration number  C     myIter - Iteration number
69  C     myTime - Current time of simulation ( s )  C     myTime - Current time of simulation ( s )
# Line 77  C     myTime - Current time of simulatio Line 72  C     myTime - Current time of simulatio
72        INTEGER myIter        INTEGER myIter
73    
74  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
 C     == Local variables ==  
75        CHARACTER*(MAX_LEN_MBUF) suff        CHARACTER*(MAX_LEN_MBUF) suff
76        INTEGER iRec        INTEGER iRec
 #ifdef ALLOW_MNC  
       _RL mnc_iter  
 #endif  
77  CEOP  CEOP
78    
79        IF (        IF (
# Line 91  CEOP Line 82  CEOP
82       &     myTime.EQ.endTime .OR.       &     myTime.EQ.endTime .OR.
83       &     myTime.EQ.startTime       &     myTime.EQ.startTime
84       &     ) THEN       &     ) THEN
85           IF ( dumpFreq .EQ. 0.0 ) THEN          IF ( dumpFreq .EQ. 0.0 ) THEN
86              iRec = 1            iRec = 1
87           ELSE          ELSE
88              iRec = int ( (myTime-startTime) / dumpFreq +1.5 )            iRec = int ( (myTime-startTime) / dumpFreq +1.5 )
89           ENDIF          ENDIF
90                    
91  C--   Going to really do some IO. Make everyone except master thread wait.  C       Going to really do some IO. Make everyone except master thread wait.
92           _BARRIER          _BARRIER
93           _BEGIN_MASTER( myThid )          _BEGIN_MASTER( myThid )
94    
95  C--     Write model fields  C       Write model fields
96            IF (snapshot_mdsio) THEN
97    
98  #ifdef MULTIPLE_RECORD_STATE_FILES  #ifdef MULTIPLE_RECORD_STATE_FILES
99    
100  C       Write each snap-shot as a new record in one file per variable  C         Write each snap-shot as a new record in one file per variable
101  C       - creates relatively few files but these files can become huge  C         - creates relatively few files but these files can become huge
102          CALL WRITE_REC_XYZ_RL( 'U',  uVel,iRec,myIter,myThid)            CALL WRITE_REC_XYZ_RL( 'U',  uVel,iRec,myIter,myThid)
103          CALL WRITE_REC_XYZ_RL( 'V',  vVel,iRec,myIter,myThid)            CALL WRITE_REC_XYZ_RL( 'V',  vVel,iRec,myIter,myThid)
104          CALL WRITE_REC_XYZ_RL( 'T', theta,iRec,myIter,myThid)            CALL WRITE_REC_XYZ_RL( 'T', theta,iRec,myIter,myThid)
105          CALL WRITE_REC_XYZ_RL( 'S',  salt,iRec,myIter,myThid)            CALL WRITE_REC_XYZ_RL( 'S',  salt,iRec,myIter,myThid)
106          CALL WRITE_REC_XY_RL('Eta',etaN,iRec,myIter,myThid)            CALL WRITE_REC_XY_RL('Eta',etaN,iRec,myIter,myThid)
107          CALL WRITE_REC_XYZ_RL( 'W',wVel,iRec,myIter,myThid)            CALL WRITE_REC_XYZ_RL( 'W',wVel,iRec,myIter,myThid)
 #ifdef ALLOW_PASSIVE_TRACER  
 ceh3 needs an IF ( usePASSIVE_TRACER ) THEN  
         CALL WRITE_REC_XYZ_RL( 'TR1',tr1,iRec,myIter,myThid)  
 #endif /* ALLOW_PASSIVE_TRACER */  
108  #ifdef ALLOW_NONHYDROSTATIC  #ifdef ALLOW_NONHYDROSTATIC
109          IF (nonHydroStatic) THEN            IF (nonHydroStatic) THEN
110           CALL WRITE_REC_XYZ_RL( 'PNH',phi_nh,iRec,myIter,myThid)              CALL WRITE_REC_XYZ_RL( 'PNH',phi_nh,iRec,myIter,myThid)
111          ENDIF            ENDIF
112  #endif /* ALLOW_NONHYDROSTATIC */  #endif /* ALLOW_NONHYDROSTATIC */
113  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
114  c       CALL WRITE_REC_XYZ_RS('hFacC.',hFacC,iRec,myIter,myThid)  c         CALL WRITE_REC_XYZ_RS('hFacC.',hFacC,iRec,myIter,myThid)
115  c       CALL WRITE_REC_XYZ_RS('hFacW.',hFacW,iRec,myIter,myThid)  c         CALL WRITE_REC_XYZ_RS('hFacW.',hFacW,iRec,myIter,myThid)
116  c       CALL WRITE_REC_XYZ_RS('hFacS.',hFacS,iRec,myIter,myThid)  c         CALL WRITE_REC_XYZ_RS('hFacS.',hFacS,iRec,myIter,myThid)
117  #endif /* NONLIN_FRSURF */  #endif /* NONLIN_FRSURF */
118    
119  #else /* MULTIPLE_RECORD_STATE_FILES */  #else /* MULTIPLE_RECORD_STATE_FILES */
120    
121  C       Write each snap-shot as a new file (original and default method)  C         Write each snap-shot as a new file (original and default
122  C       - creates many files but for large configurations is easier to  C         method) -- creates many files but for large configurations is
123  C         transfer analyse a particular snap-shots  C         easier to transfer analyse a particular snap-shots
124          WRITE(suff,'(I10.10)') myIter            WRITE(suff,'(I10.10)') myIter
125          CALL WRITE_FLD_XYZ_RL( 'U.',suff,uVel,myIter,myThid)            CALL WRITE_FLD_XYZ_RL( 'U.',suff,uVel,myIter,myThid)
126          CALL WRITE_FLD_XYZ_RL( 'V.',suff,vVel,myIter,myThid)            CALL WRITE_FLD_XYZ_RL( 'V.',suff,vVel,myIter,myThid)
127          CALL WRITE_FLD_XYZ_RL( 'T.',suff,theta,myIter,myThid)            CALL WRITE_FLD_XYZ_RL( 'T.',suff,theta,myIter,myThid)
128          CALL WRITE_FLD_XYZ_RL( 'S.',suff,salt,myIter,myThid)            CALL WRITE_FLD_XYZ_RL( 'S.',suff,salt,myIter,myThid)
129          CALL WRITE_FLD_XY_RL('Eta.',suff,etaN,myIter,myThid)            CALL WRITE_FLD_XY_RL('Eta.',suff,etaN,myIter,myThid)
130          CALL WRITE_FLD_XYZ_RL( 'W.',suff,wVel,myIter,myThid)            CALL WRITE_FLD_XYZ_RL( 'W.',suff,wVel,myIter,myThid)
131          IF ( useDynP_inEos_Zc .OR. myIter.NE.nIter0 )            IF ( useDynP_inEos_Zc .OR. myIter.NE.nIter0 ) THEN
132       &  CALL WRITE_FLD_XYZ_RL( 'PH.',suff,totPhiHyd,myIter,myThid)              CALL WRITE_FLD_XYZ_RL('PH.',suff,totPhiHyd,myIter,myThid)
133          IF (buoyancyRelation.NE.'ATMOSPHERIC' .AND. myIter.NE.nIter0)            ENDIF
134       &   CALL WRITE_FLD_XY_RL('PHL.',suff,phiHydLow,myIter,myThid)            IF ((buoyancyRelation.NE.'ATMOSPHERIC')
135  #ifdef ALLOW_PASSIVE_TRACER       &         .AND. (myIter.NE.nIter0)) THEN
136  ceh3 needs an IF ( usePASSIVE_TRACER ) THEN              CALL WRITE_FLD_XY_RL('PHL.',suff,phiHydLow,myIter,myThid)
137          CALL WRITE_FLD_XYZ_RL( 'TR1.',suff,tr1,myIter,myThid)            ENDIF
 #endif  
138  #ifdef ALLOW_NONHYDROSTATIC  #ifdef ALLOW_NONHYDROSTATIC
139          IF (nonHydroStatic) THEN            IF (nonHydroStatic) THEN
140           CALL WRITE_FLD_XYZ_RL( 'PNH.',suff,phi_nh,myIter,myThid)              CALL WRITE_FLD_XYZ_RL( 'PNH.',suff,phi_nh,myIter,myThid)
141          ENDIF            ENDIF
142  #endif /* ALLOW_NONHYDROSTATIC */  #endif /* ALLOW_NONHYDROSTATIC */
143  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
144  c       CALL WRITE_FLD_XYZ_RS('hFacC.',suff,hFacC,myIter,myThid)  c         CALL WRITE_FLD_XYZ_RS('hFacC.',suff,hFacC,myIter,myThid)
145  c       CALL WRITE_FLD_XYZ_RS('hFacW.',suff,hFacW,myIter,myThid)  c         CALL WRITE_FLD_XYZ_RS('hFacW.',suff,hFacW,myIter,myThid)
146  c       CALL WRITE_FLD_XYZ_RS('hFacS.',suff,hFacS,myIter,myThid)  c         CALL WRITE_FLD_XYZ_RS('hFacS.',suff,hFacS,myIter,myThid)
147  #endif /* NONLIN_FRSURF */  #endif /* NONLIN_FRSURF */
148    
149  #endif /* MULTIPLE_RECORD_STATE_FILES */  #endif /* MULTIPLE_RECORD_STATE_FILES */
150    
151            ENDIF
152            
153  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
154         IF (usePTRACERS) CALL PTRACERS_WRITE_STATE(myIter,myTime,myThid)          IF (usePTRACERS) THEN
155              CALL PTRACERS_WRITE_STATE(myIter,myTime,myThid)
156            ENDIF
157  #endif /* ALLOW_PTRACERS */  #endif /* ALLOW_PTRACERS */
158           _END_MASTER( myThid )          _END_MASTER( myThid )
159           _BARRIER          _BARRIER
160    
161  #ifdef ALLOW_MNC  #ifdef ALLOW_MNC
162            IF (useMNC .AND. snapshot_mnc) THEN
163  C     Write dynvars using the MNC package  C         Write dynvars using the MNC package
164        mnc_iter = myIter            CALL MNC_CW_SET_UDIM('state', -1, myThid)
165        CALL MNC_CW_RL_W_D(myThid,'state',0,0,'iter',-1,mnc_iter)            CALL MNC_CW_I_W('I','state',0,0,'iter', myIter, myThid)
166        CALL MNC_CW_RL_W_D(myThid,'state',0,0,'U', 0, uVel)            CALL MNC_CW_SET_UDIM('state', 0, myThid)
167        CALL MNC_CW_RL_W_D(myThid,'state',0,0,'V', 0, vVel)            CALL MNC_CW_RL_W('D','state',0,0,'model_time',myTime,myThid)
168        CALL MNC_CW_RL_W_D(myThid,'state',0,0,'T', 0, theta)            CALL MNC_CW_RL_W('D','state',0,0,'U', uVel, myThid)
169        CALL MNC_CW_RL_W_D(myThid,'state',0,0,'S', 0, salt)            CALL MNC_CW_RL_W('D','state',0,0,'V', vVel, myThid)
170        CALL MNC_CW_RL_W_D(myThid,'state',0,0,'Eta', 0, etaN)            CALL MNC_CW_RL_W('D','state',0,0,'T', theta, myThid)
171        CALL MNC_CW_RL_W_D(myThid,'state',0,0,'W', 0, wVel)            CALL MNC_CW_RL_W('D','state',0,0,'S', salt, myThid)
172        IF ( useDynP_inEos_Zc .OR. myIter.NE.nIter0 ) THEN            CALL MNC_CW_RL_W('D','state',0,0,'Eta', etaN, myThid)
173          CALL MNC_CW_RL_W_R(myThid,'totPhiHyd',0,0,'iter',-1,mnc_iter)            CALL MNC_CW_RL_W('D','state',0,0,'W', wVel, myThid)
174          CALL MNC_CW_RL_W_D(myThid,'totPhiHyd',0,0,'totPhiHyd',            IF ( useDynP_inEos_Zc .OR. myIter.NE.nIter0 ) THEN
175       &       0,totPhiHyd)              CALL MNC_CW_SET_UDIM('phiHyd', -1, myThid)
176        ENDIF              CALL MNC_CW_I_W('I','phiHyd',0,0,'iter',myIter,myThid)
177        IF ((buoyancyRelation .NE. 'ATMOSPHERIC')              CALL MNC_CW_SET_UDIM('phiHyd', 0, myThid)
178       &     .AND. (myIter .NE. nIter0)) THEN              CALL MNC_CW_RL_W('D','phiHyd',0,0,'phiHyd',
179          CALL MNC_CW_RL_W_D(myThid,'phiHydLow',0,0,'iter',-1,mnc_iter)       &           totPhiHyd, myThid)
180          CALL MNC_CW_RL_W_D(myThid,'phiHydLow',0,0,'phiHydLow',            ENDIF
181       &       0,phiHydLow)            IF ((buoyancyRelation .NE. 'ATMOSPHERIC')
182        ENDIF       &         .AND. (myIter .NE. nIter0)) THEN
183                CALL MNC_CW_SET_UDIM('phiHydLow', -1, myThid)
184  #ifdef ALLOW_PASSIVE_TRACER              CALL MNC_CW_I_W('I','phiHydLow',0,0,'iter',myIter,myThid)
185        CALL MNC_CW_RL_W_D(myThid,'state',0,0,'tr1', 0, tr1)              CALL MNC_CW_SET_UDIM('phiHydLow', 0, myThid)
186  #endif /*  ALLOW_PASSIVE_TRACER  */              CALL MNC_CW_RL_W('D','phiHydLow',0,0,'phiHydLow',
187         &           phiHydLow, myThid)
188              ENDIF
189  #ifdef ALLOW_NONHYDROSTATIC  #ifdef ALLOW_NONHYDROSTATIC
190        IF (nonHydroStatic) THEN            IF (nonHydroStatic) THEN
191          CALL MNC_CW_RL_W_D(myThid,'state',0,0,'phi_nh', 0, phi_nh)              CALL MNC_CW_RL_W('D','state',0,0,'phi_nh',phi_nh,myThid)
192        ENDIF            ENDIF
193  #endif /* ALLOW_NONHYDROSTATIC */  #endif /* ALLOW_NONHYDROSTATIC */
194            ENDIF
195  #endif /*  ALLOW_MNC  */  #endif /*  ALLOW_MNC  */
196            
197        ENDIF        ENDIF
198    
199        RETURN        RETURN
Legend:
Removed from v.1.33  
changed lines
  Added in v.1.42
  ViewVC Help
Powered by ViewVC 1.1.22