Skip to content

Allow nonhydrostatic FV3 #1340

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

Draft
wants to merge 2 commits into
base: cam_development
Choose a base branch
from
Draft

Allow nonhydrostatic FV3 #1340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
722cc47
modifications to allow fv3 to be run in nonhydrostatic mode
ta440 Jul 1, 2025
492be3a
merge up to cam6_4_100
jtruesdal Jul 1, 2025
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
25 changes: 24 additions & 1 deletion bld/build-namelist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -709,6 +709,19 @@ if (!($simple_phys or $aqua_mode)) {
}
}

# Setup default ndep streams only if not simple_phys or aqua_mode and
# the chemistry cannot produce the nitrogen depostion fluxes
if (!($simple_phys or $aqua_mode)) {
my $chem_nitrodep = chem_has_species($cfg, 'NO') and chem_has_species($cfg, 'NH3');
if ((!$chem_nitrodep) or ($chem =~ /geoschem/)) {
add_default($nl, 'stream_ndep_mesh_filename');
add_default($nl, 'stream_ndep_data_filename', 'sim_year'=>$sim_year);
add_default($nl, 'stream_ndep_year_first', 'sim_year'=>$sim_year);
add_default($nl, 'stream_ndep_year_last', 'sim_year'=>$sim_year);
add_default($nl, 'stream_ndep_year_align', 'sim_year'=>$sim_year);
}
}

# Topography
add_default($nl, 'use_topo_file');
my $use_topo_file = $nl->get_value('use_topo_file');
Expand Down Expand Up @@ -3868,6 +3881,14 @@ if (!$simple_phys) {
}
}

my $use_gw_movmtn_pbl = $nl->get_value('use_gw_movmtn_pbl');
if ($use_gw_movmtn_pbl =~ /$TRUE/io) {
if ( ! ($dyn =~ /se/) ) {
die "$ProgName - ERROR: use_gw_movmtn_pbl is only available with the SE dycore \n";

}
}

add_default($nl, 'use_gw_rdg_gamma' , 'val'=>'.false.');
add_default($nl, 'use_gw_front_igw' , 'val'=>'.false.');
add_default($nl, 'use_gw_convect_sh', 'val'=>'.false.');
Expand Down Expand Up @@ -4096,7 +4117,9 @@ if ($dyn eq 'fv') {

# FV3 dycore
if ( $dyn eq 'fv3') {

add_default($nl, 'fv3_a_imp');
add_default($nl, 'fv3_p_fac');
add_default($nl, 'fv3_use_logp');
add_default($nl, 'fv3_adjust_dry_mass');
add_default($nl, 'fv3_beta');
add_default($nl, 'fv3_clock_grain');
Expand Down
5 changes: 5 additions & 0 deletions bld/namelist_files/namelist_defaults_cam.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -785,6 +785,8 @@

<effgw_rdg_resid >1.0D0</effgw_rdg_resid>

<effgw_rdg_resid >1.0D0</effgw_rdg_resid>

<effgw_rdg_beta >1.0D0</effgw_rdg_beta>
<effgw_rdg_beta model_top="lt" >0.5D0</effgw_rdg_beta>
<effgw_rdg_beta model_top="mt" >0.5D0</effgw_rdg_beta>
Expand Down Expand Up @@ -3055,6 +3057,9 @@

<fv3_print_memory_usage dyn="fv3">.true.</fv3_print_memory_usage>

<fv3_a_imp > 1.0D0 </fv3_a_imp>
<fv3_p_fac > 0.05D0 </fv3_p_fac>
<fv3_use_logp > .false. </fv3_use_logp>
<fv3_adjust_dry_mass > .false. </fv3_adjust_dry_mass>
<fv3_beta > 0 </fv3_beta>
<fv3_consv_am > .false. </fv3_consv_am>
Expand Down
36 changes: 36 additions & 0 deletions bld/namelist_files/namelist_definition.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9036,6 +9036,42 @@ Default: none

<!-- for fv3 dynamical core -->

<entry id="fv3_a_imp" type="real" category="dyn_fv3"
group="fv_core_nml" valid_values="" >
Real: Controls behavior of the non-hydrostatic solver. Values greater
than 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 algo-
rithm is substantially more efficient except at very high (km-scale)
resolutions with an acoustic time step of a few seconds or less. 0.75
by default. Proper values are 0, or between 0.5 and 1. This variable is
only used if hydrostatic =.false.
Default: 1.
</entry>

<entry id="fv3_p_fac" type="real" category="dyn_fv3"
group="fv_core_nml" valid_values="" >
Real: 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. 0.05 by default. Only used if hydrostatic =.false.
and the semi-implicit solver is used. Proper range is 0 to 0.25.
Default: 0.05
</entry>

<entry id="fv3_use_logp" type="real" category="dyn_fv3"
group="fv_core_nml" valid_values="" >
Logical: Enables a variant of the Lin pressure-gradient force
algorithm, which uses the logarithm of pressure instead of the Exner
function (as in Lin 1997). This yields more accurate results for re-
gions that are nearly isothermal. Ignored if hydrostatic = true.
Default: FALSE
</entry>

<entry id="fv3_clock_grain" type="char*256" category="dyn_fv3"
group="fms_nml" valid_values="" >
The level of clock granularity used for performance timing sections
Expand Down
3 changes: 2 additions & 1 deletion cime_config/config_component.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,8 @@
<!-- hemco (harmonized emissions component) option -->
<value compset="_CAM.*%HEMCO"> use_hemco=.true. </value>
<!-- rearth provided by FMS for FV3 and must remain fixed to that value to maintain consistency between phys/dyn. -->
<value grid="a%C[0-9]"> rearth = 6.37122D6 </value>
<!-- This has been commented out to allow FV3 to run in a small Earth configuration -->
<!-- <value grid="a%C[0-9]"> rearth = 6.37122D6 </value> -->
</values>
<group>run_component_cam</group>
<file>env_run.xml</file>
Expand Down
54 changes: 45 additions & 9 deletions src/dynamics/tests/inic_analytic.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ module inic_analytic
CONTAINS
!==============================================================================

subroutine dyn_set_inic_col(vcoord, latvals, lonvals, glob_ind, zint, U, V, T, &
PS, PHIS_IN, PHIS_OUT, Q, m_cnst, mask, verbose)
subroutine dyn_set_inic_col(vcoord, latvals, lonvals, glob_ind, zint, U, V, W, &
T, PS, PHIS_IN, PHIS_OUT, Q, m_cnst, mask, verbose)
use cam_initfiles, only: pertlim
#ifdef ANALYTIC_IC
use ic_held_suarez, only: hs94_set_ic
Expand All @@ -62,6 +62,7 @@ subroutine dyn_set_inic_col(vcoord, latvals, lonvals, glob_ind, zint, U, V, T, &
real(r8), optional, intent(in) :: zint(:,:) ! height at layer interfaces
real(r8), optional, intent(inout) :: U(:,:) ! zonal velocity
real(r8), optional, intent(inout) :: V(:,:) ! meridional velocity
real(r8), optional, intent(inout) :: W(:,:) ! vertical velocity (nonhydrostatic)
real(r8), optional, intent(inout) :: T(:,:) ! temperature
real(r8), optional, intent(inout) :: PS(:) ! surface pressure
real(r8), optional, intent(in) :: PHIS_IN(:) ! surface geopotential
Expand Down Expand Up @@ -116,6 +117,13 @@ subroutine dyn_set_inic_col(vcoord, latvals, lonvals, glob_ind, zint, U, V, T, &
return
end if
end if
if (present(W)) then
if (size(W) > 0) then
call check_array_size(W(:,1), 'W', latvals, subname)
else
return
end if
end if
if (present(T)) then
if (size(T) > 0) then
call check_array_size(T(:,1), 'T', latvals, subname)
Expand Down Expand Up @@ -160,20 +168,20 @@ subroutine dyn_set_inic_col(vcoord, latvals, lonvals, glob_ind, zint, U, V, T, &
end if
select case(trim(analytic_ic_type))
case('held_suarez_1994')
call hs94_set_ic(latvals, lonvals, U=U, V=V, T=T, PS=PS, PHIS=PHIS_OUT, &
call hs94_set_ic(latvals, lonvals, U=U, V=V, W=W, T=T, PS=PS, PHIS=PHIS_OUT, &
Q=Q, m_cnst=m_cnst, mask=mask_use, verbose=verbose_use)

case('moist_baroclinic_wave_dcmip2016', 'dry_baroclinic_wave_dcmip2016')
call bc_wav_set_ic(vcoord, latvals, lonvals, zint=zint, U=U, V=V, T=T, PS=PS, &
PHIS=PHIS_OUT, Q=Q, m_cnst=m_cnst, mask=mask_use, verbose=verbose_use)
call bc_wav_set_ic(vcoord, latvals, lonvals, zint=zint, U=U, V=V, W=W, T=T, &
PS=PS, PHIS=PHIS_OUT, Q=Q, m_cnst=m_cnst, mask=mask_use, verbose=verbose_use)

case('dry_baroclinic_wave_jw2006')
call bc_dry_jw06_set_ic(vcoord, latvals, lonvals, U=U, V=V, T=T, PS=PS, &
call bc_dry_jw06_set_ic(vcoord, latvals, lonvals, U=U, V=V, W=W, T=T, PS=PS, &
PHIS=PHIS_OUT, Q=Q, m_cnst=m_cnst, mask=mask_use, verbose=verbose_use)

case('us_standard_atmosphere')
call us_std_atm_set_ic(latvals, lonvals, zint=zint, U=U, V=V, T=T, PS=PS, PHIS_IN=PHIS_IN, &
PHIS_OUT=PHIS_OUT, Q=Q, m_cnst=m_cnst, mask=mask_use, verbose=verbose_use)
call us_std_atm_set_ic(latvals, lonvals, zint=zint, U=U, V=V, W=W, T=T, PS=PS, &
PHIS_IN=PHIS_IN, PHIS_OUT=PHIS_OUT, Q=Q, m_cnst=m_cnst, mask=mask_use, verbose=verbose_use)

case default
call endrun(subname//': Unknown analytic_ic_type, "'//trim(analytic_ic_type)//'"')
Expand Down Expand Up @@ -216,7 +224,7 @@ subroutine dyn_set_inic_col(vcoord, latvals, lonvals, glob_ind, zint, U, V, T, &

end subroutine dyn_set_inic_col

subroutine dyn_set_inic_cblock(vcoord,latvals, lonvals, glob_ind, U, V, T, &
subroutine dyn_set_inic_cblock(vcoord,latvals, lonvals, glob_ind, U, V, W, T, &
PS, PHIS_IN, PHIS_OUT, Q, m_cnst, mask)
!-----------------------------------------------------------------------
!
Expand All @@ -231,6 +239,7 @@ subroutine dyn_set_inic_cblock(vcoord,latvals, lonvals, glob_ind, U, V, T, &
integer, intent(in) :: glob_ind(:) ! global column index
real(r8), optional, intent(inout) :: U(:,:,:) ! zonal velocity
real(r8), optional, intent(inout) :: V(:,:,:) ! meridional velocity
real(r8), optional, intent(inout) :: W(:,:,:) ! vertical velocity (nonhydrostatic)
real(r8), optional, intent(inout) :: T(:,:,:) ! temperature
real(r8), optional, intent(inout) :: PS(:,:) ! surface pressure
real(r8), optional, intent(in) :: PHIS_IN(:,:)! surface geopotential
Expand Down Expand Up @@ -259,6 +268,9 @@ subroutine dyn_set_inic_cblock(vcoord,latvals, lonvals, glob_ind, U, V, T, &
if(present(V)) then
call get_input_shape(V, 'V', mname, size1, size2, size3, subname)
end if
if(present(W)) then
call get_input_shape(W, 'W', mname, size1, size2, size3, subname)
end if
if(present(T)) then
call get_input_shape(T, 'T', mname, size1, size2, size3, subname)
end if
Expand Down Expand Up @@ -301,6 +313,10 @@ subroutine dyn_set_inic_cblock(vcoord,latvals, lonvals, glob_ind, U, V, T, &
call dyn_set_inic_col(vcoord,latvals(bbeg:bend), lonvals(bbeg:bend), &
glob_ind(bbeg:bend), V=V(:,:,i), mask=mask(bbeg:bend), verbose=verbose)
end if
if (present(W)) then
call dyn_set_inic_col(vcoord,latvals(bbeg:bend), lonvals(bbeg:bend), &
glob_ind(bbeg:bend), W=W(:,:,i), mask=mask(bbeg:bend), verbose=verbose)
end if
if (present(PS).and.present(PHIS_IN).and.present(T)) then
call dyn_set_inic_col(vcoord,latvals(bbeg:bend), lonvals(bbeg:bend), &
glob_ind(bbeg:bend), PS=PS(:,i), PHIS_IN=PHIS_IN(:,i), T=T(:,:,i), &
Expand Down Expand Up @@ -333,6 +349,10 @@ subroutine dyn_set_inic_cblock(vcoord,latvals, lonvals, glob_ind, U, V, T, &
call dyn_set_inic_col(vcoord,latvals(bbeg:bend), lonvals(bbeg:bend), &
glob_ind(bbeg:bend), V=V(:,:,i), verbose=verbose)
end if
if (present(W)) then
call dyn_set_inic_col(vcoord,latvals(bbeg:bend), lonvals(bbeg:bend), &
glob_ind(bbeg:bend), W=W(:,:,i), verbose=verbose)
end if
if (present(PS).and.present(PHIS_IN).and.present(T)) then
call dyn_set_inic_col(vcoord,latvals(bbeg:bend), lonvals(bbeg:bend), &
glob_ind(bbeg:bend), PHIS_IN=PHIS_IN(:,i),PS=PS(:,i),T=T(:,:,i), &
Expand Down Expand Up @@ -382,6 +402,10 @@ subroutine dyn_set_inic_cblock(vcoord,latvals, lonvals, glob_ind, U, V, T, &
call dyn_set_inic_col(vcoord,latvals(bbeg:bend), lonvals(bbeg:bend), &
glob_ind(bbeg:bend), V=V(:,i,:), mask=mask(bbeg:bend), verbose=verbose)
end if
if (present(W)) then
call dyn_set_inic_col(vcoord,latvals(bbeg:bend), lonvals(bbeg:bend), &
glob_ind(bbeg:bend), W=W(:,i,:), mask=mask(bbeg:bend), verbose=verbose)
end if
if (present(PS).and.present(PHIS_IN).and.present(T)) then
call dyn_set_inic_col(vcoord,latvals(bbeg:bend), lonvals(bbeg:bend), &
glob_ind(bbeg:bend), PHIS_IN=PHIS_IN(:,i),PS=PS(:,i),T=T(:,i,:), &
Expand Down Expand Up @@ -414,6 +438,10 @@ subroutine dyn_set_inic_cblock(vcoord,latvals, lonvals, glob_ind, U, V, T, &
call dyn_set_inic_col(vcoord,latvals(bbeg:bend), lonvals(bbeg:bend), &
glob_ind(bbeg:bend), V=V(:,i,:), verbose=verbose)
end if
if (present(W)) then
call dyn_set_inic_col(vcoord,latvals(bbeg:bend), lonvals(bbeg:bend), &
glob_ind(bbeg:bend), W=W(:,i,:), verbose=verbose)
end if
if (present(PS).and.present(PHIS_IN).and.present(T)) then
call dyn_set_inic_col(vcoord,latvals(bbeg:bend), lonvals(bbeg:bend), &
glob_ind(bbeg:bend), PHIS_IN=PHIS_IN(:,i),PS=PS(:,i),T=T(:,i,:), &
Expand Down Expand Up @@ -463,6 +491,10 @@ subroutine dyn_set_inic_cblock(vcoord,latvals, lonvals, glob_ind, U, V, T, &
call dyn_set_inic_col(vcoord,lat_use, lonvals, glob_ind(bbeg:bend), &
V=V(:,i,:), verbose=verbose)
end if
if (present(W)) then
call dyn_set_inic_col(vcoord,lat_use, lonvals, glob_ind(bbeg:bend), &
W=W(:,i,:), verbose=verbose)
end if
if (present(PS).and.present(PHIS_IN).and.present(T)) then
call dyn_set_inic_col(vcoord,lat_use, lonvals, glob_ind(bbeg:bend), &
PS=PS(:,i),T=T(:,i,:),PHIS_IN=PHIS_IN(:,i), verbose=verbose)
Expand Down Expand Up @@ -511,6 +543,10 @@ subroutine dyn_set_inic_cblock(vcoord,latvals, lonvals, glob_ind, U, V, T, &
call dyn_set_inic_col(vcoord,lat_use, lonvals, glob_ind(bbeg:bend), &
V=V(:,:,i), verbose=verbose)
end if
if (present(W)) then
call dyn_set_inic_col(vcoord,lat_use, lonvals, glob_ind(bbeg:bend), &
W=W(:,:,i), verbose=verbose)
end if
if (present(PS).and.present(PHIS_IN).and.present(T)) then
call dyn_set_inic_col(vcoord,lat_use, lonvals, glob_ind(bbeg:bend), &
T=T(:,:,i),PS=PS(:,i), PHIS_IN=PHIS_IN(:,i), verbose=verbose)
Expand Down
25 changes: 19 additions & 6 deletions src/dynamics/tests/initial_conditions/ic_baro_dry_jw06.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ module ic_baro_dry_jw06

contains

subroutine bc_dry_jw06_set_ic(vcoord, latvals, lonvals, U, V, T, PS, PHIS, &
subroutine bc_dry_jw06_set_ic(vcoord, latvals, lonvals, U, V, W, T, PS, PHIS, &
Q, m_cnst, mask, verbose)
use dyn_tests_utils, only: vc_moist_pressure, vc_dry_pressure, vc_height
use constituents, only: cnst_name
Expand All @@ -67,6 +67,7 @@ subroutine bc_dry_jw06_set_ic(vcoord, latvals, lonvals, U, V, T, PS, PHIS, &
! z_k for vccord 1)
real(r8), optional, intent(inout) :: U(:,:) ! zonal velocity
real(r8), optional, intent(inout) :: V(:,:) ! meridional velocity
real(r8), optional, intent(inout) :: W(:,:) ! vertical velocity (nonhydrostatic)
real(r8), optional, intent(inout) :: T(:,:) ! temperature
real(r8), optional, intent(inout) :: PS(:) ! surface pressure
real(r8), optional, intent(out) :: PHIS(:) ! surface geopotential
Expand All @@ -77,7 +78,7 @@ subroutine bc_dry_jw06_set_ic(vcoord, latvals, lonvals, U, V, T, PS, PHIS, &
! Local variables
logical, allocatable :: mask_use(:)
logical :: verbose_use
logical :: lu,lv,lt,lq,l3d_vars
logical :: lu,lv,lw,lt,lq,l3d_vars
integer :: i, k, m
integer :: ncol
integer :: nlev
Expand All @@ -91,8 +92,8 @@ subroutine bc_dry_jw06_set_ic(vcoord, latvals, lonvals, U, V, T, PS, PHIS, &
real(r8) :: phi_vertical
real(r8) :: u_wind(size(latvals))

a_omega = rearth*omega
exponent = rair*gamma/gravit
a_omega = rearth*omega
exponent = rair*gamma/gravit

allocate(mask_use(size(latvals)))
if (present(mask)) then
Expand Down Expand Up @@ -163,13 +164,15 @@ subroutine bc_dry_jw06_set_ic(vcoord, latvals, lonvals, U, V, T, PS, PHIS, &
!
lu = present(U)
lv = present(V)
lw = present(W)
lT = present(T)
lq = present(Q)
l3d_vars = lu .or. lv .or. lt .or.lq
l3d_vars = lu .or. lv .or. lw .or. lt .or.lq
nlev = -1
if (l3d_vars) then
if (lu) nlev = size(U, 2)
if (lv) nlev = size(V, 2)
if (lv) nlev = size(W, 2)
if (lt) nlev = size(T, 2)
if (lq) nlev = size(Q, 2)

Expand Down Expand Up @@ -201,6 +204,16 @@ subroutine bc_dry_jw06_set_ic(vcoord, latvals, lonvals, U, V, T, PS, PHIS, &
write(iulog,*) ' V initialized by "',subname,'"'
end if
end if
if (lw) then
do k = 1, nlev
where(mask_use)
W(:,k) = 0.0_r8
end where
end do
if(masterproc.and. verbose_use) then
write(iulog,*) ' W (nonhydrostatic) initialized by "',subname,'"'
end if
end if
if (lt) then
do k = 1, nlev
eta = hyam(k) + hybm(k)
Expand Down Expand Up @@ -232,7 +245,7 @@ subroutine bc_dry_jw06_set_ic(vcoord, latvals, lonvals, U, V, T, PS, PHIS, &
end where
end do
if(masterproc.and. verbose_use) then
write(iulog,*) ' ', trim(cnst_name(m_cnst(1))), ' initialized by "',subname,'"'
write(iulog,*) ' ', trim(cnst_name(m_cnst(1))), ' initialized by "',subname,'"'
end if
end if
end if
Expand Down
Loading