forked from darwinproject/darwin3
-
Notifications
You must be signed in to change notification settings - Fork 1
/
do_oceanic_phys.F
1099 lines (1029 loc) · 34 KB
/
do_oceanic_phys.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 "PACKAGES_CONFIG.h"
#include "CPP_OPTIONS.h"
#ifdef ALLOW_MOM_COMMON
# include "MOM_COMMON_OPTIONS.h"
#endif
#ifdef ALLOW_AUTODIFF
# include "AUTODIFF_OPTIONS.h"
#endif
#ifdef ALLOW_CTRL
# include "CTRL_OPTIONS.h"
#endif
#ifdef ALLOW_SALT_PLUME
# include "SALT_PLUME_OPTIONS.h"
#endif
#ifdef ALLOW_ECCO
# include "ECCO_OPTIONS.h"
#endif
#ifdef ALLOW_AUTODIFF
# ifdef ALLOW_GGL90
# include "GGL90_OPTIONS.h"
# endif
# ifdef ALLOW_GMREDI
# include "GMREDI_OPTIONS.h"
# endif
# ifdef ALLOW_KPP
# include "KPP_OPTIONS.h"
# endif
# ifdef ALLOW_SEAICE
# include "SEAICE_OPTIONS.h"
# endif
# ifdef ALLOW_EXF
# include "EXF_OPTIONS.h"
# endif
#endif /* ALLOW_AUTODIFF */
CBOP
C !ROUTINE: DO_OCEANIC_PHYS
C !INTERFACE:
SUBROUTINE DO_OCEANIC_PHYS(myTime, myIter, myThid)
C !DESCRIPTION: \bv
C *==========================================================*
C | SUBROUTINE DO_OCEANIC_PHYS
C | o Controlling routine for oceanic physics and
C | parameterization
C *==========================================================*
C | o originally, part of S/R thermodynamics
C *==========================================================*
C \ev
C !CALLING SEQUENCE:
C DO_OCEANIC_PHYS
C |
C |-- OBCS_CALC
C |
C |-- OCN_APPLY_IMPORT
C |
C |-- FRAZIL_CALC_RHS
C |
C |-- THSICE_MAIN
C |
C |-- SEAICE_FAKE
C |-- SEAICE_MODEL
C |-- SEAICE_COST_SENSI
C |
C |-- OCN_EXPORT_DATA
C |
C |-- SHELFICE_THERMODYNAMICS
C |
C |-- ICEFRONT_THERMODYNAMICS
C |
C |-- SALT_PLUME_DO_EXCH
C |
C |-- FREEZE_SURFACE
C |
C |-- EXTERNAL_FORCING_SURF
C |
C |-- OBCS_ADJUST
C |
C |- k loop (Nr:1):
C | - DWNSLP_CALC_RHO
C | - BBL_CALC_RHO
C | - FIND_RHO_2D @ p(k)
C | - FIND_RHO_2D @ p(k-1)
C | - GRAD_SIGMA
C | - CALC_IVDC
C | - DIAGS_RHO_L
C |- end k loop.
C |
C |-- CALC_OCE_MXLAYER
C |
C |-- SALT_PLUME_CALC_DEPTH
C |-- SALT_PLUME_VOLFRAC
C |-- SALT_PLUME_APPLY
C |-- SALT_PLUME_APPLY
C |-- SALT_PLUME_FORCING_SURF
C |
C |-- KPP_CALC
C |-- KPP_CALC_DUMMY
C |
C |-- PP81_CALC
C |
C |-- KL10_CALC
C |
C |-- MY82_CALC
C |
C |-- GGL90_CALC
C |
C |-- TIMEAVE_SURF_FLUX
C |
C |-- GMREDI_CALC_TENSOR
C |-- GMREDI_CALC_TENSOR_DUMMY
C |
C |-- DWNSLP_CALC_FLOW
C |-- DWNSLP_CALC_FLOW
C |
C |-- OFFLINE_GET_DIFFUS
C |
C |-- BBL_CALC_RHS
C |
C |-- MYPACKAGE_CALC_RHS
C |
C |-- GMREDI_DO_EXCH
C |
C |-- KPP_DO_EXCH
C |
C |-- GGL90_EXCHANGES
C |
C |-- DIAGS_RHO_G
C |-- DIAGS_OCEANIC_SURF_FLUX
C |-- SALT_PLUME_DIAGNOSTICS_FILL
C |
C |-- ECCO_PHYS
C !USES:
IMPLICIT NONE
C == Global variables ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "DYNVARS.h"
#ifdef ALLOW_TIMEAVE
# include "TIMEAVE_STATV.h"
#endif
#ifdef ALLOW_OFFLINE
# include "OFFLINE_SWITCH.h"
#endif
#ifdef ALLOW_AUTODIFF
# include "AUTODIFF_MYFIELDS.h"
# ifdef ALLOW_AUTODIFF_TAMC
# include "tamc.h"
# endif
# include "FFIELDS.h"
# include "SURFACE.h"
# include "EOS.h"
# ifdef ALLOW_GMREDI
# include "GMREDI.h"
# endif
# ifdef ALLOW_KPP
# include "KPP.h"
# endif
# ifdef ALLOW_GGL90
# include "GGL90.h"
# endif
# ifdef ALLOW_EBM
# include "EBM.h"
# endif
# ifdef ALLOW_EXF
# include "ctrl.h"
# include "EXF_FIELDS.h"
# ifdef ALLOW_BULKFORMULAE
# include "EXF_CONSTANTS.h"
# endif
# endif
# ifdef ALLOW_SEAICE
# include "SEAICE_SIZE.h"
# include "SEAICE.h"
# include "SEAICE_PARAMS.h"
# endif
# ifdef ALLOW_THSICE
# include "THSICE_VARS.h"
# endif
# ifdef ALLOW_SALT_PLUME
# include "SALT_PLUME.h"
# endif
# ifdef ALLOW_ECCO
# ifdef ALLOW_SIGMAR_COST_CONTRIBUTION
# include "ecco_cost.h"
# endif
# endif
#endif /* ALLOW_AUTODIFF */
C !INPUT/OUTPUT PARAMETERS:
C == Routine arguments ==
C myTime :: Current time in simulation
C myIter :: Current iteration number in simulation
C myThid :: Thread number for this instance of the routine.
_RL myTime
INTEGER myIter
INTEGER myThid
C !LOCAL VARIABLES:
C == Local variables
C rhoKp1,rhoKm1 :: Density at current level, and @ level minus one
C iMin, iMax :: Ranges and sub-block indices on which calculations
C jMin, jMax are applied.
C bi, bj :: tile indices
C msgBuf :: Temp. for building output string
C i,j,k :: loop indices
C kSrf :: surface index
_RL rhoKp1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
_RL rhoKm1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
_RL sigmaX (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
_RL sigmaY (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
_RL sigmaR (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
INTEGER iMin, iMax
INTEGER jMin, jMax
INTEGER bi, bj
INTEGER i, j, k, kSrf
CHARACTER*(MAX_LEN_MBUF) msgBuf
INTEGER doDiagsRho
LOGICAL calcGMRedi, calcKPP, calcConvect
#ifdef ALLOW_DIAGNOSTICS
LOGICAL DIAGNOSTICS_IS_ON
EXTERNAL DIAGNOSTICS_IS_ON
#endif /* ALLOW_DIAGNOSTICS */
#ifdef ALLOW_AUTODIFF
_RL thetaRef
#endif /* ALLOW_AUTODIFF */
#ifdef ALLOW_AUTODIFF_TAMC
INTEGER kkey, itdkey
#endif
CEOP
#ifdef ALLOW_AUTODIFF_TAMC
C-- dummy statement to end declaration part
itdkey = 1
#endif /* ALLOW_AUTODIFF_TAMC */
kSrf = 1
IF ( usingPCoords ) kSrf = Nr
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_ENTER('DO_OCEANIC_PHYS',myThid)
#endif
doDiagsRho = 0
#ifdef ALLOW_DIAGNOSTICS
IF ( useDiagnostics .AND. fluidIsWater ) THEN
IF ( DIAGNOSTICS_IS_ON('MXLDEPTH',myThid) )
& doDiagsRho = doDiagsRho + 1
IF ( DIAGNOSTICS_IS_ON('DRHODR ',myThid) )
& doDiagsRho = doDiagsRho + 2
IF ( DIAGNOSTICS_IS_ON('WdRHO_P ',myThid) )
& doDiagsRho = doDiagsRho + 4
IF ( DIAGNOSTICS_IS_ON('WdRHOdP ',myThid) )
& doDiagsRho = doDiagsRho + 8
ENDIF
#endif /* ALLOW_DIAGNOSTICS */
calcGMRedi = useGMRedi
calcKPP = useKPP
calcConvect = ivdc_kappa.NE.0.
#ifdef ALLOW_OFFLINE
IF ( useOffLine ) THEN
calcGMRedi = useGMRedi .AND. .NOT.offlineLoadGMRedi
calcKPP = useKPP .AND. .NOT.offlineLoadKPP
calcConvect=calcConvect.AND. .NOT.offlineLoadConvec
ENDIF
#endif /* ALLOW_OFFLINE */
#ifdef ALLOW_OBCS
IF (useOBCS) THEN
C-- Calculate future values on open boundaries
C-- moved before SEAICE_MODEL call since SEAICE_MODEL needs seaice-obcs fields
# ifdef ALLOW_AUTODIFF_TAMC
CADJ STORE theta = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE salt = comlev1, key=ikey_dynamics, kind=isbyte
# endif
# ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('OBCS_CALC',myThid)
# endif
CALL OBCS_CALC( myTime+deltaTClock, myIter+1,
I uVel, vVel, wVel, theta, salt, myThid )
ENDIF
#endif /* ALLOW_OBCS */
#ifdef ALLOW_OCN_COMPON_INTERF
C-- Apply imported data (from coupled interface) to forcing fields
C jmc: moved here before any freezing/seaice pkg adjustment of surf-fluxes
IF ( useCoupler ) THEN
CALL OCN_APPLY_IMPORT( .TRUE., myTime, myIter, myThid )
ENDIF
#endif /* ALLOW_OCN_COMPON_INTERF */
#ifdef ALLOW_AUTODIFF
DO bj=myByLo(myThid),myByHi(myThid)
DO bi=myBxLo(myThid),myBxHi(myThid)
DO j=1-OLy,sNy+OLy
DO i=1-OLx,sNx+OLx
adjustColdSST_diag(i,j,bi,bj) = 0. _d 0
# ifdef ALLOW_SALT_PLUME
saltPlumeDepth(i,j,bi,bj) = 0. _d 0
saltPlumeFlux(i,j,bi,bj) = 0. _d 0
# endif
ENDDO
ENDDO
ENDDO
ENDDO
#endif /* ALLOW_AUTODIFF */
#ifdef ALLOW_FRAZIL
IF ( useFRAZIL ) THEN
C-- Freeze water in the ocean interior and let it rise to the surface
CADJ STORE theta = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE salt = comlev1, key=ikey_dynamics, kind=isbyte
CALL FRAZIL_CALC_RHS( myTime, myIter, myThid )
ENDIF
#endif /* ALLOW_FRAZIL */
#if (defined ALLOW_THSICE) && !(defined ALLOW_ATM2D)
IF ( useThSIce .AND. fluidIsWater ) THEN
# ifdef ALLOW_AUTODIFF_TAMC
# ifdef ALLOW_SEAICE
CADJ STORE uice,vice = comlev1, key=ikey_dynamics, kind=isbyte
# endif
CADJ STORE iceMask,iceHeight = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE snowHeight, Tsrf = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE Qice1, Qice2 = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE sHeating,snowAge = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE hocemxl, icflxsw = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE salt,theta = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE uvel,vvel = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE qnet,qsw, empmr = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE atemp,aqh,precip = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE swdown,lwdown = comlev1, key=ikey_dynamics, kind=isbyte
# ifdef NONLIN_FRSURF
CADJ STORE hFac_surfC = comlev1, key=ikey_dynamics, kind=isbyte
# endif
# endif /* ALLOW_AUTODIFF_TAMC */
# ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('THSICE_MAIN',myThid)
# endif
C-- Step forward Therm.Sea-Ice variables
C and modify forcing terms including effects from ice
CALL TIMER_START('THSICE_MAIN [DO_OCEANIC_PHYS]', myThid)
CALL THSICE_MAIN( myTime, myIter, myThid )
CALL TIMER_STOP( 'THSICE_MAIN [DO_OCEANIC_PHYS]', myThid)
ENDIF
#endif /* ALLOW_THSICE */
#ifdef ALLOW_SEAICE
# ifdef ALLOW_AUTODIFF_TAMC
CADJ STORE qnet = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE qsw = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE theta = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE salt = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE fu,fv = comlev1, key=ikey_dynamics, kind=isbyte
#if (defined ALLOW_EXF) && (defined ALLOW_ATM_TEMP)
CADJ STORE evap = comlev1, key=ikey_dynamics, kind=isbyte
#endif
# endif /* ALLOW_AUTODIFF_TAMC */
#ifdef ALLOW_AUTODIFF_TAMC
CADJ STORE phiHydLow= comlev1, key=ikey_dynamics, byte=isbyte
#endif
IF ( useSEAICE ) THEN
# ifdef ALLOW_AUTODIFF_TAMC
CADJ STORE uvel,vvel = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE uice,vice = comlev1, key=ikey_dynamics, kind=isbyte
# ifdef SEAICE_USE_GROWTH_ADX
CADJ STORE tices = comlev1, key=ikey_dynamics, kind=isbyte
# endif
# ifdef ALLOW_EXF
CADJ STORE atemp,aqh,precip = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE swdown,lwdown = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE uwind,vwind = comlev1, key=ikey_dynamics, kind=isbyte
# endif
# ifdef SEAICE_VARIABLE_SALINITY
CADJ STORE hsalt = comlev1, key=ikey_dynamics, kind=isbyte
# endif
# ifdef ATMOSPHERIC_LOADING
CADJ STORE pload, siceload = comlev1, key=ikey_dynamics, kind=isbyte
# endif
# ifdef NONLIN_FRSURF
CADJ STORE recip_hfacc = comlev1, key=ikey_dynamics, kind=isbyte
# endif
# ifdef ANNUAL_BALANCE
CADJ STORE balance_itcount = comlev1, key=ikey_dynamics, kind=isbyte
# endif /* ANNUAL_BALANCE */
# ifdef ALLOW_THSICE
C-- store thSIce vars before advection (called from SEAICE_MODEL) updates them:
CADJ STORE iceMask,iceHeight = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE snowHeight,hOceMxL= comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE Qice1, Qice2 = comlev1, key=ikey_dynamics, kind=isbyte
# endif /* ALLOW_THSICE */
# endif /* ALLOW_AUTODIFF_TAMC */
# ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('SEAICE_MODEL',myThid)
# endif
CALL TIMER_START('SEAICE_MODEL [DO_OCEANIC_PHYS]', myThid)
CALL SEAICE_MODEL( myTime, myIter, myThid )
CALL TIMER_STOP ('SEAICE_MODEL [DO_OCEANIC_PHYS]', myThid)
# ifdef ALLOW_AUTODIFF_TAMC
CADJ STORE tices = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE heff = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE hsnow = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE area = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE uIce = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE vIce = comlev1, key=ikey_dynamics, kind=isbyte
# endif
# ifdef ALLOW_COST
CALL SEAICE_COST_SENSI ( myTime, myIter, myThid )
# endif
# ifdef ALLOW_AUTODIFF
ELSEIF ( SEAICEadjMODE .EQ. -1 ) THEN
CADJ STORE area = comlev1, key=ikey_dynamics, kind=isbyte
CALL SEAICE_FAKE( myTime, myIter, myThid )
# endif /* ALLOW_AUTODIFF */
ENDIF
#endif /* ALLOW_SEAICE */
#if (defined ALLOW_OCN_COMPON_INTERF) && (defined ALLOW_THSICE)
C-- After seaice-dyn and advection of pkg/thsice fields,
C Export ocean coupling fields to coupled interface (only with pkg/thsice)
IF ( useCoupler ) THEN
# ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('OCN_EXPORT_DATA',myThid)
# endif
CALL TIMER_START('OCN_EXPORT_DATA [DO_OCEANIC_PHYS]', myThid)
CALL OCN_EXPORT_DATA( myTime, myIter, myThid )
CALL TIMER_STOP ('OCN_EXPORT_DATA [DO_OCEANIC_PHYS]', myThid)
ENDIF
#endif /* ALLOW_OCN_COMPON_INTERF & ALLOW_THSICE */
#ifdef ALLOW_AUTODIFF_TAMC
CADJ STORE sst, sss = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE qsw = comlev1, key=ikey_dynamics, kind=isbyte
# ifdef ALLOW_SEAICE
CADJ STORE area = comlev1, key=ikey_dynamics, kind=isbyte
# endif
#endif
#ifdef ALLOW_SHELFICE
IF ( useShelfIce .AND. fluidIsWater ) THEN
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('SHELFICE_THERMODYNAMICS',myThid)
#endif
#ifdef ALLOW_AUTODIFF_TAMC
CADJ STORE salt, theta = comlev1, key=ikey_dynamics, kind=isbyte
CADJ STORE uvel, vvel = comlev1, key=ikey_dynamics, kind=isbyte
#endif
C compute temperature and (virtual) salt flux at the
C shelf-ice ocean interface
CALL TIMER_START('SHELFICE_THERMODYNAMICS [DO_OCEANIC_PHYS]',
& myThid)
CALL SHELFICE_THERMODYNAMICS( myTime, myIter, myThid )
CALL TIMER_STOP( 'SHELFICE_THERMODYNAMICS [DO_OCEANIC_PHYS]',
& myThid)
ENDIF
#endif /* ALLOW_SHELFICE */
#ifdef ALLOW_ICEFRONT
IF ( useICEFRONT .AND. fluidIsWater ) THEN
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('ICEFRONT_THERMODYNAMICS',myThid)
#endif
C compute temperature and (virtual) salt flux at the
C ice-front ocean interface
CALL TIMER_START('ICEFRONT_THERMODYNAMICS [DO_OCEANIC_PHYS]',
& myThid)
CALL ICEFRONT_THERMODYNAMICS( myTime, myIter, myThid )
CALL TIMER_STOP( 'ICEFRONT_THERMODYNAMICS [DO_OCEANIC_PHYS]',
& myThid)
ENDIF
#endif /* ALLOW_ICEFRONT */
#ifdef ALLOW_SALT_PLUME
IF ( useSALT_PLUME ) THEN
Catn: exchanging saltPlumeFlux:
CALL SALT_PLUME_DO_EXCH( myTime, myIter, myThid )
ENDIF
#endif /* ALLOW_SALT_PLUME */
C-- Freeze water at the surface
IF ( allowFreezing ) THEN
#ifdef ALLOW_AUTODIFF_TAMC
CADJ STORE theta = comlev1, key=ikey_dynamics, kind=isbyte
#endif
CALL FREEZE_SURFACE( myTime, myIter, myThid )
ENDIF
iMin = 1-OLx
iMax = sNx+OLx
jMin = 1-OLy
jMax = sNy+OLy
C--- Determines forcing terms based on external fields
C relaxation terms, etc.
#ifdef ALLOW_AUTODIFF
CADJ STORE salt, theta = comlev1, key=ikey_dynamics, kind=isbyte
#else /* ALLOW_AUTODIFF */
C-- if fluid is not water, by-pass surfaceForcing, find_rho, gmredi
C and all vertical mixing schemes, but keep OBCS_CALC
IF ( fluidIsWater ) THEN
#endif /* ALLOW_AUTODIFF */
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('EXTERNAL_FORCING_SURF',myThid)
#endif
CALL EXTERNAL_FORCING_SURF(
I iMin, iMax, jMin, jMax,
I myTime, myIter, myThid )
#ifdef ALLOW_OBCS
IF (useOBCS) THEN
C-- After all surface fluxes are known apply balancing fluxes and
C-- apply tidal forcing to open boundaries
# ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('OBCS_ADJUST',myThid)
# endif
CALL OBCS_ADJUST(
I myTime+deltaTClock, myIter+1, myThid )
ENDIF
#endif /* ALLOW_OBCS */
#ifdef ALLOW_AUTODIFF_TAMC
C-- HPF directive to help TAMC
CHPF$ INDEPENDENT
#endif /* ALLOW_AUTODIFF_TAMC */
DO bj=myByLo(myThid),myByHi(myThid)
#ifdef ALLOW_AUTODIFF_TAMC
C-- HPF directive to help TAMC
CHPF$ INDEPENDENT
#endif /* ALLOW_AUTODIFF_TAMC */
DO bi=myBxLo(myThid),myBxHi(myThid)
#ifdef ALLOW_AUTODIFF_TAMC
itdkey = bi + (bj-1)*nSx + (ikey_dynamics-1)*nSx*nSy
#endif /* ALLOW_AUTODIFF_TAMC */
C-- Set up work arrays with valid (i.e. not NaN) values
C These inital values do not alter the numerical results. They
C just ensure that all memory references are to valid floating
C point numbers. This prevents spurious hardware signals due to
C uninitialised but inert locations.
DO k=1,Nr
DO j=1-OLy,sNy+OLy
DO i=1-OLx,sNx+OLx
C This is currently used by GMRedi, IVDC, MXL-depth and Diagnostics
sigmaX(i,j,k) = 0. _d 0
sigmaY(i,j,k) = 0. _d 0
sigmaR(i,j,k) = 0. _d 0
#if (defined (ALLOW_SIGMAR_COST_CONTRIBUTION) || defined (ALLOW_LEITH_QG))
sigmaRfield(i,j,k,bi,bj) = 0. _d 0
#endif
ENDDO
ENDDO
ENDDO
DO j=1-OLy,sNy+OLy
DO i=1-OLx,sNx+OLx
rhoKm1 (i,j) = 0. _d 0
rhoKp1 (i,j) = 0. _d 0
ENDDO
ENDDO
#ifdef ALLOW_AUTODIFF
cph all the following init. are necessary for TAF
cph although some of these are re-initialised later.
DO k=1,Nr
DO j=1-OLy,sNy+OLy
DO i=1-OLx,sNx+OLx
rhoInSitu(i,j,k,bi,bj) = 0.
# ifdef ALLOW_GGL90
GGL90viscArU(i,j,k,bi,bj) = 0. _d 0
GGL90viscArV(i,j,k,bi,bj) = 0. _d 0
GGL90diffKr(i,j,k,bi,bj) = 0. _d 0
# endif /* ALLOW_GGL90 */
# ifdef ALLOW_SALT_PLUME
# ifdef SALT_PLUME_VOLUME
SPforcingS(i,j,k,bi,bj) = 0. _d 0
SPforcingT(i,j,k,bi,bj) = 0. _d 0
# endif
# endif /* ALLOW_SALT_PLUME */
ENDDO
ENDDO
ENDDO
#ifdef ALLOW_OFFLINE
IF ( calcConvect ) THEN
#endif
DO k=1,Nr
DO j=1-OLy,sNy+OLy
DO i=1-OLx,sNx+OLx
IVDConvCount(i,j,k,bi,bj) = 0.
ENDDO
ENDDO
ENDDO
#ifdef ALLOW_OFFLINE
ENDIF
IF ( calcGMRedi ) THEN
#endif
# ifdef ALLOW_GMREDI
DO k=1,Nr
DO j=1-OLy,sNy+OLy
DO i=1-OLx,sNx+OLx
Kwx(i,j,k,bi,bj) = 0. _d 0
Kwy(i,j,k,bi,bj) = 0. _d 0
Kwz(i,j,k,bi,bj) = 0. _d 0
Kux(i,j,k,bi,bj) = 0. _d 0
Kvy(i,j,k,bi,bj) = 0. _d 0
# ifdef GM_EXTRA_DIAGONAL
Kuz(i,j,k,bi,bj) = 0. _d 0
Kvz(i,j,k,bi,bj) = 0. _d 0
# endif
# ifdef GM_BOLUS_ADVEC
GM_PsiX(i,j,k,bi,bj) = 0. _d 0
GM_PsiY(i,j,k,bi,bj) = 0. _d 0
# endif
# ifdef GM_VISBECK_VARIABLE_K
VisbeckK(i,j,bi,bj) = 0. _d 0
# endif
ENDDO
ENDDO
ENDDO
# endif /* ALLOW_GMREDI */
#ifdef ALLOW_OFFLINE
ENDIF
IF ( calcKPP ) THEN
#endif
# ifdef ALLOW_KPP
DO k=1,Nr
DO j=1-OLy,sNy+OLy
DO i=1-OLx,sNx+OLx
KPPdiffKzS(i,j,k,bi,bj) = 0. _d 0
KPPdiffKzT(i,j,k,bi,bj) = 0. _d 0
ENDDO
ENDDO
ENDDO
# endif /* ALLOW_KPP */
#ifdef ALLOW_OFFLINE
ENDIF
#endif
#endif /* ALLOW_AUTODIFF */
#ifdef ALLOW_AUTODIFF_TAMC
CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj, key=itdkey, kind=isbyte
CADJ STORE salt (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, kind=isbyte
CADJ STORE totphihyd(:,:,:,bi,bj)
CADJ & = comlev1_bibj, key=itdkey, kind=isbyte
# ifdef ALLOW_KPP
CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, kind=isbyte
CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, kind=isbyte
# endif
# ifdef ALLOW_SALT_PLUME
CADJ STORE saltplumedepth(:,:,bi,bj)
CADJ & = comlev1_bibj, key=itdkey, kind=isbyte
CADJ STORE saltplumeflux(:,:,bi,bj)
CADJ & = comlev1_bibj, key=itdkey, kind=isbyte
# endif
#endif /* ALLOW_AUTODIFF_TAMC */
C-- Always compute density (stored in common block) here; even when it is not
C needed here, will be used anyway in calc_phi_hyd (data flow easier this way)
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('FIND_RHO_2D (xNr)',myThid)
#endif
#ifdef ALLOW_AUTODIFF
IF ( fluidIsWater ) THEN
#endif /* ALLOW_AUTODIFF */
#ifdef ALLOW_DOWN_SLOPE
IF ( useDOWN_SLOPE ) THEN
DO k=1,Nr
CALL DWNSLP_CALC_RHO(
I theta, salt,
O rhoInSitu(1-OLx,1-OLy,k,bi,bj),
I k, bi, bj, myTime, myIter, myThid )
ENDDO
ENDIF
#endif /* ALLOW_DOWN_SLOPE */
#ifdef ALLOW_BBL
IF ( useBBL ) THEN
C pkg/bbl requires in-situ bbl density for depths equal to and deeper than the bbl.
C To reduce computation and storage requirement, these densities are stored in the
C dry grid boxes of rhoInSitu. See BBL_CALC_RHO for details.
DO k=Nr,1,-1
CALL BBL_CALC_RHO(
I theta, salt,
O rhoInSitu,
I k, bi, bj, myTime, myIter, myThid )
ENDDO
ENDIF
#endif /* ALLOW_BBL */
IF ( .NOT. ( useDOWN_SLOPE .OR. useBBL ) ) THEN
DO k=1,Nr
CALL FIND_RHO_2D(
I iMin, iMax, jMin, jMax, k,
I theta(1-OLx,1-OLy,k,bi,bj),
I salt (1-OLx,1-OLy,k,bi,bj),
O rhoInSitu(1-OLx,1-OLy,k,bi,bj),
I k, bi, bj, myThid )
ENDDO
ENDIF
#ifdef ALLOW_AUTODIFF
ELSE
C- fluid is not water:
DO k=1,Nr
IF ( select_rStar.GE.1 .OR. selectSigmaCoord.GE.1 ) THEN
C- isothermal (theta=const) reference state
thetaRef = thetaConst
ELSE
C- horizontally uniform (tRef) reference state
thetaRef = tRef(k)
ENDIF
DO j=1-OLy,sNy+OLy
DO i=1-OLx,sNx+OLx
rhoInSitu(i,j,k,bi,bj) =
& ( theta(i,j,k,bi,bj)
& *( salt(i,j,k,bi,bj)*atm_Rq + oneRL )
& - thetaRef )*maskC(i,j,k,bi,bj)
ENDDO
ENDDO
ENDDO
ENDIF
#endif /* ALLOW_AUTODIFF */
#ifdef ALLOW_DEBUG
IF (debugMode) THEN
WRITE(msgBuf,'(A,2(I4,A))')
& 'ENTERING UPWARD K LOOP (bi=', bi, ', bj=', bj,')'
CALL DEBUG_MSG(msgBuf(1:43),myThid)
ENDIF
#endif
C-- Start of diagnostic loop
DO k=Nr,1,-1
#ifdef ALLOW_AUTODIFF_TAMC
C? Patrick, is this formula correct now that we change the loop range?
C? Do we still need this?
cph kkey formula corrected.
cph Needed for rhoK, rhoKm1, in the case useGMREDI.
kkey = (itdkey-1)*Nr + k
#endif /* ALLOW_AUTODIFF_TAMC */
c#ifdef ALLOW_AUTODIFF_TAMC
cCADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey,
cCADJ & kind = isbyte
cCADJ STORE salt(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey,
cCADJ & kind = isbyte
c#endif /* ALLOW_AUTODIFF_TAMC */
C-- Calculate gradients of potential density for isoneutral
C slope terms (e.g. GM/Redi tensor or IVDC diffusivity)
IF ( calcGMRedi .OR. (k.GT.1 .AND. calcConvect)
& .OR. usePP81 .OR. useKL10
& .OR. useMY82 .OR. useGGL90
& .OR. useSALT_PLUME .OR. doDiagsRho.GE.1 ) THEN
IF (k.GT.1) THEN
#ifdef ALLOW_AUTODIFF_TAMC
CADJ STORE theta(:,:,k-1,bi,bj) = comlev1_bibj_k, key=kkey,kind=isbyte
CADJ STORE salt (:,:,k-1,bi,bj) = comlev1_bibj_k, key=kkey,kind=isbyte
CADJ STORE rhokm1 (bi,bj) = comlev1_bibj_k, key=kkey,kind=isbyte
#endif /* ALLOW_AUTODIFF_TAMC */
IF ( usingZCoords ) THEN
DO j=jMin,jMax
DO i=iMin,iMax
rhoKp1(i,j) = rhoInSitu(i,j,k,bi,bj)
ENDDO
ENDDO
CALL FIND_RHO_2D(
I iMin, iMax, jMin, jMax, k,
I theta(1-OLx,1-OLy,k-1,bi,bj),
I salt (1-OLx,1-OLy,k-1,bi,bj),
O rhoKm1,
I k-1, bi, bj, myThid )
ELSE
CALL FIND_RHO_2D(
I iMin, iMax, jMin, jMax, k-1,
I theta(1-OLx,1-OLy,k,bi,bj),
I salt (1-OLx,1-OLy,k,bi,bj),
O rhoKp1,
I k, bi, bj, myThid )
DO j=jMin,jMax
DO i=iMin,iMax
rhoKm1(i,j) = rhoInSitu(i,j,k-1,bi,bj)
ENDDO
ENDDO
ENDIF
ENDIF
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('GRAD_SIGMA',myThid)
#endif
CALL GRAD_SIGMA(
I bi, bj, iMin, iMax, jMin, jMax, k,
I rhoInSitu(1-OLx,1-OLy,k,bi,bj), rhoKm1, rhoKp1,
O sigmaX, sigmaY, sigmaR,
I myThid )
#if (defined (ALLOW_SIGMAR_COST_CONTRIBUTION) || defined (ALLOW_LEITH_QG))
DO j=jMin,jMax
DO i=iMin,iMax
sigmaRfield(i,j,k,bi,bj)=sigmaR(i,j,k)
ENDDO
ENDDO
#endif /* ALLOW_SIGMAR_COST_CONTRIBUTION or ALLOW_LEITH_QG */
#ifdef ALLOW_AUTODIFF
#ifdef GMREDI_WITH_STABLE_ADJOINT
cgf zero out adjoint fields to stabilize pkg/gmredi adjoint
cgf -> cuts adjoint dependency from slope to state
CALL ZERO_ADJ_LOC( Nr, sigmaX, myThid)
CALL ZERO_ADJ_LOC( Nr, sigmaY, myThid)
CALL ZERO_ADJ_LOC( Nr, sigmaR, myThid)
#endif
#endif /* ALLOW_AUTODIFF */
ENDIF
C-- Implicit Vertical Diffusion for Convection
IF (k.GT.1 .AND. calcConvect) THEN
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('CALC_IVDC',myThid)
#endif
CALL CALC_IVDC(
I bi, bj, iMin, iMax, jMin, jMax, k,
I sigmaR,
I myTime, myIter, myThid)
ENDIF
#ifdef ALLOW_DIAGNOSTICS
IF ( doDiagsRho.GE.4 ) THEN
CALL DIAGS_RHO_L( doDiagsRho, k, bi, bj,
I rhoInSitu(1-OLx,1-OLy,1,bi,bj),
I rhoKm1, wVel,
I myTime, myIter, myThid )
ENDIF
#endif
C-- end of diagnostic k loop (Nr:1)
ENDDO
#ifdef ALLOW_AUTODIFF_TAMC
CADJ STORE IVDConvCount(:,:,:,bi,bj)
CADJ & = comlev1_bibj, key=itdkey, kind=isbyte
#endif
C-- Diagnose Mixed Layer Depth:
IF ( calcGMRedi .OR. MOD(doDiagsRho,2).EQ.1 ) THEN
CALL CALC_OCE_MXLAYER(
I rhoInSitu(1-OLx,1-OLy,kSrf,bi,bj), sigmaR,
I bi, bj, myTime, myIter, myThid )
ENDIF
#ifdef ALLOW_SALT_PLUME
IF ( useSALT_PLUME ) THEN
CALL SALT_PLUME_CALC_DEPTH(
I rhoInSitu(1-OLx,1-OLy,kSrf,bi,bj), sigmaR,
I bi, bj, myTime, myIter, myThid )
#ifdef SALT_PLUME_VOLUME
CALL SALT_PLUME_VOLFRAC(
I bi, bj, myTime, myIter, myThid )
C-- get forcings for kpp
CALL SALT_PLUME_APPLY(
I 1, bi, bj, recip_hFacC(1-OLx,1-OLy,kSrf,bi,bj),
I theta, 0,
I myTime, myIter, myThid )
CALL SALT_PLUME_APPLY(
I 2, bi, bj, recip_hFacC(1-OLx,1-OLy,kSrf,bi,bj),
I salt, 0,
I myTime, myIter, myThid )
C-- need to call this S/R from here to apply just before kpp
CALL SALT_PLUME_FORCING_SURF(
I bi, bj, iMin, iMax, jMin, jMax,
I myTime, myIter, myThid )
#endif /* SALT_PLUME_VOLUME */
ENDIF
#endif /* ALLOW_SALT_PLUME */
#ifdef ALLOW_DIAGNOSTICS
IF ( MOD(doDiagsRho,4).GE.2 ) THEN
CALL DIAGNOSTICS_FILL (sigmaR, 'DRHODR ', 0, Nr,
& 2, bi, bj, myThid)
ENDIF
#endif /* ALLOW_DIAGNOSTICS */
C-- This is where EXTERNAL_FORCING_SURF(bi,bj) used to be called;
C now called earlier, before bi,bj loop.
#ifdef ALLOW_AUTODIFF_TAMC
cph needed for KPP
CADJ STORE surfaceForcingU(:,:,bi,bj)
CADJ & = comlev1_bibj, key=itdkey, kind=isbyte
CADJ STORE surfaceForcingV(:,:,bi,bj)
CADJ & = comlev1_bibj, key=itdkey, kind=isbyte
CADJ STORE surfaceForcingS(:,:,bi,bj)
CADJ & = comlev1_bibj, key=itdkey, kind=isbyte
CADJ STORE surfaceForcingT(:,:,bi,bj)
CADJ & = comlev1_bibj, key=itdkey, kind=isbyte
#endif /* ALLOW_AUTODIFF_TAMC */
#ifdef ALLOW_KPP
C-- Compute KPP mixing coefficients
IF ( calcKPP ) THEN
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('KPP_CALC',myThid)
#endif
CALL TIMER_START('KPP_CALC [DO_OCEANIC_PHYS]', myThid)
CALL KPP_CALC(
I bi, bj, myTime, myIter, myThid )
CALL TIMER_STOP ('KPP_CALC [DO_OCEANIC_PHYS]', myThid)
#if (defined ALLOW_AUTODIFF) && !(defined ALLOW_OFFLINE)
ELSE
CALL KPP_CALC_DUMMY(
I bi, bj, myTime, myIter, myThid )
#endif /* ALLOW_AUTODIFF and not ALLOW_OFFLINE */
ENDIF
#endif /* ALLOW_KPP */
#ifdef ALLOW_PP81
C-- Compute PP81 mixing coefficients
IF (usePP81) THEN
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('PP81_CALC',myThid)
#endif
CALL PP81_CALC(
I bi, bj, sigmaR, myTime, myIter, myThid )
ENDIF
#endif /* ALLOW_PP81 */
#ifdef ALLOW_KL10
C-- Compute KL10 mixing coefficients
IF (useKL10) THEN
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('KL10_CALC',myThid)
#endif
CALL KL10_CALC(
I bi, bj, sigmaR, myTime, myIter, myThid )
ENDIF
#endif /* ALLOW_KL10 */
#ifdef ALLOW_MY82
C-- Compute MY82 mixing coefficients
IF (useMY82) THEN
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('MY82_CALC',myThid)
#endif
CALL MY82_CALC(
I bi, bj, sigmaR, myTime, myIter, myThid )
ENDIF
#endif /* ALLOW_MY82 */
#ifdef ALLOW_GGL90
#ifdef ALLOW_AUTODIFF_TAMC
CADJ STORE GGL90TKE(:,:,:,bi,bj)
CADJ & = comlev1_bibj, key=itdkey, kind=isbyte
#endif /* ALLOW_AUTODIFF_TAMC */
C-- Compute GGL90 mixing coefficients
IF ( useGGL90 .AND. Nr.GT.1 ) THEN
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('GGL90_CALC',myThid)
#endif
CALL TIMER_START('GGL90_CALC [DO_OCEANIC_PHYS]', myThid)
CALL GGL90_CALC(
I bi, bj, sigmaR, myTime, myIter, myThid )
CALL TIMER_STOP ('GGL90_CALC [DO_OCEANIC_PHYS]', myThid)
ENDIF
#endif /* ALLOW_GGL90 */
#ifdef ALLOW_TIMEAVE
IF ( taveFreq.GT. 0. _d 0 ) THEN
CALL TIMEAVE_SURF_FLUX( bi, bj, myTime, myIter, myThid)
ENDIF
IF ( taveFreq.GT.0. .AND. calcConvect ) THEN
CALL TIMEAVE_CUMULATE(ConvectCountTave, IVDConvCount,
I Nr, deltaTClock, bi, bj, myThid)
ENDIF
#endif /* ALLOW_TIMEAVE */
#ifdef ALLOW_GMREDI
#ifdef ALLOW_AUTODIFF_TAMC
# ifndef GM_EXCLUDE_CLIPPING
cph storing here is needed only for one GMREDI_OPTIONS:
cph define GM_BOLUS_ADVEC
cph keep it although TAF says you dont need to.
cph but I have avoided the #ifdef for now, in case more things change
CADJ STORE sigmaX(:,:,:) = comlev1_bibj, key=itdkey, kind=isbyte
CADJ STORE sigmaY(:,:,:) = comlev1_bibj, key=itdkey, kind=isbyte
CADJ STORE sigmaR(:,:,:) = comlev1_bibj, key=itdkey, kind=isbyte
# endif
#endif /* ALLOW_AUTODIFF_TAMC */
C-- Calculate iso-neutral slopes for the GM/Redi parameterisation
IF ( calcGMRedi ) THEN
#ifdef ALLOW_DEBUG
IF (debugMode) CALL DEBUG_CALL('GMREDI_CALC_TENSOR',myThid)
#endif
CALL GMREDI_CALC_TENSOR(
I iMin, iMax, jMin, jMax,
I sigmaX, sigmaY, sigmaR,
I bi, bj, myTime, myIter, myThid )