model/src/packages_write_pickup.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_write_pickup.F,v 1.23 2006/08/24 01:10:35 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"

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     == Common blocks ==
      COMMON /PCKP_GBLFLS/ globalFile
      LOGICAL globalFile

C     !LOCAL VARIABLES:
C     == Local variables ==
C     prec   :: file precision
C     fn     :: Temp. for building file name string.
C     lgf    :: Flag to indicate whether to use global file mode.
      CHARACTER*(MAX_LEN_FNAM) fn
      INTEGER prec
      LOGICAL lgf
CEOP

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

      prec = precFloat64
      lgf = globalFile

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

#ifdef ALLOW_CD_CODE
      IF (useCDscheme) THEN
        CALL CD_CODE_WRITE_PICKUP(
     &       prec, lgf, permPickup, myIter, myThid)
      ENDIF
#endif /* ALLOW_CD_CODE */

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

#ifdef  ALLOW_SEAICE
      IF ( useSEAICE ) THEN
        CALL SEAICE_WRITE_PICKUP(
     &       prec, lgf, permPickup, myIter, myThid)
      ENDIF
#endif  /* ALLOW_SEAICE */

#ifdef ALLOW_THSICE
      IF (useThSIce) THEN
        CALL THSICE_WRITE_PICKUP(
     &       prec, lgf, permPickup, myIter, myThid)
      ENDIF
#endif /* ALLOW_THSICE */

#ifdef  COMPONENT_MODULE
      IF (useCoupler) THEN
        CALL CPL_WRITE_PICKUP(
     &       prec, lgf, permPickup, 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,fn,
     &       myTime,myIter,myThid)
      ENDIF
#endif

#ifdef ALLOW_FIZHI
C     Write pickup file for fizhi package
      IF (usefizhi) THEN
        CALL FIZHI_WRITE_PICKUP(fn,myTime,myIter,myThid)
        CALL FIZHI_WRITE_VEGTILES(fn,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,
     &       fn,myTime,myIter,myThid)
      ENDIF
#endif

#ifdef  ALLOW_GGL90
      IF ( useGGL90 ) THEN
        CALL GGL90_WRITE_CHECKPOINT(
     &       prec, lgf, permPickup, myIter, myThid)
      ENDIF
#endif  /* ALLOW_GGL90 */

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

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

      RETURN
      END

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
1	jmc	1.24	C $Header: /u/gcmpack/MITgcm/model/src/packages_write_pickup.F,v 1.23 2006/08/24 01:10:35 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
30			C !INPUT/OUTPUT PARAMETERS:
31	jmc	1.23	C permPickup :: Is or is not a permanent pickup.
32			C myTime :: Current time of simulation ( s )
33			C myIter :: Iteration number
34			C myThid :: Thread number for this instance of the routine.
35			LOGICAL permPickup
36	jmc	1.22	_RL myTime
37			INTEGER myIter
38	edhill	1.6	INTEGER myThid
39	jmc	1.1
40	edhill	1.6	C == Common blocks ==
41			COMMON /PCKP_GBLFLS/ globalFile
42			LOGICAL globalFile
43	jmc	1.1
44	edhill	1.6	C !LOCAL VARIABLES:
45			C == Local variables ==
46	jmc	1.23	C prec :: file precision
47	edhill	1.6	C fn :: Temp. for building file name string.
48			C lgf :: Flag to indicate whether to use global file mode.
49			CHARACTER*(MAX_LEN_FNAM) fn
50			INTEGER prec
51			LOGICAL lgf
52			CEOP
53	jmc	1.1
54	edhill	1.6	C Going to really do some IO. Make everyone except master thread wait.
55			_BARRIER
56
57			prec = precFloat64
58			lgf = globalFile
59	jmc	1.22
60	edhill	1.6	C Create suffix to pass on to package pickup routines
61	jmc	1.23	IF ( permPickup ) THEN
62	edhill	1.6	WRITE(fn,'(I10.10)') myIter
63			ELSE
64			WRITE(fn,'(A)') checkPtSuff(nCheckLev)
65			ENDIF
66	jmc	1.1
67			#ifdef ALLOW_CD_CODE
68	edhill	1.6	IF (useCDscheme) THEN
69	jmc	1.24	CALL CD_CODE_WRITE_PICKUP(
70	jmc	1.23	& prec, lgf, permPickup, myIter, myThid)
71	edhill	1.6	ENDIF
72	jmc	1.1	#endif /* ALLOW_CD_CODE */
73
74			#ifdef ALLOW_OBCS
75	edhill	1.6	C SPK 4/9/01: Open boundary checkpointing
76			IF (useOBCS) THEN
77			CALL OBCS_WRITE_CHECKPOINT(
78	jmc	1.23	& prec, lgf, permPickup, myIter, myThid)
79	edhill	1.6	ENDIF
80	jmc	1.1	#endif /* ALLOW_OBCS */
81	jmc	1.22
82	jmc	1.3	#ifdef ALLOW_SEAICE
83	edhill	1.6	IF ( useSEAICE ) THEN
84			CALL SEAICE_WRITE_PICKUP(
85	jmc	1.23	& prec, lgf, permPickup, myIter, myThid)
86	edhill	1.6	ENDIF
87	jmc	1.3	#endif /* ALLOW_SEAICE */
88	jmc	1.1
89			#ifdef ALLOW_THSICE
90	edhill	1.6	IF (useThSIce) THEN
91			CALL THSICE_WRITE_PICKUP(
92	jmc	1.23	& prec, lgf, permPickup, myIter, myThid)
93	edhill	1.6	ENDIF
94	jmc	1.1	#endif /* ALLOW_THSICE */
95	jmc	1.2
96			#ifdef COMPONENT_MODULE
97	edhill	1.6	IF (useCoupler) THEN
98			CALL CPL_WRITE_PICKUP(
99	jmc	1.23	& prec, lgf, permPickup, myIter, myThid)
100	edhill	1.6	ENDIF
101	jmc	1.2	#endif /* COMPONENT_MODULE */
102	jmc	1.1
103			#ifdef ALLOW_FLT
104	edhill	1.6	C Write restart file for floats
105			IF (useFLT) THEN
106			CALL FLT_RESTART(myTime, myIter, myThid)
107			ENDIF
108	jmc	1.1	#endif
109
110			#ifdef ALLOW_LAND
111	edhill	1.17	C Write pickup file for Land package:
112	edhill	1.6	IF (useLand) THEN
113	jmc	1.23	CALL LAND_WRITE_PICKUP(permPickup,fn,
114	edhill	1.17	& myTime,myIter,myThid)
115	edhill	1.6	ENDIF
116	jmc	1.1	#endif
117	molod	1.4
118			#ifdef ALLOW_FIZHI
119	edhill	1.6	C Write pickup file for fizhi package
120			IF (usefizhi) THEN
121			CALL FIZHI_WRITE_PICKUP(fn,myTime,myIter,myThid)
122	molod	1.8	CALL FIZHI_WRITE_VEGTILES(fn,0,myTime,myIter,myThid)
123	molod	1.10	CALL FIZHI_WRITE_DATETIME(myTime,myIter,myThid)
124	edhill	1.6	ENDIF
125	molod	1.4	#endif
126
127	edhill	1.11	#ifdef ALLOW_DIAGNOSTICS
128			C Write pickup file for diagnostics package
129			IF (useDiagnostics) THEN
130	jmc	1.23	CALL DIAGNOSTICS_WRITE_PICKUP(permPickup,
131	edhill	1.18	& fn,myTime,myIter,myThid)
132	edhill	1.11	ENDIF
133			#endif
134
135	mlosch	1.9	#ifdef ALLOW_GGL90
136			IF ( useGGL90 ) THEN
137			CALL GGL90_WRITE_CHECKPOINT(
138	jmc	1.23	& prec, lgf, permPickup, myIter, myThid)
139	mlosch	1.9	ENDIF
140			#endif /* ALLOW_GGL90 */
141
142	jmc	1.1	#ifdef ALLOW_PTRACERS
143	edhill	1.15	C Write restart file for passive tracers
144			IF (usePTRACERS) THEN
145	jmc	1.24	CALL PTRACERS_WRITE_PICKUP(permPickup,
146	edhill	1.16	& fn,myIter,myTime,myThid)
147	edhill	1.15	ENDIF
148	jmc	1.1	#endif /* ALLOW_PTRACERS */
149
150	jmc	1.23	C-- Every one else must wait until writing is done.
151	jmc	1.22	_BARRIER
152
153	jmc	1.1	RETURN
154			END
155	edhill	1.6
156			C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|