model/src/packages_write_pickup.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_write_pickup.F,v 1.32 2008/04/06 20:53:22 jmc Exp $
C $Name:  $

#include "PACKAGES_CONFIG.h"
#include "CPP_OPTIONS.h"

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
C     files.

CBOP
C     !ROUTINE: PACKAGES_WRITE_PICKUP

C     !INTERFACE:
      SUBROUTINE PACKAGES_WRITE_PICKUP(
     I                    permPickup,
     I                    myTime, myIter, myThid )

C     !DESCRIPTION:
C     Write pickup files for each package which needs it to restart.
C     This routine (S/R PACKAGES_WRITE_PICKUP) calls per-package
C     write-pickup (or checkpoint) routines.  It writes both
C     "rolling-pickup" files (ckptA,ckptB) and permanent pickup.

C     !USES:
      IMPLICIT NONE
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "RESTART.h"

C     !INPUT/OUTPUT PARAMETERS:
C     permPickup :: Is or is not a permanent pickup.
C     myTime     :: Current time of simulation ( s )
C     myIter     :: Iteration number
C     myThid     :: Thread number for this instance of the routine.
      LOGICAL permPickup
      _RL     myTime
      INTEGER myIter
      INTEGER myThid

C     !LOCAL VARIABLES:
C     == Local variables ==
C     prec   :: file precision
C     suffix :: pickup-name suffix
C     lgf    :: Flag to indicate whether to use global file mode.
      CHARACTER*(10) suffix
      INTEGER prec
      LOGICAL lgf
CEOP

C     Going to really do some IO. Make everyone except master thread wait.
      _BARRIER

      prec = precFloat64
      lgf = globalFiles

C     Create suffix to pass on to package pickup routines
      IF ( permPickup ) THEN
        WRITE(suffix,'(I10.10)') myIter
      ELSE
        WRITE(suffix,'(A)') checkPtSuff(nCheckLev)
      ENDIF

#ifdef ALLOW_GENERIC_ADVDIFF
C     Write restart file for 2nd-Order moment (active) Tracers
      IF ( useGAD ) THEN
        CALL GAD_WRITE_PICKUP(
     I                 suffix, myTime, myIter, myThid )
      ENDIF
#endif /* ALLOW_GENERIC_ADVDIFF */

#ifdef ALLOW_CD_CODE
      IF (useCDscheme) THEN
        CALL CD_CODE_WRITE_PICKUP( permPickup,
     I                     suffix, myTime, myIter, myThid )
      ENDIF
#endif /* ALLOW_CD_CODE */

#ifdef  ALLOW_OBCS
C     SPK 4/9/01: Open boundary checkpointing
c      IF (useOBCS) THEN
c        CALL OBCS_WRITE_CHECKPOINT(
c     &       prec, lgf, permPickup, myIter, myThid)
c      ENDIF
#endif  /* ALLOW_OBCS */

#ifdef  ALLOW_SEAICE
      IF ( useSEAICE ) THEN
        CALL SEAICE_WRITE_PICKUP( permPickup,
     I                    suffix, myTime, myIter, myThid )
      ENDIF
#endif  /* ALLOW_SEAICE */

#ifdef ALLOW_THSICE
      IF (useThSIce) THEN
        CALL THSICE_WRITE_PICKUP( permPickup,
     I                    suffix, myTime, myIter, myThid )
      ENDIF
#endif /* ALLOW_THSICE */

#ifdef  COMPONENT_MODULE
      IF (useCoupler) THEN
        CALL CPL_WRITE_PICKUP(
     &                 suffix, myTime, myIter, myThid )
      ENDIF
#endif  /* COMPONENT_MODULE */

#ifdef ALLOW_FLT
C     Write restart file for floats
      IF (useFLT) THEN
        CALL FLT_RESTART(myTime, myIter, myThid)
      ENDIF
#endif

#ifdef ALLOW_LAND
C     Write pickup file for Land package:
      IF (useLand) THEN
        CALL LAND_WRITE_PICKUP( permPickup,
     &                  suffix, myTime, myIter, myThid )
      ENDIF
#endif

#ifdef ALLOW_FIZHI
C     Write pickup file for fizhi package
      IF (usefizhi) THEN
        CALL FIZHI_WRITE_PICKUP(suffix,myTime,myIter,myThid)
        CALL FIZHI_WRITE_VEGTILES(suffix,0,myTime,myIter,myThid)
        CALL FIZHI_WRITE_DATETIME(myTime,myIter,myThid)
      ENDIF
#endif

#ifdef ALLOW_DIAGNOSTICS
C     Write pickup file for diagnostics package
      IF (useDiagnostics) THEN
        CALL DIAGNOSTICS_WRITE_PICKUP( permPickup,
     I                         suffix, myTime, myIter, myThid )
      ENDIF
#endif

#ifdef  ALLOW_GGL90
      IF ( useGGL90 ) THEN
        CALL GGL90_WRITE_PICKUP( permPickup,
     I                      suffix, myTime, myIter, myThid )
      ENDIF
#endif  /* ALLOW_GGL90 */

#ifdef ALLOW_PTRACERS
C     Write restart file for passive tracers
      IF (usePTRACERS) THEN
        CALL PTRACERS_WRITE_PICKUP( permPickup,
     I                      suffix, myTime, myIter, myThid )
      ENDIF
#endif /* ALLOW_PTRACERS */

#ifdef ALLOW_GCHEM
C     Write restart file for GCHEM pkg & GCHEM sub-packages
      IF ( useGCHEM ) THEN
        CALL GCHEM_WRITE_PICKUP( permPickup,
     I                      suffix, myTime, myIter, myThid )
      ENDIF
#endif

#ifdef ALLOW_MYPACKAGE
      IF (useMYPACKAGE) THEN
        CALL MYPACKAGE_WRITE_PICKUP( permPickup,
     I                      suffix, myTime, myIter, myThid )
      ENDIF
#endif /* ALLOW_MYPACKAGE */

C--   Every one else must wait until writing is done.
      _BARRIER

      RETURN
      END

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
1	jmc	1.33	C $Header: /u/gcmpack/MITgcm/model/src/packages_write_pickup.F,v 1.32 2008/04/06 20:53:22 jmc Exp $
2	jmc	1.1	C $Name: $
3
4			#include "PACKAGES_CONFIG.h"
5			#include "CPP_OPTIONS.h"
6
7	edhill	1.6	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
8	jmc	1.23	C files.
9
10	jmc	1.1	CBOP
11			C !ROUTINE: PACKAGES_WRITE_PICKUP
12	edhill	1.6
13	jmc	1.1	C !INTERFACE:
14	jmc	1.22	SUBROUTINE PACKAGES_WRITE_PICKUP(
15	jmc	1.23	I permPickup,
16			I myTime, myIter, myThid )
17	edhill	1.6
18			C !DESCRIPTION:
19			C Write pickup files for each package which needs it to restart.
20			C This routine (S/R PACKAGES_WRITE_PICKUP) calls per-package
21			C write-pickup (or checkpoint) routines. It writes both
22	jmc	1.23	C "rolling-pickup" files (ckptA,ckptB) and permanent pickup.
23	jmc	1.1
24			C !USES:
25			IMPLICIT NONE
26			#include "SIZE.h"
27			#include "EEPARAMS.h"
28			#include "PARAMS.h"
29	jmc	1.27	#include "RESTART.h"
30	jmc	1.1
31			C !INPUT/OUTPUT PARAMETERS:
32	jmc	1.23	C permPickup :: Is or is not a permanent pickup.
33			C myTime :: Current time of simulation ( s )
34			C myIter :: Iteration number
35			C myThid :: Thread number for this instance of the routine.
36			LOGICAL permPickup
37	jmc	1.22	_RL myTime
38			INTEGER myIter
39	edhill	1.6	INTEGER myThid
40	jmc	1.1
41	edhill	1.6	C !LOCAL VARIABLES:
42			C == Local variables ==
43	jmc	1.23	C prec :: file precision
44	jmc	1.26	C suffix :: pickup-name suffix
45	edhill	1.6	C lgf :: Flag to indicate whether to use global file mode.
46	jmc	1.26	CHARACTER*(10) suffix
47	edhill	1.6	INTEGER prec
48			LOGICAL lgf
49			CEOP
50	jmc	1.1
51	edhill	1.6	C Going to really do some IO. Make everyone except master thread wait.
52			_BARRIER
53
54			prec = precFloat64
55	jmc	1.26	lgf = globalFiles
56	jmc	1.22
57	edhill	1.6	C Create suffix to pass on to package pickup routines
58	jmc	1.23	IF ( permPickup ) THEN
59	jmc	1.26	WRITE(suffix,'(I10.10)') myIter
60	edhill	1.6	ELSE
61	jmc	1.26	WRITE(suffix,'(A)') checkPtSuff(nCheckLev)
62	edhill	1.6	ENDIF
63	jmc	1.1
64	jmc	1.25	#ifdef ALLOW_GENERIC_ADVDIFF
65			C Write restart file for 2nd-Order moment (active) Tracers
66			IF ( useGAD ) THEN
67			CALL GAD_WRITE_PICKUP(
68	jmc	1.26	I suffix, myTime, myIter, myThid )
69	jmc	1.25	ENDIF
70			#endif /* ALLOW_GENERIC_ADVDIFF */
71
72	jmc	1.1	#ifdef ALLOW_CD_CODE
73	edhill	1.6	IF (useCDscheme) THEN
74	jmc	1.26	CALL CD_CODE_WRITE_PICKUP( permPickup,
75			I suffix, myTime, myIter, myThid )
76	edhill	1.6	ENDIF
77	jmc	1.1	#endif /* ALLOW_CD_CODE */
78
79			#ifdef ALLOW_OBCS
80	edhill	1.6	C SPK 4/9/01: Open boundary checkpointing
81	dimitri	1.28	c IF (useOBCS) THEN
82			c CALL OBCS_WRITE_CHECKPOINT(
83			c & prec, lgf, permPickup, myIter, myThid)
84			c ENDIF
85	jmc	1.1	#endif /* ALLOW_OBCS */
86	jmc	1.22
87	jmc	1.3	#ifdef ALLOW_SEAICE
88	edhill	1.6	IF ( useSEAICE ) THEN
89	jmc	1.26	CALL SEAICE_WRITE_PICKUP( permPickup,
90			I suffix, myTime, myIter, myThid )
91	edhill	1.6	ENDIF
92	jmc	1.3	#endif /* ALLOW_SEAICE */
93	jmc	1.1
94			#ifdef ALLOW_THSICE
95	edhill	1.6	IF (useThSIce) THEN
96	jmc	1.26	CALL THSICE_WRITE_PICKUP( permPickup,
97			I suffix, myTime, myIter, myThid )
98	edhill	1.6	ENDIF
99	jmc	1.1	#endif /* ALLOW_THSICE */
100	jmc	1.2
101			#ifdef COMPONENT_MODULE
102	edhill	1.6	IF (useCoupler) THEN
103			CALL CPL_WRITE_PICKUP(
104	jmc	1.26	& suffix, myTime, myIter, myThid )
105	edhill	1.6	ENDIF
106	jmc	1.2	#endif /* COMPONENT_MODULE */
107	jmc	1.1
108			#ifdef ALLOW_FLT
109	edhill	1.6	C Write restart file for floats
110			IF (useFLT) THEN
111			CALL FLT_RESTART(myTime, myIter, myThid)
112			ENDIF
113	jmc	1.1	#endif
114
115			#ifdef ALLOW_LAND
116	edhill	1.17	C Write pickup file for Land package:
117	edhill	1.6	IF (useLand) THEN
118	jmc	1.26	CALL LAND_WRITE_PICKUP( permPickup,
119			& suffix, myTime, myIter, myThid )
120	edhill	1.6	ENDIF
121	jmc	1.1	#endif
122	molod	1.4
123			#ifdef ALLOW_FIZHI
124	edhill	1.6	C Write pickup file for fizhi package
125			IF (usefizhi) THEN
126	jmc	1.26	CALL FIZHI_WRITE_PICKUP(suffix,myTime,myIter,myThid)
127			CALL FIZHI_WRITE_VEGTILES(suffix,0,myTime,myIter,myThid)
128	molod	1.10	CALL FIZHI_WRITE_DATETIME(myTime,myIter,myThid)
129	edhill	1.6	ENDIF
130	molod	1.4	#endif
131
132	edhill	1.11	#ifdef ALLOW_DIAGNOSTICS
133			C Write pickup file for diagnostics package
134			IF (useDiagnostics) THEN
135	jmc	1.26	CALL DIAGNOSTICS_WRITE_PICKUP( permPickup,
136			I suffix, myTime, myIter, myThid )
137	edhill	1.11	ENDIF
138			#endif
139
140	mlosch	1.9	#ifdef ALLOW_GGL90
141			IF ( useGGL90 ) THEN
142	jmc	1.26	CALL GGL90_WRITE_PICKUP( permPickup,
143	jmc	1.31	I suffix, myTime, myIter, myThid )
144	mlosch	1.9	ENDIF
145			#endif /* ALLOW_GGL90 */
146
147	jmc	1.1	#ifdef ALLOW_PTRACERS
148	edhill	1.15	C Write restart file for passive tracers
149			IF (usePTRACERS) THEN
150	jmc	1.26	CALL PTRACERS_WRITE_PICKUP( permPickup,
151	jmc	1.31	I suffix, myTime, myIter, myThid )
152	edhill	1.15	ENDIF
153	jmc	1.1	#endif /* ALLOW_PTRACERS */
154
155	jmc	1.32	#ifdef ALLOW_GCHEM
156			C Write restart file for GCHEM pkg & GCHEM sub-packages
157			IF ( useGCHEM ) THEN
158	jmc	1.33	CALL GCHEM_WRITE_PICKUP( permPickup,
159	jmc	1.32	I suffix, myTime, myIter, myThid )
160			ENDIF
161	dfer	1.30	#endif
162
163	jmc	1.29	#ifdef ALLOW_MYPACKAGE
164			IF (useMYPACKAGE) THEN
165			CALL MYPACKAGE_WRITE_PICKUP( permPickup,
166	jmc	1.31	I suffix, myTime, myIter, myThid )
167	jmc	1.29	ENDIF
168			#endif /* ALLOW_MYPACKAGE */
169
170	jmc	1.23	C-- Every one else must wait until writing is done.
171	jmc	1.22	_BARRIER
172
173	jmc	1.1	RETURN
174			END
175	edhill	1.6
176			C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|