Skip to content

Commit

Permalink
Control rod assembly parameter renames (#686)
Browse files Browse the repository at this point in the history
* Control rod parameter renames from `crStartingElevation` and
`crEndingElevation` to `crWithdrawnElevation` and `crInsertedElevation`
for clarity in modeling.
  • Loading branch information
jakehader committed May 26, 2022
1 parent d3889e0 commit da2fe93
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
14 changes: 10 additions & 4 deletions armi/reactor/assemblyParameters.py
Original file line number Diff line number Diff line change
Expand Up @@ -196,9 +196,12 @@ def detailedNDens(self, value):
)

pb.defParam(
"crEndingElevation",
"crInsertedElevation",
units="cm",
description="The final elevation of the bottom of the control material when fully inserted.",
description=(
"The final elevation of the bottom of the control material when fully inserted. Note that this should "
"be considered a lower elevation than the ``crWithdrawnElevation`` by definition and modeling semantics."
),
categories=[parameters.Category.assignInBlueprints],
saveToDB=True,
)
Expand All @@ -211,9 +214,12 @@ def detailedNDens(self, value):
)

pb.defParam(
"crStartingElevation",
"crWithdrawnElevation",
units="cm",
description="The initial starting elevation of the moveable section of a control rod assembly when fully withdrawn.",
description=(
"The initial starting elevation of the moveable section of a control rod assembly when fully withdrawn. Note that this should "
"be considered a higher elevation than the ``crInsertedElevation`` by definition and modeling semantics."
),
categories=[parameters.Category.assignInBlueprints],
saveToDB=True,
)
Expand Down
1 change: 1 addition & 0 deletions doc/release/0.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ What's new in ARMI
#. Minor code re-org, moving math utilities into their own module.
#. Removed the ``PyYaml`` dependency.
#. Removed all bare ``import armi`` statements, for code clarity.
#. Renamed control rod assembly parameters for generic implementations of control rod handling.
#. TBD

Bug fixes
Expand Down

0 comments on commit da2fe93

Please sign in to comment.