-
Notifications
You must be signed in to change notification settings - Fork 8
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
Update closure model documentation #358
Conversation
See https://lanl.github.io/singularity-eos/jhp/docs/index.html to view my changes |
@Yurlungur and @aematts I think I have everything updated. Please review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding this more detailed documentation, @jhp-lanl !
Co-authored-by: Jonah Miller <[email protected]>
@aematts how does this look to you? If you're happy I'll merge. |
I am looking at it now. Sorry about holding you up but I was on my Frday off and took my husband to the neurologist Monday. |
Not at all--there's no rush! |
OK @jhp-lanl and @Yurlungur. I have gone through it once now. Your turn. |
One more thing: We might want to point out that if you use sesame tables they should NOT be inverted if you use the pressure-temperature formalism, but they SHOULD BE inverted if you use the density-energy formalism. |
It is all about what gives you the best derivatives. |
Fixed pressure should also be done on original tables (NOT inverted). |
These are good rules of thumb to recommend, though I'm sure there are exceptions that prove the rule. |
I have a note in there about the need to invert from density-temperature space to density-energy space for the density-energy formulation. I mentioned that there are both performance and accuracy implications (I'm not sure how much I trust the inverted derivatives for example). |
I'll merge once the docs build and I see they look okay. Thanks for the review @aematts and @Yurlungur ! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good now.
PR Summary
Updates the PTE solver documentation. Here is a summary of the additions/changes
PR Checklist
make format
command after configuring withcmake
.If preparing for a new release, in addition please check the following: