-
Notifications
You must be signed in to change notification settings - Fork 0
/
MOM_parameter_doc.all_cn9GnMap12tp05
1532 lines (1481 loc) · 110 KB
/
MOM_parameter_doc.all_cn9GnMap12tp05
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
! This file was written by the model and records all non-layout or debugging parameters used at run-time.
! === module MOM ===
SPLIT = True ! [Boolean] default = True
! Use the split time stepping if true.
CALC_RHO_FOR_SEA_LEVEL = False ! [Boolean] default = False
! If true, the in-situ density is used to calculate the
! effective sea level that is returned to the coupler. If false,
! the Boussinesq parameter RHO_0 is used.
ENABLE_THERMODYNAMICS = False ! [Boolean] default = True
! If true, Temperature and salinity are used as state
! variables.
USE_EOS = False ! [Boolean] default = False
! If true, density is calculated from temperature and
! salinity with an equation of state. If USE_EOS is
! true, ENABLE_THERMODYNAMICS must be true as well.
DIABATIC_FIRST = False ! [Boolean] default = False
! If true, apply diabatic and thermodynamic processes,
! including buoyancy forcing and mass gain or loss,
! before stepping the dynamics forward.
USE_CONTEMP_ABSSAL = False ! [Boolean] default = False
! If true, the prognostics T&S are the conservative temperature
! and absolute salinity. Care should be taken to convert them
! to potential temperature and practical salinity before
! exchanging them with the coupler and/or reporting T&S diagnostics.
ADIABATIC = False ! [Boolean] default = False
! There are no diapycnal mass fluxes if ADIABATIC is
! true. This assumes that KD = KDML = 0.0 and that
! there is no buoyancy forcing, but makes the model
! faster by eliminating subroutine calls.
USE_LEGACY_DIABATIC_DRIVER = True ! [Boolean] default = True
! If true, use the a legacy version of the diabatic subroutine.
! This is temporary and is needed avoid change in answers.
OFFLINE_TRACER_MODE = False ! [Boolean] default = False
! If true, barotropic and baroclinic dynamics, thermodynamics
! are all bypassed with all the fields necessary to integrate
! the tracer advection and diffusion equation are read in from
! files stored from a previous integration of the prognostic model.
! NOTE: This option only used in the ocean_solo_driver.
USE_REGRIDDING = False ! [Boolean] default = False
! If True, use the ALE algorithm (regridding/remapping).
! If False, use the layered isopycnal algorithm.
BULKMIXEDLAYER = False ! [Boolean] default = False
! If true, use a Kraus-Turner-like bulk mixed layer
! with transitional buffer layers. Layers 1 through
! NKML+NKBL have variable densities. There must be at
! least NKML+NKBL+1 layers if BULKMIXEDLAYER is true.
! BULKMIXEDLAYER can not be used with USE_REGRIDDING.
! The default is influenced by ENABLE_THERMODYNAMICS.
THICKNESSDIFFUSE = True ! [Boolean] default = False
! If true, interface heights are diffused with a
! coefficient of KHTH.
THICKNESSDIFFUSE_FIRST = True ! [Boolean] default = False
! If true, do thickness diffusion before dynamics.
! This is only used if THICKNESSDIFFUSE is true.
BATHYMETRY_AT_VEL = False ! [Boolean] default = False
! If true, there are separate values for the basin depths
! at velocity points. Otherwise the effects of topography
! are entirely determined from thickness points.
DT = 5400.0 ! [s]
! The (baroclinic) dynamics time step. The time-step that
! is actually used will be an integer fraction of the
! forcing time-step (DT_FORCING in ocean-only mode or the
! coupling timestep in coupled mode.)
DT_THERM = 5400.0 ! [s] default = 5400.0
! The thermodynamic and tracer advection time step.
! Ideally DT_THERM should be an integer multiple of DT
! and less than the forcing or coupling time-step, unless
! THERMO_SPANS_COUPLING is true, in which case DT_THERM
! can be an integer multiple of the coupling timestep. By
! default DT_THERM is set to DT.
THERMO_SPANS_COUPLING = False ! [Boolean] default = False
! If true, the MOM will take thermodynamic and tracer
! timesteps that can be longer than the coupling timestep.
! The actual thermodynamic timestep that is used in this
! case is the largest integer multiple of the coupling
! timestep that is less than or equal to DT_THERM.
HMIX_SFC_PROP = 100.0 ! [m] default = 1.0
! If BULKMIXEDLAYER is false, HMIX_SFC_PROP is the depth
! over which to average to find surface properties like
! SST and SSS or density (but not surface velocities).
HMIX_UV_SFC_PROP = 100.0 ! [m] default = 0.0
! If BULKMIXEDLAYER is false, HMIX_UV_SFC_PROP is the depth
! over which to average to find surface flow properties,
! SSU, SSV. A non-positive value indicates no averaging.
MIN_Z_DIAG_INTERVAL = 0.0 ! [s] default = 0.0
! The minimum amount of time in seconds between
! calculations of depth-space diagnostics. Making this
! larger than DT_THERM reduces the performance penalty
! of regridding to depth online.
INTERPOLATE_P_SURF = False ! [Boolean] default = False
! If true, linearly interpolate the surface pressure
! over the coupling time step, using the specified value
! at the end of the step.
DTBT_RESET_PERIOD = 0.0 ! [s] default = 5400.0
! The period between recalculations of DTBT (if DTBT <= 0).
! If DTBT_RESET_PERIOD is negative, DTBT is set based
! only on information available at initialization. If 0,
! DTBT will be set every dynamics time step. The default
! is set by DT_THERM. This is only used if SPLIT is true.
FIRST_DIRECTION = 0 ! default = 0
! An integer that indicates which direction goes first
! in parts of the code that use directionally split
! updates, with even numbers (or 0) used for x- first
! and odd numbers used for y-first.
CHECK_BAD_SURFACE_VALS = False ! [Boolean] default = False
! If true, check the surface state for ridiculous values.
SAVE_INITIAL_CONDS = True ! [Boolean] default = False
! If true, write the initial conditions to a file given
! by IC_OUTPUT_FILE.
IC_OUTPUT_FILE = "MOM_IC" ! default = "MOM_IC"
! The file into which to write the initial conditions.
WRITE_GEOM = 1 ! default = 1
! If =0, never write the geometry and vertical grid files.
! If =1, write the geometry and vertical grid files only for
! a new simulation. If =2, always write the geometry and
! vertical grid files. Other values are invalid.
ENSEMBLE_OCEAN = False ! [Boolean] default = False
! If False, The model is being run in serial mode as a single realization.
! If True, The current model realization is part of a larger ensemble
! and at the end of step MOM, we will perform a gather of the ensemble
! members for statistical evaluation and/or data assimilation.
! === module MOM_domains ===
REENTRANT_X = True ! [Boolean] default = True
! If true, the domain is zonally reentrant.
REENTRANT_Y = False ! [Boolean] default = False
! If true, the domain is meridionally reentrant.
TRIPOLAR_N = False ! [Boolean] default = False
! Use tripolar connectivity at the northern edge of the
! domain. With TRIPOLAR_N, NIGLOBAL must be even.
NIGLOBAL = 60 !
! The total number of thickness grid points in the
! x-direction in the physical domain. With STATIC_MEMORY_
! this is set in MOM_memory.h at compile time.
NJGLOBAL = 55 !
! The total number of thickness grid points in the
! y-direction in the physical domain. With STATIC_MEMORY_
! this is set in MOM_memory.h at compile time.
! === module MOM_hor_index ===
! Sets the horizontal array index types.
! === module MOM_verticalGrid ===
! Parameters providing information about the vertical grid.
G_EARTH = 9.8 ! [m s-2] default = 9.8
! The gravitational acceleration of the Earth.
RHO_0 = 1035.0 ! [kg m-3] default = 1035.0
! The mean ocean density used with BOUSSINESQ true to
! calculate accelerations and the mass for conservation
! properties, or with BOUSSINSEQ false to convert some
! parameters from vertical units of m to kg m-2.
BOUSSINESQ = True ! [Boolean] default = True
! If true, make the Boussinesq approximation.
ANGSTROM = 1.0E-10 ! [m] default = 1.0E-10
! The minumum layer thickness, usually one-Angstrom.
H_TO_M = 1.0 ! [m H-1] default = 1.0
! A constant that translates the model's internal
! units of thickness into m.
NK = 30 ! [nondim]
! The number of model layers.
! === module MOM_fixed_initialization ===
INPUTDIR = "." ! default = "."
! The directory in which input files are found.
! === module MOM_grid_init ===
GRID_CONFIG = "mercator" !
! A character string that determines the method for
! defining the horizontal grid. Current options are:
! mosaic - read the grid from a mosaic (supergrid)
! file set by GRID_FILE.
! cartesian - use a (flat) Cartesian grid.
! spherical - use a simple spherical grid.
! mercator - use a Mercator spherical grid.
SOUTHLAT = -65.0 ! [degrees]
! The southern latitude of the domain.
LENLAT = 35.0 ! [degrees]
! The latitudinal length of the domain.
WESTLON = 0.0 ! [degrees] default = 0.0
! The western longitude of the domain.
LENLON = 60.0 ! [degrees]
! The longitudinal length of the domain.
RAD_EARTH = 6.378E+06 ! [m] default = 6.378E+06
! The radius of the Earth.
ISOTROPIC = True ! [Boolean] default = False
! If true, an isotropic grid on a sphere (also known as
! a Mercator grid) is used. With an isotropic grid, the
! meridional extent of the domain (LENLAT), the zonal
! extent (LENLON), and the number of grid points in each
! direction are _not_ independent. In MOM the meridional
! extent is determined to fit the zonal extent and the
! number of grid points, while grid is perfectly isotropic.
EQUATOR_REFERENCE = False ! [Boolean] default = True
! If true, the grid is defined to have the equator at the
! nearest q- or h- grid point to (-LOWLAT*NJGLOBAL/LENLAT).
LAT_ENHANCE_FACTOR = 1.0 ! [nondim] default = 1.0
! The amount by which the meridional resolution is
! enhanced within LAT_EQ_ENHANCE of the equator.
LAT_EQ_ENHANCE = 0.0 ! [degrees] default = 0.0
! The latitude range to the north and south of the equator
! over which the resolution is enhanced.
TOPO_CONFIG = "channel9" !
! This specifies how bathymetry is specified:
! file - read bathymetric information from the file
! specified by (TOPO_FILE).
! flat - flat bottom set to MAXIMUM_DEPTH.
! bowl - an analytically specified bowl-shaped basin
! ranging between MAXIMUM_DEPTH and MINIMUM_DEPTH.
! spoon - a similar shape to 'bowl', but with an vertical
! wall at the southern face.
! halfpipe - a zonally uniform channel with a half-sine
! profile in the meridional direction.
! benchmark - use the benchmark test case topography.
! Neverland - use the Neverland test case topography.
! shoebox2 - use the shoebox2 test case topography.
! shoebox3 - use the shoebox3 test case topography.
! shoebox4 - use the shoebox4 test case topography.
! channel1 - use the channel1 test case topography.
! channel2 - use the channel2 test case topography.
! channel6 - use the channel6 test case topography.
! channel7 - use the channel7 test case topography.
! channel8 - use the channel8 test case topography.
! channel9 - use the channel9 test case topography.
! DOME - use a slope and channel configuration for the
! DOME sill-overflow test case.
! ISOMIP - use a slope and channel configuration for the
! ISOMIP test case.
! DOME2D - use a shelf and slope configuration for the
! DOME2D gravity current/overflow test case.
! Kelvin - flat but with rotated land mask.
! seamount - Gaussian bump for spontaneous motion test case.
! dumbbell - Sloshing channel with reservoirs on both ends.
! shelfwave - exponential slope for shelfwave test case.
! Phillips - ACC-like idealized topography used in the Phillips config.
! dense - Denmark Strait-like dense water formation and overflow.
! USER - call a user modified routine.
! === module channel9_initialize_topography ===
MAXIMUM_DEPTH = 4000.0 ! [m]
! The maximum depth of the ocean.
MINIMUM_DEPTH = 0.0 ! [m] default = 0.0
! If MASKING_DEPTH is unspecified, then anything shallower than
! MINIMUM_DEPTH is assumed to be land and all fluxes are masked out.
! If MASKING_DEPTH is specified, then all depths shallower than
! MINIMUM_DEPTH but deeper than MASKING_DEPTH are rounded to MINIMUM_DEPTH.
! === module MOM_open_boundary ===
! Controls where open boundaries are located, what kind of boundary condition to impose, and what data to apply, if any.
OBC_NUMBER_OF_SEGMENTS = 0 ! default = 0
! The number of open boundary segments.
MASKING_DEPTH = -9999.0 ! [m] default = -9999.0
! The depth below which to mask points as land points, for which all
! fluxes are zeroed out. MASKING_DEPTH is ignored if negative.
CHANNEL_CONFIG = "none" ! default = "none"
! A parameter that determines which set of channels are
! restricted to specific widths. Options are:
! none - All channels have the grid width.
! global_1deg - Sets 16 specific channels appropriate
! for a 1-degree model, as used in CM2G.
! list - Read the channel locations and widths from a
! text file, like MOM_channel_list in the MOM_SIS
! test case.
! file - Read open face widths everywhere from a
! NetCDF file on the model grid.
ROTATION = "2omegasinlat" ! default = "2omegasinlat"
! This specifies how the Coriolis parameter is specified:
! 2omegasinlat - Use twice the planetary rotation rate
! times the sine of latitude.
! betaplane - Use a beta-plane or f-plane.
! USER - call a user modified routine.
OMEGA = 7.2921E-05 ! [s-1] default = 7.2921E-05
! The rotation rate of the earth.
! === module MOM_tracer_registry ===
! === module MOM_restart ===
PARALLEL_RESTARTFILES = False ! [Boolean] default = False
! If true, each processor writes its own restart file,
! otherwise a single restart file is generated
RESTARTFILE = "MOM.res" ! default = "MOM.res"
! The name-root of the restart file.
LARGE_FILE_SUPPORT = True ! [Boolean] default = True
! If true, use the file-size limits with NetCDF large
! file support (4Gb), otherwise the limit is 2Gb.
MAX_FIELDS = 100 ! default = 100
! The maximum number of restart fields that can be used.
RESTART_CHECKSUMS_REQUIRED = False ! [Boolean] default = True
! If true, require the restart checksums to match and error out otherwise.
! Users may want to avoid this comparison if for example the restarts are
! made from a run with a different mask_table than the current run,
! in which case the checksums will not match and cause crash.
! === module MOM_tracer_flow_control ===
USE_USER_TRACER_EXAMPLE = False ! [Boolean] default = False
! If true, use the USER_tracer_example tracer package.
USE_DOME_TRACER = False ! [Boolean] default = False
! If true, use the DOME_tracer tracer package.
USE_ISOMIP_TRACER = False ! [Boolean] default = False
! If true, use the ISOMIP_tracer tracer package.
USE_IDEAL_AGE_TRACER = False ! [Boolean] default = False
! If true, use the ideal_age_example tracer package.
USE_REGIONAL_DYES = False ! [Boolean] default = False
! If true, use the regional_dyes tracer package.
USE_OIL_TRACER = False ! [Boolean] default = False
! If true, use the oil_tracer tracer package.
USE_ADVECTION_TEST_TRACER = False ! [Boolean] default = False
! If true, use the advection_test_tracer tracer package.
USE_OCMIP2_CFC = False ! [Boolean] default = False
! If true, use the MOM_OCMIP2_CFC tracer package.
USE_generic_tracer = False ! [Boolean] default = False
! If true and _USE_GENERIC_TRACER is defined as a
! preprocessor macro, use the MOM_generic_tracer packages.
USE_PSEUDO_SALT_TRACER = False ! [Boolean] default = False
! If true, use the pseudo salt tracer, typically run as a diagnostic.
USE_BOUNDARY_IMPULSE_TRACER = False ! [Boolean] default = False
! If true, use the boundary impulse tracer.
USE_DYED_OBC_TRACER = False ! [Boolean] default = False
! If true, use the dyed_obc_tracer tracer package.
! === module MOM_coord_initialization ===
COORD_CONFIG = "file" !
! This specifies how layers are to be defined:
! ALE or none - used to avoid defining layers in ALE mode
! file - read coordinate information from the file
! specified by (COORD_FILE).
! BFB - Custom coords for buoyancy-forced basin case
! based on SST_S, T_BOT and DRHO_DT.
! linear - linear based on interfaces not layers
! layer_ref - linear based on layer densities
! ts_ref - use reference temperature and salinity
! ts_range - use range of temperature and salinity
! (T_REF and S_REF) to determine surface density
! and GINT calculate internal densities.
! gprime - use reference density (RHO_0) for surface
! density and GINT calculate internal densities.
! ts_profile - use temperature and salinity profiles
! (read from COORD_FILE) to set layer densities.
! USER - call a user modified routine.
GFS = 9.8 ! [m s-2] default = 9.8
! The reduced gravity at the free surface.
COORD_FILE = "coordinate8a.nc" !
! The file from which the coordinate densities are read.
COORD_VAR = "Layer" ! default = "Layer"
! The variable in COORD_FILE that is to be used for the
! coordinate densities.
! === module MOM_grid ===
! Parameters providing information about the lateral grid.
! === module MOM_state_initialization ===
SPONGE = True ! [Boolean] default = False
! If true, sponges may be applied anywhere in the domain.
! The exact location and properties of those sponges are
! specified via SPONGE_CONFIG.
SPONGE_CONFIG = "channel6" ! default = "file"
! A string that sets how the sponges are configured:
! file - read sponge properties from the file
! specified by (SPONGE_FILE).
! ISOMIP - apply ale sponge in the ISOMIP case
! DOME - use a slope and channel configuration for the
! DOME sill-overflow test case.
! BFB - Sponge at the southern boundary of the domain
! channel6 - Sponge at the northern boundary of the domain:
! determined by old shoebox simulation with k_GM=700,
! symmetric buoyancy and asymmetric wind across the equator.
! No artificially deepened mixed layer.
! channel5 - similar to channel6 but the stratification is
! determined by a new shoebox simulation with no topography
! in the Southern Ocean and with Visbeck parameterization.
! channel4 - similar to channel6 but the stratification is
! determined by a new shoebox simulation with TMEKE parameterization,
! asymmetric buoyancy and symmetric wind across the equator.
! It also uses an artificially deepened surface mixed layer.
! USER - call a user modified routine.
SPONGE_RATE = 1.653439153439153E-06 ! [s-1] default = 1.157407407407407E-06
! The rate at which the zonal-mean sponges damp.
!Total sponge columns = 60 !
! The total number of columns where sponges are applied.
! === module MOM_diag_mediator ===
NUM_DIAG_COORDS = 1 ! default = 1
! The number of diagnostic vertical coordinates to use.
! For each coordinate, an entry in DIAG_COORDS must be provided.
DIAG_COORDS = "z Z ZSTAR" ! default = "z Z ZSTAR"
! A list of string tuples associating diag_table modules to
! a coordinate definition used for diagnostics. Each string
! is of the form "MODULE_SUFFIX PARAMETER_SUFFIX COORDINATE_NAME".
DIAG_MISVAL = 1.0E+20 ! [not defined] default = 1.0E+20
! Set the default missing value to use for diagnostics.
DIAG_AS_CHKSUM = False ! [Boolean] default = False
! Instead of writing diagnostics to the diag manager, write
! a textfile containing the checksum (bitcount) of the array.
AVAILABLE_DIAGS_FILE = "available_diags.000000" ! default = "available_diags.000000"
! A file into which to write a list of all available
! ocean diagnostics that can be included in a diag_table.
DIAG_COORD_DEF_Z = "WOA09" ! default = "WOA09"
! Determines how to specify the coordinate
! resolution. Valid options are:
! PARAM - use the vector-parameter DIAG_COORD_RES_Z
! UNIFORM[:N] - uniformly distributed
! FILE:string - read from a file. The string specifies
! the filename and variable name, separated
! by a comma or space, e.g. FILE:lev.nc,dz
! or FILE:lev.nc,interfaces=zw
! WOA09[:N] - the WOA09 vertical grid (approximately)
! FNC1:string - FNC1:dz_min,H_total,power,precision
! HYBRID:string - read from a file. The string specifies
! the filename and two variable names, separated
! by a comma or space, for sigma-2 and dz. e.g.
! HYBRID:vgrid.nc,sigma2,dz
! === module MOM_MEKE ===
USE_MEKE = True ! [Boolean] default = False
! If true, turns on the MEKE scheme which calculates
! a sub-grid mesoscale eddy kinetic energy budget.
MEKE_DAMPING = 0.0 ! [s-1] default = 0.0
! The local depth-indepented MEKE dissipation rate.
MEKE_CD_SCALE = 0.0 ! [nondim] default = 0.0
! The ratio of the bottom eddy velocity to the column mean
! eddy velocity, i.e. sqrt(2*MEKE). This should be less than 1
! to account for the surface intensification of MEKE.
MEKE_CB = 25.0 ! [nondim] default = 25.0
! A coefficient in the expression for the ratio of bottom projected
! eddy energy and mean column energy (see Jansen et al. 2015).
MEKE_MIN_GAMMA2 = 1.0E-04 ! [nondim] default = 1.0E-04
! The minimum allowed value of gamma_b^2.
MEKE_CT = 50.0 ! [nondim] default = 50.0
! A coefficient in the expression for the ratio of barotropic
! eddy energy and mean column energy (see Jansen et al. 2015).
MEKE_GMCOEFF = 1.0 ! [nondim] default = -1.0
! The efficiency of the conversion of potential energy
! into MEKE by the thickness mixing parameterization.
! If MEKE_GMCOEFF is negative, this conversion is not
! used or calculated.
MEKE_FRCOEFF = -1.0 ! [nondim] default = -1.0
! The efficiency of the conversion of mean energy into
! MEKE. If MEKE_FRCOEFF is negative, this conversion
! is not used or calculated.
MEKE_BGSRC = 0.0 ! [W kg-1] default = 0.0
! A background energy source for MEKE.
MEKE_KH = 1000.0 ! [m2 s-1] default = -1.0
! A background lateral diffusivity of MEKE.
! Use a negative value to not apply lateral diffusion to MEKE.
MEKE_K4 = 0.0 ! [m4 s-1] default = -1.0
! A lateral bi-harmonic diffusivity of MEKE.
! Use a negative value to not apply bi-harmonic diffusion to MEKE.
MEKE_DTSCALE = 1.0 ! [nondim] default = 1.0
! A scaling factor to accelerate the time evolution of MEKE.
MEKE_KHCOEFF = 1.0 ! [nondim] default = 1.0
! A scaling factor in the expression for eddy diffusivity
! which is otherwise proportional to the MEKE velocity-
! scale times an eddy mixing-length. This factor
! must be >0 for MEKE to contribute to the thickness/
! and tracer diffusivity in the rest of the model.
MEKE_USCALE = 0.0 ! [m s-1] default = 0.0
! The background velocity that is combined with MEKE to
! calculate the bottom drag.
MEKE_VISC_DRAG = True ! [Boolean] default = True
! If true, use the vertvisc_type to calculate the bottom
! drag acting on MEKE.
MEKE_KHTH_FAC = 1.0 ! [nondim] default = 0.0
! A factor that maps MEKE%Kh to KhTh.
MEKE_KHTR_FAC = 0.0 ! [nondim] default = 0.0
! A factor that maps MEKE%Kh to KhTr.
MEKE_KHMEKE_FAC = 0.0 ! [nondim] default = 0.0
! A factor that maps MEKE%Kh to Kh for MEKE itself.
MEKE_OLD_LSCALE = False ! [Boolean] default = False
! If true, use the old formula for length scale which is
! a function of grid spacing and deformation radius.
MEKE_RD_MAX_SCALE = False ! [nondim] default = False
! If true, the length scale used by MEKE is the minimum of
! the deformation radius or grid-spacing. Only used if
! MEKE_OLD_LSCALE=True
MEKE_VISCOSITY_COEFF = 0.0 ! [nondim] default = 0.0
! If non-zero, is the scaling coefficient in the expression for
! viscosity used to parameterize lateral momentum mixing by
! unresolved eddies represented by MEKE. Can be negative to
! represent backscatter from the unresolved eddies.
MEKE_FIXED_MIXING_LENGTH = 0.0 ! [m] default = 0.0
! If positive, is a fixed length contribution to the expression
! for mixing length used in MEKE-derived diffusiviity.
MEKE_ALPHA_DEFORM = 0.0 ! [nondim] default = 0.0
! If positive, is a coefficient weighting the deformation scale
! in the expression for mixing length used in MEKE-derived diffusiviity.
MEKE_ALPHA_RHINES = 0.12 ! [nondim] default = 0.05
! If positive, is a coefficient weighting the Rhines scale
! in the expression for mixing length used in MEKE-derived diffusiviity.
MEKE_ALPHA_EADY = 0.12 ! [nondim] default = 0.05
! If positive, is a coefficient weighting the Eady length scale
! in the expression for mixing length used in MEKE-derived diffusiviity.
MEKE_ALPHA_FRICT = 0.0 ! [nondim] default = 0.0
! If positive, is a coefficient weighting the frictional arrest scale
! in the expression for mixing length used in MEKE-derived diffusiviity.
MEKE_ALPHA_GRID = 0.12 ! [nondim] default = 0.0
! If positive, is a coefficient weighting the grid-spacing as a scale
! in the expression for mixing length used in MEKE-derived diffusiviity.
MEKE_COLD_START = False ! [Boolean] default = False
! If true, initialize EKE to zero. Otherwise a local equilibrium solution
! is used as an initial condition for EKE.
MEKE_BACKSCAT_RO_C = 0.0 ! [nondim] default = 0.0
! The coefficient in the Rossby number function for scaling the buharmonic
! frictional energy source. Setting to non-zero enables the Rossby number function.
MEKE_BACKSCAT_RO_POW = 0.0 ! [nondim] default = 0.0
! The power in the Rossby number function for scaling the biharmomnic
! frictional energy source.
MEKE_ADVECTION_FACTOR = 0.0 ! [nondim] default = 0.0
! A scale factor in front of advection of eddy energy. Zero turns advection off.
! Using unity would be normal but other values could accomodate a mismatch
! between the advecting barotropic flow and the vertical structure of MEKE.
MEKE_TOPOGRAPHIC_BETA = 1.0 ! [nondim] default = 0.0
! A scale factor to determine how much topographic beta is weighed in computing beta in the expression of Rhines scale. Use 1 if full topographic beta effect is considered; use 0 if it's completely ignored.
CDRAG = 0.003 ! [nondim] default = 0.003
! CDRAG is the drag coefficient relating the magnitude of
! the velocity field to the bottom stress.
! === module MOM_lateral_mixing_coeffs ===
USE_VARIABLE_MIXING = True ! [Boolean] default = False
! If true, the variable mixing code will be called. This
! allows diagnostics to be created even if the scheme is
! not used. If KHTR_SLOPE_CFF>0 or KhTh_Slope_Cff>0,
! this is set to true regardless of what is in the
! parameter file.
RESOLN_SCALED_KH = False ! [Boolean] default = False
! If true, the Laplacian lateral viscosity is scaled away
! when the first baroclinic deformation radius is well
! resolved.
RESOLN_SCALED_KHTH = False ! [Boolean] default = False
! If true, the interface depth diffusivity is scaled away
! when the first baroclinic deformation radius is well
! resolved.
RESOLN_SCALED_KHTR = False ! [Boolean] default = False
! If true, the epipycnal tracer diffusivity is scaled
! away when the first baroclinic deformation radius is
! well resolved.
RESOLN_USE_EBT = False ! [Boolean] default = False
! If true, uses the equivalent barotropic wave speed instead
! of first baroclinic wave for calculating the resolution fn.
KHTH_USE_EBT_STRUCT = False ! [Boolean] default = False
! If true, uses the equivalent barotropic structure
! as the vertical structure of thickness diffusivity.
KHTH_SLOPE_CFF = 0.0 ! [nondim] default = 0.0
! The nondimensional coefficient in the Visbeck formula
! for the interface depth diffusivity
KHTR_SLOPE_CFF = 0.0 ! [nondim] default = 0.0
! The nondimensional coefficient in the Visbeck formula
! for the epipycnal tracer diffusivity
USE_STORED_SLOPES = False ! [Boolean] default = False
! If true, the isopycnal slopes are calculated once and
! stored for re-use. This uses more memory but avoids calling
! the equation of state more times than should be necessary.
VARMIX_KTOP = 2 ! [nondim] default = 2
! The layer number at which to start vertical integration
! of S*N for purposes of finding the Eady growth rate.
! === module MOM_set_visc ===
BOTTOMDRAGLAW = True ! [Boolean] default = True
! If true, the bottom stress is calculated with a drag
! law of the form c_drag*|u|*u. The velocity magnitude
! may be an assumed value or it may be based on the
! actual velocity in the bottommost HBBL, depending on
! LINEAR_DRAG.
CHANNEL_DRAG = False ! [Boolean] default = False
! If true, the bottom drag is exerted directly on each
! layer proportional to the fraction of the bottom it
! overlies.
LINEAR_DRAG = False ! [Boolean] default = False
! If LINEAR_DRAG and BOTTOMDRAGLAW are defined the drag
! law is cdrag*DRAG_BG_VEL*u.
DOUBLE_DIFFUSION = False ! [Boolean] default = False
! If true, increase diffusivitives for temperature or salt
! based on double-diffusive paramaterization from MOM4/KPP.
PRANDTL_TURB = 0.0 ! [nondim] default = 1.0
! The turbulent Prandtl number applied to shear
! instability.
DYNAMIC_VISCOUS_ML = True ! [Boolean] default = False
! If true, use a bulk Richardson number criterion to
! determine the mixed layer thickness for viscosity.
BULK_RI_ML_VISC = 0.0 ! [nondim] default = 0.0
! The efficiency with which mean kinetic energy released
! by mechanically forced entrainment of the mixed layer
! is converted to turbulent kinetic energy. By default,
! BULK_RI_ML_VISC = BULK_RI_ML or 0.
TKE_DECAY_VISC = 0.0 ! [nondim] default = 0.0
! TKE_DECAY_VISC relates the vertical rate of decay of
! the TKE available for mechanical entrainment to the
! natural Ekman depth for use in calculating the dynamic
! mixed layer viscosity. By default,
! TKE_DECAY_VISC = TKE_DECAY or 0.
ML_OMEGA_FRAC = 1.0 ! [nondim] default = 0.0
! When setting the decay scale for turbulence, use this
! fraction of the absolute rotation rate blended with the
! local value of f, as sqrt((1-of)*f^2 + of*4*omega^2).
HBBL = 10.0 ! [m]
! The thickness of a bottom boundary layer with a
! viscosity of KVBBL if BOTTOMDRAGLAW is not defined, or
! the thickness over which near-bottom velocities are
! averaged for the drag law if BOTTOMDRAGLAW is defined
! but LINEAR_DRAG is not.
DRAG_BG_VEL = 0.1 ! [m s-1] default = 0.0
! DRAG_BG_VEL is either the assumed bottom velocity (with
! LINEAR_DRAG) or an unresolved velocity that is
! combined with the resolved velocity to estimate the
! velocity magnitude. DRAG_BG_VEL is only used when
! BOTTOMDRAGLAW is defined.
BBL_USE_EOS = False ! [Boolean] default = False
! If true, use the equation of state in determining the
! properties of the bottom boundary layer. Otherwise use
! the layer target potential densities.
BBL_THICK_MIN = 0.1 ! [m] default = 0.0
! The minimum bottom boundary layer thickness that can be
! used with BOTTOMDRAGLAW. This might be
! Kv / (cdrag * drag_bg_vel) to give Kv as the minimum
! near-bottom viscosity.
HTBL_SHELF_MIN = 0.1 ! [m] default = 0.1
! The minimum top boundary layer thickness that can be
! used with BOTTOMDRAGLAW. This might be
! Kv / (cdrag * drag_bg_vel) to give Kv as the minimum
! near-top viscosity.
HTBL_SHELF = 10.0 ! [m] default = 10.0
! The thickness over which near-surface velocities are
! averaged for the drag law under an ice shelf. By
! default this is the same as HBBL
KV = 1.0E-06 ! [m2 s-1]
! The background kinematic viscosity in the interior.
! The molecular value, ~1e-6 m2 s-1, may be used.
ADD_KV_SLOW = False ! [Boolean] default = False
! If true, the background vertical viscosity in the interior
! (i.e., tidal + background + shear + convenction) is addded
! when computing the coupling coefficient. The purpose of this
! flag is to be able to recover previous answers and it will likely
! be removed in the future since this option should always be true.
KV_BBL_MIN = 1.0E-06 ! [m2 s-1] default = 1.0E-06
! The minimum viscosities in the bottom boundary layer.
KV_TBL_MIN = 1.0E-06 ! [m2 s-1] default = 1.0E-06
! The minimum viscosities in the top boundary layer.
TIDES = False ! [Boolean] default = False
! If true, apply tidal momentum forcing.
BE = 0.6 ! [nondim] default = 0.6
! If SPLIT is true, BE determines the relative weighting
! of a 2nd-order Runga-Kutta baroclinic time stepping
! scheme (0.5) and a backward Euler scheme (1) that is
! used for the Coriolis and inertial terms. BE may be
! from 0.5 to 1, but instability may occur near 0.5.
! BE is also applicable if SPLIT is false and USE_RK2
! is true.
BEGW = 0.0 ! [nondim] default = 0.0
! If SPLIT is true, BEGW is a number from 0 to 1 that
! controls the extent to which the treatment of gravity
! waves is forward-backward (0) or simulated backward
! Euler (1). 0 is almost always used.
! If SPLIT is false and USE_RK2 is true, BEGW can be
! between 0 and 0.5 to damp gravity waves.
SPLIT_BOTTOM_STRESS = False ! [Boolean] default = False
! If true, provide the bottom stress calculated by the
! vertical viscosity to the barotropic solver.
BT_USE_LAYER_FLUXES = True ! [Boolean] default = True
! If true, use the summed layered fluxes plus an
! adjustment due to the change in the barotropic velocity
! in the barotropic continuity equation.
! === module MOM_continuity ===
CONTINUITY_SCHEME = "PPM" ! default = "PPM"
! CONTINUITY_SCHEME selects the discretization for the
! continuity solver. The only valid value currently is:
! PPM - use a positive-definite (or monotonic)
! piecewise parabolic reconstruction solver.
! === module MOM_continuity_PPM ===
MONOTONIC_CONTINUITY = False ! [Boolean] default = False
! If true, CONTINUITY_PPM uses the Colella and Woodward
! monotonic limiter. The default (false) is to use a
! simple positive definite limiter.
SIMPLE_2ND_PPM_CONTINUITY = False ! [Boolean] default = False
! If true, CONTINUITY_PPM uses a simple 2nd order
! (arithmetic mean) interpolation of the edge values.
! This may give better PV conservation propterties. While
! it formally reduces the accuracy of the continuity
! solver itself in the strongly advective limit, it does
! not reduce the overall order of accuracy of the dynamic
! core.
UPWIND_1ST_CONTINUITY = False ! [Boolean] default = False
! If true, CONTINUITY_PPM becomes a 1st-order upwind
! continuity solver. This scheme is highly diffusive
! but may be useful for debugging or in single-column
! mode where its minimal stencil is useful.
ETA_TOLERANCE = 1.0E-06 ! [m] default = 1.5E-09
! The tolerance for the differences between the
! barotropic and baroclinic estimates of the sea surface
! height due to the fluxes through each face. The total
! tolerance for SSH is 4 times this value. The default
! is 0.5*NK*ANGSTROM, and this should not be set less x
! than about 10^-15*MAXIMUM_DEPTH.
ETA_TOLERANCE_AUX = 1.0E-06 ! [m] default = 1.0E-06
! The tolerance for free-surface height discrepancies
! between the barotropic solution and the sum of the
! layer thicknesses when calculating the auxiliary
! corrected velocities. By default, this is the same as
! ETA_TOLERANCE, but can be made larger for efficiency.
VELOCITY_TOLERANCE = 0.001 ! [m s-1] default = 3.0E+08
! The tolerance for barotropic velocity discrepancies
! between the barotropic solution and the sum of the
! layer thicknesses.
CONT_PPM_AGGRESS_ADJUST = False ! [Boolean] default = False
! If true, allow the adjusted velocities to have a
! relative CFL change up to 0.5.
CONT_PPM_VOLUME_BASED_CFL = False ! [Boolean] default = False
! If true, use the ratio of the open face lengths to the
! tracer cell areas when estimating CFL numbers. The
! default is set by CONT_PPM_AGGRESS_ADJUST.
CONTINUITY_CFL_LIMIT = 0.5 ! [nondim] default = 0.5
! The maximum CFL of the adjusted velocities.
CONT_PPM_BETTER_ITER = True ! [Boolean] default = True
! If true, stop corrective iterations using a velocity
! based criterion and only stop if the iteration is
! better than all predecessors.
CONT_PPM_USE_VISC_REM_MAX = True ! [Boolean] default = True
! If true, use more appropriate limiting bounds for
! corrections in strongly viscous columns.
CONT_PPM_MARGINAL_FACE_AREAS = True ! [Boolean] default = True
! If true, use the marginal face areas from the continuity
! solver for use as the weights in the barotropic solver.
! Otherwise use the transport averaged areas.
! === module MOM_CoriolisAdv ===
NOSLIP = False ! [Boolean] default = False
! If true, no slip boundary conditions are used; otherwise
! free slip boundary conditions are assumed. The
! implementation of the free slip BCs on a C-grid is much
! cleaner than the no slip BCs. The use of free slip BCs
! is strongly encouraged, and no slip BCs are not used with
! the biharmonic viscosity.
CORIOLIS_EN_DIS = False ! [Boolean] default = False
! If true, two estimates of the thickness fluxes are used
! to estimate the Coriolis term, and the one that
! dissipates energy relative to the other one is used.
CORIOLIS_SCHEME = "SADOURNY75_ENERGY" ! default = "SADOURNY75_ENERGY"
! CORIOLIS_SCHEME selects the discretization for the
! Coriolis terms. Valid values are:
! SADOURNY75_ENERGY - Sadourny, 1975; energy cons.
! ARAKAWA_HSU90 - Arakawa & Hsu, 1990
! SADOURNY75_ENSTRO - Sadourny, 1975; enstrophy cons.
! ARAKAWA_LAMB81 - Arakawa & Lamb, 1981; En. + Enst.
! ARAKAWA_LAMB_BLEND - A blend of Arakawa & Lamb with
! Arakawa & Hsu and Sadourny energy
BOUND_CORIOLIS = True ! [Boolean] default = False
! If true, the Coriolis terms at u-points are bounded by
! the four estimates of (f+rv)v from the four neighboring
! v-points, and similarly at v-points. This option would
! have no effect on the SADOURNY Coriolis scheme if it
! were possible to use centered difference thickness fluxes.
KE_SCHEME = "KE_ARAKAWA" ! default = "KE_ARAKAWA"
! KE_SCHEME selects the discretization for acceleration
! due to the kinetic energy gradient. Valid values are:
! KE_ARAKAWA, KE_SIMPLE_GUDONOV, KE_GUDONOV
PV_ADV_SCHEME = "PV_ADV_CENTERED" ! default = "PV_ADV_CENTERED"
! PV_ADV_SCHEME selects the discretization for PV
! advection. Valid values are:
! PV_ADV_CENTERED - centered (aka Sadourny, 75)
! PV_ADV_UPWIND1 - upwind, first order
! === module MOM_PressureForce ===
ANALYTIC_FV_PGF = True ! [Boolean] default = True
! If true the pressure gradient forces are calculated
! with a finite volume form that analytically integrates
! the equations of state in pressure to avoid any
! possibility of numerical thermobaric instability, as
! described in Adcroft et al., O. Mod. (2008).
! === module MOM_PressureForce_AFV ===
MASS_WEIGHT_IN_PRESSURE_GRADIENT = False ! [Boolean] default = False
! If true, use mass weighting when interpolating T/S for
! integrals near the bathymetry in AFV pressure gradient
! calculations.
RECONSTRUCT_FOR_PRESSURE = False ! [Boolean] default = False
! If True, use vertical reconstruction of T & S within
! the integrals of the FV pressure gradient calculation.
! If False, use the constant-by-layer algorithm.
! The default is set by USE_REGRIDDING.
PRESSURE_RECONSTRUCTION_SCHEME = 1 ! default = 1
! Order of vertical reconstruction of T/S to use in the
! integrals within the FV pressure gradient calculation. 0: PCM or no reconstruction.
! 1: PLM reconstruction.
! 2: PPM reconstruction.
BOUNDARY_EXTRAPOLATION_PRESSURE = True ! [Boolean] default = True
! If true, the reconstruction of T & S for pressure in
! boundary cells is extrapolated, rather than using PCM
! in these cells. If true, the same order polynomial is
! used as is used for the interior cells.
! === module MOM_hor_visc ===
LAPLACIAN = False ! [Boolean] default = False
! If true, use a Laplacian horizontal viscosity.
BIHARMONIC = True ! [Boolean] default = True
! If true, use a biharmonic horizontal viscosity.
! BIHARMONIC may be used with LAPLACIAN.
AH = 0.0 ! [m4 s-1] default = 0.0
! The background biharmonic horizontal viscosity.
AH_VEL_SCALE = 0.05 ! [m s-1] default = 0.0
! The velocity scale which is multiplied by the cube of
! the grid spacing to calculate the biharmonic viscosity.
! The final viscosity is the largest of this scaled
! viscosity, the Smagorinsky and Leith viscosities, and AH.
SMAGORINSKY_AH = True ! [Boolean] default = False
! If true, use a biharmonic Smagorinsky nonlinear eddy
! viscosity.
LEITH_AH = False ! [Boolean] default = False
! If true, use a biharmonic Leith nonlinear eddy
! viscosity.
BOUND_AH = True ! [Boolean] default = True
! If true, the biharmonic coefficient is locally limited
! to be stable.
BETTER_BOUND_AH = True ! [Boolean] default = True
! If true, the biharmonic coefficient is locally limited
! to be stable with a better bounding than just BOUND_AH.
SMAG_BI_CONST = 0.06 ! [nondim] default = 0.0
! The nondimensional biharmonic Smagorinsky constant,
! typically 0.015 - 0.06.
BOUND_CORIOLIS_BIHARM = True ! [Boolean] default = True
! If true use a viscosity that increases with the square
! of the velocity shears, so that the resulting viscous
! drag is of comparable magnitude to the Coriolis terms
! when the velocity differences between adjacent grid
! points is 0.5*BOUND_CORIOLIS_VEL. The default is the
! value of BOUND_CORIOLIS (or false).
BOUND_CORIOLIS_VEL = 100.0 ! [m s-1] default = 100.0
! The velocity scale at which BOUND_CORIOLIS_BIHARM causes
! the biharmonic drag to have comparable magnitude to the
! Coriolis acceleration. The default is set by MAXVEL.
USE_LAND_MASK_FOR_HVISC = False ! [Boolean] default = False
! If true, use Use the land mask for the computation of thicknesses
! at velocity locations. This eliminates the dependence on arbitrary
! values over land or outside of the domain. Default is False in order to
! maintain answers with legacy experiments but should be changed to True
! for new experiments.
HORVISC_BOUND_COEF = 0.8 ! [nondim] default = 0.8
! The nondimensional coefficient of the ratio of the
! viscosity bounds to the theoretical maximum for
! stability without considering other terms.
USE_KH_BG_2D = False ! [Boolean] default = False
! If true, read a file containing 2-d background harmonic
! viscosities. The final viscosity is the maximum of the other terms and this background value.
! === module MOM_vert_friction ===
DIRECT_STRESS = True ! [Boolean] default = False
! If true, the wind stress is distributed over the
! topmost HMIX_STRESS of fluid (like in HYCOM), and KVML
! may be set to a very small value.
HARMONIC_VISC = False ! [Boolean] default = False
! If true, use the harmonic mean thicknesses for
! calculating the vertical viscosity.
HARMONIC_BL_SCALE = 0.0 ! [nondim] default = 0.0
! A scale to determine when water is in the boundary
! layers based solely on harmonic mean thicknesses for
! the purpose of determining the extent to which the
! thicknesses used in the viscosities are upwinded.
HMIX_FIXED = 100.0 ! [m]
! The prescribed depth over which the near-surface
! viscosity and diffusivity are elevated when the bulk
! mixed layer is not used.
HMIX_STRESS = 100.0 ! [m] default = 100.0
! The depth over which the wind stress is applied if
! DIRECT_STRESS is true.
KVML = 0.01 ! [m2 s-1] default = 1.0E-06
! The kinematic viscosity in the mixed layer. A typical
! value is ~1e-2 m2 s-1. KVML is not used if
! BULKMIXEDLAYER is true. The default is set by KV.
MAXVEL = 100.0 ! [m s-1] default = 3.0E+08
! The maximum velocity allowed before the velocity
! components are truncated.
CFL_BASED_TRUNCATIONS = True ! [Boolean] default = True
! If true, base truncations on the CFL number, and not an
! absolute speed.
CFL_TRUNCATE = 0.5 ! [nondim] default = 0.5
! The value of the CFL number that will cause velocity
! components to be truncated; instability can occur past 0.5.
CFL_REPORT = 0.5 ! [nondim] default = 0.5
! The value of the CFL number that causes accelerations
! to be reported; the default is CFL_TRUNCATE.
CFL_TRUNCATE_RAMP_TIME = 0.0 ! [s] default = 0.0
! The time over which the CFL trunction value is ramped
! up at the beginning of the run.
CFL_TRUNCATE_START = 0.0 ! [nondim] default = 0.0
! The start value of the truncation CFL number used when
! ramping up CFL_TRUNC.
STOKES_MIXING_COMBINED = False ! [Boolean] default = False
! Flag to use Stokes drift Mixing via the Lagrangian
! current (Eulerian plus Stokes drift).
! Still needs work and testing, so not recommended for use.
VEL_UNDERFLOW = 0.0 ! [m s-1] default = 0.0
! A negligibly small velocity magnitude below which velocity
! components are set to 0. A reasonable value might be
! 1e-30 m/s, which is less than an Angstrom divided by
! the age of the universe.
! === module MOM_barotropic ===
BOUND_BT_CORRECTION = True ! [Boolean] default = False
! If true, the corrective pseudo mass-fluxes into the
! barotropic solver are limited to values that require
! less than maxCFL_BT_cont to be accommodated.
BT_CONT_CORR_BOUNDS = True ! [Boolean] default = True
! If true, and BOUND_BT_CORRECTION is true, use the
! BT_cont_type variables to set limits determined by
! MAXCFL_BT_CONT on the CFL number of the velocites
! that are likely to be driven by the corrective mass fluxes.
ADJUST_BT_CONT = False ! [Boolean] default = False
! If true, adjust the curve fit to the BT_cont type
! that is used by the barotropic solver to match the
! transport about which the flow is being linearized.
GRADUAL_BT_ICS = False ! [Boolean] default = False
! If true, adjust the initial conditions for the
! barotropic solver to the values from the layered
! solution over a whole timestep instead of instantly.
! This is a decent approximation to the inclusion of
! sum(u dh_dt) while also correcting for truncation errors.
BT_USE_VISC_REM_U_UH0 = False ! [Boolean] default = False
! If true, use the viscous remnants when estimating the
! barotropic velocities that were used to calculate uh0
! and vh0. False is probably the better choice.
USE_BT_CONT_TYPE = True ! [Boolean] default = True
! If true, use a structure with elements that describe
! effective face areas from the summed continuity solver
! as a function the barotropic flow in coupling between
! the barotropic and baroclinic flow. This is only used
! if SPLIT is true.
NONLINEAR_BT_CONTINUITY = True ! [Boolean] default = False
! If true, use nonlinear transports in the barotropic
! continuity equation. This does not apply if
! USE_BT_CONT_TYPE is true.
NONLIN_BT_CONT_UPDATE_PERIOD = 1 ! [nondim] default = 1
! If NONLINEAR_BT_CONTINUITY is true, this is the number
! of barotropic time steps between updates to the face
! areas, or 0 to update only before the barotropic stepping.
BT_PROJECT_VELOCITY = True ! [Boolean] default = False
! If true, step the barotropic velocity first and project
! out the velocity tendancy by 1+BEBT when calculating the
! transport. The default (false) is to use a predictor
! continuity step to find the pressure field, and then
! to do a corrector continuity step using a weighted
! average of the old and new velocities, with weights
! of (1-BEBT) and BEBT.
DYNAMIC_SURFACE_PRESSURE = False ! [Boolean] default = False
! If true, add a dynamic pressure due to a viscous ice
! shelf, for instance.
SADOURNY = True ! [Boolean] default = True
! If true, the Coriolis terms are discretized with the
! Sadourny (1975) energy conserving scheme, otherwise
! the Arakawa & Hsu scheme is used. If the internal
! deformation radius is not resolved, the Sadourny scheme
! should probably be used.
BT_THICK_SCHEME = "FROM_BT_CONT" ! default = "FROM_BT_CONT"
! A string describing the scheme that is used to set the
! open face areas used for barotropic transport and the
! relative weights of the accelerations. Valid values are:
! ARITHMETIC - arithmetic mean layer thicknesses
! HARMONIC - harmonic mean layer thicknesses
! HYBRID (the default) - use arithmetic means for
! layers above the shallowest bottom, the harmonic
! mean for layers below, and a weighted average for
! layers that straddle that depth
! FROM_BT_CONT - use the average thicknesses kept
! in the h_u and h_v fields of the BT_cont_type
BT_STRONG_DRAG = False ! [Boolean] default = False
! If true, use a stronger estimate of the retarding
! effects of strong bottom drag, by making it implicit
! with the barotropic time-step instead of implicit with
! the baroclinic time-step and dividing by the number of
! barotropic steps.
BT_LINEAR_WAVE_DRAG = False ! [Boolean] default = False
! If true, apply a linear drag to the barotropic velocities,
! using rates set by lin_drag_u & _vdivided by the depth of
! the ocean. This was introduced to facilitate tide modeling.
CLIP_BT_VELOCITY = False ! [Boolean] default = False
! If true, limit any velocity components that exceed
! CFL_TRUNCATE. This should only be used as a desperate
! debugging measure.
MAXCFL_BT_CONT = 0.25 ! [nondim] default = 0.25
! The maximum permitted CFL number associated with the
! barotropic accelerations from the summed velocities
! times the time-derivatives of thicknesses.
DT_BT_FILTER = -0.25 ! [sec or nondim] default = -0.25
! A time-scale over which the barotropic mode solutions
! are filtered, in seconds if positive, or as a fraction
! of DT if negative. When used this can never be taken to
! be longer than 2*dt. Set this to 0 to apply no filtering.
G_BT_EXTRA = 0.0 ! [nondim] default = 0.0
! A nondimensional factor by which gtot is enhanced.
SSH_EXTRA = 10.0 ! [m] default = 10.0
! An estimate of how much higher SSH might get, for use
! in calculating the safe external wave speed. The
! default is the minimum of 10 m or 5% of MAXIMUM_DEPTH.
BEBT = 0.2 ! [nondim] default = 0.1
! BEBT determines whether the barotropic time stepping
! uses the forward-backward time-stepping scheme or a
! backward Euler scheme. BEBT is valid in the range from
! 0 (for a forward-backward treatment of nonrotating
! gravity waves) to 1 (for a backward Euler treatment).
! In practice, BEBT must be greater than about 0.05.
DTBT = -0.95 ! [s or nondim] default = -0.98
! The barotropic time step, in s. DTBT is only used with