armi.reactor.components.basicShapes module

Components represented by basic shapes.

Many reactor components can be described in 2D by circles, hexagons, rectangles, etc. These are defined in this subpackage.

class armi.reactor.components.basicShapes.Circle(name, material, Tinput, Thot, od, id=0.0, mult=1.0, modArea=None, isotopics=None, mergeWith=None, components=None)

Bases: armi.reactor.components.shapes.ShapedComponent

A Circle.

is3D = False

THERMAL_EXPANSION_DIMS = {'id', 'od'}

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

getBoundingCircleOuterDiameter(Tc=None, cold=False)

Abstract bounding circle method that should be overwritten by each shape subclass.

getComponentArea(cold=False)

Computes the area for the circle component in cm^2.

isEncapsulatedBy(other)

Return True if this ring lies completely inside the argument component

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

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

paramCollectionType

alias of armi.reactor.parameters.parameterCollections.CircleParameterCollection

class armi.reactor.components.basicShapes.Hexagon(name, material, Tinput, Thot, op, ip=0.0, mult=1.0, modArea=None, isotopics=None, mergeWith=None, components=None)

Bases: armi.reactor.components.shapes.ShapedComponent

A Hexagon.

is3D = False

THERMAL_EXPANSION_DIMS = {'ip', 'op'}

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

getBoundingCircleOuterDiameter(Tc=None, cold=False)

Abstract bounding circle method that should be overwritten by each shape subclass.

getComponentArea(cold=False)

Computes the area for the hexagon component in cm^2.

Notes

http://www3.wolframalpha.com/input/?i=hexagon

getPerimeter(Tc=None)

Computes the perimeter of the hexagon component in cm.

DIMENSION_NAMES = ('op', 'ip', 'mult', 'modArea')

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

paramCollectionType

alias of armi.reactor.parameters.parameterCollections.HexagonParameterCollection

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

Bases: armi.reactor.components.basicShapes.Hexagon

Solid hexagonal block with n uniform circular holes hollowed out of it.

is3D = False

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.

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

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

paramCollectionType

alias of armi.reactor.parameters.parameterCollections.ShieldBlockParameterCollection

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

Bases: armi.reactor.components.shapes.ShapedComponent

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

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.

is3D = False

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

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

getBoundingCircleOuterDiameter(Tc=None, cold=False)

Abstract bounding circle method that should be overwritten by each shape subclass.

getComponentArea(cold=False)

Computes the area for the helix in cm^2.

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

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

paramCollectionType

alias of armi.reactor.parameters.parameterCollections.HelixParameterCollection

class armi.reactor.components.basicShapes.Rectangle(name, material, Tinput, Thot, lengthOuter=None, lengthInner=None, widthOuter=None, widthInner=None, mult=None, modArea=None, isotopics=None, mergeWith=None, components=None)

Bases: armi.reactor.components.shapes.ShapedComponent

A rectangle component.

is3D = False

THERMAL_EXPANSION_DIMS = {'lengthInner', 'lengthOuter', 'widthInner', 'widthOuter'}

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

getBoundingCircleOuterDiameter(Tc=None, cold=False)

Abstract bounding circle method that should be overwritten by each shape subclass.

getComponentArea(cold=False)

Computes the area of the rectangle in cm^2.

isLatticeComponent()

Return true if the component is a lattice component containing void material and zero area.

DIMENSION_NAMES = ('lengthOuter', 'lengthInner', 'widthOuter', 'widthInner', 'mult', 'modArea')

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

paramCollectionType

alias of armi.reactor.parameters.parameterCollections.RectangleParameterCollection

class armi.reactor.components.basicShapes.SolidRectangle(name, material, Tinput, Thot, lengthOuter=None, widthOuter=None, mult=None, modArea=None, isotopics=None, mergeWith=None, components=None)

Bases: armi.reactor.components.basicShapes.Rectangle

Solid rectangle component.

is3D = False

THERMAL_EXPANSION_DIMS = {'lengthOuter', 'widthOuter'}

getComponentArea(cold=False)

Computes the area of the solid rectangle in cm^2.

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

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

paramCollectionType

alias of armi.reactor.parameters.parameterCollections.RectangleParameterCollection

class armi.reactor.components.basicShapes.Square(name, material, Tinput, Thot, widthOuter=None, widthInner=None, mult=None, modArea=None, isotopics=None, mergeWith=None, components=None)

Bases: armi.reactor.components.basicShapes.Rectangle

Square component that can be solid or hollow.

is3D = False

getComponentArea(cold=False)

Computes the area of the square in cm^2.

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

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

paramCollectionType

alias of armi.reactor.parameters.parameterCollections.RectangleParameterCollection

class armi.reactor.components.basicShapes.Triangle(name, material, Tinput, Thot, base=None, height=None, mult=None, modArea=None, isotopics=None, mergeWith=None, components=None)

Bases: armi.reactor.components.shapes.ShapedComponent

is3D = False

THERMAL_EXPANSION_DIMS = {'base', 'height'}

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

getComponentArea(cold=False)

Computes the area of the triangle in cm^2.

DIMENSION_NAMES = ('base', 'height', 'mult', 'modArea')

INIT_SIGNATURE = ('name', 'material', 'Tinput', 'Thot', 'base', 'height', 'mult', 'modArea', 'isotopics', 'mergeWith', 'components')

paramCollectionType

alias of armi.reactor.parameters.parameterCollections.TriangleParameterCollection