/[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.9 by jmc, Tue Mar 6 16:51:02 2001 UTC revision 1.16 by jmc, Wed Jan 30 04:12:12 2002 UTC
# Line 2  C $Header$ Line 2  C $Header$
2  C $Name$  C $Name$
3  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
4    
 C--  File read_write.F: Routines to handle mid-level I/O interface.  
 C--   o WRITE_STATE - Write out model state.  
   
 C The following CPP flag (MULTIPLE_RECORD_STATE_FILES) is  
 C #define/#undefed here since it is specific to this routine and  
 C very user-preference specific.  
 C  
 C If #undefed (default) the state files are written as in all versions  
 C prior to checkpoint32, where a file is created per variable, per time  
 C and per tile. This *has* to be the default because most users use this  
 C mode and all utilities and scripts (diagnostic) assume this form.  
 C It is also robust, as explained below.  
 C  
 C If #defined, subsequent snap-shots are written as records in the  
 C same file (no iteration number in filenames).  
 C Advantages: - fewer files  
 C             - for small problems, is easy to copy the output around  
 C Disadvantages:  
 C             - breaks a lot of diagnostic scripts  
 C             - for large or long problems this creates huge files  
 C             - is an unexpected, unsolicited change in behaviour which came  
 C               as a surprise (in c32) and inconvenience to several users  
 C             - can not accomodate changing the frequency of output  
 C               after a pickup (this is trivial in previous method  
 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*  
   
5  #undef  MULTIPLE_RECORD_STATE_FILES  #undef  MULTIPLE_RECORD_STATE_FILES
     
6    
7    CBOP
8    C     !ROUTINE: WRITE_STATE
9    C     !INTERFACE:
10          SUBROUTINE WRITE_STATE ( myCurrentTime, myIter, myThid )
11    C     !DESCRIPTION: \bv
12    C     *==========================================================*
13    C     | SUBROUTINE WRITE_STATE                                    
14    C     | o Controlling routine for IO to dump model state.        
15    C     *==========================================================*
16    C     | Write model state files for post-processing. This file  
17    C     | includes code for diagnosing W and RHO for output.      
18    C     | File write_state.F: Routines to handle mid-level I/O
19    C     | interface.
20    C     | o WRITE_STATE - Write out model state.
21    C     | The following CPP flag (MULTIPLE_RECORD_STATE_FILES) is
22    C     | #define/#undefed here since it is specific to this routine
23    C     | and very user-preference specific.
24    C     |
25    C     | If #undefed (default) the state files are written as in all versions
26    C     | prior to checkpoint32, where a file is created per variable, per time
27    C     | and per tile. This *has* to be the default because most users use this
28    C     | mode and all utilities and scripts (diagnostic) assume this form.
29    C     | It is also robust, as explained below.
30    C     |
31    C     | If #defined, subsequent snap-shots are written as records in the
32    C     | same file (no iteration number in filenames).
33    C     | Advantages: - fewer files
34    C     |       - for small problems, is easy to copy the output around
35    C     | Disadvantages:
36    C     |       - breaks a lot of diagnostic scripts
37    C     |       - for large or long problems this creates huge files
38    C     |       - is an unexpected, unsolicited change in behaviour which came
39    C     |         as a surprise (in c32) and inconvenience to several users
40    C     |       - can not accomodate changing the frequency of output
41    C     |         after a pickup (this is trivial in previous method
42    C     |         but needs new code and parameters in this new method)
43    C     | Known Bugs:
44    C     |       - if the length of integration is not exactly an integer
45    C     |         times the output frequency then the last record written
46    C     |         (at end of integration) overwrites a previously written
47    C     |         record corresponding to an earier time. *BE WARNED*
48    C     *==========================================================*
49    C     \ev
50    
51  CStartofinterface  C     !USES:
       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     \==========================================================/  
52        IMPLICIT NONE        IMPLICIT NONE
   
53  C     == Global variables ===  C     == Global variables ===
54  #include "SIZE.h"  #include "SIZE.h"
55  #include "EEPARAMS.h"  #include "EEPARAMS.h"
56  #include "PARAMS.h"  #include "PARAMS.h"
57  #include "DYNVARS.h"  #include "DYNVARS.h"
58  #ifdef ALLOW_NONHYDROSTATIC  #include "GRID.h"
59  #include "CG3D.h"  #ifdef ALLOW_PASSIVE_TRACER
60  #include "GW.h"  #include "TR1.h"
61  #endif  #endif
   
62        LOGICAL  DIFFERENT_MULTIPLE        LOGICAL  DIFFERENT_MULTIPLE
63        EXTERNAL DIFFERENT_MULTIPLE        EXTERNAL DIFFERENT_MULTIPLE
64        INTEGER  IO_ERRCOUNT        INTEGER  IO_ERRCOUNT
65        EXTERNAL IO_ERRCOUNT        EXTERNAL IO_ERRCOUNT
66    
67    C     !INPUT/OUTPUT PARAMETERS:
68  C     == Routine arguments ==  C     == Routine arguments ==
69  C     myThid - Thread number for this instance of the routine.  C     myThid - Thread number for this instance of the routine.
70  C     myIter - Iteration number  C     myIter - Iteration number
71  C     myCurrentTime - Current time of simulation ( s )  C     myCurrentTime - Current time of simulation ( s )
       LOGICAL forceOutput  
72        _RL     myCurrentTime        _RL     myCurrentTime
73        INTEGER myThid        INTEGER myThid
74        INTEGER myIter        INTEGER myIter
 CEndofinterface  
75    
76    C     !LOCAL VARIABLES:
77  C     == Local variables ==  C     == Local variables ==
78        CHARACTER*(MAX_LEN_MBUF) suff        CHARACTER*(MAX_LEN_MBUF) suff
79        INTEGER iRec        INTEGER iRec
80    CEOP
81    
82        IF (        IF (
83       &     ( DIFFERENT_MULTIPLE(dumpFreq,myCurrentTime,       &     DIFFERENT_MULTIPLE(dumpFreq,myCurrentTime,
84       &     myCurrentTime-deltaTClock) .AND. myCurrentTime.NE.endTime )       &     myCurrentTime-deltaTClock) .OR.
85       &     .OR. forceOutput       &     myCurrentTime.EQ.endTime .OR.
86         &     myCurrentTime.EQ.startTime
87       &     ) THEN       &     ) THEN
88           iRec = int ( (myCurrentTime-startTime) / dumpFreq +1.5 )           iRec = int ( (myCurrentTime-startTime) / dumpFreq +1.5 )
89                    
# Line 90  C--   Going to really do some IO. Make e Line 92  C--   Going to really do some IO. Make e
92           _BEGIN_MASTER( myThid )           _BEGIN_MASTER( myThid )
93    
94  C--     Write model fields  C--     Write model fields
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 ('PS',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)
106    #ifdef ALLOW_PASSIVE_TRACER
107            CALL WRITE_REC_XYZ_RL( 'TR1',tr1,iRec,myIter,myThid)
108    #endif
109  #ifdef ALLOW_NONHYDROSTATIC  #ifdef ALLOW_NONHYDROSTATIC
110          IF (nonHydroStatic) THEN          IF (nonHydroStatic) THEN
111           CALL WRITE_REC_XYZ_RL( 'PNH',cg3d_x,iRec,myIter,myThid)           CALL WRITE_REC_XYZ_RL( 'PNH',phi_nh,iRec,myIter,myThid)
112          ENDIF          ENDIF
113  #endif /* ALLOW_NONHYDROSTATIC */  #endif /* ALLOW_NONHYDROSTATIC */
114  #else  #ifdef NONLIN_FRSURF
115            CALL WRITE_REC_XYZ_RS('hFacC.',hFacC,iRec,myIter,myThid)
116            CALL WRITE_FLD_XYZ_RS('hFacW.',hFacW,iRec,myIter,myThid)
117            CALL WRITE_FLD_XYZ_RS('hFacS.',hFacS,iRec,myIter,myThid)
118    #endif /* NONLIN_FRSURF */
119    
120    #else /* MULTIPLE_RECORD_STATE_FILES */
121    
122  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 method)
123  C       - creates many files but for large configurations is easier to  C       - creates many files but for large configurations is easier to
124  C         transfer analyse a particular snap-shots  C         transfer analyse a particular snap-shots
# Line 113  C         transfer analyse a particular Line 127  C         transfer analyse a particular
127          CALL WRITE_FLD_XYZ_RL( 'V.',suff,vVel,myIter,myThid)          CALL WRITE_FLD_XYZ_RL( 'V.',suff,vVel,myIter,myThid)
128          CALL WRITE_FLD_XYZ_RL( 'T.',suff,theta,myIter,myThid)          CALL WRITE_FLD_XYZ_RL( 'T.',suff,theta,myIter,myThid)
129          CALL WRITE_FLD_XYZ_RL( 'S.',suff,salt,myIter,myThid)          CALL WRITE_FLD_XYZ_RL( 'S.',suff,salt,myIter,myThid)
130          CALL WRITE_FLD_XY_RL( 'PS.',suff,etaN,myIter,myThid)          CALL WRITE_FLD_XY_RL('Eta.',suff,etaN,myIter,myThid)
131          CALL WRITE_FLD_XYZ_RL( 'W.',suff,wVel,myIter,myThid)          CALL WRITE_FLD_XYZ_RL( 'W.',suff,wVel,myIter,myThid)
132    #ifdef ALLOW_PASSIVE_TRACER
133            CALL WRITE_FLD_XYZ_RL( 'TR1.',suff,tr1,myIter,myThid)
134    #endif
135  #ifdef ALLOW_NONHYDROSTATIC  #ifdef ALLOW_NONHYDROSTATIC
136          IF (nonHydroStatic) THEN          IF (nonHydroStatic) THEN
137           CALL WRITE_FLD_XYZ_RL( 'PNH.',suff,cg3d_x,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
141            CALL WRITE_FLD_XYZ_RS('hFacC.',suff,hFacC,myIter,myThid)
142            CALL WRITE_FLD_XYZ_RS('hFacW.',suff,hFacW,myIter,myThid)
143            CALL WRITE_FLD_XYZ_RS('hFacS.',suff,hFacS,myIter,myThid)
144    #endif /* NONLIN_FRSURF */
145    
146  #endif /* MULTIPLE_RECORD_STATE_FILES */  #endif /* MULTIPLE_RECORD_STATE_FILES */
147    
148           _END_MASTER( myThid )           _END_MASTER( myThid )
Legend:
Removed from v.1.9  
changed lines
  Added in v.1.16
  ViewVC Help
Powered by ViewVC 1.1.22