From 4fa97fa0708be4b4cded43b5a234e6e72588a0c1 Mon Sep 17 00:00:00 2001 From: Chris Keckler Date: Tue, 7 Feb 2023 20:47:58 -0800 Subject: [PATCH] Clarify definitions of `crInsertedElevation` and `crWithdrawnElevation` (#1161) --- armi/reactor/assemblyParameters.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/armi/reactor/assemblyParameters.py b/armi/reactor/assemblyParameters.py index a582f49be..f9f0681e8 100644 --- a/armi/reactor/assemblyParameters.py +++ b/armi/reactor/assemblyParameters.py @@ -212,8 +212,9 @@ def _enforceNotesRestrictions(self, value): "crInsertedElevation", units="cm", 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." + "The elevation of the furthest-most insertion point of a control rod assembly. For a control rod assembly " + "inserted from the top, this will be the lower tip of the bottom-most moveable section in the assembly when " + "fully inserted." ), categories=[parameters.Category.assignInBlueprints], saveToDB=True, @@ -230,8 +231,9 @@ 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 " - "be considered a higher elevation than the ``crInsertedElevation`` by definition and modeling semantics." + "The elevation of the tip of a control rod assembly when it is fully withdrawn. For a control rod assembly " + "inserted from the top, this will be the lower tip of the bottom-most moveable section in the assembly when " + "fully withdrawn." ), categories=[parameters.Category.assignInBlueprints], saveToDB=True,