Skip to content
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.

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

Use RelativeSolutionTolerance #140

Merged
merged 3 commits into from
Oct 26, 2022
Merged

Use RelativeSolutionTolerance #140

merged 3 commits into from
Oct 26, 2022

Conversation

charleskawczynski
Copy link
Member

This PR addresses one of the check boxes in #134, by changing from SolutionTolerance to RelativeSolutionTolerance.

One downside of this, unfortunately, is that it's a breaking change, but I think it's fine if we know that this is what we want in the long run.

Alternatively, we could require users to pass in ::RootSolvers.AbstractTolerance, which would make the interface less likely to be breaking, however this means that our interface would be tied to using RootSolvers, so it's not a complete win to do that.

It looks like all the tests pass with these changes.

@codecov
Copy link

codecov bot commented Oct 11, 2022

Codecov Report

Base: 93.09% // Head: 93.41% // Increases project coverage by +0.32% 🎉

Coverage data is based on head (e57d9af) compared to base (d7d03c0).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #140      +/-   ##
==========================================
+ Coverage   93.09%   93.41%   +0.32%     
==========================================
  Files           9        9              
  Lines        1071     1109      +38     
==========================================
+ Hits          997     1036      +39     
+ Misses         74       73       -1     
Impacted Files Coverage Δ
src/relations.jl 96.57% <100.00%> (+0.43%) ⬆️
src/states.jl 93.95% <100.00%> (-0.53%) ⬇️
src/isentropic.jl 100.00% <0.00%> (ø)
src/TestedProfiles.jl 100.00% <0.00%> (ø)
src/Thermodynamics.jl 100.00% <0.00%> (ø)
src/DataCollection.jl 96.42% <0.00%> (+0.13%) ⬆️
src/config_numerical_method.jl 62.96% <0.00%> (+2.17%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@charleskawczynski
Copy link
Member Author

Note to self: try without catching T_freezing edge cases

Copy link
Contributor

@tapios tapios left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@charleskawczynski
Copy link
Member Author

bors r+

bors bot added a commit that referenced this pull request Oct 26, 2022
140: Use RelativeSolutionTolerance r=charleskawczynski a=charleskawczynski

This PR addresses one of the check boxes in #134, by changing from `SolutionTolerance` to `RelativeSolutionTolerance`.

One downside of this, unfortunately, is that it's a breaking change, but I think it's fine if we know that this is what we want in the long run.

Alternatively, we could require users to pass in `::RootSolvers.AbstractTolerance`, which would make the interface less likely to be breaking, however this means that our interface would be tied to using `RootSolvers`, so it's not a complete win to do that.

It looks like all the tests pass with these changes.

Co-authored-by: Charles Kawczynski <[email protected]>
@charleskawczynski
Copy link
Member Author

bors r-

@bors
Copy link
Contributor

bors bot commented Oct 26, 2022

Canceled.

@charleskawczynski
Copy link
Member Author

bors r+

@bors bors bot merged commit cdf2408 into main Oct 26, 2022
@bors bors bot deleted the ck/relative_sol_tol branch October 26, 2022 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants