Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding some impl crumbs to docstrings #1508

Merged
merged 4 commits into from
Nov 30, 2023
Merged

Adding some impl crumbs to docstrings #1508

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d49e46b
Adding impl crumb for nucDataIO req
john-science Nov 29, 2023
56e7a04
Adding impl tag
john-science Nov 29, 2023
fbd1bb3
Adding an impl tag to Block
john-science Nov 29, 2023
f4e3b42
Moving impl crump
john-science Nov 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions armi/nuclearDataIO/xsCollections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,12 @@ def __init__(
def createMacrosOnBlocklist(
self, microLibrary, blockList, nucNames=None, libType="micros"
):
"""Create macroscopic cross sections for a list of blocks.

.. impl:: Build macroscopic cross sections for blocks.
:id: I_ARMI_MACRO_XS
:implements: R_ARMI_MACRO_XS
albeanth marked this conversation as resolved.
Show resolved Hide resolved
"""
for block in blockList:
block.macros = self.createMacrosFromMicros(
microLibrary, block, nucNames, libType=libType
Expand Down Expand Up @@ -788,6 +794,10 @@ def computeMacroscopicGroupConstants(
"""
Compute any macroscopic group constants given number densities and a microscopic library.

.. impl:: Compute macroscopic cross sections from microscopic cross sections and number densities.
:id: I_ARMI_NUCDATA_MACRO
:implements: R_ARMI_NUCDATA_MACRO

Parameters
----------
constantName : str
Expand Down
4 changes: 4 additions & 0 deletions armi/reactor/blocks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1561,6 +1561,10 @@ def rotate(self, rad):
def setAxialExpTargetComp(self, targetComponent):
"""Sets the targetComponent for the axial expansion changer.

.. impl:: Set the target axial expansion components on a given block.
:id: I_ARMI_MANUAL_TARG_COMP
:implements: R_ARMI_MANUAL_TARG_COMP

Parameter
---------
targetComponent: :py:class:`Component <armi.reactor.components.component.Component>` object
Expand Down
Loading