forked from altMITgcm/MITgcm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ctrl_map_ini_genarr.F
494 lines (426 loc) · 14 KB
/
ctrl_map_ini_genarr.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
C $Header: /u/gcmpack/MITgcm/pkg/ctrl/ctrl_map_ini_genarr.F,v 1.27 2017/04/05 23:02:53 ou.wang Exp $
C $Name: $
#include "CTRL_OPTIONS.h"
#ifdef ALLOW_GMREDI
# include "GMREDI_OPTIONS.h"
#endif
CBOP
C !ROUTINE: CTRL_MAP_INI_GENARR
C !INTERFACE:
SUBROUTINE CTRL_MAP_INI_GENARR( myThid )
C !DESCRIPTION: \bv
C *=================================================================
C | SUBROUTINE CTRL_MAP_INI_GENARR
C | Add the generic arrays of the
C | control vector to the model state and update the tile halos.
C | The control vector is defined in the header file "ctrl.h".
C *=================================================================
C \ev
C !USES:
IMPLICIT NONE
C == global variables ==
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "DYNVARS.h"
#include "FFIELDS.h"
#include "CTRL_SIZE.h"
#include "ctrl.h"
#include "optim.h"
#include "ctrl_dummy.h"
#include "CTRL_FIELDS.h"
#include "CTRL_GENARR.h"
#ifdef ALLOW_PTRACERS
# include "PTRACERS_SIZE.h"
# include "PTRACERS_FIELDS.h"
#endif
C !INPUT/OUTPUT PARAMETERS:
C == routine arguments ==
INTEGER myThid
C !LOCAL VARIABLES:
C == local variables ==
#if (defined (ALLOW_GENARR2D_CONTROL) || defined(ALLOW_GENARR3D_CONTROL))
integer iarr
#endif
#ifdef ALLOW_GENARR2D_CONTROL
integer igen_etan,igen_bdrag,igen_geoth
#endif /* ALLOW_GENARR2D_CONTROL */
#ifdef ALLOW_GENARR3D_CONTROL
integer igen_theta0, igen_salt0
integer igen_kapgm, igen_kapredi, igen_diffkr
#if (defined (ALLOW_UVEL0_CONTROL) && defined (ALLOW_VVEL0_CONTROL))
integer igen_uvel0, igen_vvel0
#endif
#endif /* ALLOW_GENARR3D_CONTROL */
CEOP
#ifdef ALLOW_GENARR2D_CONTROL
C-- generic 2D control variables
igen_etan=0
igen_bdrag=0
igen_geoth=0
DO iarr = 1, maxCtrlArr2D
if (xx_genarr2d_weight(iarr).NE.' ') then
if (xx_genarr2d_file(iarr)(1:7).EQ.'xx_etan')
& igen_etan=iarr
if (xx_genarr2d_file(iarr)(1:13).EQ.'xx_bottomdrag')
& igen_bdrag=iarr
if (xx_genarr2d_file(iarr)(1:13).EQ.'xx_geothermal')
& igen_geoth=iarr
endif
ENDDO
if (igen_etan.GT.0) then
call ctrl_map_genarr2d(etaN,igen_etan,myThid)
endif
#ifdef ALLOW_BOTTOMDRAG_CONTROL
if (igen_bdrag.GT.0)
& call ctrl_map_genarr2d(bottomDragFld,igen_bdrag,myThid)
#endif
#ifdef ALLOW_GEOTHERMAL_FLUX
if (igen_geoth.GT.0)
& call ctrl_map_genarr2d(geothermalFlux,igen_geoth,myThid)
#endif
#endif /* ALLOW_GENARR2D_CONTROL */
#ifdef ALLOW_GENARR3D_CONTROL
C-- generic 3D control variables
igen_theta0=0
igen_salt0=0
igen_kapgm=0
igen_kapredi=0
igen_diffkr=0
DO iarr = 1, maxCtrlArr3D
if (xx_genarr3d_weight(iarr).NE.' ') then
if (xx_genarr3d_file(iarr)(1:8).EQ.'xx_theta')
& igen_theta0=iarr
if (xx_genarr3d_file(iarr)(1:7).EQ.'xx_salt')
& igen_salt0=iarr
if (xx_genarr3d_file(iarr)(1:8).EQ.'xx_kapgm')
& igen_kapgm=iarr
if (xx_genarr3d_file(iarr)(1:10).EQ.'xx_kapredi')
& igen_kapredi=iarr
if (xx_genarr3d_file(iarr)(1:9).EQ.'xx_diffkr')
& igen_diffkr=iarr
#if (defined (ALLOW_UVEL0_CONTROL) && defined (ALLOW_VVEL0_CONTROL))
if (xx_genarr3d_file(iarr)(1:7).EQ.'xx_uvel')
& igen_uvel0=iarr
if (xx_genarr3d_file(iarr)(1:7).EQ.'xx_vvel')
& igen_vvel0=iarr
#endif
endif
ENDDO
if (igen_theta0.GT.0)
& call ctrl_map_genarr3d(theta,igen_theta0,myThid)
if (igen_salt0.GT.0)
& call ctrl_map_genarr3d(salt,igen_salt0,myThid)
#ifdef ALLOW_KAPGM_CONTROL
if (igen_kapgm.GT.0)
& call ctrl_map_genarr3d(kapgm,igen_kapgm,myThid)
#endif
#ifdef ALLOW_KAPREDI_CONTROL
if (igen_kapredi.GT.0)
& call ctrl_map_genarr3d(kapredi,igen_kapredi,myThid)
#endif
#ifdef ALLOW_3D_DIFFKR
if (igen_diffkr.GT.0)
& call ctrl_map_genarr3d(diffkr,igen_diffkr,myThid)
#endif
#if (defined (ALLOW_UVEL0_CONTROL) && defined (ALLOW_VVEL0_CONTROL))
if (igen_uvel0.GT.0 .and. igen_vvel0.GT.0) then
call ctrl_map_genarr3d(uvel,igen_uvel0,myThid)
call ctrl_map_genarr3d(vvel,igen_vvel0,myThid)
CALL EXCH_UV_XYZ_RL(uvel,vvel,.TRUE.,myThid)
endif
#endif
#endif /* ALLOW_GENARR3D_CONTROL */
RETURN
END
C---------------------------
C !ROUTINE: CTRL_MAP_GENARR2D
C !INTERFACE:
SUBROUTINE CTRL_MAP_GENARR2D( fld, iarr, myThid )
C !DESCRIPTION: \bv
C *=================================================================
C | SUBROUTINE CTRL_MAP_GENARR2D
C | Add the generic arrays of the
C | control vector to the model state and update the tile halos.
C | The control vector is defined in the header file "ctrl.h".
C *=================================================================
C \ev
C !USES:
IMPLICIT NONE
C == global variables ==
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "CTRL_SIZE.h"
#include "ctrl.h"
#include "optim.h"
#include "CTRL_GENARR.h"
#include "ctrl_dummy.h"
C !INPUT/OUTPUT PARAMETERS:
C == routine arguments ==
_RL fld (1-olx:snx+olx,1-oly:sny+oly,nsx,nsy)
INTEGER iarr
INTEGER myThid
#ifdef ALLOW_GENARR2D_CONTROL
C !LOCAL VARIABLES:
C == local variables ==
integer bi,bj
integer i,j
integer jmin,jmax
integer imin,imax
integer numsmo, k2
logical dowc01
logical dosmooth
logical doscaling
_RL xx_gen (1-olx:snx+olx,1-oly:sny+oly,nsx,nsy)
character*(80) fnamegenIn
character*(80) fnamegenOut
character*(80) fnamebase
INTEGER ILNBLNK
EXTERNAL ILNBLNK
integer ilgen
logical doglobalread
logical ladinit
CEOP
c-- Now, read the control vector.
doglobalread = .false.
ladinit = .false.
DO bj=myByLo(myThid), myByHi(myThid)
DO bi=myBxLo(myThid), myBxHi(myThid)
DO j = 1-OLy,sNy+OLy
DO i = 1-OLx,sNx+OLx
xx_gen(i,j,bi,bj)=0. _d 0
ENDDO
ENDDO
ENDDO
ENDDO
dosmooth=.false.
dowc01 = .false.
doscaling=.true.
numsmo=1
do k2 = 1, maxCtrlProc
if (xx_genarr2d_preproc(k2,iarr).EQ.'WC01') then
dowc01=.TRUE.
if (xx_genarr2d_preproc_i(k2,iarr).NE.0)
& numsmo=xx_genarr2d_preproc_i(k2,iarr)
endif
if ((.NOT.dowc01).AND.
& (xx_genarr2d_preproc(k2,iarr).EQ.'smooth')) then
dosmooth=.TRUE.
if (xx_genarr2d_preproc_i(k2,iarr).NE.0)
& numsmo=xx_genarr2d_preproc_i(k2,iarr)
endif
if (xx_genarr2d_preproc(k2,iarr).EQ.'noscaling') then
doscaling=.FALSE.
endif
enddo
fnamebase = xx_genarr2d_file(iarr)
ilgen=ilnblnk( fnamebase )
write(fnamegenIn(1:80),'(2a,i10.10)')
& fnamebase(1:ilgen),'.',optimcycle
write(fnamegenOut(1:80),'(2a,i10.10)')
& fnamebase(1:ilgen),'.effective.',optimcycle
call mdsreadfield(xx_genarr2d_weight(iarr),ctrlprec,'RL',1,
& wgenarr2d(1-Olx,1-Oly,1,1,iarr),1,mythid)
#ifdef ALLOW_AUTODIFF
call active_read_xy( fnamegenIn, xx_gen, 1, doglobalread,
& ladinit, optimcycle, mythid, xx_genarr2d_dummy(iarr) )
#else
CALL READ_REC_XY_RL( fnamegenIn, xx_gen, 1, 1, myThid)
#endif
#ifdef ALLOW_SMOOTH
IF (useSMOOTH) THEN
IF (dowc01) call smooth_correl2d(xx_gen,maskC,numsmo,mythid)
IF (dosmooth) call smooth2d(xx_gen,maskC,numsmo,mythid)
ENDIF
#endif
DO bj=myByLo(myThid), myByHi(myThid)
DO bi=myBxLo(myThid), myBxHi(myThid)
DO j = 1,sNy
DO i = 1,sNx
c scale param adjustment
IF (doscaling) then
if ( (maskC(i,j,1,bi,bj).NE.0.).AND.
& (wgenarr2d(i,j,bi,bj,iarr).GT.0.) ) then
xx_gen(i,j,bi,bj)=xx_gen(i,j,bi,bj)
& /sqrt( wgenarr2d(i,j,bi,bj,iarr) )
else
xx_gen(i,j,bi,bj)=0.
endif
ENDIF
c add to model parameter
fld(i,j,bi,bj)=fld(i,j,bi,bj)+xx_gen(i,j,bi,bj)
enddo
enddo
enddo
enddo
c avoid param out of [boundsVec(1) boundsVec(4)]
CALL CTRL_BOUND_2D(fld,maskC,xx_genarr2d_bounds(1,iarr),myThid)
CALL EXCH_XY_RL( fld, mythid )
CALL mdswritefield(fnamegenOut,ctrlprec,.FALSE.,'RL',
& 1, fld, 1, optimcycle, mythid)
#endif /* ALLOW_GENARR2D_CONTROL */
RETURN
END
C---------------------------
C !ROUTINE: CTRL_MAP_GENARR3D
C !INTERFACE:
SUBROUTINE CTRL_MAP_GENARR3D( fld, iarr, myThid )
C !DESCRIPTION: \bv
C *=================================================================
C | SUBROUTINE CTRL_MAP_GENARR3D
C | Add the generic arrays of the
C | control vector to the model state and update the tile halos.
C | The control vector is defined in the header file "ctrl.h".
C *=================================================================
C \ev
C !USES:
IMPLICIT NONE
C == global variables ==
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "CTRL_SIZE.h"
#include "ctrl.h"
#include "optim.h"
#include "CTRL_GENARR.h"
#include "ctrl_dummy.h"
C !INPUT/OUTPUT PARAMETERS:
C == routine arguments ==
_RL fld (1-olx:snx+olx,1-oly:sny+oly,nr,nsx,nsy)
INTEGER iarr
INTEGER myThid
#ifdef ALLOW_GENARR3D_CONTROL
C !LOCAL VARIABLES:
C == local variables ==
integer bi,bj
integer i,j,k
integer numsmo,k2
logical dowc01
logical dosmooth
logical doscaling
_RL xx_gen (1-olx:snx+olx,1-oly:sny+oly,nr,nsx,nsy)
character*(80) fnamegenIn
character*(80) fnamegenOut
character*(80) fnamebase
INTEGER ILNBLNK
EXTERNAL ILNBLNK
integer ilgen
logical doglobalread
logical ladinit
#if (defined (ALLOW_UVEL0_CONTROL) && defined (ALLOW_VVEL0_CONTROL))
_RL localmask (1-olx:snx+olx,1-oly:sny+oly,nr,nsx,nsy)
#endif
CEOP
c-- Now, read the control vector.
doglobalread = .false.
ladinit = .false.
DO bj=myByLo(myThid), myByHi(myThid)
DO bi=myBxLo(myThid), myBxHi(myThid)
DO k = 1,nr
DO j = 1-OLy,sNy+OLy
DO i = 1-OLx,sNx+OLx
xx_gen(i,j,k,bi,bj)=0. _d 0
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
dosmooth=.false.
dowc01 = .false.
doscaling=.true.
numsmo=1
do k2 = 1, maxCtrlProc
if (xx_genarr3d_preproc(k2,iarr).EQ.'WC01') then
dowc01=.TRUE.
if (xx_genarr3d_preproc_i(k2,iarr).NE.0)
& numsmo=xx_genarr3d_preproc_i(k2,iarr)
endif
if ((.NOT.dowc01).AND.
& (xx_genarr3d_preproc(k2,iarr).EQ.'smooth')) then
dosmooth=.TRUE.
if (xx_genarr3d_preproc_i(k2,iarr).NE.0)
& numsmo=xx_genarr3d_preproc_i(k2,iarr)
endif
if (xx_genarr3d_preproc(k2,iarr).EQ.'noscaling') then
doscaling=.FALSE.
endif
enddo
fnamebase = xx_genarr3d_file(iarr)
ilgen=ilnblnk( fnamebase )
write(fnamegenIn(1:80),'(2a,i10.10)')
& fnamebase(1:ilgen),'.',optimcycle
write(fnamegenOut(1:80),'(2a,i10.10)')
& fnamebase(1:ilgen),'.effective.',optimcycle
call mdsreadfield(xx_genarr3d_weight(iarr),ctrlprec,'RL',nR,
& wgenarr3d(1-Olx,1-Oly,1,1,1,iarr),1,mythid)
#ifdef ALLOW_AUTODIFF
call active_read_xyz( fnamegenIn, xx_gen, 1, doglobalread,
& ladinit, optimcycle, mythid, xx_genarr3d_dummy(iarr) )
#else
CALL READ_REC_XYZ_RL( fnamegenIn, xx_gen, 1, 1, myThid)
#endif
#ifdef ALLOW_SMOOTH
IF (useSMOOTH) THEN
IF (dowc01) call smooth_correl3d(xx_gen,numsmo,mythid)
IF (dosmooth) call smooth3d(xx_gen,numsmo,mythid)
ENDIF
#endif
#if (defined (ALLOW_UVEL0_CONTROL) && defined (ALLOW_VVEL0_CONTROL))
c-- set local mask
call ecco_zero(localmask,Nr,zeroRL,myThid)
if (xx_genarr3d_file(iarr)(1:7).EQ.'xx_uvel') then
call ecco_cprsrl(maskW,nr,localmask,nr,myThid)
else if (xx_genarr3d_file(iarr)(1:7).EQ.'xx_vvel') then
call ecco_cprsrl(maskS,nr,localmask,nr,myThid)
else
call ecco_cprsrl(maskC,nr,localmask,nr,myThid)
endif
#endif
DO bj=myByLo(myThid), myByHi(myThid)
DO bi=myBxLo(myThid), myBxHi(myThid)
do k = 1,nr
DO j = 1,sNy
DO i = 1,sNx
c scale param adjustment
IF (doscaling) then
#if (defined (ALLOW_UVEL0_CONTROL) && defined (ALLOW_VVEL0_CONTROL))
if ( (localmask(i,j,k,bi,bj).NE.0.).AND.
#else
if ( (maskC(i,j,k,bi,bj).NE.0.).AND.
#endif
& (wgenarr3d(i,j,k,bi,bj,iarr).GT.0.) ) then
xx_gen(i,j,k,bi,bj)=xx_gen(i,j,k,bi,bj)
& /sqrt( wgenarr3d(i,j,k,bi,bj,iarr) )
else
xx_gen(i,j,k,bi,bj)=0.
endif
ENDIF
c add to model parameter
fld(i,j,k,bi,bj)=fld(i,j,k,bi,bj)+xx_gen(i,j,k,bi,bj)
enddo
enddo
enddo
enddo
enddo
c avoid param out of [boundsVec(1) boundsVec(4)]
#if (defined (ALLOW_UVEL0_CONTROL) && defined (ALLOW_VVEL0_CONTROL))
CALL CTRL_BOUND_3D(fld,localmask,
& xx_genarr3d_bounds(1,iarr),myThid)
#else
CALL CTRL_BOUND_3D(fld,maskC,xx_genarr3d_bounds(1,iarr),myThid)
#endif
C The tile exchange for xx_uvel and xx_vvel will be
C done in CTRL_MAP_INI_GENARR.F when both
C xx_uvel and xx_vvel are read in.
if (xx_genarr3d_file(iarr)(1:7).NE.'xx_uvel'.AND.
& xx_genarr3d_file(iarr)(1:7).NE.'xx_vvel')
& CALL EXCH_XYZ_RL( fld, mythid )
CALL mdswritefield(fnamegenOut,ctrlprec,.FALSE.,'RL',
& nr, fld, 1, optimcycle, mythid)
#endif /* ALLOW_GENARR3D_CONTROL */
RETURN
END