armi.reactor package
The reactor package houses the data model used in ARMI to represent the reactor during its simulation. It contains definitions of the reactor, assemblies, blocks, components, etc.
The key classes of the reactor package are shown below:
See Developer Docs.
- class armi.reactor.ReactorPlugin[source]
Bases:
ArmiPlugin
Plugin exposing built-in reactor components, blocks, assemblies, etc.
- static beforeReactorConstruction(cs) None [source]
Just before reactor construction, update the material “registry” with user settings, if it is set. Often it is set by the application.
Subpackages
- armi.reactor.blueprints package
loadFromCs()
Blueprints
migrate()
- Subpackages
- Submodules
- armi.reactor.components package
factory()
NullComponent
UnshapedComponent
UnshapedVolumetricComponent
UnshapedVolumetricComponent.is3D
UnshapedVolumetricComponent.getComponentArea()
UnshapedVolumetricComponent.getComponentVolume()
UnshapedVolumetricComponent.setVolume()
UnshapedVolumetricComponent.DIMENSION_NAMES
UnshapedVolumetricComponent.INIT_SIGNATURE
UnshapedVolumetricComponent.paramCollectionType
UnshapedVolumetricComponent.material
ZeroMassComponent
PositiveOrNegativeVolumeComponent
DerivedShape
- Submodules
- armi.reactor.components.basicShapes module
- armi.reactor.components.complexShapes module
- armi.reactor.components.component module
- armi.reactor.components.componentParameters module
getComponentParameterDefinitions()
getCircleParameterDefinitions()
getHexagonParameterDefinitions()
getHoledHexagonParameterDefinitions()
getHexHoledCircleParameterDefinitions()
getHoledRectangleParameterDefinitions()
getHelixParameterDefinitions()
getRectangleParameterDefinitions()
getCubeParameterDefinitions()
getTriangleParameterDefinitions()
getUnshapedParameterDefinitions()
getRadialSegmentParameterDefinitions()
- armi.reactor.components.volumetricShapes module
- armi.reactor.converters package
- armi.reactor.grids package
locatorLabelToIndices()
- Submodules
- armi.reactor.parameters package
- armi.reactor.tests package
- Submodules
- armi.reactor.tests.test_assemblies module
- armi.reactor.tests.test_blocks module
- armi.reactor.tests.test_components module
TestComponentFactory
TestGeneralComponents
TestComponent
TestNullComponent
TestUnshapedComponent
TestShapedComponent
TestDerivedShape
TestDerivedShapeGetArea
TestCircle
TestComponentExpansion
TestTriangle
TestRectangle
TestSolidRectangle
TestSquare
TestCube
TestHexagon
TestHoledHexagon
TestHexHoledCircle
TestHoledRectangle
TestHoledSquare
TestHelix
TestSphere
TestRadialSegment
TestDifferentialRadialSegment
TestMaterialAdjustments
TestPinQuantities
- armi.reactor.tests.test_composites module
- armi.reactor.tests.test_excoreStructures module
- armi.reactor.tests.test_flags module
- armi.reactor.tests.test_geometry module
- armi.reactor.tests.test_hexBlockRotate module
- armi.reactor.tests.test_parameters module
- armi.reactor.tests.test_reactors module
- armi.reactor.tests.test_rz_reactors module
- armi.reactor.tests.test_zones module
- Submodules
Submodules
- armi.reactor.assemblies module
Assembly
Assembly.pDefs
Assembly.DATABASE
Assembly.LOAD_QUEUE
Assembly.SPENT_FUEL_POOL
Assembly.NOT_IN_CORE
Assembly.renameBlocksAccordingToAssemblyNum()
Assembly.makeNameFromAssemNum()
Assembly.renumber()
Assembly.makeUnique()
Assembly.add()
Assembly.insert()
Assembly.moveTo()
Assembly.scaleParamsToNewSymmetryFactor()
Assembly.getNum()
Assembly.getLocation()
Assembly.coords()
Assembly.getArea()
Assembly.getVolume()
Assembly.getPinPlenumVolumeInCubicMeters()
Assembly.getAveragePlenumTemperature()
Assembly.adjustResolution()
Assembly.getAxialMesh()
Assembly.calculateZCoords()
Assembly.getTotalHeight()
Assembly.getHeight()
Assembly.getReactiveHeight()
Assembly.getElevationBoundariesByBlockType()
Assembly.getElevationsMatchingParamValue()
Assembly.getAge()
Assembly.makeAxialSnapList()
Assembly.setBlockMesh()
Assembly.setBlockHeights()
Assembly.dump()
Assembly.getBlocks()
Assembly.getBlocksAndZ()
Assembly.hasContinuousCoolantChannel()
Assembly.getFirstBlock()
Assembly.getFirstBlockByType()
Assembly.getBlockAtElevation()
Assembly.getBIndexFromZIndex()
Assembly.getBlocksBetweenElevations()
Assembly.getParamValuesAtZ()
Assembly.getParamOfZFunction()
Assembly.reestablishBlockOrder()
Assembly.countBlocksWithFlags()
Assembly.getDim()
Assembly.getSymmetryFactor()
Assembly.rotate()
Assembly.isOnWhichSymmetryLine()
Assembly.orientBlocks()
Assembly.paramCollectionType
HexAssembly
CartesianAssembly
RZAssembly
ThRZAssembly
- armi.reactor.assemblyParameters module
- armi.reactor.blockParameters module
- armi.reactor.blocks module
Block
Block.uniqID
Block.PITCH_DIMENSION
Block.PITCH_COMPONENT_TYPE
Block.pDefs
Block.createHomogenizedCopy()
Block.core
Block.makeName()
Block.getSmearDensity()
Block.autoCreateSpatialGrids()
Block.getMgFlux()
Block.setPinMgFluxes()
Block.getMicroSuffix()
Block.getHeight()
Block.setHeight()
Block.getWettedPerimeter()
Block.getFlowAreaPerPin()
Block.getHydraulicDiameter()
Block.adjustUEnrich()
Block.getLocation()
Block.coords()
Block.setBuLimitInfo()
Block.getMaxArea()
Block.getArea()
Block.getVolume()
Block.getSymmetryFactor()
Block.adjustDensity()
Block.completeInitialLoading()
Block.setB10VolParam()
Block.replaceBlockWithBlock()
Block.plotFlux()
Block.add()
Block.removeAll()
Block.remove()
Block.getComponentsThatAreLinkedTo()
Block.getComponentsInLinkedOrder()
Block.getSortedComponentsInsideOfComponent()
Block.getNumPins()
Block.mergeWithBlock()
Block.getComponentAreaFrac()
Block.verifyBlockDims()
Block.getDim()
Block.getPinCenterFlatToFlat()
Block.getWireWrapCladGap()
Block.getPlenumPin()
Block.isPlenumPin()
Block.getPitch()
Block.hasPinPitch()
Block.getPinPitch()
Block.getDimensions()
Block.getLargestComponent()
Block.setPitch()
Block.getMfp()
Block.setAreaFractionsReport()
Block.getBlocks()
Block.updateComponentDims()
Block.getIntegratedMgFlux()
Block.getLumpedFissionProductCollection()
Block.rotate()
Block.setAxialExpTargetComp()
Block.getPinLocations()
Block.getPinCoordinates()
Block.getTotalEnergyGenerationConstants()
Block.getFissionEnergyGenerationConstants()
Block.getCaptureEnergyGenerationConstants()
Block.getNeutronEnergyDepositionConstants()
Block.getGammaEnergyDepositionConstants()
Block.getBoronMassEnrich()
Block.getUraniumMassEnrich()
Block.getInputHeight()
Block.paramCollectionType
HexBlock
HexBlock.PITCH_COMPONENT_TYPE
HexBlock.coords()
HexBlock.createHomogenizedCopy()
HexBlock.getMaxArea()
HexBlock.getDuctIP()
HexBlock.getDuctOP()
HexBlock.initializePinLocations()
HexBlock.setPinPowers()
HexBlock.rotate()
HexBlock.verifyBlockDims()
HexBlock.getPinToDuctGap()
HexBlock.getRotationNum()
HexBlock.setRotationNum()
HexBlock.getSymmetryFactor()
HexBlock.autoCreateSpatialGrids()
HexBlock.getPinCenterFlatToFlat()
HexBlock.hasPinPitch()
HexBlock.getPinPitch()
HexBlock.getWettedPerimeter()
HexBlock.getFlowArea()
HexBlock.getHydraulicDiameter()
HexBlock.paramCollectionType
CartesianBlock
ThRZBlock
- armi.reactor.composites module
FlagSerializer
CompositeModelType
ArmiObject
ArmiObject.paramCollectionType
ArmiObject.pDefs
ArmiObject.duplicate()
ArmiObject.clearCache()
ArmiObject.copyParamsFrom()
ArmiObject.updateParamsFrom()
ArmiObject.getChildren()
ArmiObject.getChildrenWithFlags()
ArmiObject.getComponents()
ArmiObject.iterComponents()
ArmiObject.doChildrenHaveFlags()
ArmiObject.containsAtLeastOneChildWithFlags()
ArmiObject.containsOnlyChildrenWithFlags()
ArmiObject.copyParamsToChildren()
ArmiObject.getParameterCollection()
ArmiObject.getParamNames()
ArmiObject.nameContains()
ArmiObject.getName()
ArmiObject.setName()
ArmiObject.hasFlags()
ArmiObject.getType()
ArmiObject.setType()
ArmiObject.getVolume()
ArmiObject.getArea()
ArmiObject.getVolumeFractions()
ArmiObject.getVolumeFraction()
ArmiObject.getMaxArea()
ArmiObject.getMass()
ArmiObject.getMassFrac()
ArmiObject.getMicroSuffix()
ArmiObject.getMassFracs()
ArmiObject.setMassFrac()
ArmiObject.setMassFracs()
ArmiObject.adjustMassFrac()
ArmiObject.adjustMassEnrichment()
ArmiObject.getNumberDensity()
ArmiObject.getNuclideNumberDensities()
ArmiObject.getNumberDensities()
ArmiObject.getChildrenWithNuclides()
ArmiObject.getAncestor()
ArmiObject.getAncestorAndDistance()
ArmiObject.getAncestorWithFlags()
ArmiObject.getTotalNDens()
ArmiObject.setNumberDensity()
ArmiObject.setNumberDensities()
ArmiObject.updateNumberDensities()
ArmiObject.changeNDensByFactor()
ArmiObject.clearNumberDensities()
ArmiObject.density()
ArmiObject.getNumberOfAtoms()
ArmiObject.getLumpedFissionProductCollection()
ArmiObject.setLumpedFissionProducts()
ArmiObject.setChildrenLumpedFissionProducts()
ArmiObject.getFissileMassEnrich()
ArmiObject.getUraniumNumEnrich()
ArmiObject.calcTotalParam()
ArmiObject.calcAvgParam()
ArmiObject.getMaxParam()
ArmiObject.getMinParam()
ArmiObject.getChildParamValues()
ArmiObject.isFuel()
ArmiObject.containsHeavyMetal()
ArmiObject.getNuclides()
ArmiObject.getFissileMass()
ArmiObject.getHMMass()
ArmiObject.getHMMoles()
ArmiObject.getHMDens()
ArmiObject.getFPMass()
ArmiObject.getFuelMass()
ArmiObject.constituentReport()
ArmiObject.getAtomicWeight()
ArmiObject.getMasses()
ArmiObject.getIntegratedMgFlux()
ArmiObject.getMgFlux()
ArmiObject.removeMass()
ArmiObject.addMass()
ArmiObject.addMasses()
ArmiObject.setMass()
ArmiObject.setMasses()
ArmiObject.getSymmetryFactor()
ArmiObject.getBoundingIndices()
ArmiObject.getComponentNames()
ArmiObject.getComponentsOfShape()
ArmiObject.getComponentsOfMaterial()
ArmiObject.hasComponents()
ArmiObject.getComponentByName()
ArmiObject.getComponent()
ArmiObject.getNumComponents()
ArmiObject.setComponentDimensionsReport()
ArmiObject.expandAllElementalsToIsotopics()
ArmiObject.expandElementalToIsotopics()
ArmiObject.getAverageTempInC()
ArmiObject.resolveLinkedDims()
ArmiObject.getDominantMaterial()
Composite
Composite.sort()
Composite.index()
Composite.append()
Composite.extend()
Composite.add()
Composite.remove()
Composite.moveTo()
Composite.insert()
Composite.removeAll()
Composite.setChildren()
Composite.getChildren()
Composite.getChildrenWithFlags()
Composite.getChildrenOfType()
Composite.getComponents()
Composite.iterComponents()
Composite.syncMpiState()
Composite.retainState()
Composite.backUp()
Composite.restoreBackup()
Composite.getLumpedFissionProductsIfNecessary()
Composite.getLumpedFissionProductCollection()
Composite.requiresLumpedFissionProducts()
Composite.getIntegratedMgFlux()
Composite.getReactionRates()
Composite.printContents()
Composite.getBoundingCircleOuterDiameter()
Composite.getPuMoles()
Composite.paramCollectionType
StateRetainer
gatherMaterialsByVolume()
getDominantMaterial()
getReactionRateDict()
- armi.reactor.cores module
Core
Core.pDefs
Core.setOptionsFromCs()
Core.r
Core.symmetry
Core.geomType
Core.powerMultiplier
Core.lib
Core.isFullCore
Core.refAssem
Core.sortAssemsByRing()
Core.summarizeReactorStats()
Core.setPowerFromDensity()
Core.setPowerIfNecessary()
Core.setBlockMassParams()
Core.getScalarEvolution()
Core.locateAllAssemblies()
Core.removeAssembly()
Core.removeAssembliesInRing()
Core.normalizeNames()
Core.normalizeInternalBookeeping()
Core.add()
Core.genAssembliesAddedThisCycle()
Core.getNumRings()
Core.getNumHexRings()
Core.getNumAssembliesWithAllRingsFilledOut()
Core.getNumEnergyGroups()
Core.countBlocksWithFlags()
Core.countFuelAxialBlocks()
Core.getFirstFuelBlockAxialNode()
Core.getAssembliesInRing()
Core.getMaxAssembliesInHexRing()
Core.getAssembliesInSquareOrHexRing()
Core.getAssembliesInCircularRing()
Core.buildCircularRingDictionary()
Core.getAssemblyByName()
Core.getAssemblies()
Core.getNozzleTypes()
Core.getBlockByName()
Core.getBlocksByIndices()
Core.genBlocksByLocName()
Core.getBlocks()
Core.getFirstBlock()
Core.getFirstAssembly()
Core.regenAssemblyLists()
Core.getAllXsSuffixes()
Core.getNuclideCategories()
Core.summarizeNuclideCategories()
Core.getLocationContents()
Core.makeLocationLookup()
Core.getFluxVector()
Core.getAssembliesOfType()
Core.getAssembly()
Core.getAssemblyWithAssemNum()
Core.getAssemblyWithStringLocation()
Core.getAssemblyPitch()
Core.findNeighbors()
Core.setMoveList()
Core.createFreshFeed()
Core.createAssemblyOfType()
Core.saveAllFlux()
Core.getAssembliesOnSymmetryLine()
Core.getCoreRadius()
Core.findAllMeshPoints()
Core.findAllAxialMeshPoints()
Core.updateAxialMesh()
Core.findAxialMeshIndexOf()
Core.addMoreNodes()
Core.findAllAziMeshPoints()
Core.findAllRadMeshPoints()
Core.getMaxBlockParam()
Core.getTotalBlockParam()
Core.getMaxNumPins()
Core.getMinimumPercentFluxInFuel()
Core.getAvgTemp()
Core.growToFullCore()
Core.setPitchUniform()
Core.calcBlockMaxes()
Core.getFuelBottomHeight()
Core.paramCollectionType
Core.processLoading()
Core.buildManualZones()
- armi.reactor.excoreStructure module
- armi.reactor.flags module
Flags
Flags.PRIMARY
Flags.SECONDARY
Flags.TERTIARY
Flags.ANNULAR
Flags.A
Flags.B
Flags.C
Flags.D
Flags.E
Flags.HIGH
Flags.MEDIUM
Flags.LOW
Flags.MATERIAL
Flags.FUEL
Flags.TEST
Flags.CONTROL
Flags.ULTIMATE
Flags.SHUTDOWN
Flags.SHIELD
Flags.SHIELD_BLOCK
Flags.SLUG
Flags.REFLECTOR
Flags.DRIVER
Flags.IGNITER
Flags.FEED
Flags.STARTER
Flags.BLANKET
Flags.BOOSTER
Flags.TARGET
Flags.MOX
Flags.INNER
Flags.MIDDLE
Flags.OUTER
Flags.RADIAL
Flags.AXIAL
Flags.UPPER
Flags.LOWER
Flags.DUCT
Flags.GRID_PLATE
Flags.HANDLING_SOCKET
Flags.INLET_NOZZLE
Flags.PLENUM
Flags.BOND
Flags.LINER
Flags.CLAD
Flags.PIN
Flags.GAP
Flags.WIRE
Flags.COOLANT
Flags.INTERCOOLANT
Flags.LOAD_PAD
Flags.ACLP
Flags.SKID
Flags.VOID
Flags.INTERDUCTCOOLANT
Flags.DSPACERINSIDE
Flags.GUIDE_TUBE
Flags.FISSION_CHAMBER
Flags.MODERATOR
Flags.CORE_BARREL
Flags.DUMMY
Flags.BATCHMASSADDITION
Flags.POISON
Flags.STRUCTURE
Flags.DEPLETABLE
Flags.MOVEABLE
Flags.fromStringIgnoreErrors()
Flags.fromString()
Flags.toString()
InvalidFlagsError
- armi.reactor.geometry module
- armi.reactor.reactorParameters module
- armi.reactor.reactors module
- armi.reactor.spentFuelPool module
- armi.reactor.systemLayoutInput module
SystemLayoutInput
SystemLayoutInput.ROOT_TAG
SystemLayoutInput.readGeomFromFile()
SystemLayoutInput.readGeomFromStream()
SystemLayoutInput.toGridBlueprints()
SystemLayoutInput.modifyEqPaths()
SystemLayoutInput.writeGeom()
SystemLayoutInput.growToFullCore()
SystemLayoutInput.fromReactor()
SystemLayoutInput.loadFromCs()
- armi.reactor.zones module