Bug: Configuring sparse Jacobians with IDA assumes Jacobian has been evaluated already
Maintainers usually reply within 1 day
@alexander-novo is already working on this.
Since Oct 23, 2025.
Assessment
This issue has not been assessed yet.
Description
Description how to reproduce the bug
Design a simulation which uses sparse Jacobians and does not evaluate the Jacobian before running the simulation (for an example of such a simulation, see this Microgrid benchmark). The Jacobian will not be calculated correctly, and the linear solver in SUNDIALS will error, complaining about being configured incorrectly.
GridKit™ version
develop
System and environment details
N/A
Additional information
The reason for the bug is simple:
This commit changed the sparse linear solver configuration code in ida.cpp to no longer assume that there were n^2 non-zero elements in the jacobian. To do that, it calls (model_->getJacobian()).nnz() but getJacobian() must be called only after calling evaluateJacobian() (un-documented, but true).
The reason that this wasn't caught is because currently, the only simulations we have being tested using sparse Jacobians coincidentally all evaluate their Jacobian before running the simulation:
But...
- This shouldn't be a necessary step.
- Evaluating Jacobians before configuring the simulation isn't even enough - some (potentially) nonzero elements are squashed during Jacobian evaluation if the
alphacoefficient is set to 0, which it often is ifupdateTime()hasn't also been called beforehand. - The number of nonzero elements should probably be allowed to change during simulations - discrete events like faults can introduce new variables into the system.
Luckily, SUNDIALS has an interface for re-allocating sparse matrices, which we can call after evaluating the system Jacobian and realising there isn't enough space.
So the correct steps should probably be something along the lines of:
- When configuring the linear solver, allocate a small (maybe 0 sized if SUNDIALS lets us) jacobian matrix, and keep track of how much space it has for nonzero elements
- After evaluating a system jacobian, compare the number of nonzero elements it has and how much space the SUNDIALS matrix has - if they differ, then re-allocate the SUNDIALS matrix to fit
- Finally, copy the entries from the system Jacobian to the SUNDIALS matrix.
Eventually, the GridKit CSR matrix interface should also be able to handle this re-allocation automatically, without having to copy between two buffers.
- Dominant language
- C++
- Stars
- 27
- Forks
- 11
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 15
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ORNL/GridKit
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ORNL/GridKit#587 · 1 reaction ·
Maintainers usually reply within 1 day
-
Companion OPF models for PD initialization constraintsPossibly taken @lukelowry claimed this 3 days ago. OpenIVP question
ORNL/GridKit#656 · 1 assignee ·
Maintainers usually reply within 1 day
-
Extract CommonMath functionsPossibly taken @amandeep25100-a11y claimed this 6 days ago. Opencleanup
Difficulty 4/5 3-5 days Newbie friendliness 54/100
ORNL/GridKit#642 · 1 comment ·
Maintainers usually reply within 1 day
-
enhancement question
Difficulty 5/5 Over a week Newbie friendliness 30/100
ORNL/GridKit#624 · 2 comments · 2 reactions ·
Maintainers usually reply within 1 day
-
Add support for hierarchical modeling to the JSON format case file specificationsPossibly taken @abirchfield claimed this 33 days ago. Opendocumentation enhancement new case question
ORNL/GridKit#619 · 8 comments · 1 assignee ·
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
useless statementOpen
Difficulty 1/5 Under an hour Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
grizzlypeak3d/DJV#962 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day