armi.reactor.blocks.cartesianBlock module

Cartesian blocks can be square or more generically rectangular in cross section.

class armi.reactor.blocks.cartesianBlock.CartesianBlock(name: str, height: float = 1.0)[source]

Bases: Block

A Cartesian Block is a vertical slice of an Assembly which is laid out on a Cartesian grid. That is, a grid that is square or rectangular.

A Cartesian grid can have an origin that is in the middle of a grid cell:

(-1,1)

(0,1)

(1,1)

(-1,0)

(0,0)

(1,0)

(-1,-1)

(0,-1)

(1,-1)

Or the grid cells can be aligned so the origin is between the grid cells:

(-2,1)

(-1,1)

(0,1)

(1,1)

(-2,0)

(-1,0)

(0,0)

(1,0)

(-2,-1)

(-1,-1)

(0,-1)

(1,-1)

(-2,-2)

(-1,-2)

(0,-2)

(1,-2)

Builds a new ARMI block.

namestr

The name of this block

heightfloat, optional

The height of the block in cm. Defaults to 1.0 so that getVolume assumes unit height.

PITCH_DIMENSION = 'widthOuter'
PITCH_COMPONENT_TYPE

alias of Rectangle

getMaxArea()[source]

Get area of this block if it were totally full.

setPitch(val, updateBolParams=False)[source]
getSymmetryFactor()[source]

Return a factor between 1 and N where 1/N is how much cut-off by symmetry lines this mesh cell is.

getPinCenterFlatToFlat(cold=False)[source]

Return the flat-to-flat distance between the centers of opposing pins (corner-2-corner) in the outer ring.

getNumCellsGivenRings(nRings: int)[source]

Calculate the number of cells in a Cartesian grid with a given number of rings.

The logic here is separated out into two scenarios: one for when the origin is inside the center grid cell and one where the origin is on the line between grid cells.

numRingsToHoldNumCells(nCells: int)[source]

Calculate the number of rings needed in a Cartesian grid to hold a given number of cells.

The logic here is separated out into two scenarios: one for when the origin is inside the center grid cell and one where the origin is on the line between grid cells.

paramCollectionType

alias of BlockParameterCollection