Add NOAA UFS UGWP suite of physics parameterizations #1276

mdtoyNOAA · 2025-01-24T22:38:33Z

This PR incorporates NOAA's Unified Forecast System (UFS) Unified Gravity Wave Physics (UGWP) suite of physics parameterizations into MPAS: https://ufs.epic.noaa.gov/wp-content/uploads/2021/07/UGWP_in_UFS_July_2021-1.pdf.

The following is a brief overview on using the suite:

In the init_atmosphere core, there is a new static pre-processing option, 'config_native_gwd_gsl_static', that is used to generate a new static file used by the Unified Gravity Wave Physics. The static file is written by the ugwp_oro_data stream, and requires two new datasets in the geographical dataset directory: 'topo_ugwp_30s' and 'topo_ugwp_2.5m'.
In the atmosphere core, there are several new options when config_gwdo_scheme = 'bl_ugwp_gwdo': config_ngw_scheme, config_knob_ugwp_tauamp, and config_ugwp_diags.
If config_ngw_scheme = true, an additional input file, ugwp_limb_tau.nc is needed. This namelist options activates the non-stationary gravity wave drag scheme.
If config_ugwp_diags = true, the diag_ugwp output stream will be written.

NOTE: This physics package is the "NOAA/GSL" orographic gravity wave drag (GWD) suite introduced in WRF Version 4.3 (activated by WRF namelist option "gwd_opt=3"), but with the addition of a non-stationary GWD parameterization that represents gravity wave sources such as deep convection and frontal instability.

Thanks to @mgduda for help and advice on how to incorporate the NOAA/GSL code into the MPAS-Dev repository.

…tmosphere This commit adds three new source files mpas_gsl_oro_data_sm_scale.F mpas_gsl_oro_data_lg_scale.F mpas_init_atm_gwd_gsl.F to the init_atmosphere core, along with modifications to the main core_init_atmosphere Makefile to compile these source files. At present, none of the code in these files is called from the init_atmosphere core.

…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.

When the namelist option config_native_gwd_gsl_static is .true., the init_atm_setup_case() routine now calls thecalc_gsl_oro_data() routine to compute the twenty GSL GWDO static fields.

This commit adds an entry to the Externals.cfg file to obtain the GSL UGWP code from a GitHub repository. Also included in this commit are changes to the main physics Makefile to compile the UGWP code. At present, none of the UGWP code is called.

Also included in this commit is logic for setting up packages related to the GSL UGWP scheme in the atm_setup_packages() routine.

…emes This commit adds a new module, module_bl_ugwp_gwdo, in the core_atmosphere/physics/physics_wrf directory. This module serves as a wrapper for the UGWP physics that is compatible with the MPAS-A physics drivers. Changes to the Makefile in the physics_wrf directory ensure that the module_bl_ugwp_gwdo.F file is compiled, but at present the code in that module is not actually called.

With this commit, the UGWP physics can now be used in MPAS-A simulations * Setting the 'config_gwdo_scheme' namelist option to 'bl_ugwp_gwdo' selects the GSL GWDO scheme. NOTE: If the GSL GWDO scheme is selected, the 'ugwp_oro_data_in' input stream must specify a valid input file with UGWP static fields. * Setting the 'config_ngw_scheme' namelist option to 'true' will activate the non-stationary gravity wave drag scheme. NOTE: If the NGW scheme is activated, the 'ugwp_ngw_in' input stream must specify a valid input file. * Setting the 'config_ugwp_diags' namelist option to 'true' will compute UGWP diagnostic fields, which will be written by the 'diag_ugwp' output stream.

… GSL_UGWP_mdtoy

mgduda · 2025-01-29T21:43:21Z

src/core_atmosphere/physics/Makefile

@@ -243,6 +247,7 @@ clean:
 	( cd physics_noahmp/drivers/mpas; $(MAKE) clean )
 	( cd physics_noahmp/src; $(MAKE) clean )
 	( cd physics_noahmp/utility; $(MAKE) clean )
+	( cd UGWP; $(MAKE) clean )


If the command

make clean CORE=atmosphere

is run before the UWGP directory has been created (for example, if we haven't yet compiled the code), it looks like make will get stuck in a loop. A simple solution might be to change this line to:

( if [ -d UGWP ]; then cd UGWP; $(MAKE) clean; fi )

mgduda · 2025-01-31T20:35:35Z

It looks like we may need to add -I./physics/UGWP to the build commands in src/core_atmosphere/Makefile to prevent issues with the nvfortran compiler not finding modules. This seems to be a general issue with the nvfortran compiler -- that search paths for all modules that are used directly and indirectly are required.

--- a/src/core_atmosphere/Makefile
+++ b/src/core_atmosphere/Makefile
@@ -81,7 +81,7 @@ clean:
        $(RM) $@ $*.mod
 ifeq "$(GEN_F90)" "true"
        $(CPP) $(CPPFLAGS) $(PHYSICS) $(CPPINCLUDES) -I./inc $< > $*.f90
-       $(FC) $(FFLAGS) -c $*.f90 $(FCINCLUDES) -I../framework -I../operators -I./physics -I./dynamics -I./diagnostics -I./physics/physics_wrf -I./physics/physics_mmm -I../external/esmf_time_f90
+       $(FC) $(FFLAGS) -c $*.f90 $(FCINCLUDES) -I../framework -I../operators -I./physics -I./dynamics -I./diagnostics -I./physics/physics_wrf -I./physics/physics_mmm -I./physics/UGWP -I../external/esmf_time_f90
 else
-       $(FC) $(CPPFLAGS) $(PHYSICS) $(FFLAGS) -c $*.F $(CPPINCLUDES) $(FCINCLUDES) -I./inc -I../framework -I../operators -I./physics -I./dynamics -I./diagnostics -I./physics/physics_wrf -I./physics/physics_mmm -I../external/esmf_time_f90
+       $(FC) $(CPPFLAGS) $(PHYSICS) $(FFLAGS) -c $*.F $(CPPINCLUDES) $(FCINCLUDES) -I./inc -I../framework -I../operators -I./physics -I./dynamics -I./diagnostics -I./physics/physics_wrf -I./physics/physics_mmm -I./physics/UGWP -I../external/esmf_time_f90
 endif

Modified src/core_atmosphere/Makefile to avoid endless loop if running 'make clean CORE=atmospere' before the UGWP directory has been created. Added '-I./physics/UGWP' to src/core_atmosphere/physics/Makefile to prevent issues with the nvfortran compiler not finding modules. This seems to be a general issue with the nvfortran compiler -- that search paths for all modules that are used directly and indirectly are required.

mdtoyNOAA · 2025-02-01T03:40:13Z

@mgduda I added -I./physics/UGWP to the physics/Makefile, did a test compile, and pushed new commit.

mgduda

I've just left one request to add pre-processing directives in the Registry.xml file so that we can compile stand-alone MPAS-A as a dynamics-only model. I think just pushing an additional commit to the PR branch with this change should be all that's needed.

src/core_atmosphere/Registry.xml

mgduda

The code changes look good to me. Thanks for all of your work on this, @mdtoyNOAA!

I have one small request: could the PR description be updated to document some of the practical aspects of the changes in this PR? For example, it would be nice to note that:

In the init_atmosphere core, there is a new static pre-processing option, config_native_gwd_gsl_static, that is used to generate a new static file used by the Unified Gravity Wave Physics. The static file is written by the ugwp_oro_data stream, and requires two new datasets in the geographical dataset directory: topo_ugwp_30s and topo_ugwp_2.5m.
In the atmosphere core, there are several new options when config_gwdo_scheme = 'bl_ugwp_gwdo': config_ngw_scheme, config_knob_ugwp_tauamp, and config_ugwp_diags.
If config_ngw_scheme = true, an additional input file, ugwp_limb_tau.nc is needed.
If config_ugwp_diags = true, the diag_ugwp output stream will be written.

I can imagine members of the community asking about the new UGWP option, so having some of this documentation to point to in the PR description (perhaps later to be migrated to more formal user documentation) could be helpful.

mdtoyNOAA · 2025-03-06T18:48:34Z

@mgduda Thank you for your suggestion. If you don’t mind, I went ahead and used your description with a small addition.

…

On Mar 5, 2025, at 1:20 PM, Michael Duda ***@***.***> wrote: @mgduda approved this pull request. The code changes look good to me. Thanks for all of your work on this, @mdtoyNOAA <https://github.com/mdtoyNOAA>! I have one small request: could the PR description be updated to document some of the practical aspects of the changes in this PR? For example, it would be nice to note that: In the init_atmosphere core, there is a new static pre-processing option, config_native_gwd_gsl_static, that is used to generate a new static file used by the Unified Gravity Wave Physics. The static file is written by the ugwp_oro_data stream, and requires two new datasets in the geographical dataset directory: topo_ugwp_30s and topo_ugwp_2.5m. In the atmosphere core, there are several new options when config_gwdo_scheme = 'bl_ugwp_gwdo': config_ngw_scheme, config_knob_ugwp_tauamp, and config_ugwp_diags. If config_ngw_scheme = true, an additional input file, ugwp_limb_tau.nc is needed. If config_ugwp_diags = true, the diag_ugwp output stream will be written. I can imagine members of the community asking about the new UGWP option, so having some of this documentation to point to in the PR description (perhaps later to be migrated to more formal user documentation) could be helpful. — Reply to this email directly, view it on GitHub <#1276 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ARRVLIESTSY7XIW45EANWBT2S5MBHAVCNFSM6AAAAABV2T2QZGVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDMNRSGM4TSMZYGM>. You are receiving this because you were mentioned.

mdtoyNOAA added 9 commits January 24, 2025 22:09

Add call to compute GSL GWDO fields in init_atm_setup_case() routine

9ecb7cf

When the namelist option config_native_gwd_gsl_static is .true., the init_atm_setup_case() routine now calls thecalc_gsl_oro_data() routine to compute the twenty GSL GWDO static fields.

Add UGWP directory to .gitignore file in src/core_atmosphere/physics

48f988a

Define Registry.xml entities for the GSL UGWP scheme

90f8d7f

Also included in this commit is logic for setting up packages related to the GSL UGWP scheme in the atm_setup_packages() routine.

Merge branch 'develop' of https://github.com/mpas-Dev/MPAS-Model into…

839cf5b

… GSL_UGWP_mdtoy

mgduda requested review from ldfowler58 and mgduda January 24, 2025 23:01

mgduda added feature Atmosphere labels Jan 24, 2025

mgduda requested changes Jan 31, 2025

View reviewed changes

mgduda self-requested a review February 27, 2025 22:30

mgduda requested changes Feb 28, 2025

View reviewed changes

src/core_atmosphere/Registry.xml Show resolved Hide resolved

Added 'DO_PHYSICS' pre-processing directives around 'ugwp' streams

15f3337

mgduda self-requested a review February 28, 2025 19:58

mgduda approved these changes Mar 5, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add NOAA UFS UGWP suite of physics parameterizations #1276

Add NOAA UFS UGWP suite of physics parameterizations #1276

mdtoyNOAA commented Jan 24, 2025 •

edited

Loading

mgduda Jan 29, 2025

mdtoyNOAA Feb 1, 2025

mgduda commented Jan 31, 2025

mdtoyNOAA commented Feb 1, 2025

mgduda left a comment

mgduda left a comment

mdtoyNOAA commented Mar 6, 2025 via email •

edited

Loading

Add NOAA UFS UGWP suite of physics parameterizations #1276

Are you sure you want to change the base?

Add NOAA UFS UGWP suite of physics parameterizations #1276

Conversation

mdtoyNOAA commented Jan 24, 2025 • edited Loading

mgduda Jan 29, 2025

Choose a reason for hiding this comment

mdtoyNOAA Feb 1, 2025

Choose a reason for hiding this comment

mgduda commented Jan 31, 2025

mdtoyNOAA commented Feb 1, 2025

mgduda left a comment

Choose a reason for hiding this comment

mgduda left a comment

Choose a reason for hiding this comment

mdtoyNOAA commented Mar 6, 2025 via email • edited Loading

mdtoyNOAA commented Jan 24, 2025 •

edited

Loading

mdtoyNOAA commented Mar 6, 2025 via email •

edited

Loading