Skip to content

GWDO2026: Revisions in gravity wave drag scheme (bl_gwdo.F90) #1409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Songyou184 wants to merge 12 commits into
base: develop
Choose a base branch
from
Open

GWDO2026: Revisions in gravity wave drag scheme (bl_gwdo.F90) #1409

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
091b104
SFCLAY: turbulent orographic form drag (TOFD):
Songyou184 Feb 9, 2026
7c74580
modified: src/core_atmosphere/Externals.cfg
Songyou184 Feb 9, 2026
f51b3cd
modified: core_atmosphere/Externals.cfg
Songyou184 Feb 10, 2026
18aa12f
deleted: core_atmosphere/physics/mpas_atmphys_driver_sfclayer.F
Songyou184 Feb 10, 2026
fccc7fb
restore master file
Songyou184 Feb 10, 2026
879df95
modified: physics/mpas_atmphys_control.F
Songyou184 Feb 12, 2026
8b7a88d
modified: mpas_atmphys_driver_gwdo.F
Songyou184 Feb 12, 2026
5962200
modified: mpas_atmphys_driver_gwdo.F
Songyou184 Feb 12, 2026
2a95973
modified: mpas_atmphys_driver_gwdo.F
Songyou184 Feb 12, 2026
0e4db6d
modified: src/core_atmosphere/Registry.xml
Songyou184 Feb 15, 2026
75e7cfb
Merge branch 'GWDO2026' of https://github.com/Songyou184/MPAS-Model i…
Songyou184 Feb 15, 2026
eb18414
remove unnecessary files
Songyou184 Feb 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/core_atmosphere/Externals.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[MMM-physics]
local_path = ./physics_mmm
protocol = git
repo_url = https://github.com/NCAR/MMM-physics.git
tag = 20250616-MPASv8.3
repo_url = https://github.com/songyou184/MMM-physics.git
Copy link
Copy Markdown
Collaborator

@jihyeonjang jihyeonjang May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a private repository rather than the public MMM-physics repository. If possible, I think the branch/tag specified in Externals.cfg should be from https://github.com/NCAR/MMM-physics.git.

Copy link
Copy Markdown
Contributor

@weiwangncar weiwangncar May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jihyeonjang Since bl_gwdo.F90 in MMM-physics has recently updated, it is now ok to point to that repository. But it may need to update the hash to access the newest code.

branch =MMM2026-GWDO
required = True

[GSL_UGWP]
Expand Down
13 changes: 12 additions & 1 deletion src/core_atmosphere/Registry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,6 +521,7 @@
<var name="ol2"/>
<var name="ol3"/>
<var name="ol4"/>
<var name="elvmax"/>
<var name="soilcomp"/>
<var name="soilcl1"/>
<var name="soilcl2"/>
Expand Down Expand Up @@ -2278,7 +2279,7 @@
<nml_option name="config_gwdo_scheme" type="character" default_value="suite" in_defaults="false"
units="-"
description="configuration of gravity wave drag over orography"
possible_values="`suite',`bl_ysu_gwdo',`bl_ugwp_gwdo',`off'"/>
possible_values="`suite',`bl_kim_gwdo',`bl_ugwp_gwdo',`off'"/>

<nml_option name="config_ngw_scheme" type="logical" default_value="false" in_defaults="false"
units="-"
Expand Down Expand Up @@ -2451,6 +2452,14 @@
units="s"
description="Relaxation time to initial values in 1-d OML"
possible_values="Non-negative real values"/>
<nml_option name="config_gwdo_factor" type="real" default_value="2.0" in_defaults="false"
units="-"
description="Effective grid length ratio in kim_gwdo scheme"
possible_values="Non-negative real values"/>
<nml_option name="config_gwdo_nonhyd" type="logical" default_value="true" in_defaults="true"
Copy link
Copy Markdown
Collaborator

@jihyeonjang jihyeonjang May 22, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it okay to set in_defaults="false" so that config_gwdo_nonhyd is set to true automatically and does not need to be specified by users in namelist.atmosphere, similar to the other physics options?

units="-"
description="Logical index for nonhydrostatic effect in kim_gwdo scheme"
possible_values="true. or .false."/>
Copy link
Copy Markdown
Collaborator

@jihyeonjang jihyeonjang May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For possible_values, "." is needed before true, so it should be:
possible_values=".true. or .false."

</nml_record>

<var_struct name="diag_physics" time_levs="1">
Expand Down Expand Up @@ -3782,6 +3791,8 @@

<var name="ol4" type="real" dimensions="nCells" units="unitless"
description="effective orographic length for north-westerly flow"/>
<var name="elvmax" type="real" dimensions="nCells" units="m"
description="elevation maximum over a grid cell"/>

<!-- GSL GWDO fields - meso-scale -->
<var name="var2dls" type="real" dimensions="nCells" units="m"
Expand Down
10 changes: 6 additions & 4 deletions src/core_atmosphere/physics/mpas_atmphys_control.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ module mpas_atmphys_control
! * in the mesoscale_reference suite, replaced the MM5 surface layer scheme with the MM5 revised surface layer
! scheme as the default option for config_sfclayer_scheme.
! Laura D. Fowler (laura@ucar.edu) / 2024-06-18.
! * renamed "bl_ysu_gwdo" to "bl_kim_gwdo"
! Songyou Hong (hong@ucar.edu) / 2025-08-24.


contains
Expand Down Expand Up @@ -133,7 +135,7 @@ subroutine physics_namelist_check(configs)
if (trim(config_microp_scheme) == 'suite') config_microp_scheme = 'mp_wsm6'
if (trim(config_convection_scheme) == 'suite') config_convection_scheme = 'cu_ntiedtke'
if (trim(config_pbl_scheme) == 'suite') config_pbl_scheme = 'bl_ysu'
if (trim(config_gwdo_scheme) == 'suite') config_gwdo_scheme = 'bl_ysu_gwdo'
if (trim(config_gwdo_scheme) == 'suite') config_gwdo_scheme = 'bl_kim_gwdo'
if (trim(config_radt_lw_scheme) == 'suite') config_radt_lw_scheme = 'rrtmg_lw'
if (trim(config_radt_sw_scheme) == 'suite') config_radt_sw_scheme = 'rrtmg_sw'
if (trim(config_radt_cld_scheme) == 'suite') config_radt_cld_scheme = 'cld_fraction'
Expand All @@ -145,7 +147,7 @@ subroutine physics_namelist_check(configs)
if (trim(config_microp_scheme) == 'suite') config_microp_scheme = 'mp_thompson'
if (trim(config_convection_scheme) == 'suite') config_convection_scheme = 'cu_grell_freitas'
if (trim(config_pbl_scheme) == 'suite') config_pbl_scheme = 'bl_mynn'
if (trim(config_gwdo_scheme) == 'suite') config_gwdo_scheme = 'bl_ysu_gwdo'
if (trim(config_gwdo_scheme) == 'suite') config_gwdo_scheme = 'bl_kim_gwdo'
if (trim(config_radt_lw_scheme) == 'suite') config_radt_lw_scheme = 'rrtmg_lw'
if (trim(config_radt_sw_scheme) == 'suite') config_radt_sw_scheme = 'rrtmg_sw'
if (trim(config_radt_cld_scheme) == 'suite') config_radt_cld_scheme = 'cld_fraction'
Expand Down Expand Up @@ -211,7 +213,7 @@ subroutine physics_namelist_check(configs)

!gravity wave drag over orography scheme:
if(.not. (config_gwdo_scheme .eq. 'off' .or. &
config_gwdo_scheme .eq. 'bl_ysu_gwdo' .or. &
config_gwdo_scheme .eq. 'bl_kim_gwdo' .or. &
config_gwdo_scheme .eq. 'bl_ugwp_gwdo')) then

write(mpas_err_message,'(A,A20)') 'illegal value for gwdo_scheme: ', &
Expand Down Expand Up @@ -481,7 +483,7 @@ subroutine physics_compatibility_check(dminfo, blockList, streamManager, ierr)

call mpas_pool_get_config(blocklist % configs, 'config_gwdo_scheme', gwdo_scheme)

if (trim(gwdo_scheme) == 'bl_ysu_gwdo') then
if (trim(gwdo_scheme) == 'bl_kim_gwdo') then
maxvar2d_local = -huge(maxvar2d_local)
block => blockList
do while (associated(block))
Expand Down
1 change: 1 addition & 0 deletions src/core_atmosphere/physics/mpas_atmphys_driver.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ subroutine physics_driver(domain,itimestep,xtime_s)
config_sfclayer_scheme

logical, pointer:: config_oml1d
logical, pointer:: config_gwdo_nonhyd
real(kind=RKIND),pointer:: config_bucket_radt

!local variables:
Expand Down
33 changes: 20 additions & 13 deletions src/core_atmosphere/physics/mpas_atmphys_driver_gwdo.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ module mpas_atmphys_driver_gwdo
! Laura D. Fowler (laura@ucar.edu) / 2023-05-15.
! * added the NOAA UFS unified gravity wave drag scheme
! Michael D. Toy (michael.toy@noaa.gov) / 2024-10-21
! * Revised the ysu_gwdo follwing the studies (hong et al. 2025, koo and hong 2025), and renamed to kim_gwdo
! Songyou Hong (hong@ucar.edu) / 2025-11-27


contains
Expand All @@ -88,7 +90,6 @@ subroutine allocate_gwdo(configs)

if(.not.allocated(cosa_p) ) allocate(cosa_p(ims:ime,jms:jme) )
if(.not.allocated(sina_p) ) allocate(sina_p(ims:ime,jms:jme) )

if(.not.allocated(dx_p) ) allocate(dx_p(ims:ime,jms:jme) )
if(.not.allocated(kpbl_p )) allocate(kpbl_p(ims:ime,jms:jme) )
if(.not.allocated(dusfcg_p)) allocate(dusfcg_p(ims:ime,jms:jme))
Expand All @@ -101,7 +102,7 @@ subroutine allocate_gwdo(configs)

gwdo_select: select case (trim(gwdo_scheme))

case("bl_ysu_gwdo")
case("bl_kim_gwdo")
if(.not.allocated(var2d_p) ) allocate(var2d_p(ims:ime,jms:jme) )
if(.not.allocated(con_p) ) allocate(con_p(ims:ime,jms:jme) )
if(.not.allocated(oa1_p) ) allocate(oa1_p(ims:ime,jms:jme) )
Expand All @@ -112,6 +113,7 @@ subroutine allocate_gwdo(configs)
if(.not.allocated(ol2_p) ) allocate(ol2_p(ims:ime,jms:jme) )
if(.not.allocated(ol3_p) ) allocate(ol3_p(ims:ime,jms:jme) )
if(.not.allocated(ol4_p) ) allocate(ol4_p(ims:ime,jms:jme) )
if(.not.allocated(elvmax_p)) allocate(elvmax_p(ims:ime,jms:jme))

case("bl_ugwp_gwdo")
if(.not.allocated(var2dls_p) ) allocate(var2dls_p(ims:ime,jms:jme) )
Expand Down Expand Up @@ -206,7 +208,7 @@ subroutine deallocate_gwdo(configs)

gwdo_select: select case (trim(gwdo_scheme))

case("bl_ysu_gwdo")
case("bl_kim_gwdo")
if(allocated(var2d_p) ) deallocate(var2d_p )
if(allocated(con_p) ) deallocate(con_p )
if(allocated(oa1_p) ) deallocate(oa1_p )
Expand All @@ -217,7 +219,7 @@ subroutine deallocate_gwdo(configs)
if(allocated(ol2_p) ) deallocate(ol2_p )
if(allocated(ol3_p) ) deallocate(ol3_p )
if(allocated(ol4_p) ) deallocate(ol4_p )

if(allocated(elvmax_p)) deallocate(elvmax_p)
case("bl_ugwp_gwdo")
if(allocated(var2dls_p) ) deallocate(var2dls_p )
if(allocated(conls_p) ) deallocate(conls_p )
Expand Down Expand Up @@ -307,7 +309,7 @@ subroutine gwdo_from_MPAS(configs,mesh,sfc_input,ngw_input,diag_physics,tend_phy
integer,dimension(:),pointer:: jindx1_tau,jindx2_tau
real(kind=RKIND),pointer:: len_disp
real(kind=RKIND),dimension(:),pointer :: meshDensity
real(kind=RKIND),dimension(:),pointer :: oa1,oa2,oa3,oa4,ol1,ol2,ol3,ol4,con,var2d
real(kind=RKIND),dimension(:),pointer :: oa1,oa2,oa3,oa4,ol1,ol2,ol3,ol4,con,var2d,elvmax
real(kind=RKIND),dimension(:),pointer :: oa1ls,oa2ls,oa3ls,oa4ls,ol1ls,ol2ls, &
ol3ls,ol4ls,conls,var2dls
real(kind=RKIND),dimension(:),pointer :: oa1ss,oa2ss,oa3ss,oa4ss,ol1ss,ol2ss, &
Expand All @@ -333,11 +335,11 @@ subroutine gwdo_from_MPAS(configs,mesh,sfc_input,ngw_input,diag_physics,tend_phy
call mpas_pool_get_config(configs,'config_microp_scheme',microp_scheme)
call mpas_pool_get_array(mesh,'meshDensity',meshDensity)


gwdo_select: select case (trim(gwdo_scheme))

case("bl_ysu_gwdo")
case("bl_kim_gwdo")
call mpas_pool_get_array(sfc_input,'var2d',var2d)
call mpas_pool_get_array(sfc_input,'elvmax',elvmax)
call mpas_pool_get_array(sfc_input,'con' ,con )
call mpas_pool_get_array(sfc_input,'oa1' ,oa1 )
call mpas_pool_get_array(sfc_input,'oa2' ,oa2 )
Expand All @@ -359,6 +361,7 @@ subroutine gwdo_from_MPAS(configs,mesh,sfc_input,ngw_input,diag_physics,tend_phy
ol2_p(i,j) = ol2(i)
ol3_p(i,j) = ol3(i)
ol4_p(i,j) = ol4(i)
elvmax_p(i,j)= elvmax(i)
enddo
enddo

Expand Down Expand Up @@ -509,7 +512,6 @@ subroutine gwdo_from_MPAS(configs,mesh,sfc_input,ngw_input,diag_physics,tend_phy
enddo
enddo
endif

endif

case default
Expand Down Expand Up @@ -550,7 +552,7 @@ subroutine gwdo_from_MPAS(configs,mesh,sfc_input,ngw_input,diag_physics,tend_phy
enddo

end subroutine gwdo_from_MPAS

!=================================================================================================================
subroutine gwdo_to_MPAS(configs,diag_physics,tend_physics,its,ite)
!=================================================================================================================
Expand Down Expand Up @@ -687,7 +689,7 @@ subroutine gwdo_to_MPAS(configs,diag_physics,tend_physics,its,ite)
enddo

end subroutine gwdo_to_MPAS

!=================================================================================================================
subroutine driver_gwdo(itimestep,configs,mesh,sfc_input,ngw_input,diag_physics,tend_physics,its,ite)
!=================================================================================================================
Expand All @@ -708,6 +710,7 @@ subroutine driver_gwdo(itimestep,configs,mesh,sfc_input,ngw_input,diag_physics,t
!local variables:
character(len=StrKIND),pointer:: gwdo_scheme
logical,pointer:: ugwp_diags,ngw_scheme
logical,pointer:: if_nonhyd
integer,pointer:: ntau_d1y_ptr,ntau_d2t_ptr
real(kind=RKIND),dimension(:),pointer :: days_limb_ptr
real(kind=RKIND),dimension(:,:),pointer:: tau_limb_ptr
Expand All @@ -717,6 +720,7 @@ subroutine driver_gwdo(itimestep,configs,mesh,sfc_input,ngw_input,diag_physics,t

integer:: i
real(kind=RKIND),dimension(:),allocatable:: dx_max
real(kind=RKIND),pointer :: dx_factor

!CCPP-compliant flags:
character(len=StrKIND):: errmsg
Expand Down Expand Up @@ -754,7 +758,9 @@ subroutine driver_gwdo(itimestep,configs,mesh,sfc_input,ngw_input,diag_physics,t

gwdo_select: select case (trim(gwdo_scheme))

case("bl_ysu_gwdo")
case("bl_kim_gwdo")
call mpas_pool_get_config(configs,'config_gwdo_factor',dx_factor)
call mpas_pool_get_config(configs,'config_gwdo_nonhyd',if_nonhyd)
call mpas_timer_start('bl_gwdo')
call gwdo ( &
p3d = pres_hydd_p , p3di = pres2_hydd_p , pi3d = pi_p , &
Expand All @@ -768,8 +774,9 @@ subroutine driver_gwdo(itimestep,configs,mesh,sfc_input,ngw_input,diag_physics,t
var2d = var2d_p , oc12d = con_p , oa2d1 = oa1_p , &
oa2d2 = oa2_p , oa2d3 = oa3_p , oa2d4 = oa4_p , &
ol2d1 = ol1_p , ol2d2 = ol2_p , ol2d3 = ol3_p , &
ol2d4 = ol4_p , sina = sina_p , cosa = cosa_p , &
errmsg = errmsg , errflg = errflg , &
ol2d4 = ol4_p , elvmax = elvmax_p , sina = sina_p , &
cosa = cosa_p , errmsg = errmsg , errflg = errflg , &
dx_factor = dx_factor , if_nonhyd = if_nonhyd, &
ids = ids , ide = ide , jds = jds , jde = jde , kds = kds , kde = kde , &
ims = ims , ime = ime , jms = jms , jme = jme , kms = kms , kme = kme , &
its = its , ite = ite , jts = jts , jte = jte , kts = kts , kte = kte &
Expand Down
2 changes: 2 additions & 0 deletions src/core_atmosphere/physics/mpas_atmphys_vars.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,7 +469,9 @@ module mpas_atmphys_vars
sina_p !sine of map rotation [-]

real(kind=RKIND),dimension(:,:),allocatable:: &
ter_p, &!orographic height [m]
Copy link
Copy Markdown
Collaborator

@jihyeonjang jihyeonjang May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ter_p can be deleted? It does not appear to be used anywhere.

var2d_p, &!orographic variance [m2]
elvmax_p, &!orographic maximum [m]
con_p, &!orographic convexity [m2]
oa1_p, &!orographic direction asymmetry function [-]
oa2_p, &!orographic direction asymmetry function [-]
Expand Down
11 changes: 9 additions & 2 deletions src/core_atmosphere/physics/physics_wrf/module_bl_gwdo.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ subroutine gwdo(u3d,v3d,t3d,qv3d,p3d,p3di,pi3d,z, &
rublten,rvblten, &
dtaux3d,dtauy3d,dusfcg,dvsfcg, &
var2d,oc12d,oa2d1,oa2d2,oa2d3,oa2d4,ol2d1,ol2d2,ol2d3,ol2d4, &
sina,cosa,znu,znw,p_top, &
elvmax,sina,cosa,znu,znw,p_top, &
cp,g,rd,rv,ep1,pi, &
dt,dx,kpbl2d,itimestep, &
dx_factor,if_nonhyd, &
ids,ide, jds,jde, kds,kde, &
ims,ime, jms,jme, kms,kme, &
its,ite, jts,jte, kts,kte, &
Expand Down Expand Up @@ -76,6 +77,8 @@ subroutine gwdo(u3d,v3d,t3d,qv3d,p3d,p3di,pi3d,z, &
integer,intent(in),dimension(ims:ime,jms:jme):: kpbl2d

real(kind=kind_phys),intent(in):: dt,cp,g,rd,rv,ep1,pi
real(kind=kind_phys),intent(in):: dx_factor
logical ,intent(in):: if_nonhyd
real(kind=kind_phys),intent(in),optional:: p_top

real(kind=kind_phys),intent(in),dimension(kms:kme),optional:: &
Expand All @@ -88,6 +91,7 @@ subroutine gwdo(u3d,v3d,t3d,qv3d,p3d,p3di,pi3d,z, &
oc12d, &
oa2d1,oa2d2,oa2d3,oa2d4, &
ol2d1,ol2d2,ol2d3,ol2d4, &
elvmax, &
sina,cosa

real(kind=kind_phys),intent(in),dimension(ims:ime,kms:kme,jms:jme):: &
Expand Down Expand Up @@ -124,7 +128,7 @@ subroutine gwdo(u3d,v3d,t3d,qv3d,p3d,p3di,pi3d,z, &
integer:: i,j,k

real(kind=kind_phys),dimension(its:ite):: &
var2d_hv,oc12d_hv,dx_hv,sina_hv,cosa_hv
var2d_hv,oc12d_hv,dx_hv,sina_hv,cosa_hv,elvmax_hv
real(kind=kind_phys),dimension(its:ite):: &
oa2d1_hv,oa2d2_hv,oa2d3_hv,oa2d4_hv,ol2d1_hv,ol2d2_hv,ol2d3_hv,ol2d4_hv
real(kind=kind_phys),dimension(its:ite):: &
Expand Down Expand Up @@ -193,6 +197,7 @@ subroutine gwdo(u3d,v3d,t3d,qv3d,p3d,p3di,pi3d,z, &
ol2d2_hv(i) = ol2d2(i,j)
ol2d3_hv(i) = ol2d3(i,j)
ol2d4_hv(i) = ol2d4(i,j)
elvmax_hv(i) =elvmax(i,j)
enddo

call bl_gwdo_run(sina=sina_hv,cosa=cosa_hv &
Expand All @@ -209,6 +214,8 @@ subroutine gwdo(u3d,v3d,t3d,qv3d,p3d,p3di,pi3d,z, &
,oa2d3=oa2d3_hv, oa2d4=oa2d4_hv &
,ol2d1=ol2d1_hv, ol2d2=ol2d2_hv &
,ol2d3=ol2d3_hv, ol2d4=ol2d4_hv &
,omax=elvmax_hv &
,dx_factor=dx_factor,if_nonhyd=if_nonhyd &
,g_=g,cp_=cp,rd_=rd,rv_=rv,fv_=ep1,pi_=pi &
,dxmeter=dx_hv,deltim=dt &
,its=its,ite=ite,kte=kte,kme=kte+1 &
Expand Down