[brosaplanella]

BaseModel gains the summary_variables property, so the cycle summary of a model that is not a battery model is empty rather than an AttributeError. Simulation raises a ModelError, naming the steps, when the model does not read "Current function [A]", rather than silently ignoring the experiment.

Description

pybamm.Simulation accepts an experiment with any pybamm.BaseModel, but on a model that is not a battery model:

1. solving failed at the end of the first cycle, because the cycle summary reads model.summary_variables, which only BaseBatteryModel defined;
2. once that was worked around, the steps had no effect on a model that does not read "Current function [A]", with no error or warning.

Fixes #6013

Changes

• summary_variables (getter and validating setter) moves from BaseBatteryModel to pybamm.BaseModel, where _summary_variables = [] was already initialised. A model without summary variables gets an empty cycle summary.
• Simulation raises a ModelError when the model does not read "Current function [A]" as a parameter, naming the steps. Every step sets it, directly (explicit steps) or by replacing it with the current variable (implicit steps).

Steps that drive other parameters are a follow-up (#6014).

Tests

• TestBaseModel.test_summary_variables_set_get
• TestSimulationExperiment.test_experiment_on_model_without_summary_variables: a non-battery model that reads the current runs an experiment and has an empty summary.
• TestSimulationExperiment.test_experiment_on_model_that_does_not_read_the_current

Type of change

Bug fix

Important checks:

Please confirm the following before marking the PR as ready for review:

• No style issues: nox -s pre-commit
• All tests pass: nox -s tests
• The documentation builds: nox -s doctests
• Code is commented for hard-to-understand areas
• Tests added that prove fix is effective or that feature works
• If you are adding or changing a model in the zoo, you have read the policy.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.22%. Comparing base (8e54b57) to head (c8220ca).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6014      +/-   ##
==========================================
- Coverage   98.23%   98.22%   -0.01%     
==========================================
  Files         350      350              
  Lines       36173    36181       +8     
==========================================
+ Hits        35533    35540       +7     
- Misses        640      641       +1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[github-actions]

Bencher Report

Project	PyBaMM
Branch	fix/experiment-non-battery-models
Testbed	bare-metal

⚠️ WARNING: Truncated view!

The full continuous benchmarking report exceeds the maximum length allowed on this platform.

🚨 1 Alert

🐰 View full continuous benchmarking report in Bencher

[brosaplanella]

The bencher regression seems to be for SPMe, only so I think it is a one-off.