save scidoc v7 progress

NCAR · Jun 14, 2024 · 7a0c400 · 7a0c400
1 parent 2903b95
commit 7a0c400
Show file tree

Hide file tree

Showing 16 changed files with 1,303 additions and 16 deletions.
diff --git a/physics/docs/ccpp_doxyfile b/physics/docs/ccpp_doxyfile
@@ -117,8 +117,8 @@ WARN_LOGFILE           =
 INPUT                  =  pdftxt/mainpage.txt              \
                           pdftxt/all_schemes_list.txt     \
                           pdftxt/GFS_v16_suite.txt       \
-                          pdftxt/GFS_v17_p8_suite.txt    \
-                          pdftxt/GFS_v17_p8_RRTMGP.txt    \
+                          pdftxt/GFS_v17_HR3_suite.txt    \
+                          pdftxt/GFS_v17_HR3_RRTMGP_suite.txt    \
                           pdftxt/RRFS_v1_suite.txt   \
                           pdftxt/WoFS_v0_suite.txt   \
                           pdftxt/RRFS_SGSCLOUD.txt       \
@@ -176,7 +176,7 @@ EXCLUDE                =
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       =
 EXCLUDE_SYMBOLS        =
-EXAMPLE_PATH           = pdftxt/RE6 \
+EXAMPLE_PATH           = pdftxt/RE7 \
                          doc/html
 EXAMPLE_PATTERNS       = 
 EXAMPLE_RECURSIVE      = NO

diff --git a/physics/docs/pdftxt/GFS_v16_suite.txt b/physics/docs/pdftxt/GFS_v16_suite.txt
@@ -20,24 +20,26 @@ National Centers for Environmental Prediction (NCEP) in 2021. The GFS_v16 suite
  - \ref GFDL_cloud
 
 \section sdf_gfsv16b Suite Definition File 
-\include  suite_FV3_GFS_v16.xml
+\include  suite_SCM_GFS_v16.xml
 
 
 \section gfs16_nml_opt_des Namelist 
 \ref GFDL_cloud namelist options 
-\snippet RE300/FV3_GFS_v16_input.nml GFDL_CLOUD_MP_NML
+\snippet RE7/input_GFS_v16.nml GFDL_CLOUD_MP_NML
 Other namelist options
-\snippet RE300/FV3_GFS_v16_input.nml GFS_PHYSICS_NML
+\snippet RE7/input_GFS_v16.nml GFS_PHYSICS_NML
 
 - nstf_name = \f$[2,0,0,0,0]^1 [2,1,0,0,0]^2\f$
  - \f$^1\f$ NSST is on and coupled with spin up off
  - \f$^2\f$ NSST is on and coupled with spin up on
 
 - Grid-spacing dependency of \p cdmbgwd
- - \b C48:  cdmbgwd="0.071,2.1,1.0,1.0" 
- - \b C96:  cdmbgwd="0.14,1.8,1.0,1.0"
- - \b C192: cdmbgwd="0.23,1.5,1.0,1.0"
- - \b C384: cdmbgwd="1.1,0.72,1.0,1.0"
- - \b C768: cdmbgwd="4.0,0.15,1.0,1.0"
+ - \b C48:   cdmbgwd="0.071,2.1,1.0,1.0" 
+ - \b C96:   cdmbgwd="0.14,1.8,1.0,1.0"
+ - \b C192:  cdmbgwd="0.23,1.5,1.0,1.0"
+ - \b C384:  cdmbgwd="1.1,0.72,1.0,1.0"
+ - \b C768:  cdmbgwd="4.0,0.15,1.0,1.0"
+ - \b C1152: cdmbgwd="4.0,0.10,1.0,1.0"
+ - \b C3072: cdmbgwd="4.0,0.05,1.0,1.0"
 
 */
diff --git a/physics/docs/pdftxt/GFS_v17_HR3_GP_suite.txt b/physics/docs/pdftxt/GFS_v17_HR3_GP_suite.txt
@@ -0,0 +1,72 @@
+/**
+\page GFS_v17_HR3_RRTMGP_page GFS_v17_RRTMGP Suite 
+
+\section gfsv_17_suite_overview Overview
+
+Version 17 of the Global Forecast System (GFS) is scheduled for operational implementation by the NOAA
+National Centers for Environmental Prediction (NCEP) in 2024. The GFS_v17 suite is a prototype of 
+the GFS_v17 suite, and is expected to evolve before the implementation. It is available for use 
+with the CCPP SCM.  The primary differences between the GFS_v16 and GFS_v17 suites are: 
+- \b Microphysics: The replacement of \ref GFDL_cloud with \ref THOMPSON 
+- PBL and Convection updates
+- \b Gravity \b Wave \b Drag: The replacement of \ref GFS_UGWP_v0 with  \ref GFS_ugwpv1_gsldrag
+- \b Land \b Surface \b Model: The replacement of \ref GFS_NOAH with \ref NoahMP
+
+The GFS_v17 suite uses the parameterizations in the following order:
+ - \ref GFS_RRTMGP_page
+ - \ref GFS_SFCLYR
+ - \ref GFS_NSST
+ - \ref NoahMP
+ - \ref GFS_SFCSICE
+ - \ref GFS_SATMEDMFVDIFQ
+ - \ref GFS_ugwpv1_gsldrag
+ - \ref GFS_OZPHYS
+ - \ref GFS_H2OPHYS
+ - \ref GFS_SAMFdeep
+ - \ref GFS_SAMFshal
+ - \ref THOMPSON
+
+
+\section sdf_gfsv17p8 Suite Definition File 
+\include suite_SCM_GFS_v17_HR3_RRTMGP.xml
+
+\section gfs17_nml_opt_des Namelist 
+- General physics options
+\snippet input_GFS_v17_HR3_RRTMGP.nml GFS_PHYSICS_NML
+- \ref GFS_UNIFIED_UGWP related options
+\snippet input_GFS_v17_HR3_RRTMGP.nml CIRES_UGWP_NML
+
+- nstf_name = \f$[2,0,0,0,0]^1 [2,1,0,0,0]^2\f$
+ - \f$^1\f$ NSST is on and coupled with spin up off
+ - \f$^2\f$ NSST is on and coupled with spin up on
+
+- Grid-spacing dependency of \p cdmbgwd
+ - \b C48:   cdmbgwd="0.071,2.1,1.0,1.0"
+ - \b C96:   cdmbgwd="0.14,1.8,1.0,1.0"
+ - \b C192:  cdmbgwd="0.23,1.5,1.0,1.0"
+ - \b C384:  cdmbgwd="1.1,0.72,1.0,1.0"
+ - \b C768:  cdmbgwd="4.0,0.15,1.0,1.0"
+ - \b C1152: cdmbgwd="4.0,0.10,1.0,1.0"
+ - \b C3072: cdmbgwd="4.0,0.05,1.0,1.0"
+
+- Grid-spacing dependency of \p cdmbgwd_gsl
+ - \b C48:   cdmbgwd_gsl="40.0,1.77,1.0,1.0"
+ - \b C96:   cdmbgwd_gsl="20.0,2.5,1.0,1.0"
+ - \b C192:  cdmbgwd_gsl="10.0,3.5,1.0,1.0"
+ - \b C384:  cdmbgwd_gsl="5.0,5.0,1.0,1.0"
+ - \b C768:  cdmbgwd_gsl="2.5,7.5,1.0,1.0"
+ - \b C1152: cdmbgwd_gsl="1.67,8.8,1.0,1.0"
+ - \b C3072: cdmbgwd_gsl="0.625,14.1,1.0,1.0"
+
+- Grid-spacing dependency of \p knob_ugwp_tauamp
+- \b C48:    knob_ugwp_tauamp=6.0e-3 
+- \b C96:    knob_ugwp_tauamp=3.0e-3
+- \b C192:   knob_ugwp_tauamp=1.5e-3
+- \b C384:   knob_ugwp_tauamp=0.8e-3
+- \b C768:   knob_ugwp_tauamp=0.5e-3
+- \b C1152:  knob_ugwp_tauamp=0.35e-3
+- \b C3072:  knob_ugwp_tauamp=0.13e-3
+
+- Grid-spacing dependency of \p xr_cnvcld
+- \b C48 and \b C96: xr_cnvcld =.false.
+*/
diff --git a/physics/docs/pdftxt/GFS_v17_HR3_suite.txt b/physics/docs/pdftxt/GFS_v17_HR3_suite.txt
@@ -0,0 +1,72 @@
+/**
+\page GFS_v17_HR3_page GFS_v17 Suite 
+
+\section gfsv_17_suite_overview Overview
+
+Version 17 of the Global Forecast System (GFS) is scheduled for operational implementation by the NOAA
+National Centers for Environmental Prediction (NCEP) in 2024. The GFS_v17 suite is a prototype of 
+the GFS_v17 suite, and is expected to evolve before the implementation. It is available for use 
+with the CCPP SCM.  The primary differences between the GFS_v16 and GFS_v17 suites are: 
+- \b Microphysics: The replacement of \ref GFDL_cloud with \ref THOMPSON 
+- PBL and Convection updates
+- \b Gravity \b Wave \b Drag: The replacement of \ref GFS_UGWP_v0 with  \ref GFS_ugwpv1_gsldrag
+- \b Land \b Surface \b Model: The replacement of \ref GFS_NOAH with \ref NoahMP
+
+The GFS_v17 suite uses the parameterizations in the following order:
+ - \ref GFS_RRTMG_page
+ - \ref GFS_SFCLYR
+ - \ref GFS_NSST
+ - \ref NoahMP
+ - \ref GFS_SFCSICE
+ - \ref GFS_SATMEDMFVDIFQ
+ - \ref GFS_ugwpv1_gsldrag
+ - \ref GFS_OZPHYS
+ - \ref GFS_H2OPHYS
+ - \ref GFS_SAMFdeep
+ - \ref GFS_SAMFshal
+ - \ref THOMPSON
+
+
+\section sdf_gfsv17p8 Suite Definition File 
+\include suite_SCM_GFS_v17_HR3.xml
+
+\section gfs17_nml_opt_des Namelist 
+- General physics options
+\snippet input_GFS_v17_HR3.nml GFS_PHYSICS_NML
+- \ref GFS_UNIFIED_UGWP related options
+\snippet input_GFS_v17_HR3.nml CIRES_UGWP_NML
+
+- nstf_name = \f$[2,0,0,0,0]^1 [2,1,0,0,0]^2\f$
+ - \f$^1\f$ NSST is on and coupled with spin up off
+ - \f$^2\f$ NSST is on and coupled with spin up on
+
+- Grid-spacing dependency of \p cdmbgwd
+ - \b C48:   cdmbgwd="0.071,2.1,1.0,1.0"
+ - \b C96:   cdmbgwd="0.14,1.8,1.0,1.0"
+ - \b C192:  cdmbgwd="0.23,1.5,1.0,1.0"
+ - \b C384:  cdmbgwd="1.1,0.72,1.0,1.0"
+ - \b C768:  cdmbgwd="4.0,0.15,1.0,1.0"
+ - \b C1152: cdmbgwd="4.0,0.10,1.0,1.0"
+ - \b C3072: cdmbgwd="4.0,0.05,1.0,1.0"
+
+- Grid-spacing dependency of \p cdmbgwd_gsl
+ - \b C48:   cdmbgwd_gsl="40.0,1.77,1.0,1.0"
+ - \b C96:   cdmbgwd_gsl="20.0,2.5,1.0,1.0"
+ - \b C192:  cdmbgwd_gsl="10.0,3.5,1.0,1.0"
+ - \b C384:  cdmbgwd_gsl="5.0,5.0,1.0,1.0"
+ - \b C768:  cdmbgwd_gsl="2.5,7.5,1.0,1.0"
+ - \b C1152: cdmbgwd_gsl="1.67,8.8,1.0,1.0"
+ - \b C3072: cdmbgwd_gsl="0.625,14.1,1.0,1.0"
+
+- Grid-spacing dependency of \p knob_ugwp_tauamp
+- \b C48:    knob_ugwp_tauamp=6.0e-3 
+- \b C96:    knob_ugwp_tauamp=3.0e-3
+- \b C192:   knob_ugwp_tauamp=1.5e-3
+- \b C384:   knob_ugwp_tauamp=0.8e-3
+- \b C768:   knob_ugwp_tauamp=0.5e-3
+- \b C1152:  knob_ugwp_tauamp=0.35e-3
+- \b C3072:  knob_ugwp_tauamp=0.13e-3
+
+- Grid-spacing dependency of \p xr_cnvcld
+- \b C48 and \b C96: xr_cnvcld =.false.
+*/
diff --git a/physics/docs/pdftxt/RE7/input_GFS_v16.nml b/physics/docs/pdftxt/RE7/input_GFS_v16.nml
@@ -0,0 +1,144 @@
+
+&gfs_physics_nml
+    cal_pre = .false.
+    cdmbgwd = 4.0, 0.15, 1.0, 1.0
+    cnvcld = .true.
+    cnvgwd = .true.
+    debug = .false.
+    do_shum = .false.
+    do_skeb = .false.
+    do_spp = .false.
+    do_sppt = .false.
+    do_tofd = .true.
+    do_ugwp = .false.
+    dspheat = .true.
+    effr_in = .true.
+    fhcyc = 0
+    fhlwr = 1200.0
+    fhswr = 1200.0
+    fhzero = 1.0
+    h2o_phys = .true.
+    hybedmf = .false.
+    iaer = 5111
+    ialb = 1
+    iau_inc_files = ''
+    icliq_sw = 2
+    ico2 = 2
+    iems = 1
+    imfdeepcnv = 2
+    imfshalcnv = 2
+    imp_physics = 11
+    iopt_alb = 2
+    iopt_btr = 1
+    iopt_crs = 1
+    iopt_dveg = 1
+    iopt_frz = 1
+    iopt_inf = 1
+    iopt_rad = 1
+    iopt_run = 1
+    iopt_sfc = 1
+    iopt_snf = 4
+    iopt_stc = 1
+    iopt_tbot = 2
+    iovr = 3
+    isatmedmf = 1
+    isol = 2
+    isot = 1
+    isubc_lw = 2
+    isubc_sw = 2
+    ivegsrc = 1
+    ldiag3d = .true.
+    ldiag_ugwp = .false.
+    lgfdlmprad = .true.
+    lheatstrg = .true.
+    lndp_type = 0
+    lsm = 1
+    lsoil = 4
+    lwhtr = .true.
+    n_var_lndp = 0
+    n_var_spp = 0
+    nsfullradar_diag = 3600
+    nst_anl = .true.
+    nstf_name = 2, 1, 0, 0, 0
+    oz_phys = .false.
+    oz_phys_2015 = .true.
+    pdfcld = .false.
+    prautco = 0.00015, 0.00015
+    pre_rad = .false.
+    print_diff_pgr = .false.
+    prslrd0 = 0.0
+    psautco = 0.0008, 0.0005
+    qdiag3d = .true.
+    random_clds = .false.
+    redrag = .true.
+    satmedmf = .true.
+    shal_cnv = .true.
+    swhtr = .true.
+    trans_trac = .true.
+    use_ufo = .true.
+/
+
+&gfdl_cloud_microphysics_nml
+    c_cracw = 0.8
+    c_paut = 0.5
+    c_pgacs = 0.01
+    c_psaci = 0.05
+    ccn_l = 300.0
+    ccn_o = 100.0
+    const_vg = .false.
+    const_vi = .false.
+    const_vr = .false.
+    const_vs = .false.
+    de_ice = .false.
+    do_qa = .false.
+    do_sedi_heat = .false.
+    dw_land = 0.16
+    dw_ocean = 0.1
+    fast_sat_adj = .false.
+    fix_negative = .true.
+    icloud_f = 1
+    mono_prof = .true.
+    mp_time = 150.0
+    prog_ccn = .false.
+    qi0_crt = 8e-05
+    qi_lim = 1.0
+    ql_gen = 0.001
+    ql_mlt = 0.001
+    qs0_crt = 0.001
+    rad_graupel = .true.
+    rad_rain = .true.
+    rad_snow = .true.
+    reiflag = 2
+    rh_inc = 0.3
+    rh_inr = 0.3
+    rh_ins = 0.3
+    rthresh = 1e-05
+    sedi_transport = .true.
+    tau_g2v = 900.0
+    tau_i2s = 1000.0
+    tau_l2v = 225.0
+    tau_v2l = 150.0
+    use_ccn = .true.
+    use_ppm = .false.
+    vg_max = 12.0
+    vi_max = 1.0
+    vr_max = 12.0
+    vs_max = 2.0
+    z_slope_ice = .true.
+    z_slope_liq = .true.
+/
+
+&cires_ugwp_nml
+    knob_ugwp_azdir = 2, 4, 4, 4
+    knob_ugwp_doaxyz = 1
+    knob_ugwp_doheat = 1
+    knob_ugwp_dokdis = 1
+    knob_ugwp_effac = 1, 1, 1, 1
+    knob_ugwp_ndx4lh = 1
+    knob_ugwp_solver = 2
+    knob_ugwp_source = 1, 1, 0, 0
+    knob_ugwp_stoch = 0, 0, 0, 0
+    knob_ugwp_version = 0
+    knob_ugwp_wvspec = 1, 25, 25, 25
+    launch_level = 27
+/