Fix catastrophic cancellation in VanGenuchten near theta_range[0] - #98
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The functional change is targeted and the added tests cover the intended numerical-stability regression.
Pull request overview
This PR improves numerical stability of the Van Genuchten–Mualem relative conductivity computation near residual saturation to avoid catastrophic cancellation, and adds regression tests that validate values and derivatives in this regime.
Changes:
- Rewrites
VanGenuchten._krusinglog1p/expm1to improve stability for small effective saturations. - Adds tests covering Van Genuchten diffusivity and derivatives near residual saturation, plus a float32
_krregression check.
File summaries
| File | Description |
|---|---|
src/frontx/models.py |
Replaces the cancellation-prone 1 - (1 - x)**m form in _kr with a stable expm1(log1p()) formulation. |
tests/test_models.py |
Adds regression tests for near-residual behavior and a float32 stability check for _kr. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #98 +/- ##
==========================================
+ Coverage 86.05% 86.25% +0.20%
==========================================
Files 13 13
Lines 552 553 +1
==========================================
+ Hits 475 477 +2
+ Misses 77 76 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See gerlero/fronts#152