/[MITgcm]/MITgcm/model/src/packages_write_pickup.F
ViewVC logotype

Diff of /MITgcm/model/src/packages_write_pickup.F

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.20 by cnh, Tue Nov 8 23:01:10 2005 UTC revision 1.37 by jmc, Tue Sep 1 19:42:39 2009 UTC
# Line 5  C $Name$ Line 5  C $Name$
5  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
6    
7  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
8    C     files.
9    
10  CBOP  CBOP
11  C     !ROUTINE: PACKAGES_WRITE_PICKUP  C     !ROUTINE: PACKAGES_WRITE_PICKUP
12    
13  C     !INTERFACE:  C     !INTERFACE:
14        SUBROUTINE PACKAGES_WRITE_PICKUP(        SUBROUTINE PACKAGES_WRITE_PICKUP(
15       I     modelEnd,       I                    permPickup,
16       I     myTime,       I                    myTime, myIter, myThid )
      I     myIter,  
      I     myThid )  
17    
18  C     !DESCRIPTION:  C     !DESCRIPTION:
19  C     Write pickup files for each package which needs it to restart.  C     Write pickup files for each package which needs it to restart.
20  C     This routine (S/R PACKAGES_WRITE_PICKUP) calls per-package  C     This routine (S/R PACKAGES_WRITE_PICKUP) calls per-package
21  C     write-pickup (or checkpoint) routines.  It writes both  C     write-pickup (or checkpoint) routines.  It writes both
22  C     "rolling-checkpoint" files (ckptA,ckptB) and permanent checkpoint  C     "rolling-pickup" files (ckptA,ckptB) and permanent pickup.
 C     files.  
23    
24  C     !USES:  C     !USES:
25        IMPLICIT NONE        IMPLICIT NONE
26  #include "SIZE.h"  #include "SIZE.h"
27  #include "EEPARAMS.h"  #include "EEPARAMS.h"
28  #include "PARAMS.h"  #include "PARAMS.h"
29    #include "RESTART.h"
       LOGICAL  DIFFERENT_MULTIPLE  
       EXTERNAL DIFFERENT_MULTIPLE  
       INTEGER  IO_ERRCOUNT  
       EXTERNAL IO_ERRCOUNT  
30    
31  C     !INPUT/OUTPUT PARAMETERS:  C     !INPUT/OUTPUT PARAMETERS:
32  C     == Routine arguments ==  C     permPickup :: Is or is not a permanent pickup.
33  C     modelEnd    :: Checkpoint call at end of model run.  C     myTime     :: Current time of simulation ( s )
34  C     myThid :: Thread number for this instance of the routine.  C     myIter     :: Iteration number
35  C     myIter :: Iteration number  C     myThid     :: Thread number for this instance of the routine.
36  C     myTime :: Current time of simulation ( s )        LOGICAL permPickup
       LOGICAL modelEnd      
       INTEGER myThid  
       INTEGER myIter  
37        _RL     myTime        _RL     myTime
   
 C     !LOCAL VARIABLES:  
 C     == Local variables ==  
 C     permCheckPoint :: Flag indicating whether a permanent checkpoint will  
 C                       be written.  
 C     tempCheckPoint :: Flag indicating if it is time to write a non-permanent  
 C                       checkpoint (that will be permanent if permCheckPoint=T)  
 C     oldPrc :: Temp. for holding I/O precision  
 C     fn     :: Temp. for building file name string.  
 C     lgf    :: Flag to indicate whether to use global file mode.  
       LOGICAL permCheckPoint, tempCheckPoint    
 #ifdef ALLOW_CAL  
       INTEGER thisdate(4), prevdate(4)  
 #endif  
 CEOP  
   
       permCheckPoint = .FALSE.  
       tempCheckPoint = .FALSE.  
       permCheckPoint=  
      &     DIFFERENT_MULTIPLE(pChkptFreq,myTime,deltaTClock)  
       tempCheckPoint=  
      &     DIFFERENT_MULTIPLE( ChkptFreq,myTime,deltaTClock)  
   
 #ifdef ALLOW_CAL  
       IF ( calendarDumps ) THEN  
 C--   Convert approximate months (30-31 days) and years (360-372 days)  
 C     to exact calendar months and years.  
 C-    First determine calendar dates for this and previous time step.  
          call cal_GetDate( myiter  ,mytime            ,thisdate,mythid )  
          call cal_GetDate( myiter-1,mytime-deltaTClock,prevdate,mythid )  
 C-    Monthly pChkptFreq:  
          IF( pChkptFreq.GE. 2592000 .AND. pChkptFreq.LE. 2678400 ) THEN  
             permCheckPoint = .FALSE.  
             IF((thisdate(1)-prevdate(1)) .GT. 50  )permCheckPoint=.TRUE.  
          ENDIF  
 C-    Yearly  pChkptFreq:  
          IF( pChkptFreq.GE.31104000 .AND. pChkptFreq.LE.31968000 ) THEN  
             permCheckPoint = .FALSE.  
             IF((thisdate(1)-prevdate(1)) .GT. 5000)permCheckPoint=.TRUE.  
          ENDIF  
 C-    Monthly  ChkptFreq:  
          IF(  ChkptFreq.GE. 2592000 .AND.  ChkptFreq.LE. 2678400 ) THEN  
             tempCheckPoint = .FALSE.  
             IF((thisdate(1)-prevdate(1)) .GT. 50  )tempCheckPoint=.TRUE.  
          ENDIF  
 C-    Yearly   ChkptFreq:  
          IF(  ChkptFreq.GE.31104000 .AND.  ChkptFreq.LE.31968000 ) THEN  
             tempCheckPoint = .FALSE.  
             IF((thisdate(1)-prevdate(1)) .GT. 5000)tempCheckPoint=.TRUE.  
          ENDIF  
       ENDIF  
 #endif  
   
       IF (  
      &     ( .NOT.modelEnd .AND. (permCheckPoint.OR.tempCheckPoint) )  
      &     .OR.  
      &     ( modelEnd .AND. .NOT.(permCheckPoint.OR.tempCheckPoint) )  
      &     ) THEN  
   
         CALL PACKAGES_WRITE_PICKUP_NOW(  
      &       permCheckPoint, myTime, myIter, myThid )  
   
       ENDIF  
   
       RETURN  
       END  
   
   
 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  
 CBOP  
 C     !ROUTINE: PACKAGES_WRITE_PICKUP_NOW  
   
 C     !INTERFACE:  
       SUBROUTINE PACKAGES_WRITE_PICKUP_NOW(  
      I     permCheckPoint,  
      I     myTime,  
      I     myIter,  
      I     myThid )  
   
 C     !DESCRIPTION:  
 C     Write pickup files for each package which needs it to restart and  
 C     do it NOW.  
   
 C     !USES:  
       IMPLICIT NONE  
 #include "SIZE.h"  
 #include "EEPARAMS.h"  
 #include "PARAMS.h"  
   
   
 C     !INPUT/OUTPUT PARAMETERS:  
 C     permCheckPoint  :: Checkpoint is permanent  
 C     myThid :: Thread number for this instance of the routine.  
 C     myIter :: Iteration number  
 C     myTime :: Current time of simulation ( s )  
       LOGICAL permCheckPoint  
       INTEGER myThid  
38        INTEGER myIter        INTEGER myIter
39        _RL     myTime        INTEGER myThid
   
 C     == Common blocks ==  
       COMMON /PCKP_GBLFLS/ globalFile  
       LOGICAL globalFile  
40    
41  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
42  C     == Local variables ==  C     == Local variables ==
43  C     oldPrc :: Temp. for holding I/O precision  C     suffix :: pickup-name suffix
44  C     fn     :: Temp. for building file name string.        CHARACTER*(10) suffix
 C     lgf    :: Flag to indicate whether to use global file mode.  
       CHARACTER*(MAX_LEN_FNAM) fn  
       INTEGER prec  
       LOGICAL lgf  
45  CEOP  CEOP
46    
47  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.
48        _BARRIER  C     this is done within IO routines => no longer needed
49  C     _BEGIN_MASTER( myThid )  c     _BARRIER
50    
       prec = precFloat64  
       lgf = globalFile  
         
51  C     Create suffix to pass on to package pickup routines  C     Create suffix to pass on to package pickup routines
52        IF ( permCheckPoint ) THEN        IF ( permPickup ) THEN
53          WRITE(fn,'(I10.10)') myIter          WRITE(suffix,'(I10.10)') myIter
54        ELSE        ELSE
55          WRITE(fn,'(A)') checkPtSuff(nCheckLev)          WRITE(suffix,'(A)') checkPtSuff(nCheckLev)
56          ENDIF
57    
58    #ifdef ALLOW_GENERIC_ADVDIFF
59    C     Write restart file for 2nd-Order moment (active) Tracers
60          IF ( useGAD ) THEN
61            CALL GAD_WRITE_PICKUP(
62         I                 suffix, myTime, myIter, myThid )
63        ENDIF        ENDIF
64    #endif /* ALLOW_GENERIC_ADVDIFF */
65    
66  #ifdef ALLOW_CD_CODE  #ifdef ALLOW_CD_CODE
67        IF (useCDscheme) THEN        IF (useCDscheme) THEN
68          CALL CD_CODE_WRITE_CHECKPOINT(          CALL CD_CODE_WRITE_PICKUP( permPickup,
69       &       prec, lgf, permCheckPoint, myIter, myThid)       I                     suffix, myTime, myIter, myThid )
70        ENDIF        ENDIF
71  #endif /* ALLOW_CD_CODE */  #endif /* ALLOW_CD_CODE */
72    
73  #ifdef  ALLOW_OBCS  #ifdef  ALLOW_OBCS
74  C     SPK 4/9/01: Open boundary checkpointing  C     SPK 4/9/01: Open boundary checkpointing
75        IF (useOBCS) THEN  c      IF (useOBCS) THEN
76          CALL OBCS_WRITE_CHECKPOINT(  c        CALL OBCS_WRITE_PICKUP(
77       &       prec, lgf, permCheckPoint, myIter, myThid)  c     &                  suffix, myTime, myIter, myThid )
78        ENDIF  c      ENDIF
79  #endif  /* ALLOW_OBCS */  #endif  /* ALLOW_OBCS */
80          
81  #ifdef  ALLOW_SEAICE  #ifdef  ALLOW_SEAICE
82        IF ( useSEAICE ) THEN        IF ( useSEAICE ) THEN
83          CALL SEAICE_WRITE_PICKUP(          CALL SEAICE_WRITE_PICKUP( permPickup,
84       &       prec, lgf, permCheckPoint, myIter, myThid)       I                    suffix, myTime, myIter, myThid )
85        ENDIF        ENDIF
86  #endif  /* ALLOW_SEAICE */  #endif  /* ALLOW_SEAICE */
87    
88  #ifdef ALLOW_THSICE  #ifdef ALLOW_THSICE
89        IF (useThSIce) THEN        IF (useThSIce) THEN
90          CALL THSICE_WRITE_PICKUP(          CALL THSICE_WRITE_PICKUP( permPickup,
91       &       prec, lgf, permCheckPoint, myIter, myThid)       I                    suffix, myTime, myIter, myThid )
92        ENDIF        ENDIF
93  #endif /* ALLOW_THSICE */  #endif /* ALLOW_THSICE */
94    
95  #ifdef  COMPONENT_MODULE  #ifdef  COMPONENT_MODULE
96        IF (useCoupler) THEN        IF (useCoupler) THEN
97          CALL CPL_WRITE_PICKUP(          CALL CPL_WRITE_PICKUP(
98       &       prec, lgf, permCheckPoint, myIter, myThid)       &                 suffix, myTime, myIter, myThid )
99        ENDIF        ENDIF
100  #endif  /* COMPONENT_MODULE */  #endif  /* COMPONENT_MODULE */
101    
102  #ifdef ALLOW_FLT  #ifdef ALLOW_FLT
103  C     Write restart file for floats  C     Write restart file for floats
104        IF (useFLT) THEN        IF (useFLT) THEN
105          CALL FLT_RESTART(myTime, myIter, myThid)          CALL FLT_WRITE_PICKUP(
106         &                  suffix, myTime, myIter, myThid )
107        ENDIF        ENDIF
108  #endif  #endif
109    
110  #ifdef ALLOW_LAND  #ifdef ALLOW_LAND
111  C     Write pickup file for Land package:  C     Write pickup file for Land package:
112        IF (useLand) THEN        IF (useLand) THEN
113          CALL LAND_WRITE_PICKUP(permCheckPoint,fn,          CALL LAND_WRITE_PICKUP( permPickup,
114       &       myTime,myIter,myThid)       &                  suffix, myTime, myIter, myThid )
115        ENDIF        ENDIF
116  #endif  #endif
117    
118  #ifdef ALLOW_FIZHI  #ifdef ALLOW_FIZHI
119  C     Write pickup file for fizhi package  C     Write pickup file for fizhi package
120        IF (usefizhi) THEN        IF (usefizhi) THEN
121          CALL FIZHI_WRITE_PICKUP(fn,myTime,myIter,myThid)          CALL FIZHI_WRITE_PICKUP(suffix,myTime,myIter,myThid)
122          CALL FIZHI_WRITE_VEGTILES(fn,0,myTime,myIter,myThid)          CALL FIZHI_WRITE_VEGTILES(suffix,0,myTime,myIter,myThid)
123          CALL FIZHI_WRITE_DATETIME(myTime,myIter,myThid)          CALL FIZHI_WRITE_DATETIME(myTime,myIter,myThid)
124        ENDIF        ENDIF
125  #endif  #endif
# Line 234  C     Write pickup file for fizhi packag Line 127  C     Write pickup file for fizhi packag
127  #ifdef ALLOW_DIAGNOSTICS  #ifdef ALLOW_DIAGNOSTICS
128  C     Write pickup file for diagnostics package  C     Write pickup file for diagnostics package
129        IF (useDiagnostics) THEN        IF (useDiagnostics) THEN
130          CALL DIAGNOSTICS_WRITE_PICKUP(permCheckPoint,          CALL DIAGNOSTICS_WRITE_PICKUP( permPickup,
131       &       fn,myTime,myIter,myThid)       I                         suffix, myTime, myIter, myThid )
132        ENDIF        ENDIF
133  #endif  #endif
134    
135  #ifdef  ALLOW_GGL90  #ifdef  ALLOW_GGL90
136        IF ( useGGL90 ) THEN        IF ( useGGL90 ) THEN
137          CALL GGL90_WRITE_CHECKPOINT(          CALL GGL90_WRITE_PICKUP( permPickup,
138       &       prec, lgf, permCheckPoint, myIter, myThid)       I                      suffix, myTime, myIter, myThid )
139        ENDIF        ENDIF
140  #endif  /* ALLOW_GGL90 */  #endif  /* ALLOW_GGL90 */
141    
 C     _END_MASTER( myThid )  
       _BARRIER  
   
142  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
143  C     Write restart file for passive tracers  C     Write restart file for passive tracers
144        IF (usePTRACERS) THEN        IF (usePTRACERS) THEN
145          CALL PTRACERS_WRITE_CHECKPOINT(permCheckPoint,          CALL PTRACERS_WRITE_PICKUP( permPickup,
146       &       fn,myIter,myTime,myThid)       I                      suffix, myTime, myIter, myThid )
147        ENDIF        ENDIF
148  #endif /* ALLOW_PTRACERS */  #endif /* ALLOW_PTRACERS */
149    
150  #ifdef ALLOW_OFFLINE  #ifdef ALLOW_GCHEM
151  C     This is quick fix for A/B checkpoints since the main model  C     Write restart file for GCHEM pkg & GCHEM sub-packages
152  C     checkpoint routine will not be called in OFFLINE mode and will        IF ( useGCHEM ) THEN
153  C     thus not have the chance to set the alternating A/B suffix          CALL GCHEM_WRITE_PICKUP( permPickup,
154        IF ( .NOT. permCheckPoint ) THEN       I                      suffix, myTime, myIter, myThid )
         nCheckLev = MOD(nCheckLev, maxNoChkptLev)+1  
155        ENDIF        ENDIF
156  #endif /* ALLOW_OFFLINE */  #endif
157    
158    #ifdef ALLOW_CHEAPAML
159    C     Write restart file for CHEAPAML pkg
160          IF ( useCheapAML ) THEN
161             CALL CHEAPAML_WRITE_PICKUP( permPickup,
162         I                      suffix, myTime, myIter, myThid)
163           ENDIF
164    #endif /* ALLOW_CHEAPAML */
165    
166    #ifdef ALLOW_MYPACKAGE
167          IF (useMYPACKAGE) THEN
168            CALL MYPACKAGE_WRITE_PICKUP( permPickup,
169         I                      suffix, myTime, myIter, myThid )
170          ENDIF
171    #endif /* ALLOW_MYPACKAGE */
172    
173    C--   Every one else must wait until writing is done.
174    C     this is done within IO routines => no longer needed
175    c     _BARRIER
176    
177        RETURN        RETURN
178        END        END
Legend:
Removed from v.1.20  
changed lines
  Added in v.1.37
  ViewVC Help
Powered by ViewVC 1.1.22