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