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

Add Thermal Expansion/Contraction Methodology to Docs #1204

Merged
merged 8 commits into from
Mar 10, 2023

Conversation

albeanth
Copy link
Member

@albeanth albeanth commented Mar 7, 2023

Description

This is the first of a series of PRs that will add documentation for radial and axial expansion methodologies in ARMI.

This PR adds the methodology used in ARMI to perform linear expansion by creating a new page/section within doc/user and cleans up the docstring for Material.linearExpansionFactor.

Cross linking #935 as it is related.

Reviewers, please pull the feature branch and compile the ARMI docs to confirm that they build correctly. There are no new dependencies, but it will be good to confirm.


Checklist

  • This PR has only one purpose or idea.
  • Tests have been added/updated to verify that the new/changed code works.
  • The release notes (location doc/release/0.X.rst) are up-to-date with any bug fixes or new features.
  • The documentation is still up-to-date in the doc folder.
  • The dependencies are still up-to-date in setup.py.

1. Add derivation for how thermal expansion is handled in ARMI.
2. Update Material.linearExpansionFactor docstring
@albeanth albeanth added the documentation Improvements or additions to documentation label Mar 7, 2023
@albeanth
Copy link
Member Author

albeanth commented Mar 7, 2023

@john-science @alexhjames @drewj-usnctech @sombrereau @onufer @jakehader just a heads up.

Copy link
Member

@keckler keckler left a comment

Choose a reason for hiding this comment

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

Absolute poetry, I can't wait to read the next chapter!

armi/materials/material.py Show resolved Hide resolved
doc/user/radial_and_axial_expansion.rst Outdated Show resolved Hide resolved
doc/user/radial_and_axial_expansion.rst Outdated Show resolved Hide resolved
doc/user/radial_and_axial_expansion.rst Outdated Show resolved Hide resolved
Copy link
Member

@opotowsky opotowsky left a comment

Choose a reason for hiding this comment

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

Sorry for the delay! This looks great and is easy to follow.

I don't think I noticed any errors that Chris didn't already point out. Also, I agree you don't need the extra line of math getting from pct to frac.

We need a lot more of this, so thanks for leading by example!

@keckler
Copy link
Member

keckler commented Mar 9, 2023

I'm good with the changes.

@keckler keckler merged commit 4dc867b into terrapower:main Mar 10, 2023
@albeanth albeanth deleted the addThermExpDocs branch March 10, 2023 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants