Skip to content

b4b: Work on build-namelist Initial Condition file (finidat) picking #3842

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
ekluzek wants to merge 3 commits into
base: b4b-dev
Choose a base branch
from
+82 −27
Draft

b4b: Work on build-namelist Initial Condition file (finidat) picking #3842

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c2445a9
Add a subroutine setup_preliminary_use_init_interp called in the setu…
ekluzek Mar 25, 2026
834c471
Merge tag 'ctsm5.4.027' into work_on_IC_nml_picking
ekluzek Mar 25, 2026
15ffbc9
Merge branch 'b4b-dev' into work_on_IC_nml_picking
ekluzek Apr 8, 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
99 changes: 77 additions & 22 deletions bld/CLMBuildNamelist.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1680,7 +1680,7 @@ sub process_namelist_inline_logic {
setup_logic_lnd_frac($opts, $nl_flags, $definition, $defaults, $nl, $envxml_ref);
setup_logic_co2_type($opts, $nl_flags, $definition, $defaults, $nl);
setup_logic_irrigate($opts, $nl_flags, $definition, $defaults, $nl);
setup_logic_start_type($opts, $nl_flags, $nl);
setup_logic_start_type($opts, $nl_flags, $definition, $defaults, $nl, $physv);
setup_logic_decomp_performance($opts, $nl_flags, $definition, $defaults, $nl);
setup_logic_roughness_methods($opts, $nl_flags, $definition, $defaults, $nl, $physv);
setup_logic_snicar_methods($opts, $nl_flags, $definition, $defaults, $nl);
Expand Down Expand Up @@ -1921,7 +1921,7 @@ sub process_namelist_inline_logic {
#########################################
# namelist group: clm_initinterp_inparm #
#########################################
setup_logic_initinterp($opts, $nl_flags, $definition, $defaults, $nl);
setup_logic_initinterp($opts, $nl_flags, $definition, $defaults, $nl, $physv);

#################################
# namelist group: exice_streams #
Expand Down Expand Up @@ -2099,7 +2099,7 @@ sub setup_logic_irrigate {
#-------------------------------------------------------------------------------

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

my $var = "start_type";
my $drv_start_type = $nl->get_value($var);
Expand All @@ -2109,11 +2109,12 @@ sub setup_logic_start_type {
if (not defined $nl->get_value('nrevsn')) {
$log->fatal_error("nrevsn is required for a branch type.");
}
if (defined $nl->get_value('use_init_interp')) {
if ( &value_is_true($nl->get_value('use_init_interp') ) ) {
# Always print this warning, but don't stop if it happens
print "\nWARNING: use_init_interp will NOT happen for a branch case.\n\n";
}
# Check what use_init_interp is, in order to print a warning if the user set it to true
setup_preliminary_use_init_interp($opts, $nl_flags, $definition, $defaults, $nl, $physv);
# use_init_interp is not fully determined at this point, only if the user set it
if ( &value_is_true($nl_flags->{'use_init_interp'} ) ) {
# Always print this warning, but don't stop if it happens
print "\nWARNING: use_init_interp will NOT happen for a branch case.\n\n";
}
} else {
if (defined $nl->get_value('nrevsn')) {
Expand Down Expand Up @@ -2612,7 +2613,55 @@ sub setup_logic_surface_dataset {
}

#-------------------------------------------------------------------------------
sub setup_preliminary_use_init_interp {
my ($opts, $nl_flags, $definition, $defaults, $nl, $physv, $settings_ref) = @_;
# Output: $nl_flags for use_init_interp

# this can be called multitple times
my $var = "use_init_interp";
my $val = $nl->get_value($var);
if ( not defined($val) ) {
if ( remove_leading_and_trailing_quotes($nl_flags->{'clm_start_type'}) eq "branch" ) {
$val = ".false.";
} else {
# List of attributes that must be set for use_init_interp
my @attribute_list = ( "use_cndv", "use_fates", "sim_year", "lnd_tuning_mode" );

# Validate that all attributes are set in nl_flags that are needed for use_init_interp
# Should be both in nl_flags and in the settings sent in
foreach my $item ( @attribute_list ) {
if ( not defined($nl_flags->{$item}) ) {
$log->fatal_error("internal error: $var should be defined in nl_flags at this point");
}
}
# If settings reference was passed in, use it, otherwise get from the namelist defaults
my %settings;
if ( $settings_ref ) {
%settings = %$settings_ref;
} else {
foreach my $item ( @attribute_list ) {
$settings{$item} = $nl_flags->{$item};
}
}
# Make sure settings has all the attributes needed for use_init_interp
foreach my $item ( @attribute_list ) {
if ( not defined($settings{$item}) ) {
$log->fatal_error("internal error: $var should be defined in settings sent in at this point");
}
}
# Do not use add_default here, to allow the value to change
$val = $defaults->get_value($var, \%settings);
}
}
# Set the current default based on above
$nl_flags->{$var} = $val;
# Validate that its defined on output
if ( ! defined($nl_flags->{$var}) ) {
$log->fatal_error("internal error: $var should be defined at this point");
}
}

#-------------------------------------------------------------------------------
sub setup_logic_initial_conditions {
# Initial conditions
# The initial date is an attribute in the defaults file which should be matched unless
Expand Down Expand Up @@ -2643,6 +2692,8 @@ sub setup_logic_initial_conditions {
}
}
my $useinitvar = "use_init_interp";
setup_preliminary_use_init_interp($opts, $nl_flags, $definition, $defaults, $nl, $physv);
my $use_init_interp_default = $nl_flags->{$useinitvar};

my %settings;
my $use_init_interp_default = ".false.";
Expand Down Expand Up @@ -2684,11 +2735,9 @@ sub setup_logic_initial_conditions {
} else {
$settings{'ic_ymd'} = $ic_date;
}
$use_init_interp_default = $nl->get_value($useinitvar);
setup_preliminary_use_init_interp($opts, $nl_flags, $definition, $defaults, $nl, $physv, \%settings);
$use_init_interp_default = $nl_flags->{$useinitvar};
$settings{$useinitvar} = $use_init_interp_default;
if ( string_is_undef_or_empty( $use_init_interp_default ) ) {
$settings{$useinitvar} = ".false.";
}
my $try = 0;
my $done = 2;
do {
Expand Down Expand Up @@ -2722,10 +2771,11 @@ SIMYR: foreach my $sim_yr ( @sim_years ) {
$how_close = abs($st_year - $sim_yr);
}
if ( ($sim_yr == $sim_years[-1]) || (($how_close < $nl->get_value("init_interp_how_close")) && ($how_close < $close)) ) {
my $group = $definition->get_group_name($useinitvar);
setup_preliminary_use_init_interp($opts, $nl_flags, $definition, $defaults, $nl, $physv, \%settings);
$settings{$useinitvar} = $nl_flags->{$useinitvar};

$settings{'sim_year'} = $sim_yr;
$settings{$useinitvar} = $defaults->get_value($useinitvar, \%settings);
if ( ! defined($settings{$useinitvar}) ) {
if ( not &value_is_true($settings{$useinitvar}) ) {
$settings{$useinitvar} = $use_init_interp_default;
}
if ( &value_is_true($settings{$useinitvar}) ) {
Expand All @@ -2744,10 +2794,11 @@ SIMYR: foreach my $sim_yr ( @sim_years ) {
'sim_year'=>$settings{'sim_year'}, 'nofail'=>1, 'lnd_tuning_mode'=>$nl_flags->{'lnd_tuning_mode'},
'use_fates'=>$nl_flags->{'use_fates'} );
$settings{$useinitvar} = $nl->get_value($useinitvar);
if ( ! &value_is_true($nl->get_value($useinitvar) ) ) {
$nl_flags->{$useinitvar} = $settings{$useinitvar};
if ( not &value_is_true($nl_flags->{$useinitvar} ) ) {
if ( $nl_flags->{'clm_start_type'} =~ /startup/ ) {
my $err_msg = "clm_start_type is startup so an initial conditions ($var) file is required,";
if ( defined($use_init_interp_default) ) {
if ( not &value_is_true($use_init_interp_default) ) {
$log->fatal_error($err_msg." but can't find one without $useinitvar being set to true, change it to true in your user_nl_clm file in your case");
} else {
my $set = "Relevent settings: use_cndv = ". $nl_flags->{'use_cndv'} . " phys = " .
Expand Down Expand Up @@ -2775,6 +2826,7 @@ SIMYR: foreach my $sim_yr ( @sim_years ) {
$log->fatal_error("Problem interpreting init_interp_attributes from the namelist_defaults file: $pair");
}
}
$nl_flags->{'excess_ice_on_finidat'} = $settings{'use_excess_ice'};
# Add init_interp_fill_missing_urban_with_HD defaults as a function of sim_year and phys
add_default($opts, $nl_flags->{'inputdata_rootdir'}, $definition, $defaults, $nl, 'init_interp_fill_missing_urban_with_HD',
'sim_year'=>$settings{'sim_year'}, 'phys'=>$physv->as_string() );
Expand All @@ -2789,16 +2841,16 @@ SIMYR: foreach my $sim_yr ( @sim_years ) {
}
}
$finidat = $nl->get_value($var);
if ( &value_is_true($nl->get_value($useinitvar) ) && string_is_undef_or_empty($finidat) ) {
if ( ! defined($use_init_interp_default) ) {
if ( &value_is_true($nl_flags->{$useinitvar} ) && string_is_undef_or_empty($finidat) ) {
if ( &value_is_true($use_init_interp_default) ) {
$log->fatal_error("You set $useinitvar but a $var file could not be found for this case, try setting $var explicitly, and/or removing the setting for $useinitvar" );
} else {
$log->fatal_error("$useinitvar is being set for you but a $var was not found, so $useinitvar, init_interp_attributes, and finidat must not be set correctly for this configuration in the namelist_default file" );
}
}

# this check has to be here and not earlier since use_init_interp is set here and hillslope is already set above in setup_logic_hillslope
if ( &value_is_true($nl->get_value($useinitvar)) && value_is_true($nl->get_value("use_hillslope")) ) {
if ( &value_is_true($nl_flags->{$useinitvar}) && value_is_true($nl->get_value("use_hillslope")) ) {
$log->warning("WARNING: You have set use_hillslope while $useinitvar is TRUE.\n This means all hillslope columns in a gridcell will read identical values from initial conditions, even if the initial conditions (finidat) file has hillslope information. If you are sure you want this behaviour, add -ignore_warnings to CLM_BLDNML_OPTS.")
}

Expand Down Expand Up @@ -4859,10 +4911,13 @@ sub setup_logic_initinterp {
#
# Options related to init_interp
#
my ($opts, $nl_flags, $definition, $defaults, $nl) = @_;
my ($opts, $nl_flags, $definition, $defaults, $nl, $physv) = @_;

# Make sure use_init_interp is set in nl_flags at this point:
setup_preliminary_use_init_interp($opts, $nl_flags, $definition, $defaults, $nl, $physv);

my $var = 'init_interp_method';
if ( &value_is_true($nl->get_value("use_init_interp"))) {
if ( &value_is_true($nl_flags->{"use_init_interp"})) {
add_default($opts, $nl_flags->{'inputdata_rootdir'}, $definition, $defaults, $nl, $var);
} else {
if (defined($nl->get_value($var))) {
Expand Down
10 changes: 5 additions & 5 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 @@ -768,11 +768,11 @@ attributes from the config_cache.xml file (with keys converted to upper-case).

<!--

Find Initial condition files: The settings use_init_interp, init_interp_attributes and finidat MUST all
be coordinated together!

NOTE: And they need to be coordinated with clm_start_type that's in namelist_defaults_overall.xml

Find Initial condition files: The settings use_init_interp, init_interp_attributes and finidat MUST allundef;
Copy link
Copy Markdown
Contributor Author

@ekluzek ekluzek Apr 8, 2026

Choose a reason for hiding this comment

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

Looks like these changes should be in here.

be coordinated together!undef;
undef;
NOTE: And they need to be coordinated with clm_start_type that's in namelist_defaults_overall.xmlundef;
undef;
-->

<!-- Can you interpolate from an initial condition file at startup (is there a finidat file to find)? -->
Expand Down
Loading