-
Notifications
You must be signed in to change notification settings - Fork 95
/
ocean_tracer_advect.F90
7844 lines (6705 loc) · 314 KB
/
ocean_tracer_advect.F90
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
module ocean_tracer_advect_mod
!
!<CONTACT EMAIL="GFDL.Climate.Model.Info@noaa.gov"> Matt Harrison
!</CONTACT>
!
!<CONTACT EMAIL="GFDL.Climate.Model.Info@noaa.gov"> S. M. Griffies
!</CONTACT>
!
!<CONTACT EMAIL="GFDL.Climate.Model.Info@noaa.gov"> John Dunne
!</CONTACT>
!
!<CONTACT EMAIL="GFDL.Climate.Model.Info@noaa.gov"> Alistair Adcroft
!</CONTACT>
!
!<OVERVIEW>
! This module computes thickness weighted tracer advection tendencies.
!</OVERVIEW>
!
!<DESCRIPTION>
! This module computes thickness weighted tracer advection tendencies
! using a variety of advection schemes.
!</DESCRIPTION>
!
!<INFO>
!
!<REFERENCE>
! S.-J. Lin
! A "Vertically Lagrangian" Finite-Volume Dynamical Core for Global Models
! Month. Weather Rev. (2004) 132, 2293-2307
! (Appendix B)
!</REFERENCE>
!
!<REFERENCE>
! H.T. Huynh
! Schemes and Constraints for advection
! 15th Intern. Conf. on Numeric. Meth. in Fluid Mech., Springer (1997)
!</REFERENCE>
!
!<REFERENCE>
! Colella P. and P.R. Woodward
! The piecewise parabloic method (PPM) for gasdynamical simulations
! J. Comput. Phys. (1984) 54, 174-201
!</REFERENCE>
!
!<REFERENCE>
! A. Suresh and H.T. Huynh
! Accurate Monotonicity-Preserving Schemes with Runge-Kutta Time Splitting
! J. Comput. Phys. (1997) 136, 83-99
!</REFERENCE>
!
!<REFERENCE>
! V. Daru and C. Tenaud
! High order one-step monotonicity-preserving schemes for unsteady
! compressible flow calculations.
! J. Comp. Phys. (2004) 193, 563-594
!</REFERENCE>
!
!<REFERENCE>
! R.C. Easter
! Two modified versions of Botts positive-definite numerical advection scheme.
! Month. Weath. Rev. (1993) 121, 297-304
!</REFERENCE>
!
!<REFERENCE>
! Prather, M. J.,"Numerical Advection by Conservation of Second-Order Moments"
! JGR, Vol 91, NO. D6, p 6671-6681, May 20, 1986
!</REFERENCE>
!
!<REFERENCE>
! Merryfield and Holloway (2003), "Application of an accurate advection
! algorithm to sea-ice modelling". Ocean Modelling, Vol 5, p 1-15.
!</REFERENCE>
!
!<REFERENCE>
! Hundsdorder and Trompert (1994), "Method of lines and
! direct discretization: a comparison for linear
! advection", Applied Numerical Mathematics,
! pages 469--490.
!</REFERENCE>
!
!<REFERENCE>
! Sweby (1984): "High-resolution schemes using flux
! limiters for hyperbolic conservation laws",
! SIAM Journal of Numerical Analysis, vol. 21
! pages 995-1011.
!</REFERENCE>
!
!</INFO>
!
!<NOTE>
! Contains a version of quicker with MOM3 masking.
!</NOTE>
!
!<NAMELIST NAME="ocean_tracer_advect_nml">
! <DATA NAME="limit_with_upwind" TYPE="logical">
! If true, will compute tracer fluxes entering a cell using upwind
! if the tracer value is outside a specified range. Implemented
! only for quick at this time. This is an ad hoc and incomplete attempt
! to maintain monotonicity with the quicker scheme.
! </DATA>
! <DATA NAME="advect_sweby_all" TYPE="logical">
! For running all tracers with sweby, thereby utilizing a bitwise same
! routine that reorganizes loops and can be faster for certain configurations.
! Default advect_sweby_all=.false.
! </DATA>
! <DATA NAME="zero_tracer_advect_horz" TYPE="logical">
! For debugging. Set to .true. to turn off horizontal advection.
! </DATA>
! <DATA NAME="zero_tracer_advect_vert" TYPE="logical">
! For debugging. Set to .true. to turn off vertical advection.
! </DATA>
! <DATA NAME="psom_limit_prather" TYPE="logical">
! For running with the original Prather limiter for the PSOM scheme.
! The limiter is positive definite, but not monotonic. This limiter
! is NOT recommended for most applications. The default is
! psom_limit_prather=.false., since we prefer to use the limiter
! from Merryfield and Holloway (2003).
! </DATA>
!
! <DATA NAME="debug_this_module" TYPE="logical">
! For debugging
! </DATA>
!
! <DATA NAME="write_a_restart" TYPE="logical">
! Set true to write a restart. False setting only for rare
! cases where wish to benchmark model without measuring the cost
! of writing restarts and associated chksums.
! Default is write_a_restart=.true.
! </DATA>
!
! <DATA NAME="read_basin_mask" TYPE="logical">
! For reading in a mask that selects regions of the domain
! for performing gyre and overturning diagnostics.
! The basin-mask convention used at GFDL has
! Southern=1.0,Atlantic=2.0,Pacific=3.0,Arctic=4.0,Indian=5.0
! Default read_basin_mask=.false., whereby basin_mask
! is set to tmask(k=1).
! </DATA>
!
!</NAMELIST>
use constants_mod, only: epsln
use diag_manager_mod, only: register_diag_field, send_data
use fms_mod, only: write_version_number, check_nml_error, close_file, open_namelist_file
use fms_mod, only: read_data, field_exist, file_exist
use fms_io_mod, only: register_restart_field, save_restart, restore_state
use fms_io_mod, only: restart_file_type
use mpp_domains_mod, only: mpp_update_domains, mpp_define_domains, mpp_global_field
use mpp_domains_mod, only: mpp_start_update_domains, mpp_complete_update_domains
use mpp_domains_mod, only: BGRID_NE, CGRID_NE, domain2d, XUPDATE, YUPDATE
use mpp_domains_mod, only: mpp_get_domain_components, mpp_get_layout, domain1d, mpp_get_pelist
use mpp_mod, only: input_nml_file, mpp_error, FATAL, WARNING, NOTE, stdout, stdlog
use mpp_mod, only: mpp_clock_id, mpp_clock_begin, mpp_clock_end, CLOCK_ROUTINE
use mpp_mod, only: mpp_sum
use ocean_domains_mod, only: get_local_indices, set_ocean_domain
use ocean_obc_mod, only: store_ocean_obc_tracer_flux, ocean_obc_zero_boundary
use ocean_parameters_mod, only: ADVECT_UPWIND, ADVECT_2ND_ORDER, ADVECT_4TH_ORDER, ADVECT_6TH_ORDER
use ocean_parameters_mod, only: ADVECT_QUICKER, ADVECT_QUICKMOM3, ADVECT_MDFL_SUP_B
use ocean_parameters_mod, only: ADVECT_MDFL_SWEBY_TEST, ADVECT_MDFL_SWEBY
use ocean_parameters_mod, only: ADVECT_MDPPM_TEST, ADVECT_MDPPM
use ocean_parameters_mod, only: ADVECT_DST_LINEAR_TEST, ADVECT_DST_LINEAR
use ocean_parameters_mod, only: ADVECT_PSOM, ADVECT_MDMDT_TEST
use ocean_parameters_mod, only: TWO_LEVEL
use ocean_parameters_mod, only: missing_value, onesixth, rho0, rho0r
use ocean_topog_mod, only: ocean_topog_init
use ocean_tracer_util_mod, only: tracer_psom_chksum
use ocean_types_mod, only: ocean_domain_type, ocean_grid_type, ocean_density_type, ocean_time_type
use ocean_types_mod, only: ocean_prog_tracer_type, ocean_thickness_type, ocean_adv_vel_type
use ocean_workspace_mod, only: wrk1, wrk2, wrk3, wrk4, wrk5, wrk1_2d
use ocean_util_mod, only: diagnose_2d, diagnose_3d
use ocean_tracer_util_mod, only: diagnose_3d_rho
implicit none
private
integer :: id0, id1, now
integer :: id_clock_up_horz
integer :: id_clock_up_vert
integer :: id_clock_2nd_horz
integer :: id_clock_2nd_vert
integer :: id_clock_4th_horz
integer :: id_clock_4th_vert
integer :: id_clock_6th_horz
integer :: id_clock_6th_vert
integer :: id_clock_quick_horz
integer :: id_clock_quick_vert
integer :: id_clock_quickmom3_horz
integer :: id_clock_quickmom3_vert
integer :: id_clock_mdfl_sup_b
integer :: id_clock_dst_linear
integer :: id_clock_dst_linear_test
integer :: id_clock_mdfl_sweby
integer :: id_clock_mdfl_sweby_all
integer :: id_clock_mdfl_sweby_test
integer :: id_clock_psom
integer :: id_clock_psom_x
integer :: id_clock_psom_y
integer :: id_clock_psom_z
integer :: id_clock_mdppm
integer :: id_clock_mdppm_test
integer :: id_clock_mdmdt_test
integer :: id_clock_gyre_over
integer :: id_clock_adv_diss
integer :: id_clock_mdfl_sweby_mpi
integer :: id_clock_mdfl_sweby_cu1
integer :: id_clock_mdfl_sweby_cu2
integer :: id_clock_mdfl_sweby_cu3
integer :: id_clock_mdfl_sweby_dia
!for restart file
type(restart_file_type), save :: Adv_restart
#include <ocean_memory.h>
#ifdef MOM_STATIC_ARRAYS
real, dimension(isd:ied,jsd:jed,nk) :: flux_x
real, dimension(isd:ied,jsd:jed,nk) :: flux_y
real, dimension(isd:ied,jsd:jed,nk) :: flux_z
real, dimension(isd:ied,jsd:jed,nk) :: advect_tendency
real, dimension(isd:ied,jsd:jed,nk) :: neutral_temp_advect
real, dimension(isd:ied,jsd:jed,nk) :: neutral_salt_advect
! some fields for quicker
real, dimension(isd:ied,jsd:jed,nk) :: quick_x
real, dimension(isd:ied,jsd:jed,nk) :: quick_y
real, dimension(nk,2) :: quick_z
real, dimension(isd:ied,jsd:jed,3) :: curv_xp
real, dimension(isd:ied,jsd:jed,3) :: curv_xn
real, dimension(isd:ied,jsd:jed,3) :: curv_yp
real, dimension(isd:ied,jsd:jed,3) :: curv_yn
real, dimension(nk,3) :: curv_zp
real, dimension(nk,3) :: curv_zn
real, dimension(isc-2:iec+2,jsc-2:jec+2) :: dxt_quick
real, dimension(isc-2:iec+2,jsc-2:jec+2) :: dyt_quick
real, dimension(isc-2:iec+2,jsc-2:jec+2,nk) :: tmask_quick
real, dimension(isc-2:iec+2,jsc-2:jec+2,nk) :: tracer_quick
! fields for 4th adn 6th order
real, dimension(isc-2:iec+2,jsc-2:jec+2,nk) :: tmask_fourth
real, dimension(isc-3:iec+3,jsc-3:jec+3,nk) :: tmask_sixth
real, dimension(isc-2:iec+2,jsc-2:jec+2,nk) :: tracer_fourth
real, dimension(isc-3:iec+3,jsc-3:jec+3,nk) :: tracer_sixth
! fields for mdfl
real, dimension(isc-2:iec+2,jsc-2:jec+2,nk) :: tracer_mdfl
real, dimension(isc-2:iec+2,jsc-2:jec+2,nk) :: tmask_mdfl
real, dimension(isc-2:iec+2,jsc-2:jec+2,nk) :: mass_mdfl
real, dimension(isc-2:iec+2,jsc-2:jec+2,nk) :: tracermass_mdfl
! fields for mdppm
real, dimension(isc-4:iec+4,jsc-4:jec+4,nk) :: tmask_mdppm
real, dimension(isc-4:iec+4,jsc-4:jec+4,nk) :: tracer_mdppm
real, dimension(isc-4:iec+4,jsc-4:jec+4,nk) :: mass_mdppm
real, dimension(isc-4:iec+4,jsc-4:jec+4,nk) :: tracermass_mdppm
! fields for mdmdt
real, dimension(isc-4:iec+4,jsc-4:jec+4,nk) :: tmask_mdmdt
real, dimension(isc-4:iec+4,jsc-4:jec+4,nk) :: tracer_mdmdt
real, dimension(isc-4:iec+4,jsc-4:jec+4,nk) :: mass_mdmdt
real, dimension(isc-4:iec+4,jsc-4:jec+4,nk) :: tracermass_mdmdt
! for doing all tracers with sweby
type :: tracer_mdfl_type
real, dimension(isc-2:iec+2,jsc-2:jec+2,nk) :: field
end type tracer_mdfl_type
#else
real, dimension(:,:,:), allocatable :: flux_x
real, dimension(:,:,:), allocatable :: flux_y
real, dimension(:,:,:), allocatable :: flux_z
real, dimension(:,:,:), allocatable :: advect_tendency
real, dimension(:,:,:), allocatable :: neutral_temp_advect
real, dimension(:,:,:), allocatable :: neutral_salt_advect
! some flow independent quantities for quicker
real, dimension(:,:,:), allocatable :: quick_x
real, dimension(:,:,:), allocatable :: quick_y
real, dimension(:,:), allocatable :: quick_z
real, dimension(:,:,:), allocatable :: curv_xp
real, dimension(:,:,:), allocatable :: curv_xn
real, dimension(:,:,:), allocatable :: curv_yp
real, dimension(:,:,:), allocatable :: curv_yn
real, dimension(:,:), allocatable :: curv_zp
real, dimension(:,:), allocatable :: curv_zn
real, dimension(:,:), allocatable :: dxt_quick
real, dimension(:,:), allocatable :: dyt_quick
real, dimension(:,:,:), allocatable :: tmask_quick
real, dimension(:,:,:), allocatable :: tracer_quick
! masks for other advection schemes
real, dimension(:,:,:), allocatable :: tmask_fourth
real, dimension(:,:,:), allocatable :: tmask_sixth
real, dimension(:,:,:), allocatable :: tracer_fourth
real, dimension(:,:,:), allocatable :: tracer_sixth
real, dimension(:,:,:), allocatable :: tracer_mdfl
real, dimension(:,:,:), allocatable :: tmask_mdfl
real, dimension(:,:,:), allocatable :: mass_mdfl
real, dimension(:,:,:), allocatable :: tracermass_mdfl
real, dimension(:,:,:), allocatable :: tracer_mdppm
real, dimension(:,:,:), allocatable :: tmask_mdppm
real, dimension(:,:,:), allocatable :: mass_mdppm
real, dimension(:,:,:), allocatable :: tracermass_mdppm
real, dimension(:,:,:), allocatable :: tmask_mdmdt
real, dimension(:,:,:), allocatable :: tracer_mdmdt
real, dimension(:,:,:), allocatable :: mass_mdmdt
real, dimension(:,:,:), allocatable :: tracermass_mdmdt
! for doing all tracers with sweby
type :: tracer_mdfl_type
real, dimension(:,:,:), pointer :: field => NULL()
end type tracer_mdfl_type
#endif
! for psom, the mass of seawater in a tracer cell
! and the tendency for use with diagnostics
real, dimension(:,:,:), allocatable :: sm
integer :: num_prog_tracers = 0
integer :: index_temp=-1
integer :: index_salt=-1
integer :: index_temp_sq=-1
integer :: index_salt_sq=-1
character(len=256) :: version='CVS $Id: ocean_tracer_advect.F90,v 20.0 2013/12/14 00:17:22 fms Exp $'
character(len=256) :: tagname='Tag $Name: tikal $'
type(ocean_domain_type), pointer :: Dom =>NULL()
type(ocean_grid_type) , pointer :: Grd =>NULL()
type(ocean_domain_type), save :: Dom_quicker
type(ocean_domain_type), save :: Dom_fourth
type(ocean_domain_type), save :: Dom_sixth
type(ocean_domain_type), save :: Dom_mdfl
type(ocean_domain_type), save :: Dom_flux
type(ocean_domain_type), save :: Dom_mdppm
type(ocean_domain_type), save :: Dom_mdmdt
type(tracer_mdfl_type), dimension(:), allocatable :: tracer_mdfl_all
real, parameter :: a4=7.0/12.0, b4=-1.0/12.0
real, parameter :: a6=37.0/60.0, b6=-2.0/15.0, c6=1.0/60.0
logical :: used
integer :: id_neut_rho_advect
integer :: id_pot_rho_advect
integer :: id_neut_rho_advect_on_nrho
integer :: id_wdian_rho_advect
integer :: id_wdian_rho_advect_on_nrho
integer :: id_tform_rho_advect
integer :: id_tform_rho_advect_on_nrho
integer :: id_neut_temp_advect
integer :: id_neut_temp_advect_on_nrho
integer :: id_wdian_temp_advect
integer :: id_wdian_temp_advect_on_nrho
integer :: id_tform_temp_advect
integer :: id_tform_temp_advect_on_nrho
integer :: id_neut_salt_advect
integer :: id_neut_salt_advect_on_nrho
integer :: id_wdian_salt_advect
integer :: id_wdian_salt_advect_on_nrho
integer :: id_tform_salt_advect
integer :: id_tform_salt_advect_on_nrho
integer, dimension(:), allocatable :: id_tracer_advection
integer, dimension(:), allocatable :: id_tracer_advection_on_nrho
integer, dimension(:), allocatable :: id_tracer2_advection
integer, dimension(:), allocatable :: id_tracer_adv_diss
integer, dimension(:), allocatable :: id_sweby_advect
integer, dimension(:), allocatable :: id_psom_advect
integer, dimension(:), allocatable :: id_vert_advect
integer, dimension(:), allocatable :: id_horz_advect
integer, dimension(:), allocatable :: id_advection_x
integer, dimension(:), allocatable :: id_advection_y
integer, dimension(:), allocatable :: id_advection_z
integer, dimension(:), allocatable :: id_xflux_adv
integer, dimension(:), allocatable :: id_yflux_adv
integer, dimension(:), allocatable :: id_zflux_adv
integer, dimension(:), allocatable :: id_xflux_adv_int_z
integer, dimension(:), allocatable :: id_yflux_adv_int_z
! for gyre/overturning diagnostics
integer :: id_basin_mask=-1
integer, dimension(:,:), allocatable :: id_merid_flux_advect
integer, dimension(:,:), allocatable :: id_merid_flux_over
integer, dimension(:,:), allocatable :: id_merid_flux_gyre
real, dimension(:,:), allocatable :: basin_mask
real, dimension(:,:), allocatable :: basin_mask_jp1
real, dimension(:,:), allocatable :: data
real, dimension(:,:,:), allocatable :: global_basin_mask
real, dimension(:,:), allocatable :: global_dxtn
real, dimension(:,:), allocatable :: global_dxt
real, dimension(:,:,:), allocatable :: global_tmask
real, dimension(:,:,:), allocatable :: global_rho_dzt
real, dimension(:,:,:), allocatable :: global_tracer
real, dimension(:,:,:), allocatable :: global_vhrho_nt
real, dimension(:,:,:), allocatable :: global_flux_y
real, dimension(:,:,:), allocatable :: global_basin_mask_jp1
real, dimension(:,:), allocatable :: global_dxt_jp1
real, dimension(:,:,:), allocatable :: global_tracer_jp1
real, dimension(:,:,:), allocatable :: global_tmask_jp1
public horz_advect_tracer
private horz_advect_tracer_upwind
private horz_advect_tracer_2nd_order
private horz_advect_tracer_4th_order
private horz_advect_tracer_6th_order
private horz_advect_tracer_quicker
private horz_advect_tracer_quickmom3
public vert_advect_tracer
private vert_advect_tracer_upwind
private vert_advect_tracer_2nd_order
private vert_advect_tracer_4th_order
private vert_advect_tracer_6th_order
private vert_advect_tracer_quicker
private vert_advect_tracer_quickmom3
private advect_tracer_mdfl_sup_b
private advect_tracer_mdfl_sweby
private advect_tracer_mdfl_sweby_test
private advect_tracer_sweby_all
private advect_tracer_mdppm
private advect_tracer_mdppm_test
private advect_tracer_mdmdt_test
private ppm_limit_ifc
private ppm_limit_cw84
private ppm_limit_sh
private advect_tracer_psom
private psom_x
private psom_y
private psom_z
private quicker_init
private mdfl_init
private fourth_sixth_init
private mdppm_init
private psom_init
private mdmdt_init
private advection_diag_init
private watermass_diag_init
private gyre_overturn_diagnose_init
private gyre_overturn_diagnose
private compute_adv_diss
private watermass_diag
public ocean_tracer_advect_init
public ocean_tracer_advect_end
public ocean_tracer_advect_restart
logical :: module_is_initialized = .false.
logical :: have_obc = .false.
logical :: compute_watermass_diag = .false.
! for gyre/overturning diagnostics
type(domain1d),save :: Domx,Domy
logical :: read_basin_mask = .false.
logical :: compute_gyre_overturn_diagnose = .false.
integer, allocatable :: pelist_x(:)
integer :: layout(2)
real, dimension(:,:,:), allocatable :: local_basin_mask
real, dimension(:,:,:), allocatable :: local_basin_mask_jp1
logical, dimension(0:5) :: do_this_basin
logical :: limit_with_upwind = .false.
logical :: debug_this_module = .false.
logical :: advect_sweby_all = .false.
logical :: zero_tracer_advect_horz = .false.
logical :: zero_tracer_advect_vert = .false.
logical :: write_a_restart = .true.
logical :: psom_limit_prather = .false.
logical :: async_domain_update = .false.
namelist /ocean_tracer_advect_nml/ debug_this_module, limit_with_upwind, advect_sweby_all, &
zero_tracer_advect_horz, zero_tracer_advect_vert, &
write_a_restart, psom_limit_prather, read_basin_mask, &
async_domain_update
contains
!#######################################################################
! <SUBROUTINE NAME="ocean_tracer_advect_init">
!
! <DESCRIPTION>
! Initialize the tracer advection module.
! </DESCRIPTION>
!
subroutine ocean_tracer_advect_init (Grid, Domain, Time, Dens, T_prog, obc, debug)
type(ocean_grid_type), intent(in), target :: Grid
type(ocean_domain_type), intent(in), target :: Domain
type(ocean_time_type), intent(in) :: Time
type(ocean_density_type), intent(in) :: Dens
type(ocean_prog_tracer_type), intent(inout) :: T_prog(:)
logical, intent(in) :: obc
logical, intent(in), optional :: debug
integer :: n
integer :: ioun, io_status, ierr
integer :: stdoutunit,stdlogunit
stdoutunit=stdout();stdlogunit=stdlog()
write( stdlogunit,'(/a/)') trim(version)
module_is_initialized = .true.
have_obc = obc
call write_version_number(version, tagname)
! provide for namelist over-ride of defaults
#ifdef INTERNAL_FILE_NML
read (input_nml_file, nml=ocean_tracer_advect_nml, iostat=io_status)
ierr = check_nml_error(io_status,'ocean_tracer_advect_nml')
#else
ioun = open_namelist_file()
read (ioun, ocean_tracer_advect_nml,iostat=io_status)
ierr = check_nml_error(io_status, 'ocean_tracer_advect_nml')
call close_file(ioun)
#endif
write (stdoutunit,'(/)')
write (stdoutunit, ocean_tracer_advect_nml)
write (stdlogunit, ocean_tracer_advect_nml)
#ifndef MOM_STATIC_ARRAYS
call get_local_indices(Domain, isd, ied, jsd, jed, isc, iec, jsc, jec)
nk = Grid%nk
allocate(flux_x(isd:ied,jsd:jed,nk))
allocate(flux_y(isd:ied,jsd:jed,nk))
allocate(flux_z(isd:ied,jsd:jed,nk))
allocate(advect_tendency(isd:ied,jsd:jed,nk))
allocate(neutral_temp_advect(isd:ied,jsd:jed,nk))
allocate(neutral_salt_advect(isd:ied,jsd:jed,nk))
#endif
Dom => Domain
Grd => Grid
flux_x = 0.0
flux_y = 0.0
flux_z = 0.0
advect_tendency(:,:,:) = 0.0
neutral_temp_advect(:,:,:) = 0.0
neutral_salt_advect(:,:,:) = 0.0
if (PRESENT(debug) .and. .not. debug_this_module) then
debug_this_module = debug
endif
if(debug_this_module) then
write(stdoutunit,'(a)') &
'==>Note: running ocean_tracer_advect_mod with debug_this_module=.true.'
endif
num_prog_tracers = size(T_prog(:))
do n=1,num_prog_tracers
if (trim(T_prog(n)%name) == 'temp') index_temp = n
if (trim(T_prog(n)%name) == 'salt') index_salt = n
if (trim(T_prog(n)%name) == 'passive_temp_sq') index_temp_sq = n
if (trim(T_prog(n)%name) == 'passive_salt_sq') index_salt_sq = n
enddo
if(.not. write_a_restart) then
write(stdoutunit,'(a)') '==>Note: running ocean_tracer_advect with write_a_restart=.false.'
write(stdoutunit,'(a)') ' Will NOT write restart file, so cannot restart if using PSOM advection.'
endif
if(zero_tracer_advect_horz) then
call mpp_error(WARNING,'==>ocean_tracer_advect_mod: have turned OFF horizontal tracer advection')
write(stdoutunit,*)'==>WARNING: have turned off horizontal tracer advection. Unrealistic simulation.'
endif
if(zero_tracer_advect_vert) then
call mpp_error(WARNING,'==>ocean_tracer_advect_mod: have turned OFF vertical tracer advection')
write(stdoutunit,*)'==>WARNING: have turned off vertical tracer advection. Unrealistic simulation.'
endif
if(advect_sweby_all) then
if(async_domain_update) then
write(stdoutunit,'(a)') &
'==>Note: using asynchrnous domain update for MDFL SWEBY_all'
endif
write(stdoutunit,'(/a)')'==>ocean_tracer_advect_mod: advect_sweby_all=.true. so all tracers advected'
write(stdoutunit,'(a)') ' with mdfl_sweby, regardless the settings in field_table.'
write(stdoutunit,'(a/)')' This method exploits mpp_update_domain capabilities and is faster in some cases.'
else
write(stdoutunit,'(a)') ' '
write(stdoutunit,'(a)') ' From ocean_tracer_advect_init: SUMMARY OF TRACER ADVECTION SCHEMES'
do n=1,num_prog_tracers
if(T_prog(n)%horz_advect_scheme==ADVECT_UPWIND) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //'is using first order upwind for horz advection.'
endif
if(T_prog(n)%vert_advect_scheme==ADVECT_UPWIND) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //'is using first order upwind for vert advection.'
endif
if(T_prog(n)%horz_advect_scheme==ADVECT_2ND_ORDER) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //'is using 2nd order centred for horz advection.'
endif
if(T_prog(n)%vert_advect_scheme==ADVECT_2ND_ORDER) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //'is using 2nd order centred for vert advection.'
endif
if(T_prog(n)%horz_advect_scheme==ADVECT_4TH_ORDER) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using 4th order centred for horz advection.'
endif
if(T_prog(n)%vert_advect_scheme==ADVECT_4TH_ORDER) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //'is using 4th order centred for vert advection.'
endif
if(T_prog(n)%horz_advect_scheme==ADVECT_6TH_ORDER) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using 6th order centred for horz advection.'
endif
if(T_prog(n)%vert_advect_scheme==ADVECT_6TH_ORDER) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using 6th order centred for vert advection.'
endif
if(T_prog(n)%horz_advect_scheme==ADVECT_QUICKER) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using Quicker for horz advection.'
if(limit_with_upwind) then
write(stdoutunit,'(1x,a)')'limit_with_upwind reverts quicker to upwind if tracer outside limits'
endif
endif
if(T_prog(n)%vert_advect_scheme==ADVECT_QUICKER) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using Quicker for vert advection.'
if(limit_with_upwind) then
write(stdoutunit,'(1x,a)')'limit_with_upwind reverts quicker to upwind if tracer outside limits'
endif
endif
if(T_prog(n)%horz_advect_scheme==ADVECT_QUICKMOM3) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using MOM3-Quicker for horz advection.'
endif
if(T_prog(n)%vert_advect_scheme==ADVECT_QUICKMOM3) then
write(stdoutunit,'(1x,a)') 'From ocean_tracer_advect_init: tracer ',trim(T_prog(n)%name), &
' is using MOM3-Quicker for vertical advection.'
endif
if(T_prog(n)%horz_advect_scheme==ADVECT_MDFL_SUP_B) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using MDFL Super-B for horz/vert advection.'
endif
if(T_prog(n)%horz_advect_scheme==ADVECT_MDFL_SWEBY) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using MDFL Sweby for horz/vert advection.'
endif
if(T_prog(n)%horz_advect_scheme==ADVECT_DST_LINEAR) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using linear direct space-time for horiz/vert advection.'
endif
if(T_prog(n)%horz_advect_scheme==ADVECT_PSOM) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using Prather SOM for horz/vert advection.'
endif
if(T_prog(n)%horz_advect_scheme==ADVECT_MDPPM) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using multi-dim piecewise parabolic for horz/vert advection.'
endif
if(T_prog(n)%horz_advect_scheme==ADVECT_MDFL_SWEBY_TEST) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using unsupported test MDFL Sweby for horz/vert advection.'
endif
if(T_prog(n)%horz_advect_scheme==ADVECT_DST_LINEAR_TEST) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using unsupported test linear direct space-time for horiz/vert advection.'
endif
if(T_prog(n)%horz_advect_scheme==ADVECT_MDPPM_TEST) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using unsupported test multi-dim piecewise parabolic for horz/vert advection.'
endif
if(T_prog(n)%horz_advect_scheme==ADVECT_MDMDT_TEST) then
write(stdoutunit,'(1x,a)') &
trim(T_prog(n)%name) //' is using unsupported test multi-dim modified Daru & Tenaud for horz/vert advection.'
endif
enddo
write(stdoutunit,'(a)') ' '
endif
call mpp_define_domains( (/1,Grid%ni,1,Grid%nj/), Domain%layout, Dom_flux%domain2d, maskmap=Domain%maskmap&
, xflags = Domain%xflags, yflags = Domain%yflags, xhalo=1, yhalo=1,name='flux'&
, x_cyclic_offset = Domain%x_cyclic_offset, y_cyclic_offset = Domain%y_cyclic_offset)
! for the gyre/overturning diagnostic
call gyre_overturn_diagnose_init(Time, T_prog(:))
! initialize schemes other than 2nd order centered and first order upwind
call fourth_sixth_init
call quicker_init
call mdfl_init
call mdppm_init
call psom_init(Time, T_prog(:) )
call mdmdt_init
! array needed for psom advection
allocate( sm(isd:ied,jsd:jed,nk) )
sm(:,:,:) = 0.0
call advection_diag_init(Time, Dens, T_prog(:))
call watermass_diag_init(Time, Dens)
! initialize clock ids
id_clock_up_horz = mpp_clock_id('(Ocean advect: horz up) ',grain=CLOCK_ROUTINE)
id_clock_up_vert = mpp_clock_id('(Ocean advect: vert up) ',grain=CLOCK_ROUTINE)
id_clock_2nd_horz = mpp_clock_id('(Ocean advect: horz 2nd) ',grain=CLOCK_ROUTINE)
id_clock_2nd_vert = mpp_clock_id('(Ocean advect: vert 2nd) ',grain=CLOCK_ROUTINE)
id_clock_gyre_over = mpp_clock_id('(Ocean advect: gyre_overturn) ',grain=CLOCK_ROUTINE)
id_clock_adv_diss = mpp_clock_id('(Ocean advect: advect diss) ',grain=CLOCK_ROUTINE)
end subroutine ocean_tracer_advect_init
! </SUBROUTINE> NAME="ocean_tracer_advect_init"
!#######################################################################
! <SUBROUTINE NAME="advection_diag_init">
!
! <DESCRIPTION>
! Initialize the main tracer advection diagnostics.
! </DESCRIPTION>
!
subroutine advection_diag_init (Time, Dens, T_prog)
type(ocean_time_type), intent(in) :: Time
type(ocean_density_type), intent(in) :: Dens
type(ocean_prog_tracer_type), intent(in) :: T_prog(:)
integer :: n
integer :: stdoutunit
stdoutunit=stdout()
allocate (id_tracer_advection(num_prog_tracers))
allocate (id_tracer_advection_on_nrho(num_prog_tracers))
allocate (id_tracer2_advection(num_prog_tracers))
allocate (id_tracer_adv_diss(num_prog_tracers))
allocate (id_sweby_advect(num_prog_tracers))
allocate (id_psom_advect(num_prog_tracers))
allocate (id_horz_advect(num_prog_tracers))
allocate (id_vert_advect(num_prog_tracers))
allocate (id_advection_x(num_prog_tracers))
allocate (id_advection_y(num_prog_tracers))
allocate (id_advection_z(num_prog_tracers))
allocate (id_xflux_adv(num_prog_tracers))
allocate (id_yflux_adv(num_prog_tracers))
allocate (id_zflux_adv(num_prog_tracers))
allocate (id_xflux_adv_int_z(num_prog_tracers))
allocate (id_yflux_adv_int_z(num_prog_tracers))
id_tracer_advection =-1
id_tracer_advection_on_nrho =-1
id_tracer2_advection=-1
id_tracer_adv_diss =-1
id_sweby_advect =-1
id_psom_advect =-1
id_horz_advect =-1
id_vert_advect =-1
id_advection_x =-1
id_advection_y =-1
id_advection_z =-1
id_xflux_adv =-1
id_yflux_adv =-1
id_zflux_adv =-1
id_xflux_adv_int_z =-1
id_yflux_adv_int_z =-1
do n=1,num_prog_tracers
if(n==index_temp) then
id_tracer_advection(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_advection', &
Grd%tracer_axes(1:3), Time%model_time, 'cp*rho*dzt*advection tendency', &
trim(T_prog(n)%flux_units), missing_value=missing_value, range=(/-1.e18,1.e18/))
id_tracer_advection_on_nrho(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_advection_on_nrho', &
Dens%neutralrho_axes(1:3), Time%model_time, 'cp*rho*dzt*advection tendency binned to neutral density',&
trim(T_prog(n)%flux_units), missing_value=missing_value, range=(/-1.e18,1.e18/))
id_tracer2_advection(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_sq_advection', &
Grd%tracer_axes(1:3), Time%model_time, 'rho*dzt*advection tendency for (cp*temp)^2', &
'kg/(m^2*sec)*(J/kg)^2', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_sweby_advect(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_sweby_advect', &
Grd%tracer_axes(1:3), Time%model_time, 'cp*rho*dzt*sweby advect tendency', &
trim(T_prog(n)%flux_units), missing_value=missing_value, range=(/-1.e18,1.e18/))
id_psom_advect(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_psom_advect', &
Grd%tracer_axes(1:3), Time%model_time, 'cp*rho*dzt*psom advect tendency', &
trim(T_prog(n)%flux_units), missing_value=missing_value, range=(/-1.e18,1.e18/))
id_horz_advect(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_horz_advect', &
Grd%tracer_axes(1:3), Time%model_time, 'cp*rho*dzt*horz advect tendency', &
trim(T_prog(n)%flux_units), missing_value=missing_value, range=(/-1.e18,1.e18/))
id_vert_advect(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_vert_advect', &
Grd%tracer_axes(1:3), Time%model_time, 'cp*rho*dzt*vert advect tendency', &
trim(T_prog(n)%flux_units), missing_value=missing_value, range=(/-1.e18,1.e18/))
id_advection_x(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_x_adv', &
Grd%tracer_axes(1:3), Time%model_time, 'cp*rho*dzt*x-advective heating', &
trim(T_prog(n)%flux_units), missing_value=missing_value, range=(/-1.e18,1.e18/))
id_advection_y(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_y_adv', &
Grd%tracer_axes(1:3), Time%model_time, 'cp*rho*dzt*y-advective heating', &
trim(T_prog(n)%flux_units), missing_value=missing_value, range=(/-1.e18,1.e18/))
id_advection_z(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_z_adv', &
Grd%tracer_axes(1:3), Time%model_time, 'cp*rho*dzt*z-advective heating', &
trim(T_prog(n)%flux_units), missing_value=missing_value, range=(/-1.e18,1.e18/))
id_xflux_adv(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_xflux_adv', &
Grd%tracer_axes_flux_x(1:3), Time%model_time, 'cp*rho*dzt*dyt*u*temp', &
'Watts', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_yflux_adv(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_yflux_adv', &
Grd%tracer_axes_flux_y(1:3), Time%model_time, 'cp*rho*dzt*dxt*v*temp', &
'Watts', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_zflux_adv(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_zflux_adv', &
Grd%tracer_axes_wt(1:3), Time%model_time, 'cp*rho*dxt*dyt*wt*temp', &
'Watts', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_xflux_adv_int_z(n) = register_diag_field ('ocean_model', &
trim(T_prog(n)%name)//'_xflux_adv_int_z', &
Grd%tracer_axes_flux_x(1:2), Time%model_time, &
'z-integral of cp*rho*dyt*u*temp', &
'Watts', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_yflux_adv_int_z(n) = register_diag_field ('ocean_model', &
trim(T_prog(n)%name)//'_yflux_adv_int_z', &
Grd%tracer_axes_flux_y(1:2), Time%model_time, &
'z-integral of cp*rho*dxt*v*temp', &
'Watts', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_tracer_adv_diss(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_adv_diss', &
Grd%tracer_axes(1:3), Time%model_time, &
'dissipation of squared '//trim(T_prog(n)%name)//' from advection errors', &
'(Watt/m^2)^2', missing_value=missing_value, &
range=(/-1.e18,1.e18/))
else
id_tracer_advection(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_advection', &
Grd%tracer_axes(1:3), Time%model_time, 'rho*dzt*advection tendency', &
'kg/(sec*m^2)', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_tracer_advection_on_nrho(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_advection_on_nrho', &
Dens%neutralrho_axes(1:3), Time%model_time, 'rho*dzt*advection tendency binned to neutral density',&
'kg/(sec*m^2)', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_tracer2_advection(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_sq_advection', &
Grd%tracer_axes(1:3), Time%model_time, 'rho*dzt*advection tendency for tracer sqrd',&
'kg/(m^2*s)*(tracer squared)', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_sweby_advect(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_sweby_advect', &
Grd%tracer_axes(1:3), Time%model_time, 'rho*dzt*sweby advect tendency', &
'kg/(sec*m^2)', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_psom_advect(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_psom_advect', &
Grd%tracer_axes(1:3), Time%model_time, 'rho*dzt*psom advect tendency', &
'kg/(sec*m^2)', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_horz_advect(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_horz_advect', &
Grd%tracer_axes(1:3), Time%model_time, 'rho*dzt*horz advect tendency', &
'kg/(sec*m^2)', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_vert_advect(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_vert_advect', &
Grd%tracer_axes(1:3), Time%model_time, 'rho*dzt*vert advect tendency', &
'kg/(sec*m^2)', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_advection_x(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_x_adv', &
Grd%tracer_axes(1:3), Time%model_time, 'rho*dzt*x-advective tendency', &
trim(T_prog(n)%flux_units), missing_value=missing_value, range=(/-1.e18,1.e18/))
id_advection_y(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_y_adv', &
Grd%tracer_axes(1:3), Time%model_time, 'rho*dzt*y-advective tendency', &
trim(T_prog(n)%flux_units), missing_value=missing_value, range=(/-1.e18,1.e18/))
id_advection_z(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_z_adv', &
Grd%tracer_axes(1:3), Time%model_time, 'rho*dzt*z-advective tendency', &
trim(T_prog(n)%flux_units), missing_value=missing_value, range=(/-1.e18,1.e18/))
id_xflux_adv(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_xflux_adv', &
Grd%tracer_axes_flux_x(1:3), Time%model_time, 'rho*dzt*dyt*u*tracer', &
'kg/sec', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_yflux_adv(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_yflux_adv', &
Grd%tracer_axes_flux_y(1:3), Time%model_time, 'rho*dzt*dxt*v*tracer', &
'kg/sec', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_zflux_adv(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_zflux_adv', &
Grd%tracer_axes_wt(1:3), Time%model_time, 'rho*dxt*dyt*wt*tracer', &
'kg/sec', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_xflux_adv_int_z(n) = register_diag_field ('ocean_model', &
trim(T_prog(n)%name)//'_xflux_adv_int_z', &
Grd%tracer_axes_flux_x(1:2), Time%model_time, &
'z-integral of rho*dzt*dyt*u*tracer', &
'kg/sec', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_yflux_adv_int_z(n) = register_diag_field ('ocean_model', &
trim(T_prog(n)%name)//'_yflux_adv_int_z', &
Grd%tracer_axes_flux_y(1:2), Time%model_time, &
'z-integral of rho*dzt*dxt*v*tracer', &
'kg/sec', missing_value=missing_value, range=(/-1.e18,1.e18/))
id_tracer_adv_diss(n) = register_diag_field ('ocean_model', trim(T_prog(n)%name)//'_adv_diss', &
Grd%tracer_axes(1:3), Time%model_time, &
'dissipation of squared '//trim(T_prog(n)%name)//' from advection errors', &
'[kg/(m^2*sec)]^2', missing_value=missing_value, &
range=(/-1.e18,1.e18/))
endif
enddo
end subroutine advection_diag_init
! </SUBROUTINE> NAME="advection_diag_init"
!#######################################################################
! <SUBROUTINE NAME="watermass_diag_init">
!
! <DESCRIPTION>
! Initialize the watermass diagnostics.
! </DESCRIPTION>
!
subroutine watermass_diag_init (Time, Dens)
type(ocean_time_type), intent(in) :: Time
type(ocean_density_type), intent(in) :: Dens
integer :: stdoutunit
stdoutunit=stdout()
id_neut_rho_advect = register_diag_field ('ocean_model', 'neut_rho_advect', &
Grd%tracer_axes(1:3), Time%model_time, 'advection tendency for neutral rho',&
'(kg/m^3)/sec', missing_value=missing_value, range=(/-1e20,1e20/))
if(id_neut_rho_advect > 0) compute_watermass_diag = .true.
id_pot_rho_advect = register_diag_field ('ocean_model', 'pot_rho_advect', &
Grd%tracer_axes(1:3), Time%model_time, 'advection tendency for potential rho',&
'(kg/m^3)/sec', missing_value=missing_value, range=(/-1e20,1e20/))
if(id_pot_rho_advect > 0) compute_watermass_diag = .true.
id_wdian_rho_advect = register_diag_field ('ocean_model', 'wdian_rho_advect',&
Grd%tracer_axes(1:3), Time%model_time, &
'dianeutral mass transport from advection tendency for neutral rho', &
'kg/sec', missing_value=missing_value, range=(/-1e20,1e20/))
if(id_wdian_rho_advect > 0) compute_watermass_diag = .true.
id_tform_rho_advect = register_diag_field ('ocean_model', &
'tform_rho_advect', Grd%tracer_axes(1:3), Time%model_time, &
'water mass transformation from advection on level (pre-binning)',&
'kg/sec', missing_value=missing_value, range=(/-1e20,1e20/))
if(id_tform_rho_advect > 0) compute_watermass_diag = .true.
id_neut_rho_advect_on_nrho = register_diag_field ('ocean_model', &
'neut_rho_advect_on_nrho', Dens%neutralrho_axes(1:3), Time%model_time, &
'update of locally ref potrho from advection as binned to neutral density',&
'(kg/m^3)/sec', missing_value=missing_value, range=(/-1e20,1e20/))
if(id_neut_rho_advect_on_nrho > 0) compute_watermass_diag = .true.
id_wdian_rho_advect_on_nrho = register_diag_field ('ocean_model', &
'wdian_rho_advect_on_nrho', Dens%neutralrho_axes(1:3), Time%model_time, &
'dianeutral mass transport due to advection as binned to neutral density', &
'kg/sec', missing_value=missing_value, range=(/-1e20,1e20/))
if(id_wdian_rho_advect_on_nrho > 0) compute_watermass_diag = .true.
id_tform_rho_advect_on_nrho = register_diag_field ('ocean_model', &
'tform_rho_advect_on_nrho', Dens%neutralrho_axes(1:3), Time%model_time, &
'water mass transformation from advection as binned to neutral density',&
'kg/sec', missing_value=missing_value, range=(/-1e20,1e20/))
if(id_tform_rho_advect_on_nrho > 0) compute_watermass_diag = .true.
! temperature contributions
id_neut_temp_advect = register_diag_field ('ocean_model', 'neut_temp_advect', &
Grd%tracer_axes(1:3), Time%model_time, 'temp related advection tendency for neutral rho',&
'(kg/m^3)/sec', missing_value=missing_value, range=(/-1e20,1e20/))
if(id_neut_temp_advect > 0) compute_watermass_diag = .true.
id_wdian_temp_advect = register_diag_field ('ocean_model', 'wdian_temp_advect', &
Grd%tracer_axes(1:3), Time%model_time, &