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

Rename Tguess in PTE solver and document temp[0] usage #423

Closed
jhp-lanl opened this issue Oct 14, 2024 · 2 comments · Fixed by #425
Closed

Rename Tguess in PTE solver and document temp[0] usage #423

jhp-lanl opened this issue Oct 14, 2024 · 2 comments · Fixed by #425
Assignees
Labels
clean-up Changes that don't affect code execution but make the code cleaner documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@jhp-lanl
Copy link
Collaborator

In our PTE solvers, we actually use temp[0] as the starting point for the sovler (if I'm reading our code correctly). Tguess seems to really just be a ballpark value used to rescale the temperatures for numerical niceness.

I think we need to

  1. document the usage of temp[0] in our PTE solvers and note that the PTE solver benefits from a sane value
  2. rename Tguess to something that more appropriately describes its function
@jhp-lanl jhp-lanl added documentation Improvements or additions to documentation good first issue Good for newcomers clean-up Changes that don't affect code execution but make the code cleaner labels Oct 14, 2024
@jhp-lanl jhp-lanl self-assigned this Oct 14, 2024
@jhp-lanl
Copy link
Collaborator Author

I didn't realize you were already working on this @Yurlungur ! Thanks for your MR addressing this!

@Yurlungur
Copy link
Collaborator

I saw your issue yesterday and I was already playing in the PTE solver for other reasons, so I just added it. :)

@Yurlungur Yurlungur linked a pull request Oct 15, 2024 that will close this issue
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clean-up Changes that don't affect code execution but make the code cleaner documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants