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