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:
Class inheritance diagram for
armi.reactor.
See Developer Docs.
- class armi.reactor.ReactorPlugin[source]
Bases:
ArmiPluginPlugin exposing built-in reactor components, blocks, assemblies, etc.
Subpackages
- armi.reactor.blueprints package
loadFromCs()Blueprintsmigrate()- Subpackages
- Submodules
- armi.reactor.components package
factory()NullComponentUnshapedComponentUnshapedVolumetricComponentUnshapedVolumetricComponent.is3DUnshapedVolumetricComponent.getComponentArea()UnshapedVolumetricComponent.getComponentVolume()UnshapedVolumetricComponent.setVolume()UnshapedVolumetricComponent.DIMENSION_NAMESUnshapedVolumetricComponent.INIT_SIGNATUREUnshapedVolumetricComponent.paramCollectionType
ZeroMassComponentPositiveOrNegativeVolumeComponentDerivedShape- 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
- Subpackages
- Submodules
- 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
TestComponentFactoryTestGeneralComponentsTestComponentTestNullComponentTestUnshapedComponentTestShapedComponentTestDerivedShapeTestCircleTestComponentExpansionTestTriangleTestRectangleTestSolidRectangleTestSquareTestCubeTestHexagonTestHoledHexagonTestHexHoledCircleTestHoledRectangleTestHoledSquareTestHelixTestSphereTestRadialSegmentTestDifferentialRadialSegmentTestMaterialAdjustments
- armi.reactor.tests.test_composites module
- armi.reactor.tests.test_flags module
- armi.reactor.tests.test_geometry 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
AssemblyAssembly.pDefsAssembly.LOAD_QUEUEAssembly.SPENT_FUEL_POOLAssembly.DATABASEAssembly.NOT_IN_COREAssembly.renameBlocksAccordingToAssemblyNum()Assembly.makeNameFromAssemNum()Assembly.renumber()Assembly.makeUnique()Assembly.add()Assembly.moveTo()Assembly.insert()Assembly.getNum()Assembly.getLocation()Assembly.coords()Assembly.getArea()Assembly.getVolume()Assembly.getPinPlenumVolumeInCubicMeters()Assembly.getAveragePlenumTemperature()Assembly.rotatePins()Assembly.doubleResolution()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.paramCollectionType
HexAssemblyCartesianAssemblyRZAssemblyThRZAssembly
- armi.reactor.assemblyLists module
- armi.reactor.assemblyParameters module
- armi.reactor.blockParameters module
- armi.reactor.blocks module
BlockBlock.uniqIDBlock.PITCH_DIMENSIONBlock.PITCH_COMPONENT_TYPEBlock.pDefsBlock.coreBlock.rBlock.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.getMaxVolume()Block.getArea()Block.getVolume()Block.getSymmetryFactor()Block.isOnWhichSymmetryLine()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.breakFuelComponentsIntoIndividuals()Block.getIntegratedMgFlux()Block.getLumpedFissionProductCollection()Block.rotate()Block.setAxialExpTargetComp()Block.getPinCoordinates()Block.paramCollectionType
HexBlockHexBlock.PITCH_COMPONENT_TYPEHexBlock.coords()HexBlock.getMaxArea()HexBlock.getDuctIP()HexBlock.getDuctOP()HexBlock.initializePinLocations()HexBlock.setPinPowers()HexBlock.rotate()HexBlock.rotatePins()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
CartesianBlockThRZBlock
- armi.reactor.composites module
FlagSerializerCompositeModelTypeArmiObjectArmiObject.paramCollectionTypeArmiObject.pDefsArmiObject.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.getMaxVolume()ArmiObject.getMass()ArmiObject.getMassFrac()ArmiObject.getMicroSuffix()ArmiObject.getMassFracs()ArmiObject.setMassFrac()ArmiObject.setMassFracs()ArmiObject.adjustMassFrac()ArmiObject.adjustMassEnrichment()ArmiObject.getNumberDensity()ArmiObject.getNuclideNumberDensities()ArmiObject.getNumberDensities()ArmiObject.getNeutronEnergyDepositionConstants()ArmiObject.getGammaEnergyDepositionConstants()ArmiObject.getTotalEnergyGenerationConstants()ArmiObject.getFissionEnergyGenerationConstants()ArmiObject.getCaptureEnergyGenerationConstants()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.getBoronMassEnrich()ArmiObject.getUraniumMassEnrich()ArmiObject.getUraniumNumEnrich()ArmiObject.getPuN()ArmiObject.getPuMoles()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.getPuMass()ArmiObject.getPuFrac()ArmiObject.getZrFrac()ArmiObject.getMaxUraniumMassEnrich()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.printDensities()ArmiObject.expandAllElementalsToIsotopics()ArmiObject.expandElementalToIsotopics()ArmiObject.getAverageTempInC()ArmiObject.resolveLinkedDims()ArmiObject.getDominantMaterial()
CompositeComposite.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.isOnWhichSymmetryLine()Composite.getBoundingCircleOuterDiameter()Composite.paramCollectionType
StateRetainergatherMaterialsByVolume()getDominantMaterial()getReactionRateDict()
- armi.reactor.flags module
FlagsFlags.PRIMARYFlags.SECONDARYFlags.TERTIARYFlags.ANNULARFlags.AFlags.BFlags.CFlags.DFlags.EFlags.HIGHFlags.MEDIUMFlags.LOWFlags.COREFlags.REACTORFlags.MATERIALFlags.FUELFlags.TESTFlags.CONTROLFlags.ULTIMATEFlags.SHUTDOWNFlags.SHIELDFlags.SHIELD_BLOCKFlags.SLUGFlags.REFLECTORFlags.DRIVERFlags.IGNITERFlags.FEEDFlags.STARTERFlags.BLANKETFlags.BOOSTERFlags.TARGETFlags.MOXFlags.INNERFlags.MIDDLEFlags.OUTERFlags.RADIALFlags.AXIALFlags.UPPERFlags.LOWERFlags.DUCTFlags.GRID_PLATEFlags.HANDLING_SOCKETFlags.INLET_NOZZLEFlags.PLENUMFlags.BONDFlags.LINERFlags.CLADFlags.PINFlags.GAPFlags.WIREFlags.COOLANTFlags.INTERCOOLANTFlags.LOAD_PADFlags.ACLPFlags.SKIDFlags.VOIDFlags.INTERDUCTCOOLANTFlags.DSPACERINSIDEFlags.GUIDE_TUBEFlags.FISSION_CHAMBERFlags.MODERATORFlags.CORE_BARRELFlags.DUMMYFlags.BATCHMASSADDITIONFlags.POISONFlags.STRUCTUREFlags.DEPLETABLEFlags.MOVEABLEFlags.fromStringIgnoreErrors()Flags.fromString()Flags.toString()
InvalidFlagsError
- armi.reactor.geometry module
- armi.reactor.reactorParameters module
- armi.reactor.reactors module
ReactorloadFromCs()factory()CoreCore.pDefsCore.setOptionsFromCs()Core.rCore.symmetryCore.geomTypeCore.powerMultiplierCore.libCore.isFullCoreCore.refAssemCore.sortAssemsByRing()Core.summarizeReactorStats()Core.setPowerFromDensity()Core.setPowerIfNecessary()Core.setBlockMassParams()Core.getScalarEvolution()Core.locateAllAssemblies()Core.removeAssembly()Core.removeAssembliesInRing()Core.removeAllAssemblies()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.getAllNuclidesIn()Core.growToFullCore()Core.setPitchUniform()Core.calcBlockMaxes()Core.getFuelBottomHeight()Core.paramCollectionTypeCore.processLoading()Core.buildManualZones()
- armi.reactor.systemLayoutInput module
SystemLayoutInputSystemLayoutInput.ROOT_TAGSystemLayoutInput.readGeomFromFile()SystemLayoutInput.readGeomFromStream()SystemLayoutInput.toGridBlueprints()SystemLayoutInput.modifyEqPaths()SystemLayoutInput.writeGeom()SystemLayoutInput.growToFullCore()SystemLayoutInput.fromReactor()SystemLayoutInput.loadFromCs()
- armi.reactor.zones module