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.

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

Document the possibility of 2-letter XS types #1709

Closed
keckler opened this issue May 21, 2024 · 0 comments · Fixed by #1815
Closed

Document the possibility of 2-letter XS types #1709

keckler opened this issue May 21, 2024 · 0 comments · Fixed by #1815
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@keckler
Copy link
Member

keckler commented May 21, 2024

There is an undocumented feature in ARMI:

armi/armi/reactor/blocks.py

Lines 406 to 411 in cfc2335

Notes
-----
The single-letter use for xsType and buGroup limit users to 26 groups of each.
ARMI will allow 2-letter xsType designations if and only if the `buGroups`
setting has length 1 (i.e. no burnup groups are defined). This is useful for
high-fidelity XS modeling of V&V models such as the ZPPRs.

It would be good to write this in the user documentation, maybe in this section about assembly blueprints.

Other related docstrings:

"""
Update the burnup group of each block based on its burnup.
If only one burnup group exists, then this is skipped so as to accomodate the possibility
of 2-character xsGroup values (useful for detailed V&V models w/o depletion).

def getXSTypeNumberFromLabel(xsTypeLabel: str) -> int:
"""
Convert a XSID label (e.g. 'AA') to an integer.
Useful for visualizing XS type in XTVIEW.
2-digit labels are supported when there is only one burnup group.
"""
return int("".join(["{:02d}".format(ord(si)) for si in xsTypeLabel]))
def getXSTypeLabelFromNumber(xsTypeNumber: int) -> int:
"""
Convert a XSID label (e.g. 65) to an XS label (e.g. 'A').
Useful for visualizing XS type in XTVIEW.
2-digit labels are supported when there is only one burnup group.
"""

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants