Skip to content

b4b-dev: Move nml parameters (changes paramfile) #3391

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

Merged
slevis-lmwg merged 14 commits into from
Mar 12, 2026
Merged

b4b-dev: Move nml parameters (changes paramfile) #3391

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
51007cd
add ncd_inqnvars
swensosc Aug 5, 2025
90db989
move namelist parameters to parameter file
swensosc Aug 7, 2025
5b1c0db
Merge branch 'b4b-dev' into move_nml_parameters
slevis-lmwg Dec 15, 2025
d4c1d6b
Update namelist_defaults_ctsm.xml with two new paramfiles
slevis-lmwg Dec 23, 2025
4c335bb
Merge branch 'b4b-dev' into move_nml_parameters
slevis-lmwg Jan 13, 2026
c7108fc
Merge branch 'b4b-dev' into move_nml_parameters
slevis-lmwg Feb 11, 2026
c0f67b8
Merge remote-tracking branch 'escomp/b4b-dev' into move_nml_parameters
ekluzek Mar 4, 2026
dc75fe6
Update more paramfiles: coupled clm60, clm50, and clm45
ekluzek Mar 5, 2026
7cfb840
Updated testmods with special paramfiles to the latest paramfile names
slevis-lmwg Mar 10, 2026
230651e
Move code from atm2lnd_params_constructor to a new subroutine ReadParams
slevis-lmwg Mar 10, 2026
eccba8b
Refactor my latest updates as discussed in code review with @ekluzek
slevis-lmwg Mar 12, 2026
91862e0
Merge remote-tracking branch 'escomp/b4b-dev' into move_nml_parameters
slevis-lmwg Mar 12, 2026
efa29cd
Minor correction in ExpectedTestFails.xml
slevis-lmwg Mar 12, 2026
dbe13df
Merge branch 'b4b-dev' into move_nml_parameters
slevis-lmwg Mar 12, 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
41 changes: 1 addition & 40 deletions bld/CLMBuildNamelist.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1893,11 +1893,6 @@ sub process_namelist_inline_logic {
#####################################
setup_logic_canopy($opts, $nl_flags, $definition, $defaults, $nl);

########################################
# namelist group: soilhydrology_inparm #
########################################
setup_logic_hydrology_params($opts, $nl_flags, $definition, $defaults, $nl);

#####################################
# namelist group: irrigation_inparm #
#####################################
Expand Down Expand Up @@ -3354,28 +3349,6 @@ sub setup_logic_supplemental_nitrogen {

#-------------------------------------------------------------------------------

sub setup_logic_hydrology_params {
#
# Logic for hydrology parameters
#
my ($opts, $nl_flags, $definition, $defaults, $nl) = @_;

my $lower = $nl->get_value( 'lower_boundary_condition' );
my $var = "baseflow_scalar";
if ( $lower == 1 || $lower == 2 ) {
add_default($opts, $nl_flags->{'inputdata_rootdir'}, $definition, $defaults, $nl,
$var, 'lower_boundary_condition' => $lower );
}
my $val = $nl->get_value( $var );
if ( defined($val) ) {
if ( $lower != 1 && $lower != 2 ) {
$log->fatal_error("baseflow_scalar is only used for lower_boundary_condition of flux or zero-flux");
}
}
}

#-------------------------------------------------------------------------------

sub setup_logic_irrigation_parameters {
my ($opts, $nl_flags, $definition, $defaults, $nl) = @_;

Expand Down Expand Up @@ -4866,18 +4839,6 @@ sub setup_logic_atm_forcing {
}
}

foreach $var ("precip_repartition_glc_all_snow_t",
"precip_repartition_glc_all_rain_t",
"precip_repartition_nonglc_all_snow_t",
"precip_repartition_nonglc_all_rain_t") {
if ( &value_is_true($nl->get_value("repartition_rain_snow")) ) {
add_default($opts, $nl_flags->{'inputdata_rootdir'}, $definition, $defaults, $nl, $var);
} else {
if (defined($nl->get_value($var))) {
$log->fatal_error("$var can only be set if repartition_rain_snow is true");
}
}
}
}

#-------------------------------------------------------------------------------
Expand Down Expand Up @@ -5431,7 +5392,7 @@ sub write_output_files {
clm_soilhydrology_inparm dynamic_subgrid cnvegcarbonstate
finidat_consistency_checks dynpft_consistency_checks
clm_initinterp_inparm century_soilbgcdecompcascade
soilhydrology_inparm luna friction_velocity mineral_nitrogen_dynamics
luna friction_velocity mineral_nitrogen_dynamics
soilwater_movement_inparm rooting_profile_inparm
soil_resis_inparm bgc_shared canopyfluxes_inparm aerosol
clmu_inparm clm_soilstate_inparm clm_nitrogen clm_snowhydrology_inparm hillslope_hydrology_inparm hillslope_properties_inparm
Expand Down
22 changes: 2 additions & 20 deletions bld/namelist_files/namelist_defaults_ctsm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,11 +273,6 @@ attributes from the config_cache.xml file (with keys converted to upper-case).
<soil_resis_method >1</soil_resis_method>
<soil_resis_method phys="clm4_5" >0</soil_resis_method>

<!-- Soil hydrology -->
<baseflow_scalar lower_boundary_condition="2">0.001d00</baseflow_scalar>
<baseflow_scalar lower_boundary_condition="1">1.d-2</baseflow_scalar>
<baseflow_scalar phys="clm4_5" lower_boundary_condition="2">1.d-2</baseflow_scalar>

<!-- Friction velocity -->
<zetamaxstable use_biomass_heat_storage=".true." >2.0d00</zetamaxstable>
<zetamaxstable phys="clm4_5" >2.0d00</zetamaxstable>
Expand Down Expand Up @@ -306,20 +301,6 @@ attributes from the config_cache.xml file (with keys converted to upper-case).

<longwave_downscaling_limit>0.5</longwave_downscaling_limit>

<precip_repartition_nonglc_all_snow_t>0.</precip_repartition_nonglc_all_snow_t>
<precip_repartition_nonglc_all_rain_t>2.</precip_repartition_nonglc_all_rain_t>
<!-- For CLM5 and following, we assume rain at somewhat cooler temperatures. The main
motivation is to increase glacier melt, which otherwise is too low in
CESM2. The physical justification is that the 0 - 2 C ramp used elsewhere
makes sense for typical atmospheric profiles; but over glaciers, inversions
are more common, so it is more reasonable to expect rain despite
below-freezing near-surface temperatures. -->
<precip_repartition_glc_all_snow_t >-2.</precip_repartition_glc_all_snow_t>
<precip_repartition_glc_all_rain_t >0.</precip_repartition_glc_all_rain_t>
<!-- For CLM45, we used the same rain-snow partitioning for glaciers as for other landunits -->
<precip_repartition_glc_all_snow_t phys="clm4_5" >0.</precip_repartition_glc_all_snow_t>
<precip_repartition_glc_all_rain_t phys="clm4_5" >2.</precip_repartition_glc_all_rain_t>

<!-- lnd2atm defaults -->
<melt_non_icesheet_ice_runoff >.true.</melt_non_icesheet_ice_runoff>
<melt_non_icesheet_ice_runoff phys="clm4_5" >.false.</melt_non_icesheet_ice_runoff>
Expand Down Expand Up @@ -623,7 +604,8 @@ attributes from the config_cache.xml file (with keys converted to upper-case).
<!-- The default filenames are given relative to the root directory
for the CLM2 data in the CESM distribution -->
<!-- Plant function types (relative to {csmdata}) -->
<paramfile phys="clm6_0" >lnd/clm2/paramdata/ctsm60_params.c260204.nc</paramfile>
<paramfile phys="clm6_0" >lnd/clm2/paramdata/ctsm60_params.c260303.nc</paramfile>
<!-- TODO: These two will need to be updated also -->
<paramfile phys="clm6_0" lnd_tuning_mode="clm6_0_cam7.0">ctsm60-cam70_params.c260204.nc</paramfile>
<paramfile phys="clm5_0" >lnd/clm2/paramdata/clm50_params.c250311.nc</paramfile>
<paramfile phys="clm4_5" >lnd/clm2/paramdata/clm45_params.c250311.nc</paramfile>
Expand Down
30 changes: 0 additions & 30 deletions bld/namelist_files/namelist_definition_ctsm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,12 +415,6 @@ Max number of iterations used in subr. CanopyFluxes. For many years, 40 was the
If TRUE use clm5 equation for fraction of intercepted precipitation
</entry>

<entry id="baseflow_scalar" type="real" category="clm_physics"
group="soilhydrology_inparm" valid_values="" >
Scalar multiplier for base flow rate
(ONLY used if lower_boundary_condition is not aquifer or table)
</entry>

<entry id="soilwater_movement_method" type="integer" category="clm_physics"
group="soilwater_movement_inparm" valid_values="0,1" >
Index of solution method of Richards equation.
Expand Down Expand Up @@ -1728,30 +1722,6 @@ This parameter must be in the range [0,1]
Only relevant if glcmec_downscale_longwave is .true.
</entry>

<entry id="precip_repartition_glc_all_snow_t" type="real" category="clm_physics"
group="atm2lnd_inparm" valid_values="" >
Temperature below which all precipitation falls as snow, for glacier columns (deg C)
Only relevant if repartition_rain_snow is .true.
</entry>

<entry id="precip_repartition_glc_all_rain_t" type="real" category="clm_physics"
group="atm2lnd_inparm" valid_values="" >
Temperature above which all precipitation falls as rain, for glacier columns (deg C)
Only relevant if repartition_rain_snow is .true.
</entry>

<entry id="precip_repartition_nonglc_all_snow_t" type="real" category="clm_physics"
group="atm2lnd_inparm" valid_values="" >
Temperature below which all precipitation falls as snow, for non-glacier columns (deg C)
Only relevant if repartition_rain_snow is .true.
</entry>

<entry id="precip_repartition_nonglc_all_rain_t" type="real" category="clm_physics"
group="atm2lnd_inparm" valid_values="" >
Temperature above which all precipitation falls as rain, for non-glacier columns (deg C)
Only relevant if repartition_rain_snow is .true.
</entry>

<!-- ======================================================================================== -->
<!-- Namelist items controlling fields sent to atmosphere -->
<!-- ======================================================================================== -->
Expand Down
66 changes: 4 additions & 62 deletions src/biogeophys/SoilHydrologyMod.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ module SoilHydrologyMod
save
!
! !PUBLIC MEMBER FUNCTIONS:
public :: SoilHydReadNML ! Read in the Soil hydrology namelist
public :: SetSoilWaterFractions ! Set diagnostic variables related to the fraction of water and ice in each layer
public :: SetFloodc ! Apply gridcell flood water flux to non-lake columns
public :: SetQflxInputs ! Set the flux of water into the soil from the top
Expand All @@ -62,13 +61,13 @@ module SoilHydrologyMod
type, private :: params_type
real(r8) :: aq_sp_yield_min ! Minimum aquifer specific yield (unitless)
real(r8) :: n_baseflow ! Drainage power law exponent (unitless)
real(r8) :: baseflow_scalar ! Scalar multiplier for base flow rate ()
real(r8) :: perched_baseflow_scalar ! Scalar multiplier for perched base flow rate (kg/m2/s)
real(r8) :: e_ice ! Soil ice impedance factor (unitless)
end type params_type
type(params_type), public :: params_inst

!-----------------------------------------------------------------------
real(r8), private :: baseflow_scalar = 1.e-2_r8
real(r8), parameter :: tolerance = 1.e-12_r8 ! tolerance for checking whether sublimation is greater than ice in top soil layer

integer, private :: head_gradient_method ! Method for calculating hillslope saturated head gradient
Expand Down Expand Up @@ -190,71 +189,14 @@ subroutine readParams( ncid )
call readNcdioScalar(ncid, 'aq_sp_yield_min', subname, params_inst%aq_sp_yield_min)
! Drainage power law exponent (unitless)
call readNcdioScalar(ncid, 'n_baseflow', subname, params_inst%n_baseflow)
! Scalar multiplier for base flow rate ()
call readNcdioScalar(ncid, 'baseflow_scalar', subname, params_inst%baseflow_scalar)
! Scalar multiplier for perched base flow rate (kg/m2/s)
call readNcdioScalar(ncid, 'perched_baseflow_scalar', subname, params_inst%perched_baseflow_scalar)
! Soil ice impedance factor (unitless)
call readNcdioScalar(ncid, 'e_ice', subname, params_inst%e_ice)

end subroutine readParams

!-----------------------------------------------------------------------
subroutine soilHydReadNML( NLFilename )
!
! !DESCRIPTION:
! Read the namelist for soil hydrology
!
! !USES:
use fileutils , only : getavu, relavu, opnfil
use shr_nl_mod , only : shr_nl_find_group_name
use spmdMod , only : masterproc, mpicom
use shr_mpi_mod , only : shr_mpi_bcast
use clm_varctl , only : iulog
use shr_log_mod , only : errMsg => shr_log_errMsg
!
! !ARGUMENTS:
character(len=*), intent(in) :: NLFilename ! Namelist filename
!
! !LOCAL VARIABLES:
integer :: ierr ! error code
integer :: unitn ! unit for namelist file

character(len=*), parameter :: subname = 'soilHydReadNML'
character(len=*), parameter :: nmlname = 'soilhydrology_inparm'
!-----------------------------------------------------------------------
namelist /soilhydrology_inparm/ baseflow_scalar

! Initialize options to default values, in case they are not specified in
! the namelist


if (masterproc) then
unitn = getavu()
write(iulog,*) 'Read in '//nmlname//' namelist'
call opnfil (NLFilename, unitn, 'F')
call shr_nl_find_group_name(unitn, nmlname, status=ierr)
if (ierr == 0) then
read(unitn, nml=soilhydrology_inparm, iostat=ierr)
if (ierr /= 0) then
call endrun(msg="ERROR reading "//nmlname//"namelist"//errmsg(sourcefile, __LINE__))
end if
else
call endrun(msg="ERROR could NOT find "//nmlname//"namelist"//errmsg(sourcefile, __LINE__))
end if
call relavu( unitn )
end if

call shr_mpi_bcast (baseflow_scalar, mpicom)

if (masterproc) then
write(iulog,*) ' '
write(iulog,*) nmlname//' settings:'
write(iulog,nml=soilhydrology_inparm)
write(iulog,*) ' '
end if

end subroutine soilhydReadNML



!-----------------------------------------------------------------------
subroutine SetSoilWaterFractions(bounds, num_hydrologyc, filter_hydrologyc, &
Expand Down Expand Up @@ -2391,7 +2333,7 @@ subroutine SubsurfaceLateralFlow(bounds, &
! Non-hillslope columns
! baseflow is power law expression relative to bedrock layer
if(zwt(c) <= zi(c,nbedrock(c))) then
qflx_latflow_out(c) = ice_imped_col(c) * baseflow_scalar &
qflx_latflow_out(c) = ice_imped_col(c) * params_inst%baseflow_scalar &
* tan(rpi/180._r8*col%topo_slope(c))* &
(zi(c,nbedrock(c)) - zwt(c))**(params_inst%n_baseflow)
endif
Expand Down
Loading