| 1 |
C $Header: /u/gcmpack/MITgcm/model/src/write_state.F,v 1.38 2004/03/24 15:29:33 edhill Exp $ |
| 2 |
C $Name: $ |
| 3 |
|
| 4 |
#include "PACKAGES_CONFIG.h" |
| 5 |
#include "CPP_OPTIONS.h" |
| 6 |
|
| 7 |
#undef MULTIPLE_RECORD_STATE_FILES |
| 8 |
|
| 9 |
CBOP |
| 10 |
C !ROUTINE: WRITE_STATE |
| 11 |
C !INTERFACE: |
| 12 |
SUBROUTINE WRITE_STATE ( myTime, myIter, myThid ) |
| 13 |
C !DESCRIPTION: \bv |
| 14 |
C *==========================================================* |
| 15 |
C | SUBROUTINE WRITE_STATE |
| 16 |
C | o Controlling routine for IO to dump model state. |
| 17 |
C *==========================================================* |
| 18 |
C | Write model state files for post-processing. This file |
| 19 |
C | includes code for diagnosing W and RHO for output. |
| 20 |
C | File write_state.F: Routines to handle mid-level I/O |
| 21 |
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 === |
| 56 |
#include "SIZE.h" |
| 57 |
#include "EEPARAMS.h" |
| 58 |
#include "PARAMS.h" |
| 59 |
#include "DYNVARS.h" |
| 60 |
#include "GRID.h" |
| 61 |
#include "EOS.h" |
| 62 |
#ifdef ALLOW_PASSIVE_TRACER |
| 63 |
#include "TR1.h" |
| 64 |
#endif |
| 65 |
LOGICAL DIFFERENT_MULTIPLE |
| 66 |
EXTERNAL DIFFERENT_MULTIPLE |
| 67 |
INTEGER IO_ERRCOUNT |
| 68 |
EXTERNAL IO_ERRCOUNT |
| 69 |
|
| 70 |
C !INPUT/OUTPUT PARAMETERS: |
| 71 |
C myThid - Thread number for this instance of the routine. |
| 72 |
C myIter - Iteration number |
| 73 |
C myTime - Current time of simulation ( s ) |
| 74 |
_RL myTime |
| 75 |
INTEGER myThid |
| 76 |
INTEGER myIter |
| 77 |
|
| 78 |
C !LOCAL VARIABLES: |
| 79 |
CHARACTER*(MAX_LEN_MBUF) suff |
| 80 |
INTEGER iRec |
| 81 |
#ifdef ALLOW_MNC |
| 82 |
_RL mnc_iter |
| 83 |
#endif |
| 84 |
CEOP |
| 85 |
|
| 86 |
IF ( |
| 87 |
& DIFFERENT_MULTIPLE(dumpFreq,myTime, |
| 88 |
& myTime-deltaTClock) .OR. |
| 89 |
& myTime.EQ.endTime .OR. |
| 90 |
& myTime.EQ.startTime |
| 91 |
& ) THEN |
| 92 |
IF ( dumpFreq .EQ. 0.0 ) THEN |
| 93 |
iRec = 1 |
| 94 |
ELSE |
| 95 |
iRec = int ( (myTime-startTime) / dumpFreq +1.5 ) |
| 96 |
ENDIF |
| 97 |
|
| 98 |
C-- Going to really do some IO. Make everyone except master thread wait. |
| 99 |
_BARRIER |
| 100 |
_BEGIN_MASTER( myThid ) |
| 101 |
|
| 102 |
C-- Write model fields |
| 103 |
|
| 104 |
#ifdef MULTIPLE_RECORD_STATE_FILES |
| 105 |
|
| 106 |
C Write each snap-shot as a new record in one file per variable |
| 107 |
C - creates relatively few files but these files can become huge |
| 108 |
CALL WRITE_REC_XYZ_RL( 'U', uVel,iRec,myIter,myThid) |
| 109 |
CALL WRITE_REC_XYZ_RL( 'V', vVel,iRec,myIter,myThid) |
| 110 |
CALL WRITE_REC_XYZ_RL( 'T', theta,iRec,myIter,myThid) |
| 111 |
CALL WRITE_REC_XYZ_RL( 'S', salt,iRec,myIter,myThid) |
| 112 |
CALL WRITE_REC_XY_RL('Eta',etaN,iRec,myIter,myThid) |
| 113 |
CALL WRITE_REC_XYZ_RL( 'W',wVel,iRec,myIter,myThid) |
| 114 |
#ifdef ALLOW_PASSIVE_TRACER |
| 115 |
ceh3 needs an IF ( usePASSIVE_TRACER ) THEN |
| 116 |
CALL WRITE_REC_XYZ_RL( 'TR1',tr1,iRec,myIter,myThid) |
| 117 |
#endif /* ALLOW_PASSIVE_TRACER */ |
| 118 |
#ifdef ALLOW_NONHYDROSTATIC |
| 119 |
IF (nonHydroStatic) THEN |
| 120 |
CALL WRITE_REC_XYZ_RL( 'PNH',phi_nh,iRec,myIter,myThid) |
| 121 |
ENDIF |
| 122 |
#endif /* ALLOW_NONHYDROSTATIC */ |
| 123 |
#ifdef NONLIN_FRSURF |
| 124 |
c CALL WRITE_REC_XYZ_RS('hFacC.',hFacC,iRec,myIter,myThid) |
| 125 |
c CALL WRITE_REC_XYZ_RS('hFacW.',hFacW,iRec,myIter,myThid) |
| 126 |
c CALL WRITE_REC_XYZ_RS('hFacS.',hFacS,iRec,myIter,myThid) |
| 127 |
#endif /* NONLIN_FRSURF */ |
| 128 |
|
| 129 |
#else /* MULTIPLE_RECORD_STATE_FILES */ |
| 130 |
|
| 131 |
C Write each snap-shot as a new file (original and default method) |
| 132 |
C - creates many files but for large configurations is easier to |
| 133 |
C transfer analyse a particular snap-shots |
| 134 |
WRITE(suff,'(I10.10)') myIter |
| 135 |
CALL WRITE_FLD_XYZ_RL( 'U.',suff,uVel,myIter,myThid) |
| 136 |
CALL WRITE_FLD_XYZ_RL( 'V.',suff,vVel,myIter,myThid) |
| 137 |
CALL WRITE_FLD_XYZ_RL( 'T.',suff,theta,myIter,myThid) |
| 138 |
CALL WRITE_FLD_XYZ_RL( 'S.',suff,salt,myIter,myThid) |
| 139 |
CALL WRITE_FLD_XY_RL('Eta.',suff,etaN,myIter,myThid) |
| 140 |
CALL WRITE_FLD_XYZ_RL( 'W.',suff,wVel,myIter,myThid) |
| 141 |
IF ( useDynP_inEos_Zc .OR. myIter.NE.nIter0 ) |
| 142 |
& CALL WRITE_FLD_XYZ_RL( 'PH.',suff,totPhiHyd,myIter,myThid) |
| 143 |
IF (buoyancyRelation.NE.'ATMOSPHERIC' .AND. myIter.NE.nIter0) |
| 144 |
& CALL WRITE_FLD_XY_RL('PHL.',suff,phiHydLow,myIter,myThid) |
| 145 |
#ifdef ALLOW_PASSIVE_TRACER |
| 146 |
ceh3 needs an IF ( usePASSIVE_TRACER ) THEN |
| 147 |
CALL WRITE_FLD_XYZ_RL( 'TR1.',suff,tr1,myIter,myThid) |
| 148 |
#endif |
| 149 |
#ifdef ALLOW_NONHYDROSTATIC |
| 150 |
IF (nonHydroStatic) THEN |
| 151 |
CALL WRITE_FLD_XYZ_RL( 'PNH.',suff,phi_nh,myIter,myThid) |
| 152 |
ENDIF |
| 153 |
#endif /* ALLOW_NONHYDROSTATIC */ |
| 154 |
#ifdef NONLIN_FRSURF |
| 155 |
c CALL WRITE_FLD_XYZ_RS('hFacC.',suff,hFacC,myIter,myThid) |
| 156 |
c CALL WRITE_FLD_XYZ_RS('hFacW.',suff,hFacW,myIter,myThid) |
| 157 |
c CALL WRITE_FLD_XYZ_RS('hFacS.',suff,hFacS,myIter,myThid) |
| 158 |
#endif /* NONLIN_FRSURF */ |
| 159 |
|
| 160 |
#endif /* MULTIPLE_RECORD_STATE_FILES */ |
| 161 |
|
| 162 |
#ifdef ALLOW_PTRACERS |
| 163 |
IF (usePTRACERS) CALL PTRACERS_WRITE_STATE(myIter,myTime,myThid) |
| 164 |
#endif /* ALLOW_PTRACERS */ |
| 165 |
_END_MASTER( myThid ) |
| 166 |
_BARRIER |
| 167 |
|
| 168 |
#ifdef ALLOW_MNC |
| 169 |
IF (useMNC) THEN |
| 170 |
C Write dynvars using the MNC package |
| 171 |
mnc_iter = myIter |
| 172 |
CALL MNC_CW_SET_UDIM('state', -1, myThid) |
| 173 |
CALL MNC_CW_RL_W('D','state',0,0,'iter',mnc_iter, myThid) |
| 174 |
CALL MNC_CW_SET_UDIM('state', 0, myThid) |
| 175 |
CALL MNC_CW_RL_W('D','state',0,0,'model_time',myTime, myThid) |
| 176 |
CALL MNC_CW_RL_W('D','state',0,0,'U', uVel, myThid) |
| 177 |
CALL MNC_CW_RL_W('D','state',0,0,'V', vVel, myThid) |
| 178 |
CALL MNC_CW_RL_W('D','state',0,0,'T', theta, myThid) |
| 179 |
CALL MNC_CW_RL_W('D','state',0,0,'S', salt, myThid) |
| 180 |
CALL MNC_CW_RL_W('D','state',0,0,'Eta', etaN, myThid) |
| 181 |
CALL MNC_CW_RL_W('D','state',0,0,'W', wVel, myThid) |
| 182 |
IF ( useDynP_inEos_Zc .OR. myIter.NE.nIter0 ) THEN |
| 183 |
CALL MNC_CW_SET_UDIM('totPhiHyd', -1, myThid) |
| 184 |
CALL MNC_CW_RL_W('R','totPhiHyd',0,0,'iter',mnc_iter,myThid) |
| 185 |
CALL MNC_CW_SET_UDIM('totPhiHyd', 0, myThid) |
| 186 |
CALL MNC_CW_RL_W('D','totPhiHyd',0,0,'totPhiHyd', |
| 187 |
& totPhiHyd, myThid) |
| 188 |
ENDIF |
| 189 |
IF ((buoyancyRelation .NE. 'ATMOSPHERIC') |
| 190 |
& .AND. (myIter .NE. nIter0)) THEN |
| 191 |
CALL MNC_CW_SET_UDIM('phiHydLow', -1, myThid) |
| 192 |
CALL MNC_CW_RL_W('D','phiHydLow',0,0,'iter',mnc_iter,myThid) |
| 193 |
CALL MNC_CW_SET_UDIM('phiHydLow', 0, myThid) |
| 194 |
CALL MNC_CW_RL_W('D','phiHydLow',0,0,'phiHydLow', |
| 195 |
& phiHydLow, myThid) |
| 196 |
ENDIF |
| 197 |
#ifdef ALLOW_PASSIVE_TRACER |
| 198 |
CALL MNC_CW_RL_W('D','state',0,0,'tr1', tr1, myThid) |
| 199 |
#endif /* ALLOW_PASSIVE_TRACER */ |
| 200 |
#ifdef ALLOW_NONHYDROSTATIC |
| 201 |
IF (nonHydroStatic) THEN |
| 202 |
CALL MNC_CW_RL_W('D','state',0,0,'phi_nh', phi_nh, myThid) |
| 203 |
ENDIF |
| 204 |
#endif /* ALLOW_NONHYDROSTATIC */ |
| 205 |
ENDIF |
| 206 |
#endif /* ALLOW_MNC */ |
| 207 |
|
| 208 |
ENDIF |
| 209 |
|
| 210 |
RETURN |
| 211 |
END |
Parent Directory
| 
Revision Log
| 
Revision Graph