Clarify definitions of crInsertedElevation and crWithdrawnElevation
#1161
Conversation
This file contains 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
jakehader
reviewed
Feb 7, 2023
armi/reactor/assemblyParameters.py
Outdated
| @@ -230,7 +230,7 @@ def _enforceNotesRestrictions(self, value): | |||
| "crWithdrawnElevation", | |||
| units="cm", | |||
| description=( | |||
| "The initial starting elevation of the moveable section of a control rod assembly when fully withdrawn. Note that this should " | |||
| "The elevation of the bottom of the bottom-most moveable section of a control rod assembly when fully withdrawn. Note that this should " | |||
There was a problem hiding this comment.
The reason this said starting is because the direction is based on interpretation of the parameter within the context of it's definition (think rods that insert from the bottom of the core). In most cases this is the interpretation though but others may implement onto this more generically. I'm okay with this but wanted to provide some background
There was a problem hiding this comment.
Oh, yes, you're totally correct. I will change!
There was a problem hiding this comment.
Okay, what about now?0e42c08
jakehader
approved these changes
Feb 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 definition of the
crInsertedElevationparameter mistakenly referred to the length of the section with control material, when in reality it should have referred to the length of the moveable section.This PR fixes this, and generally clarifies the definitions for these two important parameters.
Checklist
doc/release/0.X.rst) are up-to-date with any bug fixes or new features.docfolder.setup.py.