-
Notifications
You must be signed in to change notification settings - Fork 87
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
The description for fpModelLibrary
is confusing
#1701
Comments
Man, more documentation doesn't make it good, eh? How about something like this:
|
I think that your suggestion helps to make the description more concise, but it does not help to clarify my major confusion. Specifically, I think the description needs to address the question of why it makes sense to set the nuclide flags for all isotopes to @jakehader should be able to clarify this point. |
A better description of the |
@john-science Here is the reviewed and approved description from the TP internal depletion solver docs: This setting should be used when |
I have been tripped up by this description multiple times now. It is enough for me to assume that I'm not the only one who finds this confusing.
armi/armi/physics/neutronics/fissionProductModel/fissionProductModelSettings.py
Lines 57 to 63 in 1e356e7
In particular, the part that confuses me is "Setting this is equivalent to adding all nuclides in the selected code library (i.e., MC2-3) within the blueprints
nuclideFlags
to be [xs:true, burn:false]."This sentence would seem to imply that none of the isotopes are being burned, since all of them have
burn: false
.My understanding is that this odd wording is in fact accurate, but it is strange because our internal depletion solver basically disregards the nuclide flags. For anybody without this additional context, though, this description probably makes no sense to them.
I would suggest one of the two options:
addOption
method to pull this confusing option into our internal plugin so that external users are not confused by thisThe text was updated successfully, but these errors were encountered: