Skip to content

1D+ sensitivities error with IDAKLU output_variables #5118

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
merged 6 commits into from
Sep 17, 2025
Merged

1D+ sensitivities error with IDAKLU output_variables #5118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
318ed1b
Adds a test checking for sensitivitiy equality between output_variabl…
pipliggins Jul 15, 2025
0f88f7e
Test with 0D, 1D and 2D variables which should all have non-zero sens…
pipliggins Jul 15, 2025
3f7abc9
Merge branch 'develop' into outvar-sensitivities-index-error
pipliggins Sep 1, 2025
0548c77
Merge branch 'develop' into outvar-sensitivities-index-error
MarcBerliner Sep 17, 2025
f13a7e6
Merge branch 'develop' into outvar-sensitivities-index-error
pipliggins Sep 17, 2025
cc1cc67
Update changelog
pipliggins Sep 17, 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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
- Fix a bug in setting initial stoichiometries where the reference temperature was used instead of the initial temperature. ([#5189](https://github.com/pybamm-team/PyBaMM/pull/5189))
- Fix a bug in the calculation of "Bulk" OCP terms in hysteresis models ([#5169](https://github.com/pybamm-team/PyBaMM/pull/5169))
- Fixed a bug where the final duration of a drive cycle would not be inferred correctly. ([#5153](https://github.com/pybamm-team/PyBaMM/pull/5153))
- Fixes a bug where sensitivities for 1D+ variables calculated using the `output_variables` options were incorrect ([#5118](https://github.com/pybamm-team/PyBaMM/pull/5118))

# [v25.8.0](https://github.com/pybamm-team/PyBaMM/tree/v25.8.0) - 2025-08-04

Expand Down
18 changes: 15 additions & 3 deletions tests/unit/test_solvers/test_idaklu_solver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -942,9 +942,10 @@ def test_with_output_variables_and_sensitivities(self):

# Use a selection of variables of different types
output_variables = [
"Voltage [V]",
"Time [min]",
"x [m]",
"Voltage [V]", # 0D
"x [m]", # 1D, empty sensitivities
"Negative electrode potential [V]", # 1D
"Negative particle concentration [mol.m-3]", # 2D
"Throughput capacity [A.h]", # ExplicitTimeIntegral
]

Expand Down Expand Up @@ -993,6 +994,17 @@ def test_with_output_variables_and_sensitivities(self):
== sol_all[varname].sensitivities["all"].shape
)

# test each of the sensitivity calculations match
for varname in output_variables:
for key in input_parameters:
np.testing.assert_allclose(
sol[varname].sensitivities[key],
sol_all[varname].sensitivities[key],
rtol=tol,
atol=tol,
err_msg=f"Failed for '{varname}', sensitivity '{key}'",
)

def test_with_output_variables_and_event_termination(self):
model = pybamm.lithium_ion.DFN()
parameter_values = pybamm.ParameterValues("Chen2020")
Expand Down
Loading