Suppress the mushy_zone_factor warning for the whole PALEOS EOS family - #874
Open
timlichtenberg wants to merge 2 commits into
Open
timlichtenberg wants to merge 2 commits into
timlichtenberg wants to merge 2 commits into
Conversation
The config validator warned that mushy_zone_factor has no effect for every mantle EOS that does not start with the literal PALEOS: prefix. The factor is consumed across the whole PALEOS family (PALEOS, PALEOS-2phase, PALEOS-API, PALEOS-API-2phase): it scales the derived solidus as T_sol = T_liq * mushy_zone_factor. A PALEOS-2phase run with mushy_zone_factor below 1.0 therefore received a false no-effect warning while the run applied the factor. Match the warning condition to the four EOS families that consume the factor, correct the warning text, and update the field docstring to describe the real scope and the exempt families. WolfBower2018 and RTPress100TPa use explicit melting curve files; Seager2007 and Analytic have no derived solidus. Add unit tests covering the four PALEOS strings staying silent, the file-curve EOS still warning, and the warning tracking the factor value rather than only the EOS name.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #874 +/- ##
==========================================
+ Coverage 93.51% 93.53% +0.01%
==========================================
Files 113 113
Lines 16878 16879 +1
Branches 3006 3006
==========================================
+ Hits 15783 15787 +4
+ Misses 1091 1088 -3
Partials 4 4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
The mushy_zone_factor docstring change went in without a docs regeneration, so the committed reference page carried the old PALEOS-only wording while the source described the four-member family. Ran tools/generate_config_reference.py; only interior.md and its JSON sidecar change, both by the one field description.
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
1 participant
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.
Description
The config validator warned that mushy_zone_factor has no effect for every interior EOS except the exact
PALEOS:prefix. The factor scales the derived solidus for the whole PALEOS family, so the warning misfired for PALEOS-2phase, PALEOS-API, and PALEOS-API-2phase. Suppress the warning for the four-member PALEOS family, matching the tuple the three real consumers already use, and correct the warning text and the field docstring. Closes #820.Validation of changes
Added TestZalmoxisMushyZoneWarning (three tests). Reverting the guard to the single
PALEOS:prefix makes a test fail at PALEOS-2phase:MgSiO3; restoring it passes. Verified by running Struct() over eight EOS strings and the solidus loader: the factor scales the derived solidus for the PALEOS family and is inert for WolfBower2018, RTPress, Seager2007, and Analytic.Checklist