-
Notifications
You must be signed in to change notification settings - Fork 118
/
fv_arrays.F90
2225 lines (1911 loc) · 116 KB
/
fv_arrays.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
!***********************************************************************
!* GNU Lesser General Public License
!*
!* This file is part of the FV3 dynamical core.
!*
!* The FV3 dynamical core is free software: you can redistribute it
!* and/or modify it under the terms of the
!* GNU Lesser General Public License as published by the
!* Free Software Foundation, either version 3 of the License, or
!* (at your option) any later version.
!*
!* The FV3 dynamical core is distributed in the hope that it will be
!* useful, but WITHOUT ANYWARRANTY; without even the implied warranty
!* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
!* See the GNU General Public License for more details.
!*
!* You should have received a copy of the GNU Lesser General Public
!* License along with the FV3 dynamical core.
!* If not, see <http://www.gnu.org/licenses/>.
!***********************************************************************
!>@brief The module 'fv_arrays' contains the 'fv_atmos_type' and associated
!! datatypes
module fv_arrays_mod
#include <fms_platform.h>
use mpp_domains_mod, only: domain2d
use fms2_io_mod, only: FmsNetcdfFile_t, FmsNetcdfDomainFile_t
use time_manager_mod, only: time_type
use horiz_interp_type_mod, only: horiz_interp_type
use mpp_mod, only: mpp_broadcast
use platform_mod, only: r8_kind
public
integer, public, parameter :: R_GRID = r8_kind
!Several 'auxiliary' structures are introduced here. These are for
! the internal use by certain modules, and although fv_atmos_type
! contains one of each of these structures all memory management
! is performed by the module in question.
integer, parameter:: max_step = 1000
!--- MAY NEED TO TEST THIS
#ifdef OVERLOAD_R4
real, parameter:: real_big = 1.e8 ! big enough to cause blowup if used
#else
real, parameter:: real_big = 1.e30 ! big enough to cause blowup if used
#endif
!This is now exclusively for fields that need to be available outside of fv_diagnostics
type fv_diag_type
real, allocatable :: zxg(:,:)
integer :: id_u_dt_sg, id_v_dt_sg, id_t_dt_sg, id_qv_dt_sg
integer :: id_ws, id_te, id_amdt, id_mdt, id_divg, id_aam
logical :: initialized = .false.
real sphum, liq_wat, ice_wat ! GFDL physics
real rainwat, snowwat, graupel, hailwat
real :: efx(max_step), efx_sum, efx_nest(max_step), efx_sum_nest, mtq(max_step), mtq_sum
integer :: steps
end type fv_diag_type
!>@brief The type 'fv_grid_type' is made up of grid-dependent information from fv_grid_tools and fv_grid_utils.
!>@details It should not contain any user options (that goes in a different structure) nor data which
!! is altered outside of those two modules.
type fv_grid_type
real(kind=R_GRID), allocatable, dimension(:,:,:) :: grid_64, agrid_64
real(kind=R_GRID), allocatable, dimension(:,:) :: area_64, area_c_64
real(kind=R_GRID), allocatable, dimension(:,:) :: sina_64, cosa_64
real(kind=R_GRID), allocatable, dimension(:,:) :: dx_64, dy_64
real(kind=R_GRID), allocatable, dimension(:,:) :: dxc_64, dyc_64
real(kind=R_GRID), allocatable, dimension(:,:) :: dxa_64, dya_64
real, allocatable, dimension(:,:,:) :: grid, agrid
real, allocatable, dimension(:,:) :: area, area_c
real, allocatable, dimension(:,:) :: rarea, rarea_c
real, allocatable, dimension(:,:) :: sina, cosa
real, allocatable, dimension(:,:,:) :: e1,e2
real, allocatable, dimension(:,:) :: dx, dy
real, allocatable, dimension(:,:) :: dxc, dyc
real, allocatable, dimension(:,:) :: dxa, dya
real, allocatable, dimension(:,:) :: rdx, rdy
real, allocatable, dimension(:,:) :: rdxc, rdyc
real, allocatable, dimension(:,:) :: rdxa, rdya
! MOLECULAR_DIFFUSION
real(kind=R_GRID), allocatable, dimension(:,:) :: area_u_64, area_v_64
real(kind=R_GRID), allocatable, dimension(:,:) :: dx6_64, dy6_64
real, allocatable, dimension(:,:) :: area_u, area_v
real, allocatable, dimension(:,:) :: rarea_u, rarea_v
real, allocatable, dimension(:,:) :: dx6, dy6
real, allocatable, dimension(:,:) :: rdx6, rdy6
real, allocatable, dimension(:,:) :: sina_6
real, allocatable, dimension(:,:) :: delu_6, delv_6
real, allocatable, dimension(:,:) :: delu_5, delv_5
! Scalars:
real(kind=R_GRID), allocatable :: edge_s(:)
real(kind=R_GRID), allocatable :: edge_n(:)
real(kind=R_GRID), allocatable :: edge_w(:)
real(kind=R_GRID), allocatable :: edge_e(:)
! Vector:
real(kind=R_GRID), allocatable :: edge_vect_s(:)
real(kind=R_GRID), allocatable :: edge_vect_n(:)
real(kind=R_GRID), allocatable :: edge_vect_w(:)
real(kind=R_GRID), allocatable :: edge_vect_e(:)
! scalar:
real(kind=R_GRID), allocatable :: ex_s(:)
real(kind=R_GRID), allocatable :: ex_n(:)
real(kind=R_GRID), allocatable :: ex_w(:)
real(kind=R_GRID), allocatable :: ex_e(:)
real, allocatable :: l2c_u(:,:), l2c_v(:,:)
! divergence Damping:
real, allocatable :: divg_u(:,:), divg_v(:,:) !
! del6 diffusion:
real, allocatable :: del6_u(:,:), del6_v(:,:) !
! Cubed_2_latlon:
real, allocatable :: a11(:,:)
real, allocatable :: a12(:,:)
real, allocatable :: a21(:,:)
real, allocatable :: a22(:,:)
! latlon_2_cubed:
real, allocatable :: z11(:,:)
real, allocatable :: z12(:,:)
real, allocatable :: z21(:,:)
real, allocatable :: z22(:,:)
! real, allocatable :: w00(:,:)
real, allocatable :: cosa_u(:,:)
real, allocatable :: cosa_v(:,:)
real, allocatable :: cosa_s(:,:)
real, allocatable :: sina_u(:,:)
real, allocatable :: sina_v(:,:)
real, allocatable :: rsin_u(:,:)
real, allocatable :: rsin_v(:,:)
real, allocatable :: rsina(:,:)
real, allocatable :: rsin2(:,:)
real(kind=R_GRID), allocatable :: ee1(:,:,:)
real(kind=R_GRID), allocatable :: ee2(:,:,:)
real(kind=R_GRID), allocatable :: ec1(:,:,:)
real(kind=R_GRID), allocatable :: ec2(:,:,:)
real(kind=R_GRID), allocatable :: ew(:,:,:,:)
real(kind=R_GRID), allocatable :: es(:,:,:,:)
!- 3D Super grid to contain all geometrical factors --
! the 3rd dimension is 9
real, allocatable :: sin_sg(:,:,:)
real, allocatable :: cos_sg(:,:,:)
!--------------------------------------------------
! Unit Normal vectors at cell edges:
real(kind=R_GRID), allocatable :: en1(:,:,:)
real(kind=R_GRID), allocatable :: en2(:,:,:)
! Extended Cubed cross-edge winds
real, allocatable :: eww(:,:)
real, allocatable :: ess(:,:)
! Unit vectors for lat-lon grid
real(kind=R_GRID), allocatable :: vlon(:,:,:), vlat(:,:,:)
real, allocatable :: fC(:,:), f0(:,:)
integer, dimension(:,:,:), allocatable :: iinta, jinta, iintb, jintb
!Scalar data
integer :: npx_g, npy_g, ntiles_g ! global domain
real(kind=R_GRID) :: global_area
logical :: g_sum_initialized = .false. !< Not currently used but can be useful
logical:: sw_corner = .false., se_corner = .false., ne_corner = .false., nw_corner = .false.
real(kind=R_GRID) :: da_min, da_max, da_min_c, da_max_c
real :: acapN, acapS
real :: globalarea !< total Global Area
logical :: latlon = .false.
logical :: cubed_sphere = .false.
logical :: have_south_pole = .false.
logical :: have_north_pole = .false.
logical :: stretched_grid = .false.
logical :: square_domain = .false.
!! Convenience pointers
integer, pointer :: grid_type !< Which type of grid to use. If 0, the equidistant gnomonic
!< cubed-sphere will be used. If 4, a doubly-periodic
!< f-plane cartesian grid will be used. If 5, a user-defined
!< orthogonal grid will be used. If -1, the grid is read
!< from INPUT/grid_spec.nc. Values 2, 3, 5, 6, and 7 are not
!< supported and will likely not run. The default value is 0.
logical, pointer :: nested !< Whether this is a nested grid. .false. by default.
logical, pointer :: regional !< Is this a (stand-alone) limited area regional domain?
logical :: bounded_domain !< Is this a regional or nested domain?
end type fv_grid_type
type fv_flags_type
!! FOR EACH VARIABLE IN FV_FLAGS:
!! 1. Must be defined here:
!! 2. Must be broadcast in fv_atmos_data
!! 3. If a namelist entry, a pointer must
!! be defined and associated in fv_control
!! 4. Must NOT appear in fv_current_grid_mod.
!! (this module will soon be removed)
!! 5. Must be referenced through Atm%flagstruct,
!! not Atm%, unless a convenience
!! pointer is defined
!-----------------------------------------------------------------------
! Grid descriptor file setup
!-----------------------------------------------------------------------
character(len=16) :: restart_resolution = 'both'
character(len=80) :: grid_name = 'Gnomonic'
character(len=120):: grid_file = 'Inline'
integer :: grid_type = 0 !< -1: read from file; 0: ED Gnomonic
! !< 0: the "true" equal-distance Gnomonic grid
! !< 1: the traditional equal-distance Gnomonic grid
! !< 2: the equal-angular Gnomonic grid
! !< 3: the lat-lon grid -- to be implemented
! !< 4: double periodic boundary condition on Cartesian grid
! !< 5: a user-defined orthogonal grid for stand alone regional model
! -> moved to grid_tools
!> Momentum (or KE) options:
integer :: hord_mt = 10 !< Horizontal advection scheme for momentum fluxes. A
!< complete list of kord options is given in the
!< corresponding table in Appendix A of the
!< FV3 technical document. The default value is 10, which
!< uses the third-order piecewise-parabolic method with the
!< monotonicity constraint of Huynh, which is less diffusive
!< but more expensive than other monotonic constraints. For hydrostatic simulation, 8
!< (the L04 monotonicity constraint) or 10 are recommended; for
!< nonhydrostatic simulation, the completely unlimited (“linear”
!< or non-monotone) PPM scheme is recommended. If no monotonicity
!< constraint is applied, enabling the flux damping
!< (do_vort_damp = .true.) is highly recommended to control grid-scale
!< noise. It is also recommended that hord_mt, hord_vt, hord_tm, and
!< hord_dp use the same value, to ensure consistent transport of all
!< dynamical fields, unless a positivity constraint on mass advection
!< (hord_dp) is desired.
integer :: kord_mt = 8 !< Vertical remapping scheme for the winds. 8 by default; 9 is recommended as
!< the safest option, although 10, and 11 can also be useful. See
!< corresponding table in Appendix A of the FV3
!< technical document for a complete list of kord options.
integer :: kord_wz = 8 !< Vertical remapping scheme for vertical velocity in nonhydrostatic simulations.
!< 8 by default; 9 recommended. It is also recommended to use the same value
!< for 'kord_wz' as for 'kord_mt'.
!> Vorticity & w transport options:
integer :: hord_vt = 10 !< Horizontal advection scheme for absolute vorticity and for
!< vertical velocity in nonhydrostatic simulations. 10 by default.
!> Heat & air mass (delp) transport options:
integer :: hord_tm = 10 !< Horizontal advection scheme for potential temperature and
!< layer thickness in nonhydrostatic simulations. 10 by default.
integer :: hord_dp = 10 !< Horizontal advection scheme for mass. A positivity
!< constraint may be warranted for hord_dp but not strictly
!< necessary. 10 by default.
integer :: kord_tm =-8 !< Vertical remapping scheme for temperature. If positive
!< (not recommended), then vertical remapping is performed on
!< total energy instead of temperature (see 'remap_t').
!< The default value is -8.
!> Tracer transport options:
integer :: hord_tr = 8 !< Horizontal advection scheme for tracers. The default is 8, for efficiency reasons.
!< This value can differ from the other hord options since
!< tracers are subcycled (if inline_q == .false.) and require
!< positive-definite advection to control the appearance of
!< non-physical negative masses. 8 (fastest) or 10 (least diffusive)
!< are typically recommended.
integer :: kord_tr = 8 !< The vertical remapping scheme for tracers. The default is 8.
!< 9 or 11 recommended. It is often recommended to use the same
!< value for 'kord_tr' as for 'kord_tm'.
real :: scale_z = 0. !< diff_z = scale_z**2 * 0.25 (only used for Riemann solver)
real :: w_max = 75. !< Not used.
real :: z_min = 0.05 !< Not used.
real :: lim_fac = 1.0 !< linear scheme limiting factor when using hord = 1. 1: hord = 5, 3: hord = 6
integer :: nord=1 !< Order of divergence damping: 0 for second-order; 1 for fourth-order
!< (default); 2 for sixth-order; 3 for eighth-order. Sixth-order generally
!< yields the best balance of low diffusivity and better stability; eighth-
!< order is effectively inviscid but may be unstable for some configurations.
integer :: nord_tr=0 !< Order of tracer damping; values mean the same as for 'nord'.
!< The default value is 0. Positivity not guaranteed for nord > 0.
!< (We really don't recommend using tracer damping.)
real :: dddmp = 0.0 !< Dimensionless coefficient for the second-order Smagorinsky-type
!< divergence damping. The default is value is 0.0. 0.2
!< (the Smagorinsky constant) is recommended if ICs are noisy.
real :: d2_bg = 0.0 !< Coefficient for explicit second-order divergence damping.
!< This option remains active even if nord is nonzero. The default
!< value is 0.0. The proper range is 0 to 0.02, with 0 strongly recommended
!< except for LES simulation.
real :: d4_bg = 0.16 !< Dimensionless coefficient for explicit higher-order divergence damping.
!< 0.0 by default. If no second-order divergence damping is used, then values
!< between 0.1 and 0.16 are recommended. Requires 'nord' > 0. Note that the
!< scaling for 'd4_bg' differs from that of 'd2_bg'; 'nord' >= 1 and
!< 'd4_bg' = 0.16 will be less diffusive than 'nord' = 0 and 'd2_bg' = 0.02.
real :: vtdm4 = 0.0 !< Coefficient for explicit other-variable damping. The value of 'vtdm4'
!< should be less than that of 'd4_bg'. A good first guess for 'vtdm4' is
!< about one-third the value of d4_bg. Requires 'do_vort_damp'
!< to be .true. Disabled for values less than 1.e-3. Other-
!< variable damping should not be used if a monotonic horizontal advection
!< scheme is used. The default value is 0.0.
real :: trdm2 = 0.0 !< Coefficient for del-2 tracer damping
real :: d2_bg_k1 = 4. !< Strength of second-order diffusion in the top sponge layer.
!< Value must be specified. This value, and d2_bg_k2, will be changed
!< appropriately in the model (depending on the height of model
!< top), so the actual damping may be very reduced. See
!< atmos_cubed_sphere/model/dyncore.F90 for details. Recommended
!< range is 0. to 0.2. Note that since diffusion is converted to
!< heat if d_con > 0 larger amounts of sponge-layer diffusion may
!< be less stable.
real :: d2_bg_k2 = 2. !< Strength of second-order diffusion in the second sponge
!< layer from the model top. This value must be specified, and
!< should be less than 'd2_bg_k1'.
real :: d2_divg_max_k1 = 0.15 !< d2_divg max value (k=1)
real :: d2_divg_max_k2 = 0.08 !< d2_divg max value (k=2)
real :: damp_k_k1 = 0.2 !< damp_k value (k=1)
real :: damp_k_k2 = 0.12 !< damp_k value (k=2)
!> Additional (after the fact) terrain filter (to further smooth the terrain after cold start)
integer :: n_zs_filter=0 !< Number of times to apply a diffusive filter to the topography
!< upon startup, if mountain is True and the model is not being
!< cold-started. This is applied every time the model is warm-started,
!< so if you want to smooth the topography make sure this is set to 0 after
!< the first simulation. If initializing the model from cold-start
!< the topography is already being filtered by an amount appropriate for
!< the model resolution. 0 by default.
integer :: nord_zs_filter=4 !< Order of the topography filter applied to n_zs_filter.
!< Set to 2 to get a second-order filter, or 4 to get a fourth-order filter;
!< other values do no filtering. 0 by default. This should not be set to a
!< non-zero value on multiple successive simulations; the filter is applied
!< every time the model restarts. This option is useful for testing the
!< terrain filter, and SHOULD NOT BE USED FOR REGULAR RUNS.
!< use del-2 (2) OR del-4 (4)
logical :: full_zs_filter=.false.!< Whether to apply the on-line topography filter during
!< initialization. Only active if get_nggps_ic = .true. This is so
!< topography filtering can be performed on the initial conditions output by the
!< pre-processing tools, which currently do not support topography filter-
!< ing for some configurations (such as the nested grid); this also allows
!< the user to easily test changes to the topography filtering on the
!< simulation. Note that for all other initialization methods (if external_ic
!< = .true.) the on-line topography filter will be applied automatically
!< during the initialization of the topography. The default value is .false.
logical :: RF_fast =.false. !< Option controlling whether to apply Rayleigh damping (for tau > 0)
!< on the dynamic/acoustic timestep rather than on the physics timestep.
!< This can help stabilize the model by applying the damping more weakly
!< more frequently, so the instantaneous amount of damping (and thereby
!< heat added) is reduced. The default is .false., which applies the Rayleigh
!< drag every physics timestep.
logical :: consv_am = .false. !< Whether to enable Angular momentum fixer. The default is .false.
logical :: do_sat_adj= .false. !< Controls split GFDL Microphysics. .false. by default. Must have the same
!< value as do_sat_adj in gfdl_mp_nml. Not compatible with other microphysics
!< schemes. Also requires GFDL microphysics be installed within the physics driver.
logical :: do_inline_mp = .false.!< Controls Inline GFDL cloud microphysics, in which the full microphysics is
!< called entirely within FV3. If .true. disabling microphysics within the physics
!< is very strongly recommended. .false. by default.
logical :: do_f3d = .false. !
logical :: no_dycore = .false. !< Disables execution of the dynamical core, only running
!< the initialization, diagnostic, and I/O routines, and
!< any physics that may be enabled. Essentially turns the
!< model into a column physics model. The default is .false.
logical :: convert_ke = .false. !< If .true., adds energy dissipated through mechanical
!< damping to heat throughout the entire depth of the domain;
!< if .false. (default) this is only done in the sponge layer
!< at the top of the domain. This option is only enabled if
!< d_con > 1.e-5.
logical :: do_vort_damp = .false. !< Whether to apply flux damping (of strength governed by 'vtdm4')
!< to the fluxes of vorticity, air mass, and nonhydrostatic
!< vertical velocity (there is no dynamically correct way to add
!< explicit diffusion to the tracer fluxes). The form is the same
!< as is used for the divergence damping, including the same order
!< (from 'nord') damping, unless 'nord' = 0, in which case this
!< damping is fourth-order, or if 'nord' = 3,in which case this
!< damping is sixth-order (instead of eighth-order). We recommend
!< enabling this damping when the linear or non-monotonic
!< horizontal advection schemes are enabled, but is unnecessary and
!< not recommended when using monotonic advection. The default is .false.
logical :: use_old_omega = .true.
!> PG off centering:
real :: beta = 0.0 !< Parameter specifying fraction of time-off-centering for backwards
!< evaluation of the pressure gradient force. The default is 0.0, which
!< produces a fully backwards evaluation of the pressure gradient force
!< that is entirely evaluated using the updated (time n+1) dynamical fields.
!< A value of 0.5 will equally weight the PGF determined at times n and
!< n+1, but may not be stable; values larger than 0.45 are not recommended.
!< A value of 0.4 is recommended for most hydrostatic simulations, which
!< allows an improved representation of inertia-gravity waves in the tropics.
!< In non-hydrostatic simulations using the semi-implicit solver (a_imp > 0.5)
!< the values of 'a_imp' and 'beta' should add to 1, so that the time-centering is
!< consistent between the PGF and the nonhydrostatic solver.
!< The proper range is 0 to 0.45.
#ifdef SW_DYNAMICS
integer :: n_sponge = 0 !< Controls the number of layers at the upper boundary on
!< which the 2Dx filter is applied. This does not control the sponge layer.
!< The default value is 0.
real :: d_ext = 0. !< Coefficient for external (barotropic) mode damping. The
!< default value is 0.02. The proper range is 0 to 0.02. A value
!< of 0.01 or 0.02 may help improve the models maximum stable
!< time step in low-resolution (2-degree or lower) simulations;
!< otherwise a value of 0 is recommended.
integer :: nwat = 0 !< Number of water species to be included in condensate and
!< water vapor loading. The masses of the first nwattracer species will be
!< added to the dry air mass, so that p is the mass of dry air, water vapor,
!< and the included condensate species. The value used depends on the
!< microphysics in the physics package you are using. For GFS physics
!< with only a single condensate species, set to 2. For schemes with
!< prognostic cloud water and cloud ice, such as GFDL AM2/AM3/AM4
!< Rotsteyn-Klein or Morrison-Gettlean microphysics, set to 3. For
!< warm-rain (Kessler) microphysics set to 4 (with an inactive ice tracer),
!< which only handles three species but uses 4 to avoid interference with the
!< R-K physics. For schemes such as WSM5 or Ferrier that have prognostic rain
!< and snow but not hail, set to 5 (not yet implemented). For six-category
!< schemes that also have prognostic hail or graupel, such as the GFDL, Thompson,
!< or WSM6 microphysics, set to 6. A value of 0 turns off condensate loading.
!< The default value is 3.
logical :: warm_start = .false. !< Whether to start from restart files, instead of cold-starting
!< the model. True by default; if this is set to .true. and restart
!< files cannot be found the model will stop.
logical :: inline_q = .true. !< Whether to compute tracer transport in-line with the rest
!< of the dynamics instead of sub-cycling, so that tracer transport is done
!< at the same time and on the same time step as is p and potential
!< temperature. False by default; if true, q_split and z_tracer are ignored.
logical :: adiabatic = .true. !< Whether to skip any physics. If true, the physics is not
!< called at all and there is no virtual temperature effect.
!< False by default; this option has no effect if not running solo_core.
#else
integer :: n_sponge = 1 !< Controls the number of layers at the upper boundary on which the 2Dx filter
!< is applied. This does not control the sponge layer. The default value is 0.
real :: d_ext = 0.02 !< Coefficient for external (barotropic) mode damping. Proper range is 0 to 0.02.
!< A value of 0.01 or 0.02 may help improve the models maximum stable time
!< step in low-resolution (2-degree or lower) simulations; otherwise a
!< value of 0 is recommended. The default value is 0.02.
integer :: nwat = 3 !< Number of water species to be included in condensate and
!< water vapor loading. The masses of the first nwat tracer species will be
!< added to the dry air mass, so that p is the mass of dry air, water vapor,
!< and the included condensate species. The value used depends on the
!< microphysics in the physics package you are using. For GFS physics
!< with only a single condensate species, set to 2. For schemes with
!< prognostic cloud water and cloud ice, such as GFDL AM2/AM3/AM4
!< Rotsteyn-Klein or Morrison-Gettlean microphysics, set to 3. For
!< warm-rain (Kessler) microphysics set to 4 (with an inactive ice tracer),
!< which only handles three species but uses 4 to avoid interference with the
!< R-K physics. For schemes such as WSM5 or Ferrier that have prognostic rain
!< and snow but not hail, set to 5 (not yet implemented). For six-category
!< schemes that also have prognostic hail or graupel, such as the GFDL, Thompson,
!< or WSM6 microphysics, set to 6. A value of 0 turns off condensate loading.
!< The default value is 3.
logical :: warm_start = .true. !< Whether to start from restart files, instead of cold-starting
!< the model. True by default; if this is set to .true. and restart
!< files cannot be found the model will stop.
logical :: inline_q = .false. !< Whether to compute tracer transport in-line with the rest
!< of the dynamics instead of sub-cycling, so that tracer transport is done
!< at the same time and on the same time step as is p and potential
!< temperature. False by default; if true, q_split and z_tracer are ignored.
logical :: adiabatic = .false. !< Run without physics (full or idealized).
#endif
!-----------------------------------------------------------
! Grid shifting, rotation, and cube transformations:
!-----------------------------------------------------------
real :: shift_fac = 18. !< Westward zonal rotation (or shift) of cubed-sphere grid from
!< its natural orientation with cube face centers at 0, 90, 180, and 270
!< degrees longitude. The shift, in degrees, is 180/shift_fac. This shift
!< does not move the poles. By default this is set to 18, shifting the grid
!< westward 180/18=10 degrees, so that the edges of the cube do not run
!< through the mountains of Japan; all standard CM2.x, AM3, CM3, and
!< HiRAM simulations use this orientation of the grid.
!< Requires do_schmidt = .false.
! Defaults for Schmidt transformation:
logical :: do_schmidt = .false. !< Whether to enable grid stretching and rotation using
!< stretch_fac, target_lat, and target_lon.
!< The default value is .false.
logical :: do_cube_transform = .false. !< alternate version of do_schmidt in which rotation is done from the north pole instead of the south pole. This ensures that the target face (tile 6) has the "conventional" orientation with North at the "top", as opposed to do_schmidt which rotates the south pole to the target and for which tile 6 has North at the "bottom". This will be ignored if do_schmidt = .true.
real(kind=R_GRID) :: stretch_fac = 1. !< Stretching factor for the Schmidt transformation. This
!< is the factor by which tile 6 of the cubed sphere will
!< be shrunk, with the grid size shrinking accordingly.
!< The default value is 1, which performs no grid stretching.
!< Requires do_schmidt =.true.
!< THE MODEL WILL CRASH IF stretch_fac IS SET TO ZERO.
!< Values of up to 40 have been found useful and stable
!< for short-term cloud-scale integrations.
real(kind=R_GRID) :: target_lat = -90. !< Latitude (in degrees) to which the center of tile 6 will be
!< rotated; if stretching is done with stretch_fac the center of
!< the high-resolution part of the grid will be at this latitude.
!< -90 by default, which does no grid rotation (the Schmidt transformation
!< rotates the south pole to the appropriate target).
!< Requires do_schmidt = .true.
real(kind=R_GRID) :: target_lon = 0. !< Longitude to which the center of tile 6 will be rotated.
!< 0 by default. Requires do_schmidt = .true.
!-----------------------------------------------------------------------------------------------
! Example #1a: US regional climate simulation, center located over Oklahoma city: (262.4, 35.4)
! stretching factor: 2.5
! Example #1b: US Hurricane model, center over Miami: (279.7, 25.8)
! stretching factor: 3-5
! Example #2a: South-East Asia Regional Climate H*** (SERACH), Central Taiwan: (121.0, 23.5)
! Example #2b: Typhoon Model: (124.0, 22.0)
! stretching factor: 5-10
!-----------------------------------------------------------------------------------------------
logical :: reset_eta = .false.
logical :: ignore_rst_cksum = .false. !< enfore (.false.) or override (.true.) data integrity restart checksums
real :: p_fac = 0.05 !< Safety factor for minimum nonhydrostatic pressures, which
!< will be limited so the full pressure is no less than p_fac
!< times the hydrostatic pressure. This is only of concern in mid-top
!< or high-top models with very low pressures near the model top, and
!< has no effect in most simulations. The pressure limiting activates
!< only when model is in danger of blowup due to unphysical negative
!< total pressures. Only used if 'hydrostatic' = .false.and the
!< semi-implicit solver is used. The proper range is 0 to 0.25.
!< The default value is 0.05.
real :: a_imp = 0.75 !< Controls behavior of the non-hydrostatic solver. Values > 0.5
!< enable the semi-implicit solver, in which the value of 'a_imp'
!< controls the time-off-centering: use a_imp = 1.0 for a fully
!< backward time stepping. For consistency, the sum of 'beta' and
!< 'a_imp' should be 1 when the semi-implicit solver is used. The
!< semi-implicit algorithm is substantially more efficient except
!< at very high (km-scale) resolutions with an acoustic time step
!< of a few seconds or less. Proper values are 0, or between 0.5
!< and 1. The default value is 0.75. Only used if
!< 'hydrostatic' = .false.
integer :: n_split = 0 !< The number of small dynamics (acoustic) time steps between
!< vertical remapping. 0 by default, in which case the model
!< produces a good first guess by examining the resolution,
!< dt_atmos, and k_split.
real :: fac_n_spl = 1.0 !< factor multiplying n_split up tp forecast hour fhouri
real :: fhouri = 0.0 !< forecast hour up to which the number of small dynamics (acoustic) time steps
!< are nint(n_split*fac_n_spl)
integer :: m_split = 0 !< Number of time splits for Riemann solver
integer :: k_split = 1 !< Number of vertical remappings per dt_atmos (physics timestep).
!< 1 by default.
logical :: use_logp = .false. !< Enables a variant of the Lin pressure-gradient force
!< algorithm, which uses the logarithm of pressure instead
!< of the Exner function (as in \cite lin1997explicit). This yields
!< more accurate results for regions that are nearly isothermal.
!< Ignored if 'hydrostatic' = .true. The default is .false.
! For doubly periodic domain with sim_phys
! 5km 150 20 (7.5 s) 2
!
! Estimates for Gnomonic grids:
!===================================================
! dx (km) dt (sc) n_split m_split
!===================================================
! C1000: ~10 150 16 3
! C2000: ~5 90 18 (5 s) 2
!===================================================
! The nonhydrostatic algorithm is described in Lin 2006, QJ, (submitted)
! C2000 should easily scale to at least 6 * 100 * 100 = 60,000 CPUs
! For a 1024 system: try 6 x 13 * 13 = 1014 CPUs
integer :: q_split = 0 !< number of time steps for sub-cycled tracer advection.
!< The default value is 0 (recommended), in which case
!< the model determines the number of time steps from the
!< global maximum wind speed at each call to the tracer advection.
integer :: print_freq = 0 !< number of hours between print out of max/min and
!< air/tracer mass diagnostics to standard output. 0 by default, which
!< never prints out any output; set to -1 to see output after every
!< dt_at-mos. Computing these diagnostics requires some computational overhead
logical :: write_3d_diags = .true. !< whether to write out three-dimensional dynamical diagnostic
!< fields (those defined in fv_diagnostics.F90). This is useful
!< for runs with multiple grids if you only want very large 3D
!< diagnostics written out for (say) a nested grid, and not for
!< the global grid. False by default.
!------------------------------------------
! Model Domain parameters
!------------------------------------------
integer :: npx !< Number of grid corners in the x-direction on one tile of the domain;
!< so one more than the number of grid cells across a tile. On the cubed sphere
!< this is one more than the number of cells across a cube face. Must be set.
integer :: npy !< Number of grid corners in the y-direction on one tile of the
!< domain. This value should be identical to npx on a cubed-sphere grid;
!< doubly periodic or nested grids do not have this restriction. Must be set.
integer :: npz !< Number of vertical levels. Each choice of npz comes with a
!< pre-defined set of hybrid sigma-pressure levels and model top
!< (see fv_eta.F90). Must be set.
#ifdef USE_GFSL63
character(24) :: npz_type = 'gfs' !< Option for selecting vertical level setup (gfs levels, when available, by default)
#else
character(24) :: npz_type = '' !< Option for selecting vertical level setup (empty by default)
#endif
character(120) :: fv_eta_file = 'global_hyblev_fcst.txt' !< FV3 user specified eta file
integer :: npz_rst = 0 !< If using a restart file with a different number of vertical
!< levels, set npz_rst to be the number of levels in your restart file.
!< The model will then remap the restart file data to the vertical coordinates
!< specified by npz. 0 by default; if 0 or equal to npz no remapping is done.
integer :: ncnst = 0 !< Number of tracer species advected by fv_tracer in the dynamical core.
!< Typically this is set automatically by reading in values from field_table,
!< but ncnst can be set to a smaller value so only the first ncnst tracers
!< listed in field_table are not advected. 0 by default, which will use the value
!< from field_table.
integer :: pnats = 0 !< The number of tracers not to advect by the dynamical core.
!< Unlike dnats, these tracers are not seen by the dynamical core.
!< The last pnats entries in field_table are not advected.
!< The default value is 0.
integer :: dnats = 0 !< The number of tracers which are not to be advected by the dynamical core,
!< but still passed into the dynamical core; the last dnats+pnats tracers
!< in field_table are not advected. 0 by default.
integer :: dnrts = -1 !< Number of non-remapped consituents. Only makes sense for dnrts <= dnats
integer :: ntiles = 1 !< Number of tiles on the domain. For the cubed sphere, this
!< should be 6, one tile for each face of the cubed sphere; normally for
!< most other domains (including nested grids) this should be set to 1.
!< Must be set.
integer :: ndims = 2 !< Lat-Lon Dims for Grid in Radians
integer :: nf_omega = 1 !< Number of times to apply second-order smoothing to the
!< diagnosed omega. When 0 the filter is disabled. 1 by default.
integer :: fv_sg_adj = -1 !< Timescale (in seconds) at which to remove two-delta-z
!< instability when the local (between two adjacent levels)
!< Richardson number is less than 1. This is achieved by local
!< mixing, which conserves mass, momentum, and total energy.
!< Values of 0 or smaller disable this feature. If n_sponge < 0
!< then the mixing is applied only to the top n_sponge layers of the
!< domain. Set to -1 (inactive) by default. The proper range is 0 to 3600.
real :: sg_cutoff = -1 !< cutoff level for fv_sg_adj (2dz filter; overrides n_sponge)
integer :: na_init = 0 !< Number of forward-backward dynamics steps used to initialize
!< adiabatic solver. This is useful for spinning up the nonhydrostatic
!< state from the hydrostatic GFS analyses. 0 by default. Recommended
!< to set this to a non-zero value (1 or 2 is typically sufficient)
!< when initializing from GFS or ECMWF analyses.
logical :: nudge_dz = .false. !< During the adiabatic initialization (na_init > 0), if set
!< to .true., delz is nudged back to the value specified in the initial
!< conditions, instead of nudging the temperature back to the initial value.
!< Nudging delz is simpler (faster), doesn’t require consideration of the
!< virtual temperature effect, and may be more stable. .false.by default.
real :: p_ref = 1.E5 !< Surface pressure used to construct a horizontally-uniform reference
!< vertical pressure profile, used in some simple physics packages
!< in the solo_core and in the Rayleigh damping. This should not be
!< confused with the actual, horizontally-varying pressure levels used
!< for all other dynamical calculations. The default value is 1.e5.
!< CHANGING THIS VALUE IS STRONGLY DISCOURAGED.
real :: dry_mass = 98290. !< If adjust_dry_mass is .true., sets the global dry air mass,
!< measured in the globally-averaged surface pressure (Pascals) by adding
!< or removing mass from the lowest layer of the atmosphere as needed.
!< The default value is 98290. (Pa).
integer :: nt_prog = 0
integer :: nt_phys = 0
real :: tau_h2o = 0. !< Time-scale (days) for simple methane chemistry to act as
!< a source of water in the stratosphere. Can be useful if the
!< stratosphere dries out too quickly; consider a value between
!< 60 and 120 days if this is the case. The default value is 0.,
!< which disables the methane chemistry. Values less than zero apply
!< the chemistry above 100 mb; else applied above 30 mb.
!< Requires 'adiabatic' to be .false.
real :: delt_max = 1. !< Maximum allowed magnitude of the dissipative heating rate, K/s;
!< larger magnitudes are clipped to this amount. This can help avoid
!< instability that can occur due to strong heating when d_con > 0.
!< A value of 0.008 (a rate equivalent to about 800 K/day) is
!< sufficient to stabilize the model at 3-km resolution.
!< Set to 1. by default, which effectively disables this limitation.
real :: d_con = 0. !< Fraction of kinetic energy lost to explicit damping to be
!< converted to heat. Acts as a dissipative heating mechanism in
!< the dynamical core. The default is 0. Proper range is 0 to 1.
!< Note that this is a local, physically correct, energy fixer.
real :: ke_bg = 0. !< background KE production (m^2/s^3) over a small step
!< Use this to conserve total energy if consv_te=0
real :: consv_te = 0. !< Fraction of total energy lost during the adiabatic integration
!< between calls of the physics, to be added backglobally as heat;
!< essentially the strength of the energy fixer in the physics.
!< Note that this is a global energy fixer and cannot add back energy
!< locally. The default algorithm increments the potential temperature
!< so the pressure gradients are unchanged. The default value is 0.
!< Proper range is 0 to 1. 1 will restore the energy completely to its
!< original value before entering the physics; a value of 0.7 roughly
!< causes the energy fixer to compensate for the amount of energy changed
!< by the physics in GFDL HiRAM or AM3.
real :: tau_w = 0. !< Time scale (in days) for Rayleigh friction applied to vertical winds
!< This option allows the vertical and horizontal winds use different time
!< scales for Rayleigh friction. The default value is 0.0, then tau_w=tau,
!< the same time scale appiled to horizontal and vertical winds.
real :: tau = 0. !< Time scale (in days) for Rayleigh friction applied to horizontal
!< and vertical winds; lost kinetic energy is converted to heat, except
!< on nested grids. The default value is 0.0, which disables damping.
!< Larger values yield less damping. For models with tops at 1 mb or lower
!< values between 10 and 30 are useful for preventing overly-strong polar night
!< jets; for higher-top hydrostatic models values between 5 and 15 should be
!< considered; and for non-hydrostatic models values of 10 or less should be
!< considered, with smaller values for higher-resolution.
real :: rf_cutoff = 30.E2 !< Pressure below which no Rayleigh damping is applied if tau > 0.
real :: fast_tau_w_sec = 0.0 !< Time scale (seconds) for Rayleigh damping applied to vertical velocity only.
!< Values of 0.2 are very effective at eliminating spurious vertical motion in
!< the stratosphere. Default is 0.0, which disables this.
logical :: filter_phys = .false.
logical :: dwind_2d = .false. !< Whether to use a simpler & faster algorithm for interpolating
!< the A-grid (cell-centered) wind tendencies computed from the physics
!< to the D-grid. Typically, the A-grid wind tendencies are first
!< converted in 3D cartesian coordinates and then interpolated before
!< converting back to 2D local coordinates. When this option enabled,
!< a much simpler but less accurate 2D interpolation is used. False by
!< default.
logical :: breed_vortex_inline = .false. !< Whether to bogus tropical cyclones into the model,
!< which are specified by an external file. Options are set in
!< fv_nwp_nudge_nml. False by default.
logical :: range_warn = .false. !< Checks whether the values of the prognostic variables
!< are within a reasonable range at the end of a dynamics time
!< step, and prints a warning if not. The default is .false.;
!< adds computational, overhead so we only recommend using
!< this when debugging.
logical :: fill = .false. !< Fills in negative tracer values by taking positive tracers from
!< the cells above and below. This option is useful when the physical
!< parameterizations produced negatives. The default is .false.
logical :: fill_dp = .false. !< Like 'fill' except for p, the hydrostatic pressure thickness.
!< When the filling occurs a diagnostic message is printed out,
!< which is helpful for diagnosing where the problem may be occurring.
!< Typically, a crash is inevitable if the pressure filling is needed;
!< thus, this option is often better for debugging than as a safety valve.
!< The default is .false.
logical :: fill_wz = .false.
logical :: fill_gfs = .true. ! default behavior
logical :: check_negative = .false. !< Whether to print the most negativ global value of microphysical tracers.
logical :: non_ortho = .true.
logical :: moist_phys = .true. !< Run with moist physics
logical :: do_Held_Suarez = .false. !< Whether to use Held-Suarez forcing. Requires adiabatic
!< to be false. The default is .false.; this option has no
!< effect if not running solo_core.
logical :: do_reed_physics = .false.
logical :: reed_cond_only = .false.
logical :: reproduce_sum = .true. !< uses an exactly-reproducible global sum operation performed
!< when computing the global energy for consv_te. This is used
!< because the FMS routine mpp_sum() is not bit-wise reproducible
!< due to its handling of floating-point arithmetic, and so can
!< return different answers for (say) different processor layouts.
!< The default is .true.
logical :: adjust_dry_mass = .false. !< Whether to adjust the global dry-air mass to the
!< value set by dry_mass. This is only done in an initialization step,
!< particularly when using an initial condition from an external dataset,
!< interpolated from another resolution (either horizontal or vertical), or
!< when changing the topography, so that the global mass of the atmosphere
!< matches some estimate of observed value. False by default. It
!< is recommended to only set this to .true. when initializing the model.
logical :: fv_debug = .false. !< Whether to turn on additional diagnostics in fv_dynamics.
!< The default is .false.
logical :: fv_timers = .false. !< Whether to turn on performance metering timers in the dycore and moving nest
!< The default is .false.
logical :: srf_init = .false.
logical :: mountain = .true. !< Takes topography into account when initializing the
!< model. Set this to .true. to apply the terrain filter (if n_zs_filter = 2
!< or 4) upon startup; also set to True when cold starting so that the
!< topography can be initialized. Only set this to .false. if you wish to
!< cold-start without any topography; this value is ignored for the aquaplanet
!< test_case = 14. The default is .true. It is highly recommended TO NOT ALTER
!< this value unless you know what you are doing.
logical :: remap_t = .true. !< Whether the vertical remapping is performed on (virtual) temperature
!< instead of (virtual) potential temperature. Since typically potential
!< temperature increases exponentially from layer to layer near the top
!< boundary, the cubic-spline interpolation in the vertical remapping
!< will have difficulty with the exponential profile. Temperature
!< does not have this problem and will often yield a more accurate result.
!< The default is .true.
logical :: z_tracer = .false. !< Whether to transport sub-cycled tracers layer-by-layer,
!< each with its own computed sub-cycling time step (if q_split = 0).
!< This may improve efficiency for very large numbers of tracers.
!< The default value is .false.; currently not implemented.
logical :: old_divg_damp = .false. !< parameter to revert damping parameters back to values
!< defined in a previous revision
!< old_values:
!< d2_bg_k1 = 6. d2_bg_k2 = 4.
!< d2_divg_max_k1 = 0.02 d2_divg_max_k2 = 0.01
!< damp_k_k1 = 0. damp_k_k2 = 0.
!< current_values:
!< d2_bg_k1 = 4. d2_bg_k2 = 2.
!< d2_divg_max_k1 = 0.15 d2_divg_max_k2 = 0.08
!< damp_k_k1 = 0.2 damp_k_k2 = 0.12
logical :: fv_land = .false. !< Whether to create terrain deviation and land fraction for
!< output to mg_drag restart files, for use in mg_drag and in the land
!< model. The default is .false; .true. is recommended when, and only
!< when, initializing the model, since the mg_drag files created provide a
!< much more accurate terrain representation for the mountain gravity
!< wave drag parameterization and for the land surface roughness than
!< either computes internally. This has no effect on the representation of
!< the terrain in the dynamics.
!--------------------------------------------------------------------------------------
! The following options are useful for NWP experiments using datasets on the lat-lon grid
!--------------------------------------------------------------------------------------
logical :: nudge = .false. !< Whether to use the nudging towards the state in some externally-supplied
!< file (such as from reanalysis or another simulation). Further
!< nudging options are set in fv_nwp_nudge_nml. The default is .false.
logical :: nudge_ic = .false. !< Same as nudge, but works in adiabatic solo_core simulations to
!< nudge the field to a single external analysis file.
!< The default is .false.
logical :: ncep_ic = .false. !< If external_ic = .true., this variable says whether the
!< file in res_latlon_dynamics is an NCEP analysis or reanalysis file.
!< This option zeros out all tracer fields except specific humidity.
!< The default is .false.
logical :: nggps_ic = .false. !< If external_ic = .true., reads initial conditions from
!< horizontally-interpolated output from chgres. The default is .false.
!< Additional options are available through external_ic_nml.
logical :: hrrrv3_ic = .false.
logical :: ecmwf_ic = .false. !< If external_ic = .true., reads initial conditions from ECMWF analyses.
!< The default is .false.
logical :: gfs_phil = .false. !< if .T., compute geopotential inside of GFS physics (not used?)
logical :: agrid_vel_rst = .false. !< Whether to write the unstaggered latitude-longitude winds
!< (ua and va) to the restart files. This is useful for data
!< assimilation cycling systems which do not handle staggered winds.
!< The default is .false.
logical :: use_new_ncep = .false. !< use the NCEP ICs created after 2014/10/22, if want to read CWAT (not used??)
logical :: use_ncep_phy = .false. !< if .T., separate CWAT by weights of liq_wat and liq_ice in FV_IC (not used??)
logical :: fv_diag_ic = .false. !< reconstruct IC from fv_diagnostics on lat-lon grid
logical :: external_ic = .false. !< Whether to initialize the models state using the data
!< in an externally specified file, given in res_latlon_dynamics.
!< By default this file is assumed to be a legacy lat-lon FV core restart file;
!< set either ncep_ic or fv_diag_ic to .true.to override this behavior.
!< The default is .false. Note that external_ic = .true. will cause the
!< model to re-initialize the dynamical fields from the input dataset
!< regardless of whether warm_start is set.
logical :: external_eta = .false. !< If .true., reads the interface coefficients ak and bk
!< from either the restart file (if restarting) or from the external initial
!< condition file (if nggps_ic or ecwmf_ic are .true.). This overrides the
!< hard-coded levels in fv_eta. The default is .false.
logical :: read_increment = .false. !< read in analysis increment and add to restart
logical :: increment_file_on_native_grid = .false. !< increment is on native cubed sphere grid grid else on Gaussian grid
! following are namelist parameters for Stochastic Energy Baskscatter dissipation estimate
logical :: do_skeb = .false. !< save dissipation estimate
integer :: skeb_npass = 11 !< Filter dissipation estimate "skeb_npass" times
! Default restart files from the "Memphis" latlon FV core:
character(len=128) :: res_latlon_dynamics = 'INPUT/fv_rst.res.nc' !< If external_ic =.true.gives the filename of the
!< input IC file. The default is 'INPUT/fv_rst.res.nc'.
character(len=128) :: res_latlon_tracers = 'INPUT/atmos_tracers.res.nc' !< If external_ic =.true.and both ncep_ic and fv_diag_ic
!< are.false., this variable gives the filename of the
!< initial conditions for the tracers, assumed to be a
!< legacy lat-lon FV core restart file.
!< The default is 'INPUT/atmos_tracers.res.nc'.
! The user also needs to copy the "cold start" cubed sphere restart files (fv_core.res.tile1-6)
! to the INPUT dir during runtime
!------------------------------------------------
! Parameters related to non-hydrostatic dynamics:
!------------------------------------------------
logical :: hydrostatic = .true. !< Whether to use the hydrostatic or nonhydrostatic solver.
!< The default is .true.
logical :: phys_hydrostatic = .true. !< Option to enable hydrostatic application of heating from the physics
!< in a nonhydrostatic simulation: heating is applied in hydrostatic
!< balance, causing the entire atmospheric column to expand instantaneously.
!< If .false., heating from the physics is applied simply as a temperature
!< tendency. The default value is .true.; ignored if hydrostatic = .true.
logical :: use_hydro_pressure = .false. !< Whether to compute hydrostatic pressure for input to the physics.
!< Currently only enabled for the UFS model.
!< Ignored in hydrostatic simulations. The default is .false.
logical :: do_uni_zfull = .false. !< Whether to compute z_full (the height of each modellayer,
!< as opposed to z_half, the height of each model interface)
!< as the midpoint of the layer, as is done for the nonhydrostatic
!< solver, instead of the height of the location where p = p the mean
!< pressure in the layer. This option is not available for UFS or
!< the solo_core. The default is .false.
logical :: hybrid_z = .false. !< Whether to use a hybrid-height coordinate, instead of
!< the usual sigma-p coordinate. The default value is .false.
!< (Not currently maintained.)
logical :: Make_NH = .false. !< Whether to re-initialize the nonhydrostatic state, by recomputing
!< dz from hydrostatic balance and setting w to 0. The default is
!< false.
logical :: make_hybrid_z = .false. !< Converts the vertical coordinate to a hybrid-height coordinate,
!< instead of the usual sigma-p coordinate. Requires hybrid_z = .true.
!< The default value is .false.
logical :: nudge_qv = .false. !< During the adiabatic initialization (na_init > 0), if set to .true.,
!< the water vapor profile is nudged to an analytic fit to the
!< HALOE climatology. This is to improve the water vapor concentrations
!< in GFS initial conditions, especially in the stratosphere, where
!< values can be several times higher than observed. This nudging is
!< unnecessary for other ICs, especially the ECMWF initial conditions.
!< The default is .false.
real :: add_noise = -1. !< Amplitude of random thermal noise (in K) to add upon startup.
!< Useful for perturbing initial conditions. -1 by default;
!< disabled if 0 or negative.
logical :: butterfly_effect = .false. !< Flip the least-significant-bit of the lowest level temperature
!< at the center of the domain (the center of tile 1), if set to .true.
!< The default value is .false.
logical :: molecular_diffusion = .false. !< Apply Whole Atmosphere Model (WAM) molecular diffusion
!< developed by Henry Juang
real :: dz_min = 2 !< Minimum thickness depth to to enforce monotonicity of height to prevent blowup.
!< 2 by default
integer :: psm_bc = 0 !< Option to use origional BCs (0) or zero-gradient BCs (1)
!< to reconstruct interface u/v with the Parabolic Spline Method
!< for the advection of height. 0 by default.
integer :: a2b_ord = 4 !< Order of interpolation used by the pressure gradient force
!< to interpolate cell-centered (A-grid) values to the grid corners.
!< The default value is 4 (recommended), which uses fourth-order
!< interpolation; otherwise second-order interpolation is used.
integer :: c2l_ord = 4 !< Order of interpolation from the solvers native D-grid winds
!< to latitude-longitude A-grid winds, which are used as input to
!< the physics routines and for writing to history files.
!< The default value is 4 (recommended); fourth-order interpolation
!< is used unless c2l_ord = 2.
real(kind=R_GRID) :: dx_const = 1000. !< Specifies the (uniform) grid-cell-width in the x-direction
!< on a doubly-periodic grid (grid_type = 4) in meters.
!< The default value is 1000.
real(kind=R_GRID) :: dy_const = 1000. !< Specifies the (uniform) grid-cell-width in the y-direction
!< on a doubly-periodic grid (grid_type = 4) in meters.
!< The default value is 1000.
real(kind=R_GRID) :: deglat=15. !< Latitude (in degrees) used to compute the uniform f-plane
!< Coriolis parameter for doubly-periodic simulations
!< (grid_type = 4). The default value is 15.
!The following deglat_*, deglon_* options are not used.
real(kind=R_GRID) :: deglon_start = -30., deglon_stop = 30., & !< boundaries of latlon patch
deglat_start = -30., deglat_stop = 30.
logical :: regional = .false. !< Default setting for the regional domain.
integer :: bc_update_interval = 3 !< Default setting for interval (hours) between external regional BC data files.
integer :: nrows_blend = 0 !< # of blending rows in the outer integration domain.
logical :: write_restart_with_bcs = .false. !< Default setting for using DA-updated BC files
logical :: regional_bcs_from_gsi = .false. !< Default setting for writing restart files with boundary rows
logical :: pass_full_omega_to_physics_in_non_hydrostatic_mode = .false. !< Default to passing local omega to physics in non-hydrostatic
!>Convenience pointers
integer, pointer :: grid_number
!f1p
logical :: adj_mass_vmr = .false. !TER: This is to reproduce answers for verona patch. This default can be changed
! to .true. in the next city release if desired
!integer, pointer :: test_case
!real, pointer :: alpha
end type fv_flags_type
type fv_nest_BC_type_3D
!!! CLEANUP: could we have pointers to np[xyz], nest_domain, and the index/weight arrays?
real, allocatable, dimension(:,:,:) :: west_t1, east_t1, south_t1, north_t1
real, allocatable, dimension(:,:,:) :: west_t0, east_t0, south_t0, north_t0
integer :: istag, jstag
logical :: allocated = .false.
logical :: initialized = .false.
end type fv_nest_BC_type_3D
type fv_nest_BC_type_4D
real, allocatable, dimension(:,:,:,:) :: west_t1, east_t1, south_t1, north_t1
real, allocatable, dimension(:,:,:,:) :: west_t0, east_t0, south_t0, north_t0
integer :: istag, jstag
logical :: allocated = .false.
logical :: initialized = .false.
end type fv_nest_BC_type_4D
type nest_level_type
!Interpolation arrays for grid nesting
logical :: on_level ! indicate if current processor on this level.
logical :: do_remap_BC
integer, allocatable, dimension(:,:,:) :: ind_h, ind_u, ind_v, ind_b ! I don't think these are necessary since BC interpolation is done locally
real, allocatable, dimension(:,:,:) :: wt_h, wt_u, wt_v, wt_b
end type nest_level_type
type fv_nest_type
!nested grid flags:
integer :: refinement = 3 !< Refinement ratio of the nested grid. This is the number
!< of times that each coarse-grid cell face will be divided
!< into smaller segments on the nested grid. Required to be a
!< positive integer if nested = true. Nested grids are aligned
!< with the coarse grid, so non-integer refinements are not
!< permitted. The default value is 3.
integer :: parent_tile = 1 !< Number of the tile (ie. face) in which this nested grid
!< is found in its parent. Required to be a positive value if nested = true.
!< If the parent grid is not a cubed sphere, or itself is a nested grid, this
!< should be set to 1. If the parent grid has been rotated (using do_schmidt) with
!< the intent of centering the nested grid at target_lat and target_lon, then
!< parent_tile should be set to 6. The default value is 1.
logical :: nested = .false. !< Whether this is a nested grid. The default value is .false.
integer :: nestbctype = 1
integer :: nsponge = 0
integer :: nestupdate = 7 !< Type of nested-grid update to use; details are given in
!< model/fv_nesting.F90. The default is 7.