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)

Bases: StructuredGrid

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

Note

It is recommended to use fromNCells() rather than calling the __init_ constructor directly

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

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]]

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

static getIndicesFromRingAndPos(ring: int, pos: int) → NoReturn

static getMinimumRings(n: int) → NoReturn

static getPositionsInRing(ring: int) → NoReturn

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

property pitch: float

Grid spacing in the z-direction.

Returns:

Pitch in cm

Return type:

float

armiObject: Optional[ArmiObject]