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

Annotation of /MITgcm/model/src/do_write_pickup.F

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


Revision 1.4 - (hide annotations) (download)
Fri Oct 19 14:36:47 2007 UTC (16 years, 7 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint59i, checkpoint59k, checkpoint59j
Changes since 1.3: +2 -1 lines
prepare for "clever pickup" implementation:
new header file: RESTART.h for internal parameters related to restart process
(move parameters from PARAMS.h & GAD.h to new header file RESTART.h)

1 jmc 1.4 C $Header: /u/gcmpack/MITgcm/model/src/do_write_pickup.F,v 1.3 2006/09/06 18:15:57 jmc Exp $
2 jmc 1.1 C $Name: $
3    
4     #include "PACKAGES_CONFIG.h"
5     #include "CPP_OPTIONS.h"
6    
7     C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
8     CBOP
9     C !ROUTINE: DO_WRITE_PICKUP
10     C !INTERFACE:
11     SUBROUTINE DO_WRITE_PICKUP(
12     I modelEnd,
13     I myTime, myIter, myThid )
14    
15     C !DESCRIPTION:
16     C This is the controlling routine that decides when to write restart
17     C (or "pickup" or "checkpoint" ) files. Then it calls 2 subroutines
18     C to write the main-model pickup and each package pickup files.
19     C
20     C Both ``rolling-pickup'' files and permanent pickup files
21     C are written from here. A rolling pickup works through a circular
22     C list of suffices. Generally the circular list has two entries so
23     C that a rolling pickup will overwrite the last rolling
24     C pickup but one. This is useful for running long jobs without
25     C filling too much disk space. In a permanent pickup, data is
26     C written suffixed by the current timestep number. Permanent
27     C pickups can be used to provide snap-shots from which the
28     C model can be restarted.
29    
30     C !USES:
31     IMPLICIT NONE
32     #include "SIZE.h"
33     #include "EEPARAMS.h"
34     #include "PARAMS.h"
35 jmc 1.4 #include "RESTART.h"
36 jmc 1.1 LOGICAL DIFFERENT_MULTIPLE
37     EXTERNAL DIFFERENT_MULTIPLE
38    
39     C !INPUT PARAMETERS:
40     C modelEnd :: true if call at end of model run.
41     C myTime :: Current time of simulation ( s )
42     C myIter :: Iteration number
43     C myThid :: Thread number for this instance of the routine.
44     LOGICAL modelEnd
45     INTEGER myThid
46     INTEGER myIter
47     _RL myTime
48     CEOP
49    
50     C !LOCAL VARIABLES:
51     C permPickup :: Flag indicating whether a permanent pickup will
52     C be written.
53     C tempPickup :: Flag indicating if it is time to write a non-permanent
54     C pickup (that will be permanent if permPickup=T)
55     C fn :: Temp. for building file name string.
56     C msgBuf :: message buffer
57     LOGICAL permPickup, tempPickup
58     CHARACTER*(MAX_LEN_FNAM) fn
59     CHARACTER*(MAX_LEN_MBUF) msgBuf
60    
61     permPickup = .FALSE.
62     tempPickup = .FALSE.
63     permPickup =
64     & DIFFERENT_MULTIPLE(pChkPtFreq,myTime,deltaTClock)
65     tempPickup =
66     & DIFFERENT_MULTIPLE( chkPtFreq,myTime,deltaTClock)
67    
68     #ifdef ALLOW_CAL
69     IF ( useCAL ) THEN
70     CALL CAL_TIME2DUMP( pChkPtFreq, deltaTClock,
71     U permPickup,
72     I myTime, myIter, myThid )
73     CALL CAL_TIME2DUMP( chkPtFreq, deltaTClock,
74     U tempPickup,
75     I myTime, myIter, myThid )
76     ENDIF
77     #endif
78    
79     IF (
80     & ( .NOT.modelEnd .AND. (permPickup.OR.tempPickup) )
81     & .OR.
82     & ( modelEnd .AND. .NOT.(permPickup.OR.tempPickup) )
83     & ) THEN
84     C-- this is time to write pickup files
85    
86     C- write a pickup for each package which need it to restart
87     CALL PACKAGES_WRITE_PICKUP(
88     I permPickup, myTime, myIter, myThid )
89    
90     C- write main model pickup
91 jmc 1.3 IF ( .NOT.useOffLine ) THEN
92 jmc 1.1 CALL WRITE_PICKUP(
93     I permPickup, myTime, myIter, myThid )
94     ENDIF
95    
96     _BEGIN_MASTER(myThid)
97     C- Write suffix for stdout information
98     IF ( permPickup ) THEN
99     WRITE(fn,'(I10.10)') myIter
100     ELSE
101     WRITE(fn,'(A)') checkPtSuff(nCheckLev)
102     ENDIF
103    
104     C- Write information to stdout so there is a record that
105     C writing the pickup was completed
106     WRITE(msgBuf,'(A11,I10,1X,A10)')
107     & "%CHECKPOINT ",myIter,fn
108     CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
109     & SQUEEZE_RIGHT, myThid )
110    
111     C- Update pickup level for the next time we write pickup
112     IF ( .NOT. permPickup ) THEN
113     nCheckLev = MOD(nCheckLev, maxNoChkptLev)+1
114     ENDIF
115     _END_MASTER(myThid)
116    
117     C-- time to write pickup files: end
118     ENDIF
119    
120     RETURN
121     END

  ViewVC Help
Powered by ViewVC 1.1.22