/[MITgcm]/MITgcm/pkg/mypackage/mypackage_read_pickup.F
ViewVC logotype

Contents of /MITgcm/pkg/mypackage/mypackage_read_pickup.F

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


Revision 1.1 - (show annotations) (download)
Sun Jan 27 20:52:11 2008 UTC (18 years, 1 month ago) by jmc
Branch: MAIN
CVS Tags: checkpoint60, checkpoint61, checkpoint59q, checkpoint59p, checkpoint59r, checkpoint59o, checkpoint59n, checkpoint61f, checkpoint61g, checkpoint61d, checkpoint61e, checkpoint61b, checkpoint61c, checkpoint61a, checkpoint61n, checkpoint61o, checkpoint61l, checkpoint61m, checkpoint61j, checkpoint61k, checkpoint61h, checkpoint61i, checkpoint61p
re-arrange myPackage:
- more standard variable names
- add example of read/write pickup for state-var (+ add call)
- add option to disable un-used array (MYPACKAGE_OPTIONS.h, MYPACKAGE.h)
- rename S/R MYPACKAGE_DIAGNOSTICS_FILL to MYPACKAGE_DIAGNOSTICS_STATE
 and call it from do_statevars_diags.F

1 C $Header: $
2 C $Name: $
3
4 #include "MYPACKAGE_OPTIONS.h"
5
6 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
7 CBOP
8 C !ROUTINE: MYPACKAGE_READ_PICKUP
9
10 C !INTERFACE:
11 SUBROUTINE MYPACKAGE_READ_PICKUP( myIter, myThid )
12
13 C !DESCRIPTION:
14 C Reads current state of MYPACKAGE from a pickup file
15
16 C !USES:
17 IMPLICIT NONE
18 #include "SIZE.h"
19 #include "EEPARAMS.h"
20 #include "PARAMS.h"
21 #include "MYPACKAGE.h"
22
23 C !INPUT PARAMETERS:
24 C myIter :: time-step number
25 C myThid :: thread number
26 INTEGER myIter
27 INTEGER myThid
28
29 #ifdef ALLOW_MYPACKAGE
30 #if (defined MYPACKAGE_3D_STATE) || (defined MYPACKAGE_3D_STATE)
31
32 C !LOCAL VARIABLES:
33 C fn :: character buffer for creating filename
34 C fp :: precision of pickup files
35 C filePrec :: pickup-file precision (read from meta file)
36 C nbFields :: number of fields in pickup file (read from meta file)
37 C missFldList :: List of missing fields (attempted to read but not found)
38 C missFldDim :: Dimension of missing fields list array: missFldList
39 C nMissing :: Number of missing fields (attempted to read but not found)
40 C j :: loop index
41 C nj :: record number
42 C ioUnit :: temp for writing msg unit
43 C msgBuf :: Informational/error message buffer
44 INTEGER fp
45 INTEGER filePrec, nbFields
46 INTEGER missFldDim, nMissing
47 INTEGER j, nj, ioUnit
48 PARAMETER( missFldDim = 12 )
49 CHARACTER*(MAX_LEN_FNAM) fn
50 CHARACTER*(8) missFldList(missFldDim)
51 CHARACTER*(MAX_LEN_MBUF) msgBuf
52 CEOP
53
54 _BARRIER
55
56 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
57
58 IF ( pickupSuff.EQ.' ' ) THEN
59 WRITE(fn,'(A,I10.10)') 'pickup_mypackage.',myIter
60 ELSE
61 WRITE(fn,'(A,A10)') 'pickup_mypackage.',pickupSuff
62 ENDIF
63 fp = precFloat64
64
65 CALL READ_MFLDS_SET(
66 I fn,
67 O nbFields, filePrec,
68 I Nr, myIter, myThid )
69 _BEGIN_MASTER( myThid )
70 c IF ( filePrec.NE.0 .AND. filePrec.NE.fp ) THEN
71 IF ( nbFields.GE.0 .AND. filePrec.NE.fp ) THEN
72 WRITE(msgBuf,'(2A,I4)') 'MYPACKAGE_READ_PICKUP: ',
73 & 'pickup-file binary precision do not match !'
74 CALL PRINT_ERROR( msgBuf, myThid )
75 WRITE(msgBuf,'(A,2(A,I4))') 'MYPACKAGE_READ_PICKUP: ',
76 & 'file prec.=', filePrec, ' but expecting prec.=', fp
77 CALL PRINT_ERROR( msgBuf, myThid )
78 STOP 'ABNORMAL END: S/R MYPACKAGE_READ_PICKUP (data-prec Pb)'
79 ENDIF
80 _END_MASTER( myThid )
81
82 IF ( nbFields.LE.0 ) THEN
83 C- No meta-file or old meta-file without List of Fields
84 ioUnit = errorMessageUnit
85 IF ( pickupStrictlyMatch ) THEN
86 WRITE(msgBuf,'(4A)') 'MYPACKAGE_READ_PICKUP: ',
87 & 'no field-list found in meta-file',
88 & ' => cannot check for strick-matching'
89 CALL PRINT_ERROR( msgBuf, myThid )
90 WRITE(msgBuf,'(4A)') 'MYPACKAGE_READ_PICKUP: ',
91 & 'try with " pickupStrictlyMatch=.FALSE.,"',
92 & ' in file: "data", NameList: "PARM03"'
93 CALL PRINT_MESSAGE( msgBuf, ioUnit, SQUEEZE_RIGHT, myThid )
94 STOP 'ABNORMAL END: S/R MYPACKAGE_READ_PICKUP'
95 ELSE
96 WRITE(msgBuf,'(4A)') 'WARNING >> MYPACKAGE_READ_PICKUP: ',
97 & ' no field-list found'
98 CALL PRINT_MESSAGE( msgBuf, ioUnit, SQUEEZE_RIGHT, myThid )
99 IF ( nbFields.EQ.-1 ) THEN
100 C- No meta-file
101 WRITE(msgBuf,'(4A)') 'WARNING >> ',
102 & ' try to read pickup as currently written'
103 CALL PRINT_MESSAGE( msgBuf, ioUnit, SQUEEZE_RIGHT, myThid )
104 ELSE
105 C- Old meta-file without List of Fields
106 c WRITE(msgBuf,'(4A)') 'WARNING >> ',
107 c & ' try to read pickup as it used to be written'
108 c CALL PRINT_MESSAGE( msgBuf, ioUnit, SQUEEZE_RIGHT, myThid )
109 c WRITE(msgBuf,'(4A)') 'WARNING >> ',
110 c & ' until checkpoint59l (2007 Dec 17)'
111 c CALL PRINT_MESSAGE( msgBuf, ioUnit, SQUEEZE_RIGHT, myThid )
112 WRITE(msgBuf,'(4A)') 'MYPACKAGE_READ_PICKUP: ',
113 & 'no field-list found in meta-file'
114 CALL PRINT_ERROR( msgBuf, myThid )
115 STOP 'ABNORMAL END: S/R MYPACKAGE_READ_PICKUP'
116 ENDIF
117 ENDIF
118 ENDIF
119
120 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
121
122 IF ( nbFields.EQ.0 ) THEN
123 C--- Old way to read pickup:
124
125 ELSE
126 C--- New way to read MYPACKAGE pickup:
127 nj = 0
128 C--- read MYPACKAGE 3-D fields for restart
129 #ifdef MYPACKAGE_3D_STATE
130 CALL READ_MFLDS_3D_RL( 'myPaSta1', myPa_StatScal1,
131 & nj, fp, Nr, myIter, myThid )
132 CALL READ_MFLDS_3D_RL( 'myPaSta2', myPa_StatScal2,
133 & nj, fp, Nr, myIter, myThid )
134 CALL READ_MFLDS_3D_RL( 'myPaStaU', myPa_StatVelU,
135 & nj, fp, Nr, myIter, myThid )
136 CALL READ_MFLDS_3D_RL( 'myPaStaV', myPa_StatVelV,
137 & nj, fp, Nr, myIter, myThid )
138 #endif /* MYPACKAGE_3D_STATE */
139 nj = nj*Nr
140 C--- read MYPACKAGE 2-D fields for restart
141 #ifdef MYPACKAGE_2D_STATE
142 CALL READ_MFLDS_3D_RL( 'myPaSur1', myPa_Surf1,
143 & nj, fp, 1 , myIter, myThid )
144 CALL READ_MFLDS_3D_RL( 'myPaSur2', myPa_Surf1,
145 & nj, fp, 1 , myIter, myThid )
146 #endif /* MYPACKAGE_2D_STATE */
147
148 C-- end: new way to read pickup file
149 ENDIF
150
151 C-- Check for missing fields:
152 nMissing = missFldDim
153 CALL READ_MFLDS_CHECK(
154 O missFldList,
155 U nMissing,
156 I myIter, myThid )
157 IF ( nMissing.GT.missFldDim ) THEN
158 WRITE(msgBuf,'(2A,I4)') 'MYPACKAGE_READ_PICKUP: ',
159 & 'missing fields list has been truncated to', missFldDim
160 CALL PRINT_ERROR( msgBuf, myThid )
161 STOP 'ABNORMAL END: S/R MYPACKAGE_READ_PICKUP (list-size Pb)'
162 ENDIF
163 IF ( nMissing.GE.1 ) THEN
164 ioUnit = errorMessageUnit
165 DO j=1,nMissing
166 WRITE(msgBuf,'(4A)') 'MYPACKAGE_READ_PICKUP: ',
167 & 'cannot restart without field "',missFldList(nj),'"'
168 CALL PRINT_ERROR( msgBuf, myThid )
169 ENDDO
170 STOP 'ABNORMAL END: S/R MYPACKAGE_READ_PICKUP'
171 ENDIF
172
173 C-- Update overlap regions:
174 #ifdef MYPACKAGE_3D_STATE
175 CALL EXCH_3D_RL( myPa_StatScal1, Nr, myThid )
176 CALL EXCH_3D_RL( myPa_StatScal2, Nr, myThid )
177 IF ( myPa_StaV_Cgrid ) THEN
178 CALL EXCH_UV_3D_RL( myPa_StatVelU, myPa_StatVelV,
179 & .TRUE., Nr, myThid )
180 ELSE
181 C- Assume Agrid position:
182 CALL EXCH_UV_AGRID_3D_RL( myPa_StatVelU, myPa_StatVelV,
183 & .TRUE., Nr, myThid )
184 ENDIF
185 #endif /* MYPACKAGE_3D_STATE */
186 #ifdef MYPACKAGE_2D_STATE
187 CALL EXCH_XY_RL( myPa_Surf1, myThid )
188 CALL EXCH_XY_RL( myPa_Surf2, myThid )
189 #endif /* MYPACKAGE_2D_STATE */
190
191 #endif /* MYPACKAGE_3D_STATE or MYPACKAGE_3D_STATE */
192 #endif /* ALLOW_ALLOW_MYPACKAGE */
193
194 RETURN
195 END

  ViewVC Help
Powered by ViewVC 1.1.22