Rename inconsistent ICON short variable names to descriptive names across codebase

[Copilot]

Several stencil parameters and state fields still used ICON Fortran short names while callers, state dataclasses, and metric factories had already adopted descriptive names — requiring awkward keyword mappings like scalfac_dd3d=scaling_factor_for_3d_divdamp at call sites.

Renames applied

Metric state fields (initial batch):

• scalfac_dd3d → scaling_factor_for_3d_divdamp
• hmask_dd3d → horizontal_mask_for_3d_divdamp
• vwind_impl_wgt → exner_w_implicit_weight_parameter
• vwind_expl_wgt → exner_w_explicit_weight_parameter
• exner_exfac → time_extrapolation_parameter_for_exner
• exner_ref_mc → reference_exner_at_cells_on_model_levels
• theta_ref_mc → reference_theta_at_cells_on_model_levels
• rho_ref_mc → reference_rho_at_cells_on_model_levels
• theta_ref_ic → reference_theta_at_cells_on_half_levels

Stencil parameters across all dycore stencils (93 files):

• theta_v_ic → theta_v_at_cells_on_half_levels
• exner_pr → perturbed_exner_at_cells_on_model_levels
• rho_ic → rho_at_cells_on_half_levels
• z_exner_expl → exner_explicit_term
• z_rho_expl → rho_explicit_term
• z_w_expl → w_explicit_term
• z_alpha → tridiagonal_alpha_coeff_at_cells_on_half_levels
• z_beta → tridiagonal_beta_coeff_at_cells_on_model_levels
• z_q → tridiagonal_intermediate_result
• z_contr_w_fl_l → vertical_mass_flux_at_cells_on_half_levels
• z_flxdiv_mass → divergence_of_mass
• z_flxdiv_theta → divergence_of_theta_v
• z_theta_v_pr_ic → perturbed_theta_v_at_cells_on_half_levels
• z_exner_ex_pr → temporal_extrapolation_of_perturbed_exner
• z_th_ddz_exner_c → ddz_of_temporal_extrapolation_of_perturbed_exner_on_model_levels
• z_hydro_corr → hydrostatic_correction_on_lowest_level
• z_raylfac → rayleigh_damping_factor
• z_rth_pr → perturbed_theta_v_at_cells_on_model_levels
• z_theta_v_fl_e → theta_v_flux_at_edges_on_model_levels
• z_graddiv_vn → horizontal_gradient_of_normal_wind_divergence
• z_graddiv2_vn → squared_horizontal_gradient_of_total_divergence
• z_gradh_exner → horizontal_pressure_gradient
• z_dwdz_dd → dwdz_at_cells_on_model_levels
• z_theta_v_e → theta_v_at_edges_on_model_levels
• rho_nnow / rho_now → current_rho
• exner_nnow / exner_now → current_exner
• theta_v_nnow / theta_v_now → current_theta_v
• vn_nnow / p_vn → current_vn
• p_vt → tangential_wind
• rho_incr → rho_iau_increment
• exner_incr → exner_iau_increment
• vn_incr → normal_wind_iau_increment
• ddt_exner_phy → exner_tendency_due_to_slow_physics
• ddt_vn_apc_ntl1 → predictor_normal_wind_advective_tendency
• ddt_vn_apc_ntl2 → corrector_normal_wind_advective_tendency
• ddt_vn_phy → normal_wind_tendency_due_to_slow_physics_process
• wgt_nnow_vel → advection_explicit_weight_parameter
• wgt_nnew_vel → advection_implicit_weight_parameter
• scal_divdamp_o2 → second_order_divdamp_scaling_coeff
• rho_ref_me → reference_rho_at_edges_on_model_levels
• theta_ref_me → reference_theta_at_edges_on_model_levels
• mass_fl_e → mass_flux_at_edges_on_model_levels
• mass_flx_ic → dynamical_vertical_mass_flux_at_cells_on_half_levels
• vol_flx_ic → dynamical_vertical_volumetric_flux_at_cells_on_half_levels
• exner_dyn_incr → exner_dynamical_increment
• w_concorr_c → contravariant_correction_at_cells_on_half_levels

Each rename covers the @gtx.field_operator / @gtx.program signatures, callers (compute_edge_diagnostics_for_dycore_and_update_vn, compute_cell_diagnostics_for_dycore, vertically_implicit_dycore_solver, solve_nonhydro), and corresponding stencil tests.

Additionally, renames are applied in:

• Diffusion module: DiffusionMetricState dataclass, diffusion.py constant_args, temporary_field_for_grid_point_cold_pools_enhancement and calculate_enhanced_diffusion_coefficients_for_grid_point_cold_pools stencils, diffusion fixtures and tests
• Driver initialization: initialization_utils.py keyword argument for DiffusionMetricState
• Driver testcases: utils.py function parameters and body, gauss3d.py and jablonowski_williamson.py local variables
• Driver tests: test_icon4py.py and test_utils.py

Before:

# caller had to map between naming conventions
_add_vertical_wind_derivative_to_divergence_damping(
    hmask_dd3d=horizontal_mask_for_3d_divdamp,
    scalfac_dd3d=scaling_factor_for_3d_divdamp,
    ...
)

After:

_add_vertical_wind_derivative_to_divergence_damping(
    horizontal_mask_for_3d_divdamp=horizontal_mask_for_3d_divdamp,
    scaling_factor_for_3d_divdamp=scaling_factor_for_3d_divdamp,
    ...
)

Not changed (intentionally preserved)

• Serialbox deserialization keys (metrics_savepoint.scalfac_dd3d(), .exner_pr(), .rho_ic(), etc.) — these are serialization format identifiers
• icon_var_name entries in metrics_attributes.py — documentation of ICON Fortran names
• "Declared as X in ICON" docstrings in dycore_states.py
• py2fgen wrapper parameters (dycore_wrapper.py) — these are Fortran API boundary names

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[jenkins-apn]

Hi there, this is jenkins continuous integration...
Do you want me to verify this patch?

[jenkins-apn]

Hi there, this is jenkins continuous integration...
Do you want me to verify this patch?

[jcanton]

@copilot can you also do the "Known remaining work"? or?
Diffusion module still uses theta_ref_mc in DiffusionMetricState, stencils, and tests
Driver testcases (utils.py, jablonowski_williamson.py, gauss3d.py) still use short names as local variables

[Copilot]

@copilot can you also do the "Known remaining work"? or?
Diffusion module still uses theta_ref_mc in DiffusionMetricState, stencils, and tests
Driver testcases (utils.py, jab...

Done in ae676f6. Renamed theta_ref_mc → reference_theta_at_cells_on_model_levels in DiffusionMetricState, diffusion stencils, and all diffusion tests. Also renamed exner_ref_mc → reference_exner_at_cells_on_model_levels and theta_ref_ic → reference_theta_at_cells_on_half_levels in driver testcases (utils.py, jablonowski_williamson.py, gauss3d.py) and driver tests. Serialbox method calls on the right side of assignments are preserved.

[github-actions]

Mandatory Tests

Please make sure you run these tests via comment before you merge!

• cscs-ci run default
• cscs-ci run distributed

Optional Tests

To run benchmarks you can use:

• cscs-ci run benchmark-bencher

To run tests and benchmarks with the DaCe backend you can use:

• cscs-ci run dace

To run test levels ignored by the default test suite (mostly simple datatest for static fields computations) you can use:

• cscs-ci run extra

For more detailed information please look at CI in the EXCLAIM universe.

[OngChia]

@copilot There are still call sites where we have consistent keyword mapping, for example,
theta_v_ic and z_exner_expl in vertically_implicit_dycore_solver.py. Can you continue to replace all of them with the corresponding more descriptive names?

[Copilot]

@copilot There are still call sites where we have consistent keyword mapping, for example,
theta_v_ic and z_exner_expl in vertically_implicit_dycore_solver.py. Can you continue to replace all of...

Done in 34d5566. Renamed all remaining inconsistent keyword mappings across 93 files in the dycore module — including theta_v_ic → theta_v_at_cells_on_half_levels, z_exner_expl → exner_explicit_term, z_rho_expl → rho_explicit_term, z_alpha/z_beta → tridiagonal_alpha_coeff_at_cells_on_half_levels/tridiagonal_beta_coeff_at_cells_on_model_levels, exner_pr → perturbed_exner_at_cells_on_model_levels, rho_nnow/rho_now → current_rho, rho_ic → rho_at_cells_on_half_levels, z_raylfac → rayleigh_damping_factor, ddt_exner_phy → exner_tendency_due_to_slow_physics, z_q → tridiagonal_intermediate_result, and ~30 more parameters across all stencil files, their callers (vertically_implicit_dycore_solver, compute_cell_diagnostics_for_dycore, compute_edge_diagnostics_for_dycore_and_update_vn, solve_nonhydro), and tests. Serialbox deserialization keys, icon_var_name entries, "Declared as X in ICON" docstrings, and py2fgen wrapper parameters are preserved.