armi.reactor.components.complexShapes module

Components represented by complex shapes, and typically less widely used.

class armi.reactor.components.complexShapes.HoledHexagon(name, material, Tinput, Thot, op, holeOD, nHoles, mult=1.0, modArea=None, isotopics=None, mergeWith=None, components=None)

Bases: Hexagon

Hexagon with n uniform circular holes hollowed out of it.

Implementation: Holed hexagon shaped Component I_ARMI_COMP_SHAPES5

signature: HoledHexagon requirements: R_ARMI_COMP_SHAPES

This class provides an implementation for a holed hexagonal Component. This includes setting key parameters such as its material, temperature, and dimensions. It also provides the capability to retrieve the diameter of the inner hole via the getCircleInnerDiameter method.

THERMAL_EXPANSION_DIMS = {'holeOD', 'op'}

pDefs = <armi.reactor.parameters.parameterDefinitions.ParameterDefinitionCollection object>

getComponentArea(cold=False)

Computes the area for the hexagon with n number of circular holes in cm^2.

getCircleInnerDiameter(Tc=None, cold=False)

For the special case of only one single hole, returns the diameter of that hole.

For any other case, returns 0.0 because an “circle inner diameter” becomes undefined.

DIMENSION_NAMES = ('op', 'holeOD', 'nHoles', 'mult', 'modArea')

INIT_SIGNATURE = ('name', 'material', 'Tinput', 'Thot', 'op', 'holeOD', 'nHoles', 'mult', 'modArea', 'isotopics', 'mergeWith', 'components')

paramCollectionType

alias of HoledHexagonParameterCollection

material: Material

class armi.reactor.components.complexShapes.HexHoledCircle(name, material, Tinput, Thot, od, holeOP, mult=1.0, modArea=None, isotopics=None, mergeWith=None, components=None)

Bases: Circle

Circle with a single uniform hexagonal hole hollowed out of it.

THERMAL_EXPANSION_DIMS = {'holeOP', 'od'}

pDefs = <armi.reactor.parameters.parameterDefinitions.ParameterDefinitionCollection object>

getComponentArea(cold=False)

Computes the area for the circle with one hexagonal hole.

getCircleInnerDiameter(Tc=None, cold=False)

Returns the diameter of the hole equal to the hexagon outer pitch.

DIMENSION_NAMES = ('od', 'holeOP', 'mult', 'modArea')

INIT_SIGNATURE = ('name', 'material', 'Tinput', 'Thot', 'od', 'holeOP', 'mult', 'modArea', 'isotopics', 'mergeWith', 'components')

paramCollectionType

alias of HexHoledCircleParameterCollection

material: Material

class armi.reactor.components.complexShapes.HoledRectangle(name, material, Tinput, Thot, holeOD, lengthOuter=None, widthOuter=None, mult=1.0, modArea=None, isotopics=None, mergeWith=None, components=None)

Bases: Rectangle

Rectangle with one circular hole in it.

THERMAL_EXPANSION_DIMS = {'holeOD', 'lengthOuter', 'widthOuter'}

pDefs = <armi.reactor.parameters.parameterDefinitions.ParameterDefinitionCollection object>

getComponentArea(cold=False)

Computes the area (in cm^2) for the the rectangle with one hole in it.

getCircleInnerDiameter(Tc=None, cold=False)

Returns the holeOD.

DIMENSION_NAMES = ('holeOD', 'lengthOuter', 'widthOuter', 'mult', 'modArea')

INIT_SIGNATURE = ('name', 'material', 'Tinput', 'Thot', 'holeOD', 'lengthOuter', 'widthOuter', 'mult', 'modArea', 'isotopics', 'mergeWith', 'components')

paramCollectionType

alias of HoledRectangleParameterCollection

material: Material

class armi.reactor.components.complexShapes.HoledSquare(name, material, Tinput, Thot, holeOD, widthOuter=None, mult=1.0, modArea=None, isotopics=None, mergeWith=None, components=None)

Bases: Square

Square with one circular hole in it.

Implementation: Holed square shaped Component I_ARMI_COMP_SHAPES6

signature: HoledSquare requirements: R_ARMI_COMP_SHAPES

This class provides an implementation for a holed square Component. This includes setting key parameters such as its material, temperature, and dimensions. It also includes methods to retrieve geometric dimension information unique to holed squares via the getComponentArea and getCircleInnerDiameter methods.

THERMAL_EXPANSION_DIMS = {'holeOD', 'widthOuter'}

pDefs = <armi.reactor.parameters.parameterDefinitions.ParameterDefinitionCollection object>

getComponentArea(cold=False)

Computes the area (in cm^2) for the the square with one hole in it.

getCircleInnerDiameter(Tc=None, cold=False)

Returns the holeOD.

DIMENSION_NAMES = ('holeOD', 'widthOuter', 'mult', 'modArea')

INIT_SIGNATURE = ('name', 'material', 'Tinput', 'Thot', 'holeOD', 'widthOuter', 'mult', 'modArea', 'isotopics', 'mergeWith', 'components')

paramCollectionType

alias of HoledSquareParameterCollection

material: Material

class armi.reactor.components.complexShapes.Helix(name, material, Tinput, Thot, od, axialPitch, helixDiameter, mult=1.0, id=0.0, modArea=None, isotopics=None, mergeWith=None, components=None)

Bases: ShapedComponent

A spiral wire component used to model a pin wire-wrap.

Implementation: Helix shaped Component I_ARMI_COMP_SHAPES7

signature: Helix requirements: R_ARMI_COMP_SHAPES

This class provides the implementation for a helical Component. This includes setting key parameters such as its material, temperature, and dimensions. It also includes the getComponentArea method to retrieve the area of a helix. Helixes can be used for wire wrapping around fuel pins in fast reactor designs.

Notes

http://mathworld.wolfram.com/Helix.html In a single rotation with an axial climb of P, the length of the helix will be a factor of 2*pi*sqrt(r^2+c^2)/2*pi*c longer than vertical length L. P = 2*pi*c.

• od: outer diameter of the helix wire

• id: inner diameter of the helix wire (if non-zero, helix wire is annular.)

• axialPitch: vertical distance between wraps. Is also the axial distance required to complete

  a full 2*pi rotation.

• helixDiameter: The helix diameter is the distance from the center of the

  wire-wrap on one side to the center of the wire-wrap on the opposite side (can be visualized if the axial pitch is 0.0 - creates a circle).

is3D = False

THERMAL_EXPANSION_DIMS = {'axialPitch', 'helixDiameter', 'id', 'od'}

pDefs = <armi.reactor.parameters.parameterDefinitions.ParameterDefinitionCollection object>

getBoundingCircleOuterDiameter(Tc=None, cold=False)

The diameter of a circle which is encompassed by the exterior of the wire-wrap.

getCircleInnerDiameter(Tc=None, cold=False)

The diameter of a circle which is encompassed by the interior of the wire-wrap.

• should be equal to the outer diameter of the pin in which the wire is wrapped around

getComponentArea(cold=False)

Computes the area for the helix in cm^2.

DIMENSION_NAMES = ('od', 'axialPitch', 'helixDiameter', 'mult', 'id', 'modArea')

INIT_SIGNATURE = ('name', 'material', 'Tinput', 'Thot', 'od', 'axialPitch', 'helixDiameter', 'mult', 'id', 'modArea', 'isotopics', 'mergeWith', 'components')

paramCollectionType

alias of HelixParameterCollection

material: Material