/[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.20 by dimitri, Tue Feb 18 05:33:54 2003 UTC revision 1.49 by mlosch, Wed Dec 1 22:53:12 2004 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4    #include "PACKAGES_CONFIG.h"
5  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
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"
58  #ifdef ALLOW_PASSIVE_TRACER  
 #include "TR1.h"  
 #endif  
59        LOGICAL  DIFFERENT_MULTIPLE        LOGICAL  DIFFERENT_MULTIPLE
60        EXTERNAL DIFFERENT_MULTIPLE        EXTERNAL DIFFERENT_MULTIPLE
61        INTEGER  IO_ERRCOUNT        INTEGER  IO_ERRCOUNT
62        EXTERNAL IO_ERRCOUNT        EXTERNAL IO_ERRCOUNT
63    
64  C     !INPUT/OUTPUT PARAMETERS:  C     !INPUT/OUTPUT PARAMETERS:
 C     == Routine arguments ==  
65  C     myThid - Thread number for this instance of the routine.  C     myThid - Thread number for this instance of the routine.
66  C     myIter - Iteration number  C     myIter - Iteration number
67  C     myTime - Current time of simulation ( s )  C     myTime - Current time of simulation ( s )
# Line 75  C     myTime - Current time of simulatio Line 70  C     myTime - Current time of simulatio
70        INTEGER myIter        INTEGER myIter
71    
72  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
 C     == Local variables ==  
73        CHARACTER*(MAX_LEN_MBUF) suff        CHARACTER*(MAX_LEN_MBUF) suff
74        INTEGER iRec        INTEGER iRec
75  CEOP  CEOP
# Line 86  CEOP Line 80  CEOP
80       &     myTime.EQ.endTime .OR.       &     myTime.EQ.endTime .OR.
81       &     myTime.EQ.startTime       &     myTime.EQ.startTime
82       &     ) THEN       &     ) THEN
83           IF ( dumpFreq .EQ. 0.0 ) THEN          IF ( dumpFreq .EQ. 0.0 ) THEN
84              iRec = 1            iRec = 1
85           ELSE          ELSE
86              iRec = int ( (myTime-startTime) / dumpFreq +1.5 )            iRec = int ( (myTime-startTime) / dumpFreq +1.5 )
87           ENDIF          ENDIF
88                    
89  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.
90           _BARRIER          _BARRIER
91           _BEGIN_MASTER( myThid )          _BEGIN_MASTER( myThid )
92    
93  C--     Write model fields  C       Write model fields
94            IF (snapshot_mdsio) THEN
95    
96  #ifdef MULTIPLE_RECORD_STATE_FILES  #ifdef MULTIPLE_RECORD_STATE_FILES
97    
98  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
99  C       - creates relatively few files but these files can become huge  C         - creates relatively few files but these files can become huge
100          CALL WRITE_REC_XYZ_RL( 'U',  uVel,iRec,myIter,myThid)            CALL WRITE_REC_XYZ_RL( 'U',  uVel,iRec,myIter,myThid)
101          CALL WRITE_REC_XYZ_RL( 'V',  vVel,iRec,myIter,myThid)            CALL WRITE_REC_XYZ_RL( 'V',  vVel,iRec,myIter,myThid)
102          CALL WRITE_REC_XYZ_RL( 'T', theta,iRec,myIter,myThid)            CALL WRITE_REC_XYZ_RL( 'T', theta,iRec,myIter,myThid)
103          CALL WRITE_REC_XYZ_RL( 'S',  salt,iRec,myIter,myThid)            CALL WRITE_REC_XYZ_RL( 'S',  salt,iRec,myIter,myThid)
104          CALL WRITE_REC_XY_RL('Eta',etaN,iRec,myIter,myThid)            CALL WRITE_REC_XY_RL('Eta',etaN,iRec,myIter,myThid)
105          CALL WRITE_REC_XYZ_RL( 'W',wVel,iRec,myIter,myThid)            CALL WRITE_REC_XYZ_RL( 'W',wVel,iRec,myIter,myThid)
 #ifdef ALLOW_PASSIVE_TRACER  
         CALL WRITE_REC_XYZ_RL( 'TR1',tr1,iRec,myIter,myThid)  
 #endif  
106  #ifdef ALLOW_NONHYDROSTATIC  #ifdef ALLOW_NONHYDROSTATIC
107          IF (nonHydroStatic) THEN            IF (nonHydroStatic) THEN
108           CALL WRITE_REC_XYZ_RL( 'PNH',phi_nh,iRec,myIter,myThid)              CALL WRITE_REC_XYZ_RL( 'PNH',phi_nh,iRec,myIter,myThid)
109          ENDIF            ENDIF
110  #endif /* ALLOW_NONHYDROSTATIC */  #endif /* ALLOW_NONHYDROSTATIC */
111  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
112          CALL WRITE_REC_XYZ_RS('hFacC.',hFacC,iRec,myIter,myThid)  c         CALL WRITE_REC_XYZ_RS('hFacC.',hFacC,iRec,myIter,myThid)
113          CALL WRITE_FLD_XYZ_RS('hFacW.',hFacW,iRec,myIter,myThid)  c         CALL WRITE_REC_XYZ_RS('hFacW.',hFacW,iRec,myIter,myThid)
114          CALL WRITE_FLD_XYZ_RS('hFacS.',hFacS,iRec,myIter,myThid)  c         CALL WRITE_REC_XYZ_RS('hFacS.',hFacS,iRec,myIter,myThid)
115  #endif /* NONLIN_FRSURF */  #endif /* NONLIN_FRSURF */
116    
117  #else /* MULTIPLE_RECORD_STATE_FILES */  #else /* MULTIPLE_RECORD_STATE_FILES */
118    
119  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
120  C       - creates many files but for large configurations is easier to  C         method) -- creates many files but for large configurations is
121  C         transfer analyse a particular snap-shots  C         easier to transfer analyse a particular snap-shots
122          WRITE(suff,'(I10.10)') myIter            WRITE(suff,'(I10.10)') myIter
123          CALL WRITE_FLD_XYZ_RL( 'U.',suff,uVel,myIter,myThid)            CALL WRITE_FLD_XYZ_RL( 'U.',suff,uVel,myIter,myThid)
124          CALL WRITE_FLD_XYZ_RL( 'V.',suff,vVel,myIter,myThid)            CALL WRITE_FLD_XYZ_RL( 'V.',suff,vVel,myIter,myThid)
125          CALL WRITE_FLD_XYZ_RL( 'T.',suff,theta,myIter,myThid)            CALL WRITE_FLD_XYZ_RL( 'T.',suff,theta,myIter,myThid)
126          CALL WRITE_FLD_XYZ_RL( 'S.',suff,salt,myIter,myThid)            CALL WRITE_FLD_XYZ_RL( 'S.',suff,salt,myIter,myThid)
127          CALL WRITE_FLD_XY_RL('Eta.',suff,etaN,myIter,myThid)            CALL WRITE_FLD_XY_RL('Eta.',suff,etaN,myIter,myThid)
128          CALL WRITE_FLD_XYZ_RL( 'W.',suff,wVel,myIter,myThid)            CALL WRITE_FLD_XYZ_RL( 'W.',suff,wVel,myIter,myThid)
129          if ( buoyancyRelation .eq. 'OCEANIC' .and.            IF ( useDynP_inEos_Zc .OR. myIter.NE.nIter0 ) THEN
130       &       (    equationOfState .eq. 'JMD95P'              CALL WRITE_FLD_XYZ_RL('PH.',suff,totPhiHyd,myIter,myThid)
131       &       .or. equationOfState .eq. 'MDJWF'            ENDIF
132       &       .or. equationOfState .eq. 'UNESCO' ) ) then            IF ( fluidIsWater .AND. (myIter.NE.nIter0) ) THEN
133             CALL WRITE_FLD_XYZ_RL( 'P.',suff,pressure,myIter,myThid)              CALL WRITE_FLD_XY_RL('PHL.',suff,phiHydLow,myIter,myThid)
134          end if            ENDIF
         if ( buoyancyRelation .ne. 'ATMOSPHERIC' )  
      &     CALL WRITE_FLD_XY_RL('PHL.',suff,phiHydLow,myIter,myThid)  
 #ifdef ALLOW_PASSIVE_TRACER  
         CALL WRITE_FLD_XYZ_RL( 'TR1.',suff,tr1,myIter,myThid)  
 #endif  
135  #ifdef ALLOW_NONHYDROSTATIC  #ifdef ALLOW_NONHYDROSTATIC
136          IF (nonHydroStatic) THEN            IF (nonHydroStatic) THEN
137           CALL WRITE_FLD_XYZ_RL( 'PNH.',suff,phi_nh,myIter,myThid)              CALL WRITE_FLD_XYZ_RL( 'PNH.',suff,phi_nh,myIter,myThid)
138          ENDIF            ENDIF
139  #endif /* ALLOW_NONHYDROSTATIC */  #endif /* ALLOW_NONHYDROSTATIC */
140  #ifdef NONLIN_FRSURF  #ifdef NONLIN_FRSURF
141          CALL WRITE_FLD_XYZ_RS('hFacC.',suff,hFacC,myIter,myThid)  c         CALL WRITE_FLD_XYZ_RS('hFacC.',suff,hFacC,myIter,myThid)
142          CALL WRITE_FLD_XYZ_RS('hFacW.',suff,hFacW,myIter,myThid)  c         CALL WRITE_FLD_XYZ_RS('hFacW.',suff,hFacW,myIter,myThid)
143          CALL WRITE_FLD_XYZ_RS('hFacS.',suff,hFacS,myIter,myThid)  c         CALL WRITE_FLD_XYZ_RS('hFacS.',suff,hFacS,myIter,myThid)
144  #endif /* NONLIN_FRSURF */  #endif /* NONLIN_FRSURF */
145    
146  #endif /* MULTIPLE_RECORD_STATE_FILES */  #endif /* MULTIPLE_RECORD_STATE_FILES */
147    
148  #ifdef ALLOW_PTRACERS          ENDIF
149         IF (usePTRACERS) CALL PTRACERS_WRITE_STATE(myIter,myTime,myThid)          
150  #endif /* ALLOW_PTRACERS */          _END_MASTER( myThid )
151           _END_MASTER( myThid )          _BARRIER
152           _BARRIER  
153    #ifdef ALLOW_MNC
154            IF (useMNC .AND. snapshot_mnc) THEN
155    C         Write dynvars using the MNC package
156              CALL MNC_CW_SET_UDIM('state', -1, myThid)
157              CALL MNC_CW_I_W_S('I','state',0,0,'iter', myIter, myThid)
158              CALL MNC_CW_SET_UDIM('state', 0, myThid)
159              CALL MNC_CW_RL_W_S('D','state',0,0,'model_time',myTime,myThid)
160              CALL MNC_CW_RL_W('D','state',0,0,'U', uVel, myThid)
161              CALL MNC_CW_RL_W('D','state',0,0,'V', vVel, myThid)
162              CALL MNC_CW_RL_W('D','state',0,0,'Temp', theta, myThid)
163              CALL MNC_CW_RL_W('D','state',0,0,'S', salt, myThid)
164              CALL MNC_CW_RL_W('D','state',0,0,'Eta', etaN, myThid)
165              CALL MNC_CW_RL_W('D','state',0,0,'W', wVel, myThid)
166              IF ( useDynP_inEos_Zc .OR. myIter.NE.nIter0 ) THEN
167                CALL MNC_CW_SET_UDIM('phiHyd', -1, myThid)
168                CALL MNC_CW_I_W_S('I','phiHyd',0,0,'iter',myIter,myThid)
169                CALL MNC_CW_SET_UDIM('phiHyd', 0, myThid)
170                CALL MNC_CW_RL_W('D','phiHyd',0,0,'phiHyd',
171         &           totPhiHyd, myThid)
172              ENDIF
173              IF ( fluidIsWater .AND. (myIter .NE. nIter0) ) THEN
174                CALL MNC_CW_SET_UDIM('phiHydLow', -1, myThid)
175                CALL MNC_CW_I_W_S('I','phiHydLow',0,0,'iter',myIter,myThid)
176                CALL MNC_CW_SET_UDIM('phiHydLow', 0, myThid)
177                CALL MNC_CW_RL_W('D','phiHydLow',0,0,'phiHydLow',
178         &           phiHydLow, myThid)
179              ENDIF
180    #ifdef ALLOW_NONHYDROSTATIC
181              IF (nonHydroStatic) THEN
182                CALL MNC_CW_RL_W('D','state',0,0,'phi_nh',phi_nh,myThid)
183              ENDIF
184    #endif /* ALLOW_NONHYDROSTATIC */
185            ENDIF
186    #endif /*  ALLOW_MNC  */
187            
188        ENDIF        ENDIF
189    
190        RETURN        RETURN
Legend:
Removed from v.1.20  
changed lines
  Added in v.1.49
  ViewVC Help
Powered by ViewVC 1.1.22