forked from altMITgcm/MITgcm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
active_file_control.F
623 lines (546 loc) · 20.4 KB
/
active_file_control.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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
C $Header: /u/gcmpack/MITgcm/pkg/autodiff/active_file_control.F,v 1.14 2015/02/17 14:31:42 gforget Exp $
C $Name: $
#include "AUTODIFF_OPTIONS.h"
#ifdef ALLOW_CTRL
# include "CTRL_OPTIONS.h"
#endif
C ==================================================================
C active_file_control.F: Routines to handle the I/O of active
C variables for the adjoint calculations.
C All files are direct access files.
C Routines:
C o ACTIVE_READ_3D_RL : Basic routine to handle active 3D read operations
C o ACTIVE_READ_3D_RS : Basic routine to handle active 3D read operations
C o ACTIVE_WRITE_3D_RL : Basic routine to handle active 3D write operations
C o ACTIVE_WRITE_3D_RS : Basic routine to handle active 3D write operations
C
C changed: Christian Eckert eckert@mit.edu 24-Apr-2000
C - Added routines that do active writes on tiles
C instead of a whole thread.
C ==================================================================
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ACTIVE_READ_3D_RL
C !INTERFACE:
SUBROUTINE ACTIVE_READ_3D_RL(
I activeVar_file,
O active_var,
I globalFile,
I useCurrentDir,
I lAdInit,
I iRec,
I myNr,
I theSimulationMode,
I myOptimIter,
I myThid )
C !DESCRIPTION: \bv
C ==================================================================
C SUBROUTINE ACTIVE_READ_3D_RL
C ==================================================================
C o Read an active 3D _RL variable from file.
C The variable *globalfile* can be used as a switch, which allows
C to read from a global file. The adjoint files are, however, always
C treated as tiled files.
C started: Christian Eckert eckert@mit.edu Jan-1999
C ==================================================================
C SUBROUTINE ACTIVE_READ_3D_RL
C ==================================================================
C \ev
C !USES:
IMPLICIT NONE
C == global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
#include "PARAMS.h"
#include "ctrl.h"
C !INPUT/OUTPUT PARAMETERS:
C activeVar_file :: filename
C active_var :: array
C globalFile ::
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 iRec :: record number
C myNr :: vertical array dimension
C theSimulationMode :: forward mode or reverse mode simulation
C myOptimIter :: number of optimization iteration (default: 0)
C myThid :: thread number for this instance
CHARACTER*(*) activeVar_file
INTEGER myNr
_RL active_var(1-OLx:sNx+OLx,1-OLy:sNy+OLy,myNr,nSx,nSy)
LOGICAL globalFile
LOGICAL useCurrentDir
LOGICAL lAdInit
INTEGER iRec
INTEGER theSimulationMode
INTEGER myOptimIter
INTEGER myThid
C !FUNCTIONS:
INTEGER ILNBLNK
EXTERNAL ILNBLNK
C !LOCAL VARIABLES:
CHARACTER*(2) adpref
CHARACTER*(80) adfname
INTEGER bi,bj
INTEGER i,j,k
INTEGER prec
INTEGER il
LOGICAL w_globFile
_RS dummyRS(1)
_RL active_data_t(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
CEOP
C force 64-bit io
prec = ctrlprec
adpref = 'ad'
il = ILNBLNK( activeVar_file )
WRITE(adfname(1:80),'(80a)') ' '
WRITE(adfname(1:il+2),'(2A)') adpref, activeVar_file(1:il)
C >>>>>>>>>>>>>>>>>>> FORWARD RUN <<<<<<<<<<<<<<<<<<<
IF (theSimulationMode .EQ. FORWARD_SIMULATION) THEN
C Read the active variable from file.
CALL MDS_READ_FIELD(
I activeVar_file, prec, useCurrentDir,
I 'RL', myNr, 1, myNr,
O active_var, dummyRS,
I iRec, myThid )
IF ( lAdInit ) THEN
C Initialise the corresponding adjoint variable on the
C adjoint variable file. These files are tiled.
DO bj = myByLo(myThid), myByHi(myThid)
DO bi = myBxLo(myThid), myBxHi(myThid)
DO k = 1, myNr
DO j=1,sNy
DO i=1,sNx
active_data_t(i,j,k,bi,bj) = 0. _d 0
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
CALL MDS_WRITE_FIELD(
I adfname, prec, globalFile, useCurrentDir,
I 'RL', Nr, 1, myNr,
I active_data_t, dummyRS,
I iRec, myOptimIter, myThid )
ENDIF
ENDIF
C >>>>>>>>>>>>>>>>>>> ADJOINT RUN <<<<<<<<<<<<<<<<<<<
IF (theSimulationMode .EQ. REVERSE_SIMULATION) THEN
CALL MDS_READ_FIELD(
I activeVar_file, prec, useCurrentDir,
I 'RL', Nr, 1, myNr,
O active_data_t, dummyRS,
I iRec, myThid )
C Add active_var from appropriate location to data.
DO bj = myByLo(myThid), myByHi(myThid)
DO bi = myBxLo(myThid), myBxHi(myThid)
DO k = 1, myNr
DO j=1,sNy
DO i=1,sNx
active_data_t(i,j,k,bi,bj) = active_data_t(i,j,k,bi,bj)
& + active_var(i,j,k,bi,bj)
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
C Store the result on disk.
w_globFile = .FALSE.
CALL MDS_WRITE_FIELD(
I activeVar_file, prec, w_globFile, useCurrentDir,
I 'RL', Nr, 1, myNr,
I active_data_t, dummyRS,
I iRec, myOptimIter, myThid )
C Set active_var to zero.
DO bj = myByLo(myThid), myByHi(myThid)
DO bi = myBxLo(myThid), myBxHi(myThid)
DO k = 1, myNr
DO j=1,sNy
DO i=1,sNx
active_var(i,j,k,bi,bj) = 0 _d 0
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
ENDIF
C >>>>>>>>>>>>>>>>>>> TANGENT RUN <<<<<<<<<<<<<<<<<<<
IF (theSimulationMode .EQ. TANGENT_SIMULATION) THEN
C Read the active variable from file.
CALL MDS_READ_FIELD(
I activeVar_file, prec, useCurrentDir,
I 'RL', myNr, 1, myNr,
O active_var, dummyRS,
I iRec, myThid )
ENDIF
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ACTIVE_READ_3D_RS
C !INTERFACE:
SUBROUTINE ACTIVE_READ_3D_RS(
I activeVar_file,
O active_var,
I globalFile,
I useCurrentDir,
I lAdInit,
I iRec,
I myNr,
I theSimulationMode,
I myOptimIter,
I myThid )
C !DESCRIPTION: \bv
C ==================================================================
C SUBROUTINE ACTIVE_READ_3D_RS
C ==================================================================
C o Read an active 3D _RS variable from file.
C The variable *globalfile* can be used as a switch, which allows
C to read from a global file. The adjoint files are, however, always
C treated as tiled files.
C started: Christian Eckert eckert@mit.edu Jan-1999
C ==================================================================
C SUBROUTINE ACTIVE_READ_3D_RS
C ==================================================================
C \ev
C !USES:
IMPLICIT NONE
C == global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
#include "PARAMS.h"
#include "ctrl.h"
C !INPUT/OUTPUT PARAMETERS:
C activeVar_file :: filename
C active_var :: array
C globalFile ::
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 iRec :: record number
C myNr :: vertical array dimension
C theSimulationMode :: forward mode or reverse mode simulation
C myOptimIter :: number of optimization iteration (default: 0)
C myThid :: thread number for this instance
CHARACTER*(*) activeVar_file
INTEGER myNr
_RS active_var(1-OLx:sNx+OLx,1-OLy:sNy+OLy,myNr,nSx,nSy)
LOGICAL globalFile
LOGICAL useCurrentDir
LOGICAL lAdInit
INTEGER iRec
INTEGER theSimulationMode
INTEGER myOptimIter
INTEGER myThid
C !FUNCTIONS:
INTEGER ILNBLNK
EXTERNAL ILNBLNK
C !LOCAL VARIABLES:
CHARACTER*(2) adpref
CHARACTER*(80) adfname
INTEGER bi,bj
INTEGER i,j,k
INTEGER prec
INTEGER il
LOGICAL w_globFile
_RS active_data_t(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL dummyRL(1)
CEOP
C force 64-bit io
prec = ctrlprec
adpref = 'ad'
il = ILNBLNK( activeVar_file )
WRITE(adfname(1:80),'(80a)') ' '
WRITE(adfname(1:il+2),'(2A)') adpref, activeVar_file(1:il)
C >>>>>>>>>>>>>>>>>>> FORWARD RUN <<<<<<<<<<<<<<<<<<<
IF (theSimulationMode .EQ. FORWARD_SIMULATION) THEN
C Read the active variable from file.
CALL MDS_READ_FIELD(
I activeVar_file, prec, useCurrentDir,
I 'RS', myNr, 1, myNr,
O dummyRL, active_var,
I iRec, myThid )
IF ( lAdInit ) THEN
C Initialise the corresponding adjoint variable on the
C adjoint variable file. These files are tiled.
DO bj = myByLo(myThid), myByHi(myThid)
DO bi = myBxLo(myThid), myBxHi(myThid)
DO k = 1, myNr
DO j=1,sNy
DO i=1,sNx
active_data_t(i,j,k,bi,bj) = 0. _d 0
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
CALL MDS_WRITE_FIELD(
I adfname, prec, globalFile, useCurrentDir,
I 'RS', Nr, 1, myNr,
I dummyRL, active_data_t,
I iRec, myOptimIter, myThid )
ENDIF
ENDIF
C >>>>>>>>>>>>>>>>>>> ADJOINT RUN <<<<<<<<<<<<<<<<<<<
IF (theSimulationMode .EQ. REVERSE_SIMULATION) THEN
CALL MDS_READ_FIELD(
I activeVar_file, prec, useCurrentDir,
I 'RS', Nr, 1, myNr,
O dummyRL, active_data_t,
I iRec, myThid )
C Add active_var from appropriate location to data.
DO bj = myByLo(myThid), myByHi(myThid)
DO bi = myBxLo(myThid), myBxHi(myThid)
DO k = 1, myNr
DO j=1,sNy
DO i=1,sNx
active_data_t(i,j,k,bi,bj) = active_data_t(i,j,k,bi,bj)
& + active_var(i,j,k,bi,bj)
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
C Store the result on disk.
w_globFile = .FALSE.
CALL MDS_WRITE_FIELD(
I activeVar_file, prec, w_globFile, useCurrentDir,
I 'RS', Nr, 1, myNr,
I dummyRL, active_data_t,
I iRec, myOptimIter, myThid )
C Set active_var to zero.
DO bj = myByLo(myThid), myByHi(myThid)
DO bi = myBxLo(myThid), myBxHi(myThid)
DO k = 1, myNr
DO j=1,sNy
DO i=1,sNx
active_var(i,j,k,bi,bj) = 0 _d 0
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
ENDIF
C >>>>>>>>>>>>>>>>>>> TANGENT RUN <<<<<<<<<<<<<<<<<<<
IF (theSimulationMode .EQ. TANGENT_SIMULATION) THEN
C Read the active variable from file.
CALL MDS_READ_FIELD(
I activeVar_file, prec, useCurrentDir,
I 'RS', myNr, 1, myNr,
O dummyRL, active_var,
I iRec, myThid )
ENDIF
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ACTIVE_WRITE_3D_RL
C !INTERFACE:
SUBROUTINE ACTIVE_WRITE_3D_RL(
I activeVar_file,
I active_var,
I globalFile,
I useCurrentDir,
I iRec,
I myNr,
I theSimulationMode,
I myOptimIter,
I myThid )
C !DESCRIPTION: \bv
C ==================================================================
C SUBROUTINE ACTIVE_WRITE_3D_RL
C ==================================================================
C o Write an active 3D _RL variable to a file.
C started: Christian Eckert eckert@mit.edu Jan-1999
C ==================================================================
C SUBROUTINE ACTIVE_WRITE_3D_RL
C ==================================================================
C \ev
C !USES:
IMPLICIT NONE
C == global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
#include "PARAMS.h"
#include "ctrl.h"
C !INPUT/OUTPUT PARAMETERS:
C activeVar_file :: filename
C active_var :: array
C globalFile ::
C useCurrentDir :: always write to the current directory
C (even if "mdsioLocalDir" is set)
C iRec :: record number
C myNr :: vertical array dimension
C theSimulationMode :: forward mode or reverse mode simulation
C myOptimIter :: number of optimization iteration (default: 0)
C myThid :: thread number for this instance
CHARACTER*(*) activeVar_file
INTEGER myNr
_RL active_var(1-OLx:sNx+OLx,1-OLy:sNy+OLy,myNr,nSx,nSy)
LOGICAL globalFile
LOGICAL useCurrentDir
INTEGER iRec
INTEGER theSimulationMode
INTEGER myOptimIter
INTEGER myThid
C !LOCAL VARIABLES:
INTEGER i,j,k
INTEGER bi,bj
INTEGER prec
_RS dummyRS(1)
_RL active_data_t(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
CEOP
C force 64-bit io
prec = ctrlprec
C >>>>>>>>>>>>>>>>>>> FORWARD RUN <<<<<<<<<<<<<<<<<<<
IF (theSimulationMode .EQ. FORWARD_SIMULATION) THEN
CALL MDS_WRITE_FIELD(
I activeVar_file, prec, globalFile, useCurrentDir,
I 'RL', myNr, 1, myNr,
I active_var, dummyRS,
I iRec, myOptimIter, myThid )
ENDIF
C >>>>>>>>>>>>>>>>>>> ADJOINT RUN <<<<<<<<<<<<<<<<<<<
IF (theSimulationMode .EQ. REVERSE_SIMULATION) THEN
CALL MDS_READ_FIELD(
I activeVar_file, prec, useCurrentDir,
I 'RL', Nr, 1, myNr,
O active_data_t, dummyRS,
I iRec, myThid )
C Add active_var from appropriate location to data.
DO bj = myByLo(myThid), myByHi(myThid)
DO bi = myBxLo(myThid), myBxHi(myThid)
DO k = 1, myNr
DO j=1,sNy
DO i=1,sNx
active_var(i,j,k,bi,bj) = active_var(i,j,k,bi,bj)
& + active_data_t(i,j,k,bi,bj)
active_data_t(i,j,k,bi,bj) = 0. _d 0
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
CALL MDS_WRITE_FIELD(
I activeVar_file, prec, globalFile, useCurrentDir,
I 'RL', Nr, 1, myNr,
I active_data_t, dummyRS,
I iRec, myOptimIter, myThid )
ENDIF
C >>>>>>>>>>>>>>>>>>> TANGENT RUN <<<<<<<<<<<<<<<<<<<
IF (theSimulationMode .EQ. TANGENT_SIMULATION) THEN
CALL MDS_WRITE_FIELD(
I activeVar_file, prec, globalFile, useCurrentDir,
I 'RL', myNr, 1, myNr,
I active_var, dummyRS,
I iRec, myOptimIter, myThid )
ENDIF
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ACTIVE_WRITE_3D_RS
C !INTERFACE:
SUBROUTINE ACTIVE_WRITE_3D_RS(
I activeVar_file,
I active_var,
I globalFile,
I useCurrentDir,
I iRec,
I myNr,
I theSimulationMode,
I myOptimIter,
I myThid )
C !DESCRIPTION: \bv
C ==================================================================
C SUBROUTINE ACTIVE_WRITE_3D_RS
C ==================================================================
C o Write an active 3D _RS variable to a file.
C started: Christian Eckert eckert@mit.edu Jan-1999
C ==================================================================
C SUBROUTINE ACTIVE_WRITE_3D_RS
C ==================================================================
C \ev
C !USES:
IMPLICIT NONE
C == global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
#include "PARAMS.h"
#include "ctrl.h"
C !INPUT/OUTPUT PARAMETERS:
C activeVar_file :: filename
C active_var :: array
C globalFile ::
C useCurrentDir :: always write to the current directory
C (even if "mdsioLocalDir" is set)
C iRec :: record number
C myNr :: vertical array dimension
C theSimulationMode :: forward mode or reverse mode simulation
C myOptimIter :: number of optimization iteration (default: 0)
C myThid :: thread number for this instance
CHARACTER*(*) activeVar_file
INTEGER myNr
_RS active_var(1-OLx:sNx+OLx,1-OLy:sNy+OLy,myNr,nSx,nSy)
LOGICAL globalFile
LOGICAL useCurrentDir
INTEGER iRec
INTEGER theSimulationMode
INTEGER myOptimIter
INTEGER myThid
C !LOCAL VARIABLES:
INTEGER i,j,k
INTEGER bi,bj
INTEGER prec
_RS active_data_t(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL dummyRL(1)
CEOP
C force 64-bit io
prec = ctrlprec
C >>>>>>>>>>>>>>>>>>> FORWARD RUN <<<<<<<<<<<<<<<<<<<
IF (theSimulationMode .EQ. FORWARD_SIMULATION) THEN
CALL MDS_WRITE_FIELD(
I activeVar_file, prec, globalFile, useCurrentDir,
I 'RS', myNr, 1, myNr,
I dummyRL, active_var,
I iRec, myOptimIter, myThid )
ENDIF
C >>>>>>>>>>>>>>>>>>> ADJOINT RUN <<<<<<<<<<<<<<<<<<<
IF (theSimulationMode .EQ. REVERSE_SIMULATION) THEN
CALL MDS_READ_FIELD(
I activeVar_file, prec, useCurrentDir,
I 'RS', Nr, 1, myNr,
O dummyRL, active_data_t,
I iRec, myThid )
C Add active_var from appropriate location to data.
DO bj = myByLo(myThid), myByHi(myThid)
DO bi = myBxLo(myThid), myBxHi(myThid)
DO k = 1, myNr
DO j=1,sNy
DO i=1,sNx
active_var(i,j,k,bi,bj) = active_var(i,j,k,bi,bj)
& + active_data_t(i,j,k,bi,bj)
active_data_t(i,j,k,bi,bj) = 0. _d 0
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
CALL MDS_WRITE_FIELD(
I activeVar_file, prec, globalFile, useCurrentDir,
I 'RS', Nr, 1, myNr,
I dummyRL, active_data_t,
I iRec, myOptimIter, myThid )
ENDIF
C >>>>>>>>>>>>>>>>>>> TANGENT RUN <<<<<<<<<<<<<<<<<<<
IF (theSimulationMode .EQ. TANGENT_SIMULATION) THEN
CALL MDS_WRITE_FIELD(
I activeVar_file, prec, globalFile, useCurrentDir,
I 'RS', myNr, 1, myNr,
I dummyRL, active_var,
I iRec, myOptimIter, myThid )
ENDIF
RETURN
END