Cleaning out the overly-specific methods in ArmiObject

[john-science]

What is the change?

Removing extraneous ArmiOjbect methods:

• Moving ArmiObject.getBoronMassEnrich() to Block
• Moving ArmiObject.getPuMoles() to Block
• Moving ArmiObject.getUraniumMassEnrich() to Block
• Removing ArmiObject.getMaxUraniumMassEnrich.()
• Removing ArmiObject.getMaxVolume() & Block.getMaxVolume()
• Removing ArmiObject.getPuFrac()
• Removing ArmiObject.getPuMass()
• Removing ArmiObject.getPuN()
• Removing ArmiObject.getZrFrac()
• Removing ArmiObject.printDensities()
• Moving Composite.isOnWhichSymmetryLine() to Assembly
• Removing Block.isOnWhichSymmetryLine()

Why is the change being made?

There are several methods in ArmiObject (and Composite) that seem a little too specific to be included everywhere in the ARMI object tree. And after doing some research, some of them are entirely unused anyway.

Close #1375

---

Checklist

• This PR has only one purpose or idea.
• Tests have been added/updated to verify any new/changed code.

• The code style follows good practices.
• The commit message(s) follow good practices.

• The release notes have been updated if necessary.
• The documentation is still up-to-date in the doc folder.
• The dependencies are still up-to-date in pyproject.toml.

[john-science]

Bump

[albeanth]

Hmmmm.

Moving ArmiObject.getBoronMassEnrich() to Block
Moving ArmiObject.getPuMoles() to Block
Moving ArmiObject.getUraniumMassEnrich() to Block

I could see utility in having this at the composite level. I don't think it's unreasonable to have the ability to query these things at the Assembly, Core, or Component level (specifically on the Component as well, for flexibility with future applications)

[john-science]

@albeanth

Moving ArmiObject.getBoronMassEnrich() to Block
Moving ArmiObject.getPuMoles() to Block
Moving ArmiObject.getUraniumMassEnrich() to Block

I could see utility in having this at the composite level....

If it helps, I tested this PR downstream in all repos, including benchmark repos, it passes. So that is firm confirmation that these methods are NOT used at the Composite level, if that helps.

Cards on the table...

None of these methods should have been added to the API in the first place. That was the cause of Jake/Mark's complaint. They are fair too specific. An entire method for just one nuclide? If we have one for "boron mass' why not "boron moles" and "uranium mass" and "uranium moles" and OMG that paradigm leads us to hundreds and hundreds of nearly identical stupid methods.

Jake and Mark make a compelling argument: (1) remove any of these too-specific methods we can, and (2) reduce the surface area of the ones we can't remove.

Moving these methods from ArmiObject / Composite to something less specific means these methods aren't usable everywhere. (Which, they aren't now.) And that's a good thing. Because we want to limit how much these methods are used.

[albeanth]

They are fair too specific. An entire method for just one nuclide? If we have one for "boron mass' why not "boron moles" and "uranium mass" and "uranium moles" and OMG that paradigm leads us to hundreds and hundreds of nearly identical stupid methods.

Oh yeah, totally agree here. I wonder if they could be generalized? Hmmm, likely not in a useful/elegant way. The underlying functionality of these is retained, so any downstream user could recreate them as needed.

Ok, I will retract. Remove!

[john-science]

Oh yeah, totally agree here. I wonder if they could be generalized?

Yeah, I was thinking something like:

# class ArmiObject
    def getNuclide(self, nuclide, units="mass"):
        """Note: units needs to be in ("mass", "frac", "moles")"""

Or, you know, something like that. Some sort of more general method that replaces all this stuff.

Also, I note that we already have ArmiObject.getNumberDensity(), which takes a nuclide name and does most of the heavy lifting all these other methods do; it's just a difference of units.

#just-thinking-aloud

[albeanth]

Oh yeah, totally agree here. I wonder if they could be generalized?

Yeah, I was thinking something like:

# class ArmiObject
    def getNuclide(self, nuclide, units="mass"):
        """Note: units needs to be in ("mass", "frac", "moles")"""

Or, you know, something like that. Some sort of more general method that replaces all this stuff.

Also, I note that we already have ArmiObject.getNumberDensity(), which takes a nuclide name and does most of the heavy lifting all these other methods do; it's just a difference of units.

#just-thinking-aloud

You could always do a poll in the discussion on what would be useful!