armi.reactor.components package

Components package contains components and shapes.

These objects hold the dimensions, temperatures, composition, and shape of reactor primitives.

Class inheritance diagram for armi.reactor.components.

armi.reactor.components.factory(shape, bcomps, kwargs)

Build a new component object.

Parameters:

• shape (str) – lowercase string corresponding to the component type name

• bcomps (list(Component)) – list of “sibling” components. This list is used to find component links, which are of the form <name>.<dimension.

• kwargs (dict) – dictionary of inputs for the Component subclass’s __init__ method.

class armi.reactor.components.NullComponent(name, material, Tinput, Thot, area=None, isotopics='', mergeWith='', components=None)

Bases: Component

Returns zero for all dimensions.

getBoundingCircleOuterDiameter(Tc=None, cold=False)

getDimension(key, Tc=None, cold=False)

DIMENSION_NAMES = ()

INIT_SIGNATURE = ('name', 'material', 'Tinput', 'Thot', 'area', 'isotopics', 'mergeWith', 'components')

paramCollectionType

alias of ComponentParameterCollection

material: Material

class armi.reactor.components.UnshapedComponent(name, material, Tinput, Thot, area=nan, modArea=None, isotopics=None, mergeWith=None, components=None)

Bases: Component

A component with undefined dimensions.

Useful for situations where you just want to enter the area directly.

For instance, when you want to model neutronic behavior of an assembly based on only knowing the area fractions of each material in the assembly.

See also

DerivedShape

Useful to just fill leftover space in a block with a material

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

getComponentArea(cold=False)

Get the area of this component in cm^2.

Parameters:

cold (bool, optional) – If True, compute the area with as-input dimensions, instead of thermally-expanded.

getBoundingCircleOuterDiameter(Tc=None, cold=False)

Approximate it as circular and return the radius.

This is the smallest it can possibly be. Since this is used to determine the outer component, it will never be allowed to be the outer one.

Parameters:

• Tc (float) – Ignored for this component

• cold (bool, optional) – If True, compute the area with as-input dimensions, instead of thermally-expanded.

Notes

Tc is not used in this method for this particular component.

static fromComponent(otherComponent)

Build a new UnshapedComponent that has area equal to that of another component.

This can be used to “freeze” a DerivedShape, among other things.

Notes

Components created in this manner will not thermally expand beyond the expanded area of the original component, but will retain their hot temperature.

DIMENSION_NAMES = ('modArea',)

INIT_SIGNATURE = ('name', 'material', 'Tinput', 'Thot', 'area', 'modArea', 'isotopics', 'mergeWith', 'components')

paramCollectionType

alias of UnshapedComponentParameterCollection

material: Material

class armi.reactor.components.UnshapedVolumetricComponent(name, material, Tinput, Thot, area=nan, op=None, isotopics=None, mergeWith=None, components=None, volume=nan)

Bases: UnshapedComponent

A component with undefined dimensions.

Useful for situations where you just want to enter the volume directly.

is3D = True

getComponentArea(cold=False)

getComponentVolume()

Get the volume of the component in cm^3.

setVolume(val)

DIMENSION_NAMES = ('op', 'volume')

INIT_SIGNATURE = ('name', 'material', 'Tinput', 'Thot', 'area', 'op', 'isotopics', 'mergeWith', 'components', 'volume')

paramCollectionType

alias of UnshapedComponentParameterCollection

material: Material

class armi.reactor.components.ZeroMassComponent(name, material, Tinput, Thot, area=nan, op=None, isotopics=None, mergeWith=None, components=None, volume=nan)

Bases: UnshapedVolumetricComponent

A component that never has mass – it always returns zero for getMass and getNumberDensity.

Useful for situations where you want to give a block integrated flux, but ensure mass is never added to it

See also

armi.reactor.batch.makeMgFluxBlock

getNumberDensity(*args, **kwargs)

Always return 0 because this component has not mass.

setNumberDensity(*args, **kwargs)

Never add mass.

DIMENSION_NAMES = ('op', 'volume')

INIT_SIGNATURE = ('name', 'material', 'Tinput', 'Thot', 'area', 'op', 'isotopics', 'mergeWith', 'components', 'volume')

paramCollectionType

alias of UnshapedComponentParameterCollection

material: Material

class armi.reactor.components.PositiveOrNegativeVolumeComponent(name, material, Tinput, Thot, area=nan, op=None, isotopics=None, mergeWith=None, components=None, volume=nan)

Bases: UnshapedVolumetricComponent

A component that may have negative mass for removing mass from batches.

See also

armi.reactor.batch.makeMassAdditionComponent

DIMENSION_NAMES = ('op', 'volume')

INIT_SIGNATURE = ('name', 'material', 'Tinput', 'Thot', 'area', 'op', 'isotopics', 'mergeWith', 'components', 'volume')

paramCollectionType

alias of UnshapedComponentParameterCollection

material: Material

class armi.reactor.components.DerivedShape(name, material, Tinput, Thot, area=nan, modArea=None, isotopics=None, mergeWith=None, components=None)

Bases: UnshapedComponent

This a component that does have specific dimensions, but they’re complicated.

Notes

• This component type is “derived” through the addition or subtraction of other shaped components (e.g. Coolant)

• Because its area and volume are defined by other components, a DerivedShape’s area and volume may change as the other components thermally expand. However the DerivedShape cannot drive thermal expansion itself, even if it is a solid component with non-zero thermal expansion coefficient

getBoundingCircleOuterDiameter(Tc=None, cold=False)

The bounding circle for a derived component.

Notes

This is used to sort components relative to one another.

There can only be one derived component per block, this is generally the coolant inside a duct. Under most circumstances, the volume (or area) of coolant will be greater than any other (single) component (i.e. a single pin) within the assembly. So, sorting based on the Dh of the DerivedShape will result in somewhat expected results.

computeVolume()

Cannot compute volume until it is derived.

getMaxVolume()

The maximum volume of the parent Block.

Returns:

vol – volume in cm^3.

Return type:

float

DIMENSION_NAMES = ('modArea',)

INIT_SIGNATURE = ('name', 'material', 'Tinput', 'Thot', 'area', 'modArea', 'isotopics', 'mergeWith', 'components')

paramCollectionType

alias of UnshapedComponentParameterCollection

material: Material

getVolume()

Get volume of derived shape.

The DerivedShape must pay attention to all of the companion objects, because if they change, this changes. However it’s inefficient to always recompute the derived volume, so we have to rely on the parent to know if anything has changed.

Since each parent is only allowed one DerivedShape, we can reset the update flag here.

Returns:

volume of component in cm^3.

Return type:

float

getComponentArea(cold=False)

Get the area of this component in cm^2.

Parameters:

cold (bool, optional) – If True, compute the area with as-input dimensions, instead of thermally-expanded.

Submodules

• armi.reactor.components.basicShapes module
  • Circle
    • Circle.is3D
    • Circle.THERMAL_EXPANSION_DIMS
    • Circle.pDefs
    • Circle.getBoundingCircleOuterDiameter()
    • Circle.getCircleInnerDiameter()
    • Circle.getComponentArea()
    • Circle.isEncapsulatedBy()
    • Circle.DIMENSION_NAMES
    • Circle.INIT_SIGNATURE
    • Circle.paramCollectionType
    • Circle.material
  • Hexagon
    • Hexagon.is3D
    • Hexagon.THERMAL_EXPANSION_DIMS
    • Hexagon.pDefs
    • Hexagon.getBoundingCircleOuterDiameter()
    • Hexagon.getCircleInnerDiameter()
    • Hexagon.getComponentArea()
    • Hexagon.getPerimeter()
    • Hexagon.getPitchData()
    • Hexagon.DIMENSION_NAMES
    • Hexagon.INIT_SIGNATURE
    • Hexagon.paramCollectionType
    • Hexagon.material
  • Rectangle
    • Rectangle.is3D
    • Rectangle.THERMAL_EXPANSION_DIMS
    • Rectangle.pDefs
    • Rectangle.getBoundingCircleOuterDiameter()
    • Rectangle.getCircleInnerDiameter()
    • Rectangle.getComponentArea()
    • Rectangle.isLatticeComponent()
    • Rectangle.getPitchData()
    • Rectangle.DIMENSION_NAMES
    • Rectangle.INIT_SIGNATURE
    • Rectangle.paramCollectionType
    • Rectangle.material
  • SolidRectangle
    • SolidRectangle.is3D
    • SolidRectangle.THERMAL_EXPANSION_DIMS
    • SolidRectangle.getComponentArea()
    • SolidRectangle.DIMENSION_NAMES
    • SolidRectangle.INIT_SIGNATURE
    • SolidRectangle.paramCollectionType
    • SolidRectangle.material
  • Square
    • Square.is3D
    • Square.getComponentArea()
    • Square.getBoundingCircleOuterDiameter()
    • Square.getCircleInnerDiameter()
    • Square.getPitchData()
    • Square.DIMENSION_NAMES
    • Square.INIT_SIGNATURE
    • Square.paramCollectionType
    • Square.material
  • Triangle
    • Triangle.is3D
    • Triangle.THERMAL_EXPANSION_DIMS
    • Triangle.pDefs
    • Triangle.getComponentArea()
    • Triangle.DIMENSION_NAMES
    • Triangle.INIT_SIGNATURE
    • Triangle.paramCollectionType
    • Triangle.material
• armi.reactor.components.complexShapes module
  • HoledHexagon
    • HoledHexagon.THERMAL_EXPANSION_DIMS
    • HoledHexagon.pDefs
    • HoledHexagon.getComponentArea()
    • HoledHexagon.getCircleInnerDiameter()
    • HoledHexagon.DIMENSION_NAMES
    • HoledHexagon.INIT_SIGNATURE
    • HoledHexagon.paramCollectionType
    • HoledHexagon.material
  • HexHoledCircle
    • HexHoledCircle.THERMAL_EXPANSION_DIMS
    • HexHoledCircle.pDefs
    • HexHoledCircle.getComponentArea()
    • HexHoledCircle.getCircleInnerDiameter()
    • HexHoledCircle.DIMENSION_NAMES
    • HexHoledCircle.INIT_SIGNATURE
    • HexHoledCircle.paramCollectionType
    • HexHoledCircle.material
  • HoledRectangle
    • HoledRectangle.THERMAL_EXPANSION_DIMS
    • HoledRectangle.pDefs
    • HoledRectangle.getComponentArea()
    • HoledRectangle.getCircleInnerDiameter()
    • HoledRectangle.DIMENSION_NAMES
    • HoledRectangle.INIT_SIGNATURE
    • HoledRectangle.paramCollectionType
    • HoledRectangle.material
  • HoledSquare
    • HoledSquare.THERMAL_EXPANSION_DIMS
    • HoledSquare.pDefs
    • HoledSquare.getComponentArea()
    • HoledSquare.getCircleInnerDiameter()
    • HoledSquare.DIMENSION_NAMES
    • HoledSquare.INIT_SIGNATURE
    • HoledSquare.paramCollectionType
    • HoledSquare.material
  • Helix
    • Helix.is3D
    • Helix.THERMAL_EXPANSION_DIMS
    • Helix.pDefs
    • Helix.getBoundingCircleOuterDiameter()
    • Helix.getCircleInnerDiameter()
    • Helix.getComponentArea()
    • Helix.DIMENSION_NAMES
    • Helix.INIT_SIGNATURE
    • Helix.paramCollectionType
    • Helix.material
• armi.reactor.components.component module
  • componentTypeIsValid()
  • ComponentType
    • ComponentType.TYPES
    • ComponentType.NON_DIMENSION_NAMES
  • Component
    • Component.DIMENSION_NAMES
    • Component.INIT_SIGNATURE
    • Component.is3D
    • Component.THERMAL_EXPANSION_DIMS
    • Component.pDefs
    • Component.material
    • Component.temperatureInC
    • Component.temperatureInK
    • Component.resolveLinkedDims()
    • Component.setLink()
    • Component.setProperties()
    • Component.applyMaterialMassFracsToNumberDensities()
    • Component.adjustDensityForHeightExpansion()
    • Component.getHeightFactor()
    • Component.getProperties()
    • Component.liquidPorosity
    • Component.gasPorosity
    • Component.setLumpedFissionProducts()
    • Component.getArea()
    • Component.getVolume()
    • Component.clearCache()
    • Component.computeVolume()
    • Component.containsVoidMaterial()
    • Component.containsSolidMaterial()
    • Component.getComponentArea()
    • Component.getComponentVolume()
    • Component.setVolume()
    • Component.setArea()
    • Component.setTemperature()
    • Component.getNuclides()
    • Component.getNumberDensity()
    • Component.getNuclideNumberDensities()
    • Component.setName()
    • Component.setNumberDensity()
    • Component.setNumberDensities()
    • Component.updateNumberDensities()
    • Component.getEnrichment()
    • Component.getMassEnrichment()
    • Component.getMass()
    • Component.setDimension()
    • Component.getDimension()
    • Component.getBoundingCircleOuterDiameter()
    • Component.getCircleInnerDiameter()
    • Component.dimensionIsLinked()
    • Component.getDimensionNamesLinkedTo()
    • Component.clearLinkedCache()
    • Component.getLinkedComponents()
    • Component.getThermalExpansionFactor()
    • Component.printContents()
    • Component.setDimensionReport()
    • Component.updateDims()
    • Component.mergeNuclidesInto()
    • Component.iterComponents()
    • Component.backUp()
    • Component.restoreBackup()
    • Component.adjustMassEnrichment()
    • Component.getIntegratedMgFlux()
    • Component.density()
    • Component.getLumpedFissionProductCollection()
    • Component.getMicroSuffix()
    • Component.paramCollectionType
    • Component.getPitchData()
    • Component.getFuelMass()
    • Component.finalizeLoadingFromDB()
  • ShapedComponent
    • ShapedComponent.DIMENSION_NAMES
    • ShapedComponent.INIT_SIGNATURE
    • ShapedComponent.paramCollectionType
    • ShapedComponent.material
• armi.reactor.components.componentParameters module
  • getComponentParameterDefinitions()
  • getCircleParameterDefinitions()
  • getHexagonParameterDefinitions()
  • getHoledHexagonParameterDefinitions()
  • getHexHoledCircleParameterDefinitions()
  • getHoledRectangleParameterDefinitions()
  • getHelixParameterDefinitions()
  • getRectangleParameterDefinitions()
  • getCubeParameterDefinitions()
  • getTriangleParameterDefinitions()
  • getUnshapedParameterDefinitions()
  • getRadialSegmentParameterDefinitions()
• armi.reactor.components.volumetricShapes module
  • Sphere
    • Sphere.is3D
    • Sphere.THERMAL_EXPANSION_DIMS
    • Sphere.pDefs
    • Sphere.getBoundingCircleOuterDiameter()
    • Sphere.getComponentArea()
    • Sphere.getComponentVolume()
    • Sphere.DIMENSION_NAMES
    • Sphere.INIT_SIGNATURE
    • Sphere.paramCollectionType
    • Sphere.material
  • Cube
    • Cube.is3D
    • Cube.THERMAL_EXPANSION_DIMS
    • Cube.pDefs
    • Cube.getComponentArea()
    • Cube.getComponentVolume()
    • Cube.DIMENSION_NAMES
    • Cube.INIT_SIGNATURE
    • Cube.paramCollectionType
    • Cube.material
  • RadialSegment
    • RadialSegment.is3D
    • RadialSegment.THERMAL_EXPANSION_DIMS
    • RadialSegment.pDefs
    • RadialSegment.getComponentArea()
    • RadialSegment.getComponentVolume()
    • RadialSegment.getBoundingCircleOuterDiameter()
    • RadialSegment.DIMENSION_NAMES
    • RadialSegment.INIT_SIGNATURE
    • RadialSegment.paramCollectionType
    • RadialSegment.material
  • DifferentialRadialSegment
    • DifferentialRadialSegment.is3D
    • DifferentialRadialSegment.THERMAL_EXPANSION_DIMS
    • DifferentialRadialSegment.updateDims()
    • DifferentialRadialSegment.getComponentArea()
    • DifferentialRadialSegment.getComponentVolume()
    • DifferentialRadialSegment.DIMENSION_NAMES
    • DifferentialRadialSegment.INIT_SIGNATURE
    • DifferentialRadialSegment.paramCollectionType
    • DifferentialRadialSegment.material