forked from darwinproject/darwin3
-
Notifications
You must be signed in to change notification settings - Fork 1
/
ecco_toolbox.F
1015 lines (861 loc) · 25.4 KB
/
ecco_toolbox.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
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include "ECCO_OPTIONS.h"
#ifdef ALLOW_CTRL
# include "CTRL_OPTIONS.h"
#endif
C-- File ecco_toolbox.F: Routines to handle basic operations common in ecco.
C-- Contents
C-- o ECCO_ZERO
C-- o ECCO_CP
C-- o ECCO_CPRSRL
C-- o ECCO_DIFFMSK
C-- o ECCO_ADDCOST
C-- o ECCO_ADD (currently not used)
C-- o ECCO_SUBTRACT
C-- o ECCO_ADDMASK
C-- o ECCO_DIV
C-- o ECCO_DIVFIELD
C-- o ECCO_MULT
C-- o ECCO_MULTFIELD (currently not used)
C-- o ECCO_MASKMINDEPTH
C-- o ECCO_OFFSET
C-- o ECCO_READBAR
C-- o ECCO_READWEI
C-- o ECCO_ERROR
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_ZERO
C !INTERFACE:
SUBROUTINE ECCO_ZERO( fld, nzIn, zeroLoc, myThid )
C !DESCRIPTION: \bv
C fill a field with zeroLoc
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
C !INPUT/OUTPUT PARAMETERS:
INTEGER nzIn
INTEGER myThid
_RL fld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL zeroLoc
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj,i,j,k
CEOP
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
DO k = 1,nzIn
DO j = 1-OLy,sNy+OLy
DO i = 1-OLx,sNx+OLx
fld(i,j,k,bi,bj) = zeroLoc
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_DIFFMSK
C !INTERFACE:
SUBROUTINE ECCO_DIFFMSK(
I localBar, localObs, localMask,
I nzIn, nLev, spMinLoc, spMaxLoc, spzeroLoc,
O localDif, difMask,
I myThid )
C !DESCRIPTION: \bv
C compute masked difference between model and observations
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
C !INPUT PARAMETERS:
INTEGER nzIn, nLev
INTEGER myThid
_RL localBar (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL localObs (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL localMask(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL spMinLoc, spMaxLoc, spzeroLoc
C !OUTPUT PARAMETERS:
_RL localDif (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL difMask (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj,i,j,k
CEOP
c-- Determine the model-data difference mask
IF ( nLev .GT. nzIn ) CALL ECCO_ERROR( 'ECCO_DIFFMSK',
& 'nLev > nzIn not allowed.', myThid )
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
DO k = 1,nLev
DO j = 1,sNy
DO i = 1,sNx
difMask(i,j,k,bi,bj) = localMask(i,j,k,bi,bj)
IF ( localObs(i,j,k,bi,bj) .LT. spMinLoc .OR.
& localObs(i,j,k,bi,bj) .GT. spMaxLoc .OR.
& localObs(i,j,k,bi,bj) .EQ. spzeroLoc ) THEN
difMask(i,j,k,bi,bj) = 0. _d 0
ENDIF
localDif(i,j,k,bi,bj) = difMask(i,j,k,bi,bj)*
& (localBar(i,j,k,bi,bj)-localObs(i,j,k,bi,bj))
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_CP
C !INTERFACE:
SUBROUTINE ECCO_CP(
I fldIn,
U fldOut,
I nzIn, nlev, myThid )
C !DESCRIPTION: \bv
C copy a field to another array
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
C !INPUT/OUTPUT PARAMETERS:
INTEGER nzIn, nLev
INTEGER myThid
_RL fldIn (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL fldOut(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj,i,j,k
CEOP
IF ( nLev .GT. nzIn ) CALL ECCO_ERROR( 'ECCO_CP',
& 'nLev > nzIn not allowed.', myThid )
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
DO k = 1,nLev
DO j = 1,sNy
DO i = 1,sNx
fldOut(i,j,k,bi,bj) = fldIn(i,j,k,bi,bj)
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_CPRSRL
C !INTERFACE:
SUBROUTINE ECCO_CPRSRL(
I fldIn,
U fldOut,
I nzIn, nlev, myThid )
C !DESCRIPTION: \bv
C copy a field to another array, switching from _RS to _RL
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
C !INPUT/OUTPUT PARAMETERS:
INTEGER nzIn, nLev
INTEGER myThid
_RS fldIn (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL fldOut(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj,i,j,k
CEOP
IF ( nLev .GT. nzIn ) CALL ECCO_ERROR( 'ECCO_CPRSRL',
& 'nLev > nzIn not allowed.', myThid )
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
DO k = 1,nLev
DO j = 1,sNy
DO i = 1,sNx
fldOut(i,j,k,bi,bj) = fldIn(i,j,k,bi,bj)
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_ADDCOST
C !INTERFACE:
SUBROUTINE ECCO_ADDCOST(
I localDif, localWeight, difMask, nzIn, nLev, doSumSq,
U objf_local, num_local,
I myThid )
C !DESCRIPTION: \bv
C adds to a cost function term
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
C !INPUT PARAMETERS:
INTEGER nzIn, nLev
LOGICAL doSumSq
INTEGER myThid
_RL localDif (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL localWeight(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL difMask (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
C !OUTPUT PARAMETERS:
_RL objf_local (nSx,nSy)
_RL num_local (nSx,nSy)
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj,i,j,k
_RL localwww
_RL localcost
_RL junk
CEOP
localwww = 0. _d 0
IF ( nLev .GT. nzIn ) CALL ECCO_ERROR( 'ECCO_ADDCOST',
& 'nLev > nzIn not allowed.', myThid )
c-- Compute normalized model-obs cost function
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
localcost = 0. _d 0
DO k = 1,nLev
DO j = 1,sNy
DO i = 1,sNx
localwww = localWeight(i,j,k,bi,bj) * difMask(i,j,k,bi,bj)
junk = localDif(i,j,k,bi,bj)
IF ( doSumSq ) THEN
localcost = localcost + junk*junk*localwww
ELSE
localcost = localcost + junk*localwww
ENDIF
IF ( localwww .NE. 0. )
& num_local(bi,bj) = num_local(bi,bj) + 1. _d 0
ENDDO
ENDDO
ENDDO
objf_local(bi,bj) = objf_local(bi,bj) + localcost
ENDDO
ENDDO
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_ADD
C !INTERFACE:
SUBROUTINE ECCO_ADD(
U fldOut,
I fldIn, nzIn, nLev, myThid )
C !DESCRIPTION: \bv
C add a field (fldIn) to another field (fldOut)
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
C !INPUT/OUTPUT PARAMETERS:
INTEGER nzIn, nLev
INTEGER myThid
_RL fldOut(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL fldIn (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj,i,j,k
CEOP
IF ( nLev .GT. nzIn ) CALL ECCO_ERROR( 'ECCO_ADD',
& 'nLev > nzIn not allowed.', myThid )
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
DO k = 1,nLev
DO j = 1,sNy
DO i = 1,sNx
fldOut(i,j,k,bi,bj) = fldOut(i,j,k,bi,bj)
& + fldIn (i,j,k,bi,bj)
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_SUBTRACT
C !INTERFACE:
SUBROUTINE ECCO_SUBTRACT(
U fldOut,
I fldIn, nzIn, nLev, myThid )
C !DESCRIPTION: \bv
C subtract a field (fldIn) from another field (fldOut)
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
#include "PARAMS.h"
#ifdef ALLOW_ECCO
# include "ECCO_SIZE.h"
# include "ECCO.h"
#endif
C !INPUT/OUTPUT PARAMETERS:
INTEGER nzIn, nLev
INTEGER myThid
_RL fldOut(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL fldIn (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj,i,j,k
CEOP
IF ( nLev .GT. nzIn ) CALL ECCO_ERROR( 'ECCO_SUBTRACT',
& 'nLev > nzIn not allowed.', myThid )
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
DO k = 1,nLev
DO j = 1,sNy
DO i = 1,sNx
fldOut(i,j,k,bi,bj) = fldOut(i,j,k,bi,bj)
& - fldIn (i,j,k,bi,bj)
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_ADDMASK
C !INTERFACE:
SUBROUTINE ECCO_ADDMASK(
I fldIn, fldInmask,
U fldOut, fldOutnum,
I nzIn, nLev, myThid )
C !DESCRIPTION: \bv
C add a field to another array only grids where the mask is non-zero.
C Also increase the counter by one one those girds.
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
C !INPUT/OUTPUT PARAMETERS:
INTEGER nzIn, nLev
INTEGER myThid
_RL fldIn (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL fldInmask (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL fldOut (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL fldOutnum (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj,i,j,k
CEOP
IF ( nLev .GT. nzIn ) CALL ECCO_ERROR( 'ECCO_ADDMASK',
& 'nLev > nzIn not allowed.', myThid )
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
DO k = 1,nLev
DO j = 1,sNy
DO i = 1,sNx
IF ( fldInmask(i,j,k,bi,bj) .NE. 0. _d 0 ) THEN
fldOut(i,j,k,bi,bj) = fldOut(i,j,k,bi,bj)
& + fldIn (i,j,k,bi,bj)
fldOutnum(i,j,k,bi,bj) = fldOutnum(i,j,k,bi,bj) + 1. _d 0
ENDIF
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_DIV
C !INTERFACE:
SUBROUTINE ECCO_DIV(
U fld,
I numerLoc, nzIn, nLev, myThid )
C !DESCRIPTION: \bv
C divide a field with RL constant
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
C !INPUT/OUTPUT PARAMETERS:
INTEGER nzIn, nLev
INTEGER myThid
_RL fld(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL numerLoc
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj,i,j,k
_RL recip_num
CEOP
IF ( nLev .GT. nzIn ) CALL ECCO_ERROR( 'ECCO_DIV',
& 'nLev > nzIn not allowed.', myThid )
IF ( numerLoc .NE. 0. _d 0 ) THEN
recip_num = 1. _d 0 / numerLoc
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
DO k = 1,nLev
DO j = 1,sNy
DO i = 1,sNx
fld(i,j,k,bi,bj) = fld(i,j,k,bi,bj) * recip_num
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
ENDIF
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_DIVFIELD
C !INTERFACE:
SUBROUTINE ECCO_DIVFIELD( fld, fldDenom, nzIn, nLev, myThid )
C !DESCRIPTION: \bv
C divide a field by another field
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
C !INPUT/OUTPUT PARAMETERS:
INTEGER nzIn, nLev
INTEGER myThid
_RL fld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL fldDenom(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj,i,j,k
CEOP
IF ( nLev .GT. nzIn ) CALL ECCO_ERROR( 'ECCO_DIVFIELD',
& 'nLev > nzIn not allowed.', myThid )
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
DO k = 1,nLev
DO j = 1,sNy
DO i = 1,sNx
IF ( fldDenom(i,j,k,bi,bj) .NE. 0. _d 0 ) THEN
fld(i,j,k,bi,bj) = fld(i,j,k,bi,bj)/fldDenom(i,j,k,bi,bj)
ELSE
fld(i,j,k,bi,bj) = 0. _d 0
ENDIF
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_MULT
C !INTERFACE:
SUBROUTINE ECCO_MULT(
U fld,
I multLoc, nzIn, nLev, myThid )
C !DESCRIPTION: \bv
C multiply a field with RL constant
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
C !INPUT/OUTPUT PARAMETERS:
INTEGER nzIn, nLev
INTEGER myThid
_RL multLoc
_RL fld(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj,i,j,k
CEOP
IF ( nLev .GT. nzIn ) CALL ECCO_ERROR('ECCO_MULT',
& 'nLev > nzIn not allowed.', myThid)
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
DO k = 1,nLev
DO j = 1,sNy
DO i = 1,sNx
fld(i,j,k,bi,bj) = fld(i,j,k,bi,bj)*multLoc
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_MULTFIELD
C !INTERFACE:
SUBROUTINE ECCO_MULTFIELD(
U fldOut,
I fldIn, nzIn, nLev, myThid )
C !DESCRIPTION: \bv
C multiply a field by another field, fldOut is updated on output
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
C !INPUT/OUTPUT PARAMETERS:
INTEGER nzIn, nLev
INTEGER myThid
_RL fldOut(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL fldIn (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj,i,j,k
CEOP
IF ( nLev .GT. nzIn ) CALL ECCO_ERROR( 'ECCO_MULTFIELD',
& 'nLev > nzIn not allowed.', myThid )
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
DO k = 1,nLev
DO j = 1,sNy
DO i = 1,sNx
fldOut(i,j,k,bi,bj) = fldOut(i,j,k,bi,bj)*fldIn(i,j,k,bi,bj)
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_MASKMINDEPTH
C !INTERFACE:
SUBROUTINE ECCO_MASKMINDEPTH(
U difMask,
I nzIn, nLev, topoMin, myThid )
C !DESCRIPTION: \bv
C set difMask to zero where topography is shallower that topoMin
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
#include "GRID.h"
C !INPUT/OUTPUT PARAMETERS:
INTEGER nzIn, nLev
INTEGER myThid
_RL difMask(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL topoMin
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj,i,j,k
CEOP
IF ( nLev .GT. nzIn ) CALL ECCO_ERROR( 'ECCO_MASMINDEPTH',
& 'nLev > nzIn not allowed.', myThid )
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
DO j = 1,sNy
DO i = 1,sNx
IF ( R_low(i,j,bi,bj) .GT. topoMin ) THEN
DO k = 1,nLev
difMask(i,j,k,bi,bj) = zeroRL
ENDDO
ENDIF
ENDDO
ENDDO
ENDDO
ENDDO
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_OFFSET
C !INTERFACE:
SUBROUTINE ECCO_OFFSET(
I fName,
U fld,
I difMask, nzIn, nLev,
I myThid )
C !DESCRIPTION: \bv
C remove mean of masked field
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
C !INPUT/OUTPUT PARAMETERS:
INTEGER myThid
INTEGER nzIn, nLev
CHARACTER*(*) fName
_RL fld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL difMask(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj,i,j,k
_RL volTile(nSx,nSy), sumTile(nSx,nSy)
_RL tmpVol, volGlob, sumGlob
_RL theMean
CHARACTER*(MAX_LEN_MBUF) msgBuf
CEOP
IF ( nLev .GT. nzIn ) CALL ECCO_ERROR( 'ECCO_OFFSET',
& 'nLev > nzIn not allowed.', myThid )
c-- Compute the mean
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
volTile(bi,bj) = 0. _d 0
sumTile(bi,bj) = 0. _d 0
DO k = 1,nLev
DO j = 1,sNy
DO i = 1,sNx
tmpVol = difMask(i,j,k,bi,bj)
volTile(bi,bj) = volTile(bi,bj) + tmpVol
sumTile(bi,bj) = sumTile(bi,bj) + tmpVol*fld(i,j,k,bi,bj)
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
CALL GLOBAL_SUM_TILE_RL( volTile, volGlob, myThid )
CALL GLOBAL_SUM_TILE_RL( sumTile, sumGlob, myThid )
IF ( volGlob.GT.zeroRL ) THEN
theMean = sumGlob/volGlob
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
DO k = 1,nLev
DO j = 1,sNy
DO i = 1,sNx
IF (difMask(i,j,k,bi,bj) .NE. 0. _d 0) THEN
fld(i,j,k,bi,bj) = fld(i,j,k,bi,bj) - theMean
ENDIF
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
ELSE
theMean = 0. _d 0
ENDIF
C Print the global mean to standard output
_BEGIN_MASTER( myThid )
WRITE(msgBuf,'(3A,1PE21.14)')
& 'ecco_offset: # of nonzero constributions to mean of ',
& fname, ' = ', volGlob
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
WRITE(msgBuf,'(3A,1PE21.14)')
& 'ecco_offset: Global mean of ',
& fname, ' = ', theMean
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
_END_MASTER( myThid )
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_READBAR
C !INTERFACE:
SUBROUTINE ECCO_READBAR(
I active_var_file,
O active_var,
I iRec, nzIn, nLev,
I dummy,
I myThid )
C !DESCRIPTION: \bv
C reads one record from averaged time series ("bar file")
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
#ifdef ALLOW_ECCO
# include "ECCO_SIZE.h"
# include "ECCO.h"
#endif
C !INPUT/OUTPUT PARAMETERS:
C active_var_file :: filename
C active_var :: array
C iRec :: record number
C nzIn :: size of active_var
C nLev :: number vertical levels used
CHARACTER*(*) active_var_file
INTEGER iRec, nzIn, nLev
INTEGER myThid
_RL active_var(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
_RL dummy
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
LOGICAL doGlobalRead
LOGICAL lAdInit
INTEGER i,j,bi,bj
_RL tmpFld2D(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
CHARACTER*(MAX_LEN_MBUF) msgBuf
CEOP
doGlobalRead = .FALSE.
lAdInit = .FALSE.
#ifdef ALLOW_AUTODIFF
IF ( nLev .EQ. 1 ) THEN
CALL ACTIVE_READ_XY( active_var_file, tmpFld2D,
& iRec, doGlobalRead,
& lAdInit, eccoiter, myThid,
& dummy )
ELSEIF ( nLev .EQ. Nr .AND. nzIn .EQ. Nr ) THEN
CALL ACTIVE_READ_XYZ( active_var_file, active_var,
& iRec, doGlobalRead,
& lAdInit, eccoiter, myThid,
& dummy )
ELSE
WRITE(msgBuf,'(A,I3,A)') 'nLev = ',nLev,' should not happen'
CALL ECCO_ERROR( 'ECCO_READBAR', msgBuf, myThid )
ENDIF
#else
IF ( nLev .EQ. 1 ) THEN
CALL READ_REC_XY_RL( active_var_file, tmpFld2D,
& iRec, 1, myThid )
ELSEIF ( nLev .EQ. Nr .AND. nzIn .EQ. Nr ) THEN
CALL READ_REC_XYZ_RL( active_var_file, active_var,
& iRec, 1, myThid )
ELSE
WRITE(msgBuf,'(A,I3,A)') 'nLev = ',nLev,' should not happen'
CALL ECCO_ERROR( 'ECCO_READBAR', msgBuf, myThid )
ENDIF
#endif
IF ( nLev .EQ. 1 ) THEN
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),myBxHi(myThid)
DO j = 1,sNy
DO i = 1,sNx
active_var(i,j,1,bi,bj) = tmpFld2D(i,j,bi,bj)
ENDDO
ENDDO
ENDDO
ENDDO
ENDIF
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_READWEI
C !INTERFACE:
SUBROUTINE ECCO_READWEI(
I localErr_file,
O localWeight,
I iRec, nzIn, nLev,
I doSumSq,
I myThid )
C !DESCRIPTION: \bv
C reads uncertainty field and compute weight as squared inverse
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
#ifdef ALLOW_ECCO
# include "ECCO_SIZE.h"
# include "ECCO.h"
#endif
C !INPUT/OUTPUT PARAMETERS:
C localErr_file :: filename
C localWeight :: array
C iRec :: record number
CHARACTER*(*) localErr_file
INTEGER iRec, nzIn, nLev
LOGICAL doSumSq
INTEGER myThid
_RL localWeight(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nzIn,nSx,nSy)
#ifdef ALLOW_ECCO
C !LOCAL VARIABLES:
INTEGER bi,bj
INTEGER i,j,k
CEOP
CALL READ_REC_LEV_RL( localErr_file, cost_iprec, nzIn, 1, nLev,
& localWeight, iRec, 1, myThid )
DO bj=myByLo(myThid),myByHi(myThid)
DO bi=myBxLo(myThid),myBxHi(myThid)
DO k = 1,nLev
DO j = 1,sNy
DO i = 1,sNx
c-- Test for missing values.
IF (localWeight(i,j,k,bi,bj) .LT. -9900.) THEN
localWeight(i,j,k,bi,bj) = 0. _d 0
c-- Convert to weight
ELSEIF ( localWeight(i,j,k,bi,bj).NE.0. .AND. doSumSq ) THEN
localWeight(i,j,k,bi,bj) =
& oneRL/localWeight(i,j,k,bi,bj)/localWeight(i,j,k,bi,bj)
ELSEIF ( localWeight(i,j,k,bi,bj).NE.0. ) THEN
localWeight(i,j,k,bi,bj) =
& oneRL/localWeight(i,j,k,bi,bj)
ENDIF
ENDDO
ENDDO
ENDDO
ENDDO
ENDDO
#endif /* ALLOW_ECCO */
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: ECCO_ERROR
C !INTERFACE:
SUBROUTINE ECCO_ERROR( srName, errMsg, myThid )
C !DESCRIPTION: \bv
C prints error messages and stops
C \ev
C !USES:
IMPLICIT NONE
C == Global variables ==
#include "SIZE.h"
#include "EEPARAMS.h"
C !INPUT/OUTPUT PARAMETERS:
C srName :: name of caller
C errMsg :: error message to be printed
CHARACTER*(*) srName, errMsg
INTEGER myThid