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

PercentBuMin parameter has ParamLocation.MAX tag #1980

Open
drewj-tp opened this issue Oct 28, 2024 · 2 comments
Open

PercentBuMin parameter has ParamLocation.MAX tag #1980

drewj-tp opened this issue Oct 28, 2024 · 2 comments
Labels
feature request Smaller user request

Comments

@drewj-tp
Copy link
Contributor

Feels weird?

pb.defParam(
"percentBuMin",
units=units.PERCENT_FIMA,
description="Minimum percentage of the initial heavy metal atoms that have been fissioned",
location=ParamLocation.MAX,
)

We don't have a min tag. But also a "location" as "max" feels odd? Other locations are more spatially-oriented

class ParamLocation(enum.Flag):
"""Represents the point on which a parameter is physically meaningful."""
TOP = 1
CENTROID = 2
BOTTOM = 4
AVERAGE = 10 # 2 + 8
MAX = 16
CORNERS = 32
EDGES = 64
VOLUME_INTEGRATED = 128
CHILDREN = 256 # on some child of a composite, like a pin

Two potential resolution paths:

  1. Add a ParamLocation.MIN attribute and use that.
  2. Determine a better way to indicate if a parameter reflects some min / max / averaged quantity
@john-science john-science added the feature request Smaller user request label Oct 29, 2024
@john-science
Copy link
Member

@drewj-tp I count 16 usages of ParamLocation.MAX in ARMI, and 19 usages downstream.

Some parameters that use this:

  • fluxPeak
  • fastFluencePeak
  • dpaPeakFromFluence
  • peakFluxEstimate
  • b10PeakCaptureDensity
  • buRatePeak

But also:

  • percentBuMin

So, I think you are seeing MAX, and want to see MIN. But it is written so that people see AVERAGE and MAX as opposing ideas. I'm not sure I see that as wrong or bad.

Thoughts?

@drewj-tp
Copy link
Contributor Author

So, I think you are seeing MAX, and want to see MIN

That makes sense to me.

But it is written so that people see AVERAGE and MAX as opposing ideas

This does not make sense to me, nor is it communicated in the docs. I guess how often do people use these min / max tags rather than grabbing the parameters in question. We have some selection routines so you could grab all MAX parameters and make a report of that. That's probably good for lots of reporting purposes. But then you'd also see percentBuMin in that report which is not a maximum quantity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Smaller user request
Projects
None yet
Development

No branches or pull requests

2 participants