terrapower / armi

An open-source nuclear reactor analysis automation framework that helps design teams increase efficiency and quality
https://terrapower.github.io/armi/
Apache License 2.0
212 stars 82 forks source link

Group specifications in cross section control setting are weird #1710

Open keckler opened 1 month ago

keckler commented 1 month ago

A typical example of using the crossSectionControl setting might look something like this:

  crossSectionControl:
    GA:
      geometry: 0D
      fluxFileLocation: \\some\location
    LA:
      geometry: 1D cylinder
      validBlockTypes:
        - control
      blockRepresentation: ComponentAverage1DCylinder
      driverID: AA
      numExternalRings: 2
      mergeIntoClad:
        - gap
      meshSubdivisionsPerCm: 1.0
      xsMaxAtomNumber: 10
      minDriverDensity: 1e-8
      xsPriority: 1

Is it odd that XS groups in this setting are referred to by their type+burnup group (i.e. GA as compared to just G)? Here are a few potential points of confusion:

It doesn't help that the crossSectionControl setting is hardly mentioned in the user docs.

I would suggest clarifying these few points, primarily by adding thorough documentation of the crossSectionControl setting, but also potentially by updating the way XS groups are specified within the setting itself.