armi.physics.neutronics package

The neutronics physics package in the ARMI framework.

Neutronics encompasses the modeling of nuclear chain reactions and their associated transmutation and decay.

armi.physics.neutronics.gammaTransportIsRequested(cs)[source]

Check if gamma transport was requested by the user.

Parameters:

cs (ARMI settings object) – Object containing the default and user-specified ARMI settings controlling the simulation

Returns:

flag – Returns true if gamma transport is requested.

Return type:

bool

armi.physics.neutronics.gammaXsAreRequested(cs)[source]

Check if gamma cross-sections generation was requested by the user.

Parameters:

cs (ARMI settings object) – Object containing the default and user-specified ARMI settings controlling the simulation.

Returns:

flag – Returns true if gamma cross section generation is requested.

Return type:

bool

armi.physics.neutronics.adjointCalculationRequested(cs)[source]

Return true if an adjoint calculation is requested based on the CONF_NEUTRONICS_TYPE setting.

armi.physics.neutronics.realCalculationRequested(cs)[source]

Return true if a real calculation is requested based on the CONF_NEUTRONICS_TYPE type setting.

class armi.physics.neutronics.LatticePhysicsFrequency(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntEnum

Enumeration for lattice physics update frequency options.

NEVER = never automatically trigger lattice physics (a custom script could still trigger it) BOL = Beginning-of-life (c0n0) BOC = Beginning-of-cycle (c*n0) everyNode = Every interaction node (c*n*) firstCoupledIteration = every node + the first coupled iteration at each node all = every node + every coupled iteration

Notes

firstCoupledIteration only updates the cross sections during the first coupled iteration, but not on any subsequent iterations. This may be an appropriate approximation in some cases to save compute time, but each individual user should give careful consideration to whether this is the behavior they want for a particular application. The main purpose of this setting is to capture a large change in temperature distribution when running a snapshot at a different power/flow condition than the original state being loaded from the database.

never = 0
BOL = 1
BOC = 2
everyNode = 3
firstCoupledIteration = 4
all = 5

Subpackages

Submodules