Define Registry.xml entities for GSL GWDO scheme in the init_atmosphe…

…re core

This commit defines new static fields, a new package, a new namelist option, and
a new output stream for the GSL GWDO scheme. Also included in this commit are
changes to the init_atm_setup_packages() routine to set the new
'gwd_gsl_stage_out' package if and only if the new namelist option
'config_native_gwd_gsl_static' is true.

When 'config_native_gwd_gsl_static' is set in the namelist, the init_atmosphere
core will write the twenty new static fields (var2d, con, oa{1,2,3,4}, and
ol{1,2,3,4}) for large scale (ls) and small scale (ss) to a new 'ugwp_oro_data'
output stream.

As of this commit, code to actually compute the twenty new static fields is not
being called, and so the fields are expected to be zero everywhere.

src/core_init_atmosphere/Registry.xml

@@ -268,6 +268,11 @@
                      description="Whether to recompute subgrid-scale orography statistics directly on the native MPAS mesh (case 7 only)"
                      possible_values="true or false"/>
 
+                <nml_option name="config_native_gwd_gsl_static"     type="logical"       default_value="false"
+                     units="-"
+                     description="Whether to recompute subgrid-scale orography statistics for the GSL drag directly on the native MPAS mesh (case 7 only)"
+                     possible_values="true or false"/>
+
                 <nml_option name="config_gwd_cell_scaling"      type="real"          default_value="1.0"      in_defaults="false"
                      units="-"
                      description="Scaling factor for the effective grid cell diameter used in computation of GWD static fields"
@@ -348,6 +353,7 @@
                 <package name="lbcs" description="Active when lateral boundary conditions are interpolated and written."/>
                 <package name="gwd_stage_in" description="Active only if GWD static fields are be generated and other static fields are not being generated"/>
                 <package name="gwd_stage_out" description="Active only if GWD static fields are be generated and other static fields are not being generated"/>
+                <package name="gwd_gsl_stage_out" description="Active only if GSL GWD static fields are be generated"/>
                 <package name="vertical_stage_in" description="Active only if a vertical grid is being generated"/>
                 <package name="vertical_stage_out" description="Active only if a vertical grid is being generated"/>
                 <package name="met_stage_in" description="Active only if meteorological fields are being interpolated"/>
@@ -605,6 +611,35 @@
                         <var name="t2m" packages="met_stage_out"/>
 		</stream>
 
+                <stream name="ugwp_oro_data"
+                        type="output"
+                        filename_template="x1.40962.ugwp_oro_data.nc"
+                        output_interval="initial_only"
+                        immutable="true"
+                        packages="gwd_gsl_stage_out">
+
+                        <var name="var2dls"/>
+                        <var name="conls"/>
+                        <var name="oa1ls"/>
+                        <var name="oa2ls"/>
+                        <var name="oa3ls"/>
+                        <var name="oa4ls"/>
+                        <var name="ol1ls"/>
+                        <var name="ol2ls"/>
+                        <var name="ol3ls"/>
+                        <var name="ol4ls"/>
+                        <var name="var2dss"/>
+                        <var name="conss"/>
+                        <var name="oa1ss"/>
+                        <var name="oa2ss"/>
+                        <var name="oa3ss"/>
+                        <var name="oa4ss"/>
+                        <var name="ol1ss"/>
+                        <var name="ol2ss"/>
+                        <var name="ol3ss"/>
+                        <var name="ol4ss"/>
+                </stream>
+
 		<stream name="surface" 
                         type="output" 
                         filename_template="x1.40962.sfc_update.nc"
@@ -869,14 +904,96 @@
                      description="effective orographic length for southerly flow"
                      packages="gwd_stage_out;vertical_stage_out;met_stage_out"/>
 
-                <var name="ol3" type="real" dimensions="nCells" units="unitles"
+                <var name="ol3" type="real" dimensions="nCells" units="unitless"
                      description="effective orographic length for south-westerly flow"
                      packages="gwd_stage_out;vertical_stage_out;met_stage_out"/>
 
                 <var name="ol4" type="real" dimensions="nCells" units="unitless"
                      description="effective orographic length for north-westerly flow"
                      packages="gwd_stage_out;vertical_stage_out;met_stage_out"/>
 
+                <!-- GSL GWDO fields - meso-scale -->
+                <var name="var2dls" type="real" dimensions="nCells" units="m"
+                     description="standard deviation of subgrid-scale orography (meso-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="conls" type="real" dimensions="nCells" units="unitless"
+                     description="orographic convexity (meso-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="oa1ls" type="real" dimensions="nCells" units="unitless"
+                     description="asymmetry of subgrid-scale orography for westerly flow (meso-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="oa2ls" type="real" dimensions="nCells" units="unitless"
+                     description="asymmetry of subgrid-scale orography for southerly flow (meso-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="oa3ls" type="real" dimensions="nCells" units="unitless"
+                     description="asymmetry of subgrid-scale orography for south-westerly flow (meso-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="oa4ls" type="real" dimensions="nCells" units="unitless"
+                     description="asymmetry of subgrid-scale orography for north-westerly flow (meso-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="ol1ls" type="real" dimensions="nCells" units="unitless"
+                     description="effective orographic length for westerly flow (meso-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="ol2ls" type="real" dimensions="nCells" units="unitless"
+                     description="effective orographic length for southerly flow (meso-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="ol3ls" type="real" dimensions="nCells" units="unitless"
+                     description="effective orographic length for south-westerly flow (meso-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="ol4ls" type="real" dimensions="nCells" units="unitless"
+                     description="effective orographic length for north-westerly flow (meso-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <!-- GSL GWDO fields - small-scale -->
+                <var name="var2dss" type="real" dimensions="nCells" units="m"
+                     description="standard deviation of subgrid-scale orography (small-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="conss" type="real" dimensions="nCells" units="unitless"
+                     description="orographic convexity (small-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="oa1ss" type="real" dimensions="nCells" units="unitless"
+                     description="asymmetry of subgrid-scale orography for westerly flow (small-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="oa2ss" type="real" dimensions="nCells" units="unitless"
+                     description="asymmetry of subgrid-scale orography for southerly flow (small-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="oa3ss" type="real" dimensions="nCells" units="unitless"
+                     description="asymmetry of subgrid-scale orography for south-westerly flow (small-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="oa4ss" type="real" dimensions="nCells" units="unitless"
+                     description="asymmetry of subgrid-scale orography for north-westerly flow (small-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="ol1ss" type="real" dimensions="nCells" units="unitless"
+                     description="effective orographic length for westerly flow (small-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="ol2ss" type="real" dimensions="nCells" units="unitless"
+                     description="effective orographic length for southerly flow (small-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="ol3ss" type="real" dimensions="nCells" units="unitless"
+                     description="effective orographic length for south-westerly flow (small-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
+                <var name="ol4ss" type="real" dimensions="nCells" units="unitless"
+                     description="effective orographic length for north-westerly flow (small-scale GWD)"
+                     packages="gwd_gsl_stage_out"/>
+
                 <!-- GOCART aerosol fields -->
                 <var name="nifa_gocart_clim" type="real" dimensions="nMonths nGocartLevels nCells" units="nb kg^{-1}"
                      description="climatological Gocart ice-friendly number concentration"

src/core_init_atmosphere/mpas_init_atm_core_interface.F

@@ -116,7 +116,9 @@ function init_atm_setup_packages(configs, streamInfo, packages, iocontext) resul
 
       logical, pointer :: initial_conds, sfc_update, lbcs
       logical, pointer :: gwd_stage_in, gwd_stage_out, vertical_stage_in, vertical_stage_out, met_stage_in, met_stage_out
+      logical, pointer :: gwd_gsl_stage_out
       logical, pointer :: config_native_gwd_static, config_static_interp, config_vertical_grid, config_met_interp
+      logical, pointer :: config_native_gwd_gsl_static
       logical, pointer :: first_guess_field
       logical, pointer :: mp_thompson_aers_in
       integer, pointer :: config_init_case
@@ -127,6 +129,7 @@ function init_atm_setup_packages(configs, streamInfo, packages, iocontext) resul
       call mpas_pool_get_config(configs, 'config_init_case', config_init_case)
       call mpas_pool_get_config(configs, 'config_static_interp', config_static_interp)
       call mpas_pool_get_config(configs, 'config_native_gwd_static', config_native_gwd_static)
+      call mpas_pool_get_config(configs, 'config_native_gwd_gsl_static', config_native_gwd_gsl_static)
       call mpas_pool_get_config(configs, 'config_vertical_grid', config_vertical_grid)
       call mpas_pool_get_config(configs, 'config_met_interp', config_met_interp)
 
@@ -145,6 +148,9 @@ function init_atm_setup_packages(configs, streamInfo, packages, iocontext) resul
       nullify(gwd_stage_out)
       call mpas_pool_get_package(packages, 'gwd_stage_outActive', gwd_stage_out)
 
+      nullify(gwd_gsl_stage_out)
+      call mpas_pool_get_package(packages, 'gwd_gsl_stage_outActive', gwd_gsl_stage_out)
+
       nullify(vertical_stage_in)
       call mpas_pool_get_package(packages, 'vertical_stage_inActive', vertical_stage_in)
 
@@ -164,6 +170,7 @@ function init_atm_setup_packages(configs, streamInfo, packages, iocontext) resul
           .not. associated(sfc_update) .or. &
           .not. associated(gwd_stage_in) .or. &
           .not. associated(gwd_stage_out) .or. &
+          .not. associated(gwd_gsl_stage_out) .or. &
           .not. associated(vertical_stage_in) .or. &
           .not. associated(vertical_stage_out) .or. &
           .not. associated(met_stage_in) .or. &
@@ -204,6 +211,7 @@ function init_atm_setup_packages(configs, streamInfo, packages, iocontext) resul
          gwd_stage_in = config_native_gwd_static .and. &
                         (.not. config_static_interp)
          gwd_stage_out = config_native_gwd_static
+         gwd_gsl_stage_out = config_native_gwd_gsl_static
          vertical_stage_in = config_vertical_grid .and. &
                              (.not. config_native_gwd_static) .and. &
                              (.not. config_static_interp)
@@ -221,6 +229,7 @@ function init_atm_setup_packages(configs, streamInfo, packages, iocontext) resul
       else if (config_init_case == 8) then
          gwd_stage_in = .false.
          gwd_stage_out = .false.
+         gwd_gsl_stage_out = .false.
          vertical_stage_in = .true.
          vertical_stage_out = .false.
          met_stage_in = .false.
@@ -233,6 +242,7 @@ function init_atm_setup_packages(configs, streamInfo, packages, iocontext) resul
       else if (config_init_case == 9) then
          gwd_stage_in = .false.
          gwd_stage_out = .false.
+         gwd_gsl_stage_out = .false.
          vertical_stage_in = .false.
          vertical_stage_out = .false.
          met_stage_in = .true.
@@ -247,6 +257,7 @@ function init_atm_setup_packages(configs, streamInfo, packages, iocontext) resul
       else if (config_init_case == 13) then
          gwd_stage_in = .false.
          gwd_stage_out = .false.
+         gwd_gsl_stage_out = .false.
          vertical_stage_in = .false.
          vertical_stage_out = .true.
          met_stage_in = .false.
@@ -255,6 +266,7 @@ function init_atm_setup_packages(configs, streamInfo, packages, iocontext) resul
       else
          gwd_stage_in = .false.
          gwd_stage_out = .false.
+         gwd_gsl_stage_out = .false.
          vertical_stage_in = .false.
          vertical_stage_out = .false.
          met_stage_in = .false.