armi.reactor.grids.axial module

class armi.reactor.grids.axial.AxialGrid(unitSteps=(0, 0, 0), bounds=(None, None, None), unitStepLimits=((0, 1), (0, 1), (0, 1)), offset=None, geomType='', symmetry='', armiObject=None)[source]

Bases: StructuredGrid

1-D grid in the k-direction (z).

classmethod fromNCells(numCells: int, armiObject: Optional[ArmiObject] = None) → AxialGrid[source]

Produces an unit grid where each bin is 1-cm tall.

numCells + 1 mesh boundaries are added, since one block would require a bottom and a top.

static getSymmetricEquivalents(indices: Tuple[int, int]) → List[Tuple[int, int]][source]

static locatorInDomain(locator: LocationBase, symmetryOverlap: Optional[bool] = False) → NoReturn[source]

static getIndicesFromRingAndPos(ring: int, pos: int) → NoReturn[source]

static getMinimumRings(n: int) → NoReturn[source]

static getPositionsInRing(ring: int) → NoReturn[source]

static overlapsWhichSymmetryLine(indices: Tuple[int, int]) → None[source]

property pitch: float

Grid spacing in the z-direction.

Returns:: Pitch in cm
Return type:: float

armiObject: Optional[ArmiObject]

armi.reactor.grids.axial.axialUnitGrid(numCells: int, armiObject: Optional[ArmiObject] = None) → AxialGrid[source]: Build a 1-D unit grid in the k-direction based on a number of times. Each mesh is 1cm wide.