forked from altMITgcm/MITgcm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
active_file_gen_g.F
475 lines (409 loc) · 17 KB
/
active_file_gen_g.F
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
C $Header: /u/gcmpack/MITgcm/pkg/autodiff/active_file_gen_g.F,v 1.2 2012/08/06 19:27:13 jmc Exp $
C $Name: $
#include "AUTODIFF_OPTIONS.h"
C ==================================================================
C active_file_gen_g.F: Routines to handle the I/O of the active file
C for the tangent linear calculations.
C Routines
C o g_ACTIVE_READ_GEN_RL - Read an active RL variable from file.
C o g_ACTIVE_READ_GEN_RS - Read an active RS variable from file.
C
C o g_ACTIVE_WRITE_GEN_RL - Write an active RL variable to a file.
C o g_ACTIVE_WRITE_GEN_RS - Write an active RS variable to a file.
C
C Generic version for each array type (_RL or _RS).
C Note: the _RL version can replace the 4 x 2 shape-specific
C (_xy,_xyz,_xz,_yz) and standard or "_loc" routines.
C ==================================================================
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: g_ACTIVE_READ_GEN_RL
C !INTERFACE:
SUBROUTINE g_ACTIVE_READ_GEN_RL(
I activeVar_file,
O active_var,
O g_active_var,
I arrShape, myNr,
I iRec,
I globalFile,
I useCurrentDir,
I lAdInit,
I myOptimIter,
I myThid,
I dummy, g_dummy )
C !DESCRIPTION: \bv
C ==================================================================
C SUBROUTINE g_ACTIVE_READ_GEN_RL
C ==================================================================
C o Read an active (_RL) variable from file (generic version).
C Accept active variable of various (XY,XZ,YZ) shape and level
C number, according to arguments arrShape and myNr.
C ==================================================================
C \ev
C !USES:
IMPLICIT NONE
C == global variables ==
#include "EEPARAMS.h"
C !INPUT/OUTPUT PARAMETERS:
C activeVar_file :: filename
C active_var :: active variable array
C arrShape :: shape of active-var array ('XY','XZ' or 'YZ')
C myNr :: number of vertical-levels in active-var array
C iRec :: record number in file
C globalFile :: used for writing global (if =T) or tiled files
C useCurrentDir :: always read from the current directory
C (even if "mdsioLocalDir" is set)
C lAdInit :: initialisation of corresponding adjoint variable
C and write to active file
C myOptimIter :: number of optimization iteration (default: 0)
C myThid :: my Thread Id number
C dummy :: (needed for 2nd derivative code)
CHARACTER*(*) activeVar_file
_RL active_var(*)
_RL g_active_var(*)
CHARACTER*(2) arrShape
INTEGER myNr
INTEGER iRec
LOGICAL globalFile
LOGICAL useCurrentDir
LOGICAL lAdInit
INTEGER myOptimIter
INTEGER myThid
_RL dummy, g_dummy
C !FUNCTIONS:
INTEGER ILNBLNK
EXTERNAL ILNBLNK
C !LOCAL VARIABLES:
CHARACTER*(2) pref
CHARACTER*(80) fName
INTEGER il
CEOP
pref = 'g_'
il = ILNBLNK( activeVar_file )
WRITE(fName(1:80),'(A)') ' '
WRITE(fName(1:2+il),'(2A)') pref, activeVar_file(1:il)
IF ( arrShape.EQ.'XY' ) THEN
CALL ACTIVE_READ_3D_RL(
& activeVar_file, active_var, globalFile,
& useCurrentDir, lAdInit, iRec, myNr,
& FORWARD_SIMULATION, myOptimIter, myThid )
CALL ACTIVE_READ_3D_RL(
& fName, g_active_var, globalFile,
& useCurrentDir, lAdInit, iRec, myNr,
& TANGENT_SIMULATION, myOptimIter, myThid )
ELSEIF ( arrShape.EQ.'XZ' ) THEN
CALL ACTIVE_READ_XZ_RL(
& activeVar_file, active_var, globalFile,
& useCurrentDir, lAdInit, iRec, myNr,
& FORWARD_SIMULATION, myOptimIter, myThid )
CALL ACTIVE_READ_XZ_RL(
& fName, g_active_var, globalFile,
& useCurrentDir, lAdInit, iRec, myNr,
& TANGENT_SIMULATION, myOptimIter, myThid )
ELSEIF ( arrShape.EQ.'YZ' ) THEN
CALL ACTIVE_READ_YZ_RL(
& activeVar_file, active_var, globalFile,
& useCurrentDir, lAdInit, iRec, myNr,
& FORWARD_SIMULATION, myOptimIter, myThid )
CALL ACTIVE_READ_YZ_RL(
& fName, g_active_var, globalFile,
& useCurrentDir, lAdInit, iRec, myNr,
& TANGENT_SIMULATION, myOptimIter, myThid )
ELSE
STOP
& 'ABNORMAL END: S/R g_ACTIVE_READ_GEN_RL: invalid arrShape'
ENDIF
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: g_ACTIVE_READ_GEN_RS
C !INTERFACE:
SUBROUTINE g_ACTIVE_READ_GEN_RS(
I activeVar_file,
O active_var,
O g_active_var,
I arrShape, myNr,
I iRec,
I globalFile,
I useCurrentDir,
I lAdInit,
I myOptimIter,
I myThid,
I dummy, g_dummy )
C !DESCRIPTION: \bv
C ==================================================================
C SUBROUTINE g_ACTIVE_READ_GEN_RS
C ==================================================================
C o Read an active (_RS) variable from file (generic version).
C Accept active variable of various (XY,XZ,YZ) shape and level
C number, according to arguments arrShape and myNr.
C ==================================================================
C \ev
C !USES:
IMPLICIT NONE
C == global variables ==
#include "EEPARAMS.h"
C !INPUT/OUTPUT PARAMETERS:
C activeVar_file :: filename
C active_var :: active variable array
C arrShape :: shape of active-var array ('XY','XZ' or 'YZ')
C myNr :: number of vertical-levels in active-var array
C iRec :: record number in file
C globalFile :: used for writing global (if =T) or tiled files
C useCurrentDir :: always read from the current directory
C (even if "mdsioLocalDir" is set)
C lAdInit :: initialisation of corresponding adjoint variable
C and write to active file
C myOptimIter :: number of optimization iteration (default: 0)
C myThid :: my Thread Id number
C dummy :: (needed for 2nd derivative code)
CHARACTER*(*) activeVar_file
_RS active_var(*)
_RS g_active_var(*)
CHARACTER*(2) arrShape
INTEGER myNr
INTEGER iRec
LOGICAL globalFile
LOGICAL useCurrentDir
LOGICAL lAdInit
INTEGER myOptimIter
INTEGER myThid
_RS dummy, g_dummy
C !FUNCTIONS:
INTEGER ILNBLNK
EXTERNAL ILNBLNK
C !LOCAL VARIABLES:
CHARACTER*(2) pref
CHARACTER*(80) fName
INTEGER il
CEOP
pref = 'g_'
il = ILNBLNK( activeVar_file )
WRITE(fName(1:80),'(A)') ' '
WRITE(fName(1:2+il),'(2A)') pref, activeVar_file(1:il)
IF ( arrShape.EQ.'XY' ) THEN
CALL ACTIVE_READ_3D_RS(
& activeVar_file, active_var, globalFile,
& useCurrentDir, lAdInit, iRec, myNr,
& FORWARD_SIMULATION, myOptimIter, myThid )
CALL ACTIVE_READ_3D_RS(
& fName, g_active_var, globalFile,
& useCurrentDir, lAdInit, iRec, myNr,
& TANGENT_SIMULATION, myOptimIter, myThid )
ELSEIF ( arrShape.EQ.'XZ' ) THEN
CALL ACTIVE_READ_XZ_RS(
& activeVar_file, active_var, globalFile,
& useCurrentDir, lAdInit, iRec, myNr,
& FORWARD_SIMULATION, myOptimIter, myThid )
CALL ACTIVE_READ_XZ_RS(
& fName, g_active_var, globalFile,
& useCurrentDir, lAdInit, iRec, myNr,
& TANGENT_SIMULATION, myOptimIter, myThid )
ELSEIF ( arrShape.EQ.'YZ' ) THEN
CALL ACTIVE_READ_YZ_RS(
& activeVar_file, active_var, globalFile,
& useCurrentDir, lAdInit, iRec, myNr,
& FORWARD_SIMULATION, myOptimIter, myThid )
CALL ACTIVE_READ_YZ_RS(
& fName, g_active_var, globalFile,
& useCurrentDir, lAdInit, iRec, myNr,
& TANGENT_SIMULATION, myOptimIter, myThid )
ELSE
STOP
& 'ABNORMAL END: S/R g_ACTIVE_READ_GEN_RS: invalid arrShape'
ENDIF
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: g_ACTIVE_WRITE_GEN_RL
C !INTERFACE:
SUBROUTINE g_ACTIVE_WRITE_GEN_RL(
I activeVar_file,
I active_var,
I g_active_var,
I arrShape, myNr,
I iRec,
I useCurrentDir,
I myOptimIter,
I myThid,
I dummy, g_dummy )
C !DESCRIPTION: \bv
C ==================================================================
C SUBROUTINE g_ACTIVE_WRITE_GEN_RL
C ==================================================================
C o Write an active (_RL) variable from file (generic version).
C Accept active variable of various (XY,XZ,YZ) shape and level
C number, according to arguments arrShape and myNr.
C ==================================================================
C \ev
C !USES:
IMPLICIT NONE
C == global variables ==
#include "EEPARAMS.h"
C !INPUT/OUTPUT PARAMETERS:
C activeVar_file :: filename
C active_var :: active variable array
C arrShape :: shape of active-var array ('XY','XZ' or 'YZ')
C myNr :: number of vertical-levels in active-var array
C iRec :: record number in file
C useCurrentDir :: always write to the current directory
C (even if "mdsioLocalDir" is set)
C myOptimIter :: number of optimization iteration (default: 0)
C myThid :: my Thread Id number
C dummy :: (needed for 2nd derivative code)
CHARACTER*(*) activeVar_file
_RL active_var(*)
_RL g_active_var(*)
CHARACTER*(2) arrShape
INTEGER myNr
INTEGER iRec
LOGICAL useCurrentDir
INTEGER myOptimIter
INTEGER myThid
_RL dummy, g_dummy
C !FUNCTIONS:
INTEGER ILNBLNK
EXTERNAL ILNBLNK
C !LOCAL VARIABLES:
C globalFile :: used for writing global (if =T) or tiled files
CHARACTER*(2) pref
CHARACTER*(80) fName
INTEGER il
LOGICAL globalFile
CEOP
pref = 'g_'
il = ILNBLNK( activeVar_file )
WRITE(fName(1:80),'(A)') ' '
WRITE(fName(1:2+il),'(2A)') pref, activeVar_file(1:il)
globalFile = .FALSE.
IF ( arrShape.EQ.'XY' ) THEN
CALL ACTIVE_WRITE_3D_RL(
& activeVar_file, active_var, globalFile,
& useCurrentDir, iRec, myNr,
& FORWARD_SIMULATION, myOptimIter, myThid )
CALL ACTIVE_WRITE_3D_RL(
& fName, g_active_var, globalFile,
& useCurrentDir, iRec, myNr,
& TANGENT_SIMULATION, myOptimIter, myThid )
ELSEIF ( arrShape.EQ.'XZ' ) THEN
CALL ACTIVE_WRITE_XZ_RL(
& activeVar_file, active_var, globalFile,
& useCurrentDir, iRec, myNr,
& FORWARD_SIMULATION, myOptimIter, myThid )
CALL ACTIVE_WRITE_XZ_RL(
& fName, g_active_var, globalFile,
& useCurrentDir, iRec, myNr,
& TANGENT_SIMULATION, myOptimIter, myThid )
ELSEIF ( arrShape.EQ.'YZ' ) THEN
CALL ACTIVE_WRITE_YZ_RL(
& activeVar_file, active_var, globalFile,
& useCurrentDir, iRec, myNr,
& FORWARD_SIMULATION, myOptimIter, myThid )
CALL ACTIVE_WRITE_YZ_RL(
& fName, g_active_var, globalFile,
& useCurrentDir, iRec, myNr,
& TANGENT_SIMULATION, myOptimIter, myThid )
ELSE
STOP
& 'ABNORMAL END: S/R g_ACTIVE_WRITE_GEN_RL: invalid arrShape'
ENDIF
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: g_ACTIVE_WRITE_GEN_RS
C !INTERFACE:
SUBROUTINE g_ACTIVE_WRITE_GEN_RS(
I activeVar_file,
I active_var,
I g_active_var,
I arrShape, myNr,
I iRec,
I useCurrentDir,
I myOptimIter,
I myThid,
I dummy, g_dummy )
C !DESCRIPTION: \bv
C ==================================================================
C SUBROUTINE g_ACTIVE_WRITE_GEN_RS
C ==================================================================
C o Write an active (_RS) variable from file (generic version).
C Accept active variable of various (XY,XZ,YZ) shape and level
C number, according to arguments arrShape and myNr.
C ==================================================================
C \ev
C !USES:
IMPLICIT NONE
C == global variables ==
#include "EEPARAMS.h"
C !INPUT/OUTPUT PARAMETERS:
C activeVar_file :: filename
C active_var :: active variable array
C arrShape :: shape of active-var array ('XY','XZ' or 'YZ')
C myNr :: number of vertical-levels in active-var array
C iRec :: record number in file
C useCurrentDir :: always write to the current directory
C (even if "mdsioLocalDir" is set)
C myOptimIter :: number of optimization iteration (default: 0)
C myThid :: my Thread Id number
C dummy :: (needed for 2nd derivative code)
CHARACTER*(*) activeVar_file
_RS active_var(*)
_RS g_active_var(*)
CHARACTER*(2) arrShape
INTEGER myNr
INTEGER iRec
LOGICAL useCurrentDir
INTEGER myOptimIter
INTEGER myThid
_RS dummy, g_dummy
C !FUNCTIONS:
INTEGER ILNBLNK
EXTERNAL ILNBLNK
C !LOCAL VARIABLES:
C globalFile :: used for writing global (if =T) or tiled files
CHARACTER*(2) pref
CHARACTER*(80) fName
INTEGER il
LOGICAL globalFile
CEOP
pref = 'g_'
il = ILNBLNK( activeVar_file )
WRITE(fName(1:80),'(A)') ' '
WRITE(fName(1:2+il),'(2A)') pref, activeVar_file(1:il)
globalFile = .FALSE.
IF ( arrShape.EQ.'XY' ) THEN
CALL ACTIVE_WRITE_3D_RS(
& activeVar_file, active_var, globalFile,
& useCurrentDir, iRec, myNr,
& FORWARD_SIMULATION, myOptimIter, myThid )
CALL ACTIVE_WRITE_3D_RS(
& fName, g_active_var, globalFile,
& useCurrentDir, iRec, myNr,
& TANGENT_SIMULATION, myOptimIter, myThid )
ELSEIF ( arrShape.EQ.'XZ' ) THEN
CALL ACTIVE_WRITE_XZ_RS(
& activeVar_file, active_var, globalFile,
& useCurrentDir, iRec, myNr,
& FORWARD_SIMULATION, myOptimIter, myThid )
CALL ACTIVE_WRITE_XZ_RS(
& fName, g_active_var, globalFile,
& useCurrentDir, iRec, myNr,
& TANGENT_SIMULATION, myOptimIter, myThid )
ELSEIF ( arrShape.EQ.'YZ' ) THEN
CALL ACTIVE_WRITE_YZ_RS(
& activeVar_file, active_var, globalFile,
& useCurrentDir, iRec, myNr,
& FORWARD_SIMULATION, myOptimIter, myThid )
CALL ACTIVE_WRITE_YZ_RS(
& fName, g_active_var, globalFile,
& useCurrentDir, iRec, myNr,
& TANGENT_SIMULATION, myOptimIter, myThid )
ELSE
STOP
& 'ABNORMAL END: S/R g_ACTIVE_WRITE_GEN_RS: invalid arrShape'
ENDIF
RETURN
END