Skip to content

Commit

Permalink
Some editorial and grammatical fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
keckler committed Jan 23, 2024
1 parent c685041 commit 59e1633
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
10 changes: 5 additions & 5 deletions armi/reactor/blueprints/componentBlueprint.py
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions armi/reactor/blueprints/gridBlueprint.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions armi/reactor/blueprints/isotopicOptions.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions armi/reactor/blueprints/reactorBlueprint.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 59e1633

Please sign in to comment.