armi icon indicating copy to clipboard operation
armi copied to clipboard

Published 20 hours ago • verified publisher icon terrapower

Many `material` methods that return physical quantities are lacking units

Open keckler opened this issue 3 years ago • 2 comments

Taking a look at the docstrings for various material methods, the units of the returned physical quantity are not defined in the docstring and are thus not easy to infer (especially because many of the units are non-SI 😞).

On first glance, the following should have units that are missing:

  • [ ] heatCapacity
  • [ ] getTempChangeForDensityChange
  • [ ] thermalConductivity
  • [ ] getCorrosionRate
  • [ ] density3
  • [ ] density
  • [ ] liquidPorosity
  • [ ] gasPorosity
  • [ ] getTemperatureAtDensity

Possibly others as well. These should have their docstrings updated.

keckler avatar Jul 29 '22 20:07 keckler

Well, we can infer the units of density3:

https://github.com/terrapower/armi/blob/bc556fc5ce3f0445a4b1e841f00b8bdc3888f5a3/armi/materials/material.py#L413-L421

john-science avatar Aug 02 '22 22:08 john-science

@ntouran Can you fill in the blanks above, for what these units should be?

john-science avatar Aug 02 '22 22:08 john-science

PR for this is open.

john-science avatar Jul 21 '23 14:07 john-science