From 59e1633b242e61e14af433e57dbcbc60830abd90 Mon Sep 17 00:00:00 2001 From: Chris Keckler Date: Tue, 23 Jan 2024 22:25:45 +0000 Subject: [PATCH] Some editorial and grammatical fixes --- armi/reactor/blueprints/componentBlueprint.py | 10 +++++----- armi/reactor/blueprints/gridBlueprint.py | 6 +++--- armi/reactor/blueprints/isotopicOptions.py | 4 ++-- armi/reactor/blueprints/reactorBlueprint.py | 6 +++--- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/armi/reactor/blueprints/componentBlueprint.py b/armi/reactor/blueprints/componentBlueprint.py index 7f7d5b399..dcd8b94ed 100644 --- a/armi/reactor/blueprints/componentBlueprint.py +++ b/armi/reactor/blueprints/componentBlueprint.py @@ -193,11 +193,11 @@ def construct(self, blueprint, matMods): :implements: R_ARMI_MAT_USER_INPUT Allows for user input to impact a component's materials by applying - the ``material modifications`` section of a blueprints file (see :need:`I_ARMI_MAT_USER_INPUT0`) - to the material during constructions. This takes place during lower + the "material modifications" section of a blueprints file (see :need:`I_ARMI_MAT_USER_INPUT0`) + to the material during construction. This takes place during lower calls to ``_conformKwargs()`` and subsequently ``_constructMaterial()``, - which is passed in the component blueprint and the associated material - modifications for the block that the component belongs to. + which operate using the component blueprint and associated material + modifications from the component's block. Within ``_constructMaterial()``, the material class is resolved into a material object by calling :py:func:`~armi.materials.resolveMaterialClassByName`. @@ -337,7 +337,7 @@ def insertDepletableNuclideKeys(c, blueprint): :id: I_ARMI_BP_NUC_FLAGS0 :implements: R_ARMI_BP_NUC_FLAGS - This called during the component construction process for each component from within + This is called during the component construction process for each component from within :py:meth:`~armi.reactor.blueprints.componentBlueprint.ComponentBlueprint.construct`. For a given initialized component, check its flags to determine if it diff --git a/armi/reactor/blueprints/gridBlueprint.py b/armi/reactor/blueprints/gridBlueprint.py index f2010b15a..5b4286b17 100644 --- a/armi/reactor/blueprints/gridBlueprint.py +++ b/armi/reactor/blueprints/gridBlueprint.py @@ -148,15 +148,15 @@ class GridBlueprint(yamlize.Object): :id: I_ARMI_BP_GRID :implements: R_ARMI_BP_GRID - Defines a yaml construct that allows the user to define a grid + Defines a yaml construct that allows the user to specify a grid from within their blueprints file, including a name, geometry, dimensions, - symmetry, and a map specifying the relative locations of components within that grid. + symmetry, and a map with the relative locations of components within that grid. Relies on the underlying infrastrature from the ``yamlize`` package for reading from text files, serialization, and internal storage of the data. Is implemented as part of a blueprints file by being used in key-value pairs - within the :py:class:~`armi.reactor.blueprints.gridBlueprint.Grid` class, + within the :py:class:`~armi.reactor.blueprints.gridBlueprint.Grid` class, which is imported and used as an attribute within the larger :py:class:`~armi.reactor.blueprints.Blueprints` class. diff --git a/armi/reactor/blueprints/isotopicOptions.py b/armi/reactor/blueprints/isotopicOptions.py index 8a351af02..662027826 100644 --- a/armi/reactor/blueprints/isotopicOptions.py +++ b/armi/reactor/blueprints/isotopicOptions.py @@ -181,11 +181,11 @@ class CustomIsotopic(yamlize.Map): reading from text files, serialization, and internal storage of the data. Is implemented as part of a blueprints file by being used in key-value pairs - within the :py:class:~`armi.reactor.blueprints.isotopicOptions.CustomIsotopics` class, + within the :py:class:`~armi.reactor.blueprints.isotopicOptions.CustomIsotopics` class, which is imported and used as an attribute within the larger :py:class:`~armi.reactor.blueprints.Blueprints` class. - These isotopics are linked to a component during calls to :py:meth:`~armi.reactor.blueprints.componentBlueprint.ComponentBlueprint.apply`, + These isotopics are linked to a component during calls to :py:meth:`~armi.reactor.blueprints.componentBlueprint.ComponentBlueprint.construct`, where the name specified in the ``isotopics`` attribute of the component blueprint is searched against the available ``CustomIsotopics`` defined in the "custom isotopics" section of the blueprints. diff --git a/armi/reactor/blueprints/reactorBlueprint.py b/armi/reactor/blueprints/reactorBlueprint.py index 8c9979e73..a52104435 100644 --- a/armi/reactor/blueprints/reactorBlueprint.py +++ b/armi/reactor/blueprints/reactorBlueprint.py @@ -49,7 +49,7 @@ class SystemBlueprint(yamlize.Object): """ The reactor-level structure input blueprint. - .. impl:: Build core and spent fuel pool from blueprint + .. impl:: Build core and spent fuel pool from blueprints :id: I_ARMI_BP_SYSTEMS :implements: R_ARMI_BP_SYSTEMS, R_ARMI_BP_CORE @@ -61,13 +61,13 @@ class SystemBlueprint(yamlize.Object): which is in turn included into the overall blueprints within :py:class:`~armi.reactor.blueprints.Blueprints`. - This class includes an :py:meth:`~armi.reactor.blueprints.reactorBlueprint.SystemBlueprint.construct` + This class includes a :py:meth:`~armi.reactor.blueprints.reactorBlueprint.SystemBlueprint.construct` method, which is typically called from within :py:func:`~armi.reactor.reactors.factory` during the initialization of the reactor object to instantiate the core and/or spent fuel pool objects. During that process, a spatial grid is constructed based on the grid blueprints specified in the "grids" section of the blueprints (see :need:`I_ARMI_BP_GRID`) and the assemblies needed - to fill that lattice are built from blueprints using :py:meth:`~armi.reactor.blueprints.Blueprints.constructAssem`. + to fill the lattice are built from blueprints using :py:meth:`~armi.reactor.blueprints.Blueprints.constructAssem`. .. note:: We use string keys to link grids to objects that use them. This differs from how blocks/assembies are specified, which use YAML anchors. YAML anchors