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.
See Developer Docs.
- class armi.reactor.ReactorPlugin[source]
Bases:
ArmiPluginPlugin 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()Blueprintsmigrate()- Subpackages
- Submodules
- armi.reactor.components package
factory()NullComponentUnshapedComponentUnshapedComponent.pDefsUnshapedComponent.getComponentArea()UnshapedComponent.getBoundingCircleOuterDiameter()UnshapedComponent.getCircleInnerDiameter()UnshapedComponent.fromComponent()UnshapedComponent.DIMENSION_NAMESUnshapedComponent.INIT_SIGNATUREUnshapedComponent.paramCollectionTypeUnshapedComponent.material
UnshapedVolumetricComponentUnshapedVolumetricComponent.is3DUnshapedVolumetricComponent.getComponentArea()UnshapedVolumetricComponent.getComponentVolume()UnshapedVolumetricComponent.setVolume()UnshapedVolumetricComponent.DIMENSION_NAMESUnshapedVolumetricComponent.INIT_SIGNATUREUnshapedVolumetricComponent.paramCollectionTypeUnshapedVolumetricComponent.material
ZeroMassComponentPositiveOrNegativeVolumeComponentDerivedShape- Subpackages
- 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()getFilletedHexagonParameterDefinitions()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
buildSimpleFuelBlock()buildLinkedFuelBlock()loadTestBlock()applyDummyData()getComponentData()TestDetailedNDensUpdateTestValidateSFPSpatialGridsBlock_TestCaseBlockInputHeightsTestsBlockEnergyDepositionConstantsTestNegativeVolumeHexBlock_TestCaseMultiPinIndicesTestsTestHexBlockOrientationThRZBlock_TestCaseCartesianBlock_TestCaseMassConservationTests
- armi.reactor.tests.test_components module
MockCompositionDependentExpanderTestComponentFactoryTestGeneralComponentsTestComponentNDensTestComponentTestNullComponentTestUnshapedComponentTestShapedComponentTestDerivedShapeTestDerivedShapeGetAreaTestComponentSortTestCircleTestComponentExpansionTestTriangleTestRectangleTestSolidRectangleTestSquareTestCubeTestHexagonTestFilletedHexagonTestHoledHexagonTestHexHoledCircleTestHoledRectangleTestHoledSquareTestHelixTestSphereTestRadialSegmentTestDifferentialRadialSegmentTestMaterialAdjustmentsTestPinQuantities
- armi.reactor.tests.test_composites module
- armi.reactor.tests.test_cores 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
AssemblyAssembly.pDefsAssembly.DATABASEAssembly.LOAD_QUEUEAssembly.SPENT_FUEL_POOLAssembly.NOT_IN_COREAssembly.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.iterBlocks()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
HexAssemblyCartesianAssemblyRZAssemblyThRZAssembly
- armi.reactor.assemblyParameters module
- armi.reactor.blockParameters module
- armi.reactor.blocks module
BlockBlock.uniqIDBlock.PITCH_DIMENSIONBlock.PITCH_COMPONENT_TYPEBlock.pDefsBlock.createHomogenizedCopy()Block.coreBlock.makeName()Block.getSmearDensity()Block.computeSmearDensity()Block.autoCreateSpatialGrids()Block.assignPinIndices()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.sort()Block.paramCollectionType
HexBlockHexBlock.PITCH_COMPONENT_TYPEHexBlock.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.assignPinIndices()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.iterChildren()ArmiObject.getChildren()ArmiObject.iterChildrenWithFlags()ArmiObject.getChildrenWithFlags()ArmiObject.iterChildrenOfType()ArmiObject.getChildrenOfType()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()
CompositeComposite.sort()Composite.index()Composite.append()Composite.extend()Composite.add()Composite.remove()Composite.moveTo()Composite.insert()Composite.removeAll()Composite.setChildren()Composite.iterChildren()Composite.iterChildrenWithMaterials()Composite.getChildren()Composite.getComponents()Composite.getFirstComponent()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
StateRetainergatherMaterialsByVolume()getDominantMaterial()getReactionRateDict()
- armi.reactor.cores module
CoreCore.pDefsCore.setOptionsFromCs()Core.rCore.symmetryCore.geomTypeCore.powerMultiplierCore.libCore.hasLib()Core.isFullCoreCore.refAssemCore.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.processLoading()Core.buildManualZones()Core.paramCollectionTypeCore.iterBlocks()
- armi.reactor.excoreStructure module
- armi.reactor.flags module
FlagsFlags.PRIMARYFlags.SECONDARYFlags.TERTIARYFlags.ANNULARFlags.AFlags.BFlags.CFlags.DFlags.EFlags.HIGHFlags.MEDIUMFlags.LOWFlags.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.COLLARFlags.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
- armi.reactor.spentFuelPool module
- armi.reactor.zones module