Tally

To support the intricacies of MCNP’s tally bin structure, there are a variety of classes to represent the different cell and surface bin constructs. Using these classes is greatly simplified by using operators which take after the ones used in native MCNP syntax.

Note

These bins are not to be confused with MCNP’s energy, time, angle, etc. bin cards. Cell and surface bins appear of the tally card itself.

Tally Bin Operators

Operation

Symbol (Python)

Symbol (MCNP)

Semantics

Union

|

( )

OR

Level

&

space

Grouping of cells

Levels

<<

<

Within repeated structure levels

Index

C1[i1, i2, ... i3]

C1[i1 i2 ... i3]

Elements of lattice cell

To illustrate these operators, refer to the following example where we assume some cells, surfaces, and universes have been created already.

# Simple tally bin
bins = [cell_1, cell_2, cell_3]

f4_tally = mcnpy.Tally.CellFlux(particles=[mcnpy.Particle.NEUTRON], bins=bins)
# F4:N 1 2 3

Important

Using the particles and bins keywords are required when the name (Tally ID) is omitted. Omitting name invokes automated tally numbering.

# Tally bin with operators
cell_union = cell_1 | cell_2
cell_level = cell_union & cell_3
indexed_cell = cell_4[[1,2,3], [4,5,6]]
cell_levels = indexed_cell << cell_level

f4_tally = mcnpy.Tally.CellFlux(particles=[mcnpy.Particle.NEUTRON], bins=cell_levels)
# F4:N 4[1 2 3, 4 5 6] < ((1 2) 3)

Note

Surfaces and Universes can also be used where appropriate.

class mcnpy.Tally[source]

Bases: object

class Bin[source]

Bases: ABC

class CellBins(*args, **kwargs)[source]

Bases: CellBins

A representation of the model object Tally.Bin.CellBins.

Parameters

bins (iterable of Object) – Bins for Tally.Bin.CellBins.

property bins
class CellLevel(*args, **kwargs)[source]

Bases: CellLevel, Level, MutableSequence

A representation of the model object Tally.Bin.CellLevel.

Parameters

level (iterable of Object) – Level for Tally.Bin.CellLevel.

insert(index, value)[source]

S.insert(index, value) – insert value before index

property level
class CellLevels(*args, **kwargs)[source]

Bases: CellLevels, MutableSequence

A representation of the model object Tally.Bin.CellLevels.

Parameters

levels (iterable of mcnpy.Tally.Bin.CellLevel) – Levels for Tally.Bin.CellLevels.

insert(index, value)[source]

S.insert(index, value) – insert value before index

property levels
class CellUnion(*args, **kwargs)[source]

Bases: CellUnion, Level, MutableSequence

A representation of the model object Tally.Bin.CellUnion.

Parameters

union (iterable of mcnpy.Tally.Bin.UnaryCellBin) – Union for Tally.Bin.CellUnion.

insert(index, value)[source]

S.insert(index, value) – insert value before index

class FS_halfspace(*args, **kwargs)[source]

Bases: FS_halfspace

A representation of the model object Tally.Bin.FS_halfspace.

Parameters

  • bin (float) – Bin for Tally.Bin.FS_halfspace.

  • hs (mcnpy.Halfspace) – Hs for Tally.Bin.FS_halfspace.

class Level[source]

Bases: ABC

class ROCBin(*args, **kwargs)[source]

Bases: ROCBin

A representation of the model object Tally.Bin.ROCBin.

Parameters

bins (iterable of mcnpy.Tally.Bin.ROCBinRange) – Bins for Tally.Bin.ROCBin.

class ROCBinRange(*args, **kwargs)[source]

Bases: ROCBinRange

A representation of the model object Tally.Bin.ROCBinRange.

Parameters

  • lower (int) – Lower for Tally.Bin.ROCBinRange.

  • upper (int) – Upper for Tally.Bin.ROCBinRange.

class SurfaceBins(*args, **kwargs)[source]

Bases: SurfaceBins

A representation of the model object Tally.Bin.SurfaceBins.

Parameters

bins (iterable of Object) – Bins for Tally.Bin.SurfaceBins.

property bins
class SurfaceLevel(*args, **kwargs)[source]

Bases: SurfaceLevel, Level, MutableSequence

A representation of the model object Tally.Bin.SurfaceLevel.

Parameters

level (iterable of Object) – Level for Tally.Bin.SurfaceLevel.

insert(index, value)[source]

S.insert(index, value) – insert value before index

property level
class SurfaceLevels(*args, **kwargs)[source]

Bases: SurfaceLevels, MutableSequence

A representation of the model object Tally.Bin.SurfaceLevels.

Parameters
insert(index, value)[source]

S.insert(index, value) – insert value before index

property levels
class SurfaceUnion(*args, **kwargs)[source]

Bases: SurfaceUnion, Level, MutableSequence

A representation of the model object Tally.Bin.SurfaceUnion.

Parameters

union (iterable of mcnpy.Tally.Bin.UnarySurfaceBin) – Union for Tally.Bin.SurfaceUnion.

insert(index, value)[source]

S.insert(index, value) – insert value before index

class UnaryCellBin(*args, **kwargs)[source]

Bases: UnaryCellBin, Level

A representation of the model object Tally.Bin.UnaryCellBin.

Parameters
class UnarySurfaceBin(*args, **kwargs)[source]

Bases: UnarySurfaceBin, Level

A representation of the model object Tally.Bin.UnarySurfaceBin.

Parameters

  • surface (mcnpy.Surface) – Surface for Tally.Bin.UnarySurfaceBin.

  • facets (str) – Facets for Tally.Bin.UnarySurfaceBin.

property surface
class Bins[source]

Bases: ABC

class AngleMultiplier(*args, **kwargs)[source]

Bases: TallyRef, AngleMultiplier

A representation of the model object Tally.Bins.AngleMultiplier.

Parameters

  • tally (mcnpy.Tally) – Tally for Tally.Bins.AngleMultiplier.

  • multipliers (iterable of float) – Multipliers for Tally.Bins.AngleMultiplier.

class Angles(*args, **kwargs)[source]

Bases: TallyRef, TallyAngles

A representation of the model object Tally.Bins.Angles.

Parameters

  • unit (mcnpy.AngleUnit) – Unit for Tally.Bins.Angles.

  • tally (mcnpy.Tally) – Tally for Tally.Bins.Angles.

  • max_angles (iterable of float) – MaxAngles for Tally.Bins.Angles.

  • total (mcnpy.Boolean) – Total for Tally.Bins.Angles.

  • cumulative (mcnpy.Boolean) – Cumulative for Tally.Bins.Angles.

class DoseEnergy(*args, **kwargs)[source]

Bases: TallyRef, DoseEnergy

A representation of the model object Tally.Bins.DoseEnergy.

Parameters

  • tally (mcnpy.Tally) – Tally for Tally.Bins.DoseEnergy.

  • interpolation (mcnpy.Interpolation) – Interpolation for Tally.Bins.DoseEnergy.

  • energies (iterable of float) – Energies for Tally.Bins.DoseEnergy.

class DoseFunction(*args, **kwargs)[source]

Bases: TallyRef, DoseFunction

A representation of the model object Tally.Bins.DoseFunction.

Parameters
class Normalization(*args, **kwargs)[source]

Bases: DoseNormalization

A representation of the model object Tally.Bins.DoseFunction.Normalization.

Parameters

  • fac (str) – Fac for Tally.Bins.DoseFunction.Normalization.

  • user_fac (float) – UserFac for Tally.Bins.DoseFunction.Normalization.

class DoseTable(*args, **kwargs)[source]

Bases: TallyRef, DoseTable

A representation of the model object Tally.Bins.DoseTable.

Parameters

  • tally (mcnpy.Tally) – Tally for Tally.Bins.DoseTable.

  • interpolation (mcnpy.Interpolation) – Interpolation for Tally.Bins.DoseTable.

  • doses (iterable of float) – Doses for Tally.Bins.DoseTable.

class Energies(*args, **kwargs)[source]

Bases: TallyRef, TallyEnergies

A representation of the model object Tally.Bins.Energies.

Parameters

  • particles (iterable of mcnpy.Particle) – Particles for Tally.Bins.Energies.

  • max_energies (iterable of float) – MaxEnergies for Tally.Bins.Energies.

  • no_total (mcnpy.Boolean) – NoTotal for Tally.Bins.Energies.

  • cumulative (mcnpy.Boolean) – Cumulative for Tally.Bins.Energies.

  • tally (mcnpy.Tally) – Tally for Tally.Bins.Energies.

class EnergyMultiplier(*args, **kwargs)[source]

Bases: TallyRef, EnergyMultiplier

A representation of the model object Tally.Bins.EnergyMultiplier.

Parameters

  • tally (mcnpy.Tally) – Tally for Tally.Bins.EnergyMultiplier.

  • multipliers (iterable of float) – Multipliers for Tally.Bins.EnergyMultiplier.

class FlagCells(*args, **kwargs)[source]

Bases: TallyRef, FlagCells

A representation of the model object Tally.Bins.FlagCells.

Parameters

  • tally (mcnpy.Tally) – Tally for Tally.Bins.FlagCells.

  • cells (iterable of mcnpy.Cell) – Cells for Tally.Bins.FlagCells.

class FlagSurfaces(*args, **kwargs)[source]

Bases: TallyRef, FlagSurfaces

A representation of the model object Tally.Bins.FlagSurfaces.

Parameters

  • tally (mcnpy.Tally) – Tally for Tally.Bins.FlagSurfaces.

  • surfaces (iterable of mcnpy.Surface) – Surfaces for Tally.Bins.FlagSurfaces.

class Fluctuation(*args, **kwargs)[source]

Bases: TallyRef, TallyFluctuation

A representation of the model object Tally.Bins.Fluctuation.

Parameters

  • tally (mcnpy.Tally) – Tally for Tally.Bins.Fluctuation.

  • geometry (int) – Geometry for Tally.Bins.Fluctuation.

  • direct (int) – Direct for Tally.Bins.Fluctuation.

  • user (int) – User for Tally.Bins.Fluctuation.

  • segment (int) – Segment for Tally.Bins.Fluctuation.

  • multiplier (int) – Multiplier for Tally.Bins.Fluctuation.

  • angle (int) – Angle for Tally.Bins.Fluctuation.

  • energy (int) – Energy for Tally.Bins.Fluctuation.

  • time (int) – Time for Tally.Bins.Fluctuation.

  • j_geometry (str) – J_geometry for Tally.Bins.Fluctuation.

  • j_direct (str) – J_direct for Tally.Bins.Fluctuation.

  • j_user (str) – J_user for Tally.Bins.Fluctuation.

  • j_segment (str) – J_segment for Tally.Bins.Fluctuation.

  • j_multiplier (str) – J_multiplier for Tally.Bins.Fluctuation.

  • j_angle (str) – J_angle for Tally.Bins.Fluctuation.

  • j_energy (str) – J_energy for Tally.Bins.Fluctuation.

  • j_time (str) – J_time for Tally.Bins.Fluctuation.

class FluctuationROC(*args, **kwargs)[source]

Bases: TallyRef, TallyFluctuationROC

A representation of the model object Tally.Bins.FluctuationROC.

Parameters

  • tally (mcnpy.Tally) – Tally for Tally.Bins.FluctuationROC.

  • geometry1 (mcnpy.Tally.Bin.ROCBin) – Geometry1 for Tally.Bins.FluctuationROC.

  • direct1 (mcnpy.Tally.Bin.ROCBin) – Direct1 for Tally.Bins.FluctuationROC.

  • user1 (mcnpy.Tally.Bin.ROCBin) – User1 for Tally.Bins.FluctuationROC.

  • segment1 (mcnpy.Tally.Bin.ROCBin) – Segment1 for Tally.Bins.FluctuationROC.

  • multiplier1 (mcnpy.Tally.Bin.ROCBin) – Multiplier1 for Tally.Bins.FluctuationROC.

  • angle1 (mcnpy.Tally.Bin.ROCBin) – Angle1 for Tally.Bins.FluctuationROC.

  • energy1 (mcnpy.Tally.Bin.ROCBin) – Energy1 for Tally.Bins.FluctuationROC.

  • time1 (mcnpy.Tally.Bin.ROCBin) – Time1 for Tally.Bins.FluctuationROC.

  • geometry2 (mcnpy.Tally.Bin.ROCBin) – Geometry2 for Tally.Bins.FluctuationROC.

  • direct2 (mcnpy.Tally.Bin.ROCBin) – Direct2 for Tally.Bins.FluctuationROC.

  • user2 (mcnpy.Tally.Bin.ROCBin) – User2 for Tally.Bins.FluctuationROC.

  • segment2 (mcnpy.Tally.Bin.ROCBin) – Segment2 for Tally.Bins.FluctuationROC.

  • multiplier2 (mcnpy.Tally.Bin.ROCBin) – Multiplier2 for Tally.Bins.FluctuationROC.

  • angle2 (mcnpy.Tally.Bin.ROCBin) – Angle2 for Tally.Bins.FluctuationROC.

  • energy2 (mcnpy.Tally.Bin.ROCBin) – Energy2 for Tally.Bins.FluctuationROC.

  • time2 (mcnpy.Tally.Bin.ROCBin) – Time2 for Tally.Bins.FluctuationROC.

  • j_geometry1 (str) – J_geometry1 for Tally.Bins.FluctuationROC.

  • j_direct1 (str) – J_direct1 for Tally.Bins.FluctuationROC.

  • j_user1 (str) – J_user1 for Tally.Bins.FluctuationROC.

  • j_segment1 (str) – J_segment1 for Tally.Bins.FluctuationROC.

  • j_multiplier1 (str) – J_multiplier1 for Tally.Bins.FluctuationROC.

  • j_angle1 (str) – J_angle1 for Tally.Bins.FluctuationROC.

  • j_energy1 (str) – J_energy1 for Tally.Bins.FluctuationROC.

  • j_time1 (str) – J_time1 for Tally.Bins.FluctuationROC.

  • j_geometry2 (str) – J_geometry2 for Tally.Bins.FluctuationROC.

  • j_direct2 (str) – J_direct2 for Tally.Bins.FluctuationROC.

  • j_user2 (str) – J_user2 for Tally.Bins.FluctuationROC.

  • j_segment2 (str) – J_segment2 for Tally.Bins.FluctuationROC.

  • j_multiplier2 (str) – J_multiplier2 for Tally.Bins.FluctuationROC.

  • j_angle2 (str) – J_angle2 for Tally.Bins.FluctuationROC.

  • j_energy2 (str) – J_energy2 for Tally.Bins.FluctuationROC.

  • j_time2 (str) – J_time2 for Tally.Bins.FluctuationROC.

class Multiplier(*args, **kwargs)[source]

Bases: TallyRef, TallyMultiplier

A representation of the model object Tally.Bins.Multiplier.

Parameters

  • sign (str) – Sign for Tally.Bins.Multiplier.

  • tally (mcnpy.Tally) – Tally for Tally.Bins.Multiplier.

  • bins (Object) – Bins for Tally.Bins.Multiplier.

  • total (mcnpy.Boolean) – Total for Tally.Bins.Multiplier.

  • cumulative (mcnpy.Boolean) – Cumulative for Tally.Bins.Multiplier.

class AttnMatSet(*args, **kwargs)[source]

Bases: AttnMatSet

A representation of the model object Tally.Bins.Multiplier.AttnMatSet.

Parameters

  • m (mcnpy.Material) – M for Tally.Bins.Multiplier.AttnMatSet.

  • sign (mcnpy.Boolean) – Sign for Tally.Bins.Multiplier.AttnMatSet.

  • px (float) – Px for Tally.Bins.Multiplier.AttnMatSet.

class AttnSet(*args, **kwargs)[source]

Bases: AttnSet

A representation of the model object Tally.Bins.Multiplier.AttnSet.

Parameters
class MultBin(*args, **kwargs)[source]

Bases: MultBin

A representation of the model object Tally.Bins.Multiplier.MultBin.

Parameters

bin (Object) – Bin for Tally.Bins.Multiplier.MultBin.

class MultBinSet(*args, **kwargs)[source]

Bases: MultBinSet

A representation of the model object Tally.Bins.Multiplier.MultBinSet.

Parameters

set (iterable of mcnpy.Tally.Bins.Multiplier.MultBin) – Set for Tally.Bins.Multiplier.MultBinSet.

class MultBinSets(*args, **kwargs)[source]

Bases: MultBinSets

A representation of the model object Tally.Bins.Multiplier.MultBinSets.

Parameters

sets (iterable of mcnpy.Tally.Bins.Multiplier.MultBinSet) – Sets for Tally.Bins.Multiplier.MultBinSets.

class MultSet(*args, **kwargs)[source]

Bases: MultSet

A representation of the model object Tally.Bins.Multiplier.MultSet.

Parameters
class MultSetSpecial(*args, **kwargs)[source]

Bases: MultSetSpecial

A representation of the model object Tally.Bins.Multiplier.MultSetSpecial.

Parameters

  • c (float) – C for Tally.Bins.Multiplier.MultSetSpecial.

  • k (str) – K for Tally.Bins.Multiplier.MultSetSpecial.

class RxnLists(*args, **kwargs)[source]

Bases: RxnLists

A representation of the model object Tally.Bins.Multiplier.RxnLists.

Parameters

nodes (iterable of mcnpy.Tally.Bins.Multiplier.Rxns) – Nodes for Tally.Bins.Multiplier.RxnLists.

class RxnMult(*args, **kwargs)[source]

Bases: RxnMult

A representation of the model object Tally.Bins.Multiplier.RxnMult.

Parameters

nodes (iterable of mcnpy.Tally.Bins.Multiplier.RxnNum) – Nodes for Tally.Bins.Multiplier.RxnMult.

class RxnNum(*args, **kwargs)[source]

Bases: RxnNum

A representation of the model object Tally.Bins.Multiplier.RxnNum.

Parameters

  • sign (mcnpy.PositiveNegative) – Sign for Tally.Bins.Multiplier.RxnNum.

  • value (int) – Value for Tally.Bins.Multiplier.RxnNum.

class RxnSum(*args, **kwargs)[source]

Bases: RxnSum

A representation of the model object Tally.Bins.Multiplier.RxnSum.

Parameters

nodes (iterable of mcnpy.Tally.Bins.Multiplier.RxnMult) – Nodes for Tally.Bins.Multiplier.RxnSum.

class Rxns(*args, **kwargs)[source]

Bases: Rxns

A representation of the model object Tally.Bins.Multiplier.Rxns.

class SegmentDivisors(*args, **kwargs)[source]

Bases: TallyRef, TallySegmentDivisors

A representation of the model object Tally.Bins.SegmentDivisors.

Parameters
class Divisor(*args, **kwargs)[source]

Bases: TallyDivisor

A representation of the model object Tally.Bins.SegmentDivisors.Divisor.

Parameters

quantities (iterable of float) – Quantities for Tally.Bins.SegmentDivisors.Divisor.

class Segments(*args, **kwargs)[source]

Bases: TallyRef, TallySegments

A representation of the model object Tally.Bins.Segments.

Parameters
class TimeMultiplier(*args, **kwargs)[source]

Bases: TallyRef, TimeMultiplier

A representation of the model object Tally.Bins.TimeMultiplier.

Parameters

  • tally (mcnpy.Tally) – Tally for Tally.Bins.TimeMultiplier.

  • multipliers (iterable of float) – Multipliers for Tally.Bins.TimeMultiplier.

class Times(*args, **kwargs)[source]

Bases: TallyRef, TallyTimes

A representation of the model object Tally.Bins.Times.

Parameters

  • tally (mcnpy.Tally) – Tally for Tally.Bins.Times.

  • max_times (iterable of float) – MaxTimes for Tally.Bins.Times.

  • no_total (mcnpy.Boolean) – NoTotal for Tally.Bins.Times.

  • cumulative (mcnpy.Boolean) – Cumulative for Tally.Bins.Times.

class TimesCyclic(*args, **kwargs)[source]

Bases: TallyRef, TallyTimesCyclic

A representation of the model object Tally.Bins.TimesCyclic.

Parameters

  • tally (mcnpy.Tally) – Tally for Tally.Bins.TimesCyclic.

  • start (float) – Start for Tally.Bins.TimesCyclic.

  • frequency (float) – Frequency for Tally.Bins.TimesCyclic.

  • dead_time (float) – DeadTime for Tally.Bins.TimesCyclic.

  • alive_time (float) – AliveTime for Tally.Bins.TimesCyclic.

  • subdivisions (float) – Subdivisions for Tally.Bins.TimesCyclic.

  • end (float) – End for Tally.Bins.TimesCyclic.

class Treatments(*args, **kwargs)[source]

Bases: TallyRef, TallyTreatments

A representation of the model object Tally.Bins.Treatments.

Parameters

  • tally (mcnpy.Tally) – Tally for Tally.Bins.Treatments.

  • keyword (mcnpy.TTreatment) – Keyword for Tally.Bins.Treatments.

  • treatment_vals (iterable of float) – TreatmentVals for Tally.Bins.Treatments.

class User(*args, **kwargs)[source]

Bases: TallyRef, TallyUser

A representation of the model object Tally.Bins.User.

Parameters

  • tally (mcnpy.Tally) – Tally for Tally.Bins.User.

  • parameters (iterable of float) – Parameters for Tally.Bins.User.

  • no_total (mcnpy.Boolean) – NoTotal for Tally.Bins.User.

  • cumulative (mcnpy.Boolean) – Cumulative for Tally.Bins.User.

class CellFlux(*args, **kwargs)[source]

Bases: FTallyABC, TallyCellFlux

A representation of the model object Tally.CellFlux.

Parameters

  • unit (mcnpy.FluxUnit) – Unit for Tally.CellFlux.

  • name (int) – Name for Tally.CellFlux.

  • particles (iterable of mcnpy.Particle) – Particles for Tally.CellFlux.

  • bins (mcnpy.Tally.Bin.CellBins) – Bins for Tally.CellFlux.

  • total (str) – Total for Tally.CellFlux.

increment = 10
next_id = 4
class ChargeDeposition(*args, **kwargs)[source]

Bases: FTallyABC, TallyChargeDeposition

A representation of the model object Tally.ChargeDeposition.

Parameters

  • name (int) – Name for Tally.ChargeDeposition.

  • particles (iterable of mcnpy.Particle) – Particles for Tally.ChargeDeposition.

  • bins (mcnpy.Tally.Bin.CellBins) – Bins for Tally.ChargeDeposition.

  • total (str) – Total for Tally.ChargeDeposition.

increment = 10
next_id = 8
class CollisionHeating(*args, **kwargs)[source]

Bases: FTallyABC, TallyCollisionHeating

A representation of the model object Tally.CollisionHeating.

Parameters

  • name (int) – Name for Tally.CollisionHeating.

  • particles (iterable of mcnpy.Particle) – Particles for Tally.CollisionHeating.

  • bins (mcnpy.Tally.Bin.CellBins) – Bins for Tally.CollisionHeating.

  • total (str) – Total for Tally.CollisionHeating.

increment = 10
next_id = 6
class CylindricalImageFlux(*args, **kwargs)[source]

Bases: RadTallyABC, TallyCylindricalImageFlux

A representation of the model object Tally.CylindricalImageFlux.

Parameters

  • scattered_only (mcnpy.Boolean) – ScatteredOnly for Tally.CylindricalImageFlux.

  • scattered_value (int) – ScatteredValue for Tally.CylindricalImageFlux.

  • field_of_view (float) – FieldOfView for Tally.CylindricalImageFlux.

  • centered (mcnpy.Boolean) – Centered for Tally.CylindricalImageFlux.

  • centered_value (int) – CenteredValue for Tally.CylindricalImageFlux.

increment = 10
next_id = 5
class EnergyDeposition(*args, **kwargs)[source]

Bases: FTallyABC, TallyEnergyDeposition

A representation of the model object Tally.EnergyDeposition.

Parameters

  • unit (mcnpy.FluxUnit) – Unit for Tally.EnergyDeposition.

  • name (int) – Name for Tally.EnergyDeposition.

  • particles (iterable of mcnpy.Particle) – Particles for Tally.EnergyDeposition.

  • bins (mcnpy.Tally.Bin.CellBins) – Bins for Tally.EnergyDeposition.

  • total (str) – Total for Tally.EnergyDeposition.

increment = 10
next_id = 6
class FMESH(*args, **kwargs)[source]

Bases: TallyABC, TallyMesh

A representation of the model object Tally.FMESH.

Parameters

  • name (int) – Name for Tally.FMESH.

  • geometry (mcnpy.Tally.FMESHGeometry) – Geometry for Tally.FMESH.

  • origin (mcnpy.Point) – Origin for Tally.FMESH.

  • axis (mcnpy.Point) – Axis for Tally.FMESH.

  • vector (mcnpy.Point) – Vector for Tally.FMESH.

  • i_nodes (iterable of float) – INodes for Tally.FMESH.

  • i_subdivisions (iterable of int) – ISubdivisions for Tally.FMESH.

  • j_nodes (iterable of float) – JNodes for Tally.FMESH.

  • j_subdivisions (iterable of int) – JSubdivisions for Tally.FMESH.

  • k_nodes (iterable of float) – KNodes for Tally.FMESH.

  • k_subdivisions (iterable of int) – KSubdivisions for Tally.FMESH.

  • energy_nodes (iterable of float) – EnergyNodes for Tally.FMESH.

  • energy_subdivisions (iterable of int) – EnergySubdivisions for Tally.FMESH.

  • energy_normalization (mcnpy.YesNo) – EnergyNormalization for Tally.FMESH.

  • time_node (iterable of float) – TimeNode for Tally.FMESH.

  • time_subdivisions (iterable of int) – TimeSubdivisions for Tally.FMESH.

  • time_normalization (mcnpy.YesNo) – TimeNormalization for Tally.FMESH.

  • factor (float) – Factor for Tally.FMESH.

  • format (mcnpy.Tally.FMESHFormat) – Format for Tally.FMESH.

  • transformation (mcnpy.Transformation) – Transformation for Tally.FMESH.

  • collision_l (float) – CollisionL for Tally.FMESH.

  • collision_u (float) – CollisionU for Tally.FMESH.

  • type_quantity (mcnpy.TallyQuantityType) – TypeQuantity for Tally.FMESH.

  • kcode_cycles (float) – KcodeCycles for Tally.FMESH.

  • particles (iterable of mcnpy.Particle) – Particles for Tally.FMESH.

increment = 10
next_id = 4
class FissionHeating(*args, **kwargs)[source]

Bases: FTallyABC, TallyFissionHeating

A representation of the model object Tally.FissionHeating.

Parameters

  • unit (mcnpy.DepositionUnit) – Unit for Tally.FissionHeating.

  • name (int) – Name for Tally.FissionHeating.

  • particles (iterable of mcnpy.Particle) – Particles for Tally.FissionHeating.

  • bins (mcnpy.Tally.Bin.CellBins) – Bins for Tally.FissionHeating.

  • total (str) – Total for Tally.FissionHeating.

increment = 10
next_id = 7
class PinholeImageFlux(*args, **kwargs)[source]

Bases: RadTallyABC, TallyPinholeImageFlux

A representation of the model object Tally.PinholeImageFlux.

Parameters

  • collimator_radius (float) – CollimatorRadius for Tally.PinholeImageFlux.

  • pinhole_radius (float) – PinholeRadius for Tally.PinholeImageFlux.

  • distance (float) – Distance for Tally.PinholeImageFlux.

increment = 10
next_id = 5
class PlanarImageFlux(*args, **kwargs)[source]

Bases: RadTallyABC, TallyPlanarImageFlux

A representation of the model object Tally.PlanarImageFlux.

Parameters

  • scattered_only (mcnpy.Boolean) – ScatteredOnly for Tally.PlanarImageFlux.

  • scattered_value (int) – ScatteredValue for Tally.PlanarImageFlux.

  • field_of_view (float) – FieldOfView for Tally.PlanarImageFlux.

  • centered (mcnpy.Boolean) – Centered for Tally.PlanarImageFlux.

  • centered_value (int) – CenteredValue for Tally.PlanarImageFlux.

increment = 10
next_id = 5
class PointFlux(*args, **kwargs)[source]

Bases: DetTallyABC, TallyPointFlux

A representation of the model object Tally.PointFlux.

Parameters

  • detectors (iterable of mcnpy.Tally.PointFluxDetector) – Detectors for Tally.PointFlux.

  • no_direct (str) – NoDirect for Tally.PointFlux.

class Detector(*args, **kwargs)[source]

Bases: TallyPointFluxDetector

A representation of the model object Tally.PointFlux.Detector.

Parameters

  • x0 (float) – X0 for Tally.PointFlux.Detector.

  • y0 (float) – Y0 for Tally.PointFlux.Detector.

  • z0 (float) – Z0 for Tally.PointFlux.Detector.

  • mean_free_paths (mcnpy.Boolean) – MeanFreePaths for Tally.PointFlux.Detector.

  • exclusion (float) – Exclusion for Tally.PointFlux.Detector.

increment = 10
next_id = 5
class PulseHeight(*args, **kwargs)[source]

Bases: FTallyABC, TallyPulseHeight

A representation of the model object Tally.PulseHeight.

Parameters

  • unit (mcnpy.PulseUnit) – Unit for Tally.PulseHeight.

  • name (int) – Name for Tally.PulseHeight.

  • particles (iterable of mcnpy.Particle) – Particles for Tally.PulseHeight.

  • bins (mcnpy.Tally.Bin.CellBins) – Bins for Tally.PulseHeight.

  • total (str) – Total for Tally.PulseHeight.

increment = 10
next_id = 8
class RingFlux(*args, **kwargs)[source]

Bases: DetTallyABC, TallyRingFlux

A representation of the model object Tally.RingFlux.

Parameters

  • axis (mcnpy.Axis) – Axis for Tally.RingFlux.

  • detectors (iterable of mcnpy.Tally.RingFluxDetector) – Detectors for Tally.RingFlux.

  • no_direct (str) – NoDirect for Tally.RingFlux.

  • faxis (mcnpy.fAxis) – Faxis for Tally.RingFlux.

class Detector(*args, **kwargs)[source]

Bases: TallyRingFluxDetector

A representation of the model object Tally.RingFlux.Detector.

Parameters

  • distance (float) – Distance for Tally.RingFlux.Detector.

  • radius (float) – Radius for Tally.RingFlux.Detector.

  • mean_free_paths (mcnpy.Boolean) – MeanFreePaths for Tally.RingFlux.Detector.

  • exclusion (float) – Exclusion for Tally.RingFlux.Detector.

increment = 10
next_id = 5
class Setting[source]

Bases: ABC

class Comment(*args, **kwargs)[source]

Bases: TallyRef, TallySettingABC, TallyComment

A representation of the model object Tally.Setting.Comment.

Parameters

  • tally (mcnpy.Tally) – Tally for Tally.Setting.Comment.

  • comment (iterable of str) – Comment for Tally.Setting.Comment.

class CriticalitySensitivity(*args, **kwargs)[source]

Bases: IDManagerMixin, TallySettingABC, CriticalitySensitivity

A representation of the model object Tally.Setting.CriticalitySensitivity.

Parameters

  • name (int) – Name for Tally.Setting.CriticalitySensitivity.

  • type (mcnpy.Tally.Setting.CriticalitySensitivityType) – Type for Tally.Setting.CriticalitySensitivity.

  • nuclides (iterable of str) – Nuclides for Tally.Setting.CriticalitySensitivity.

  • sabnuclides (iterable of mcnpy.SabNuclide) – Sabnuclides for Tally.Setting.CriticalitySensitivity.

  • sign (iterable of str) – Sign for Tally.Setting.CriticalitySensitivity.

  • reactions (iterable of int) – Reactions for Tally.Setting.CriticalitySensitivity.

  • energy_bins (iterable of float) – EnergyBins for Tally.Setting.CriticalitySensitivity.

  • incoming_energy_bins (iterable of float) – IncomingEnergyBins for Tally.Setting.CriticalitySensitivity.

  • moment (iterable of int) – Moment for Tally.Setting.CriticalitySensitivity.

  • angles (iterable of float) – Angles for Tally.Setting.CriticalitySensitivity.

  • normalize (mcnpy.YesNo) – Normalize for Tally.Setting.CriticalitySensitivity.

next_id = 1
used_ids = {}
class LatticeSpeedTallyEnhancement(*args, **kwargs)[source]

Bases: NoIDMixin, TallySettingABC, LatticeSpeedTallyEnhancement

A representation of the model object Tally.Setting.LatticeSpeedTallyEnhancement.

Parameters

enabled (mcnpy.ForceOff) – Enabled for Tally.Setting.LatticeSpeedTallyEnhancement.

class NoTransport(*args, **kwargs)[source]

Bases: NoIDMixin, TallySettingABC, NoTransport

NOTRN

class Perturbation(*args, **kwargs)[source]

Bases: IDManagerMixin, TallySettingABC, Perturbation

A representation of the model object Tally.Setting.Perturbation.

Parameters

  • name (int) – Name for Tally.Setting.Perturbation.

  • cells (iterable of mcnpy.Cell) – Cells for Tally.Setting.Perturbation.

  • material (mcnpy.Material) – Material for Tally.Setting.Perturbation.

  • density (float) – Density for Tally.Setting.Perturbation.

  • method (int) – Method for Tally.Setting.Perturbation.

  • min_energy (float) – MinEnergy for Tally.Setting.Perturbation.

  • max_energy (float) – MaxEnergy for Tally.Setting.Perturbation.

  • sign (iterable of str) – Sign for Tally.Setting.Perturbation.

  • reactions (iterable of int) – Reactions for Tally.Setting.Perturbation.

  • particles (iterable of mcnpy.Particle) – Particles for Tally.Setting.Perturbation.

next_id = 1
used_ids = {}
class Print(*args, **kwargs)[source]

Bases: TallyRef, TallySettingABC, TallyPrint

A representation of the model object Tally.Setting.Print.

Parameters
class ReactivityPerturbation(*args, **kwargs)[source]

Bases: IDManagerMixin, TallySettingABC, ReactivityPerturbation

A representation of the model object Tally.Setting.ReactivityPerturbation.

Parameters

  • name (int) – Name for Tally.Setting.ReactivityPerturbation.

  • cells (iterable of mcnpy.Cell) – Cells for Tally.Setting.ReactivityPerturbation.

  • materials (iterable of mcnpy.Material) – Materials for Tally.Setting.ReactivityPerturbation.

  • densities (iterable of float) – Densities for Tally.Setting.ReactivityPerturbation.

  • nuclides (iterable of str) – Nuclides for Tally.Setting.ReactivityPerturbation.

  • sign (iterable of str) – Sign for Tally.Setting.ReactivityPerturbation.

  • reactions (iterable of int) – Reactions for Tally.Setting.ReactivityPerturbation.

  • energy_bins (iterable of float) – EnergyBins for Tally.Setting.ReactivityPerturbation.

  • linear (mcnpy.YesNo) – Linear for Tally.Setting.ReactivityPerturbation.

next_id = 1
used_ids = {}
class SuperimposedTallyMesh(*args, **kwargs)[source]

Bases: SuperimposedTallyMesh

A representation of the model object Tally.SuperimposedTallyMesh.

Parameters

meshes (iterable of mcnpy.Tally.TMESH) – Meshes for Tally.SuperimposedTallyMesh.

class SurfaceCurrent(*args, **kwargs)[source]

Bases: FTallyABC, TallySurfaceCurrent

A representation of the model object Tally.SurfaceCurrent.

Parameters

  • unit (mcnpy.CurrentUnit) – Unit for Tally.SurfaceCurrent.

  • name (int) – Name for Tally.SurfaceCurrent.

  • particles (iterable of mcnpy.Particle) – Particles for Tally.SurfaceCurrent.

  • bins (mcnpy.Tally.Bin.SurfaceBins) – Bins for Tally.SurfaceCurrent.

  • total (str) – Total for Tally.SurfaceCurrent.

increment = 10
next_id = 1
class SurfaceFlux(*args, **kwargs)[source]

Bases: FTallyABC, TallySurfaceFlux

A representation of the model object Tally.SurfaceFlux.

Parameters

  • unit (mcnpy.FluxUnit) – Unit for Tally.SurfaceFlux.

  • name (int) – Name for Tally.SurfaceFlux.

  • particles (iterable of mcnpy.Particle) – Particles for Tally.SurfaceFlux.

  • bins (mcnpy.Tally.Bin.SurfaceBins) – Bins for Tally.SurfaceFlux.

  • total (str) – Total for Tally.SurfaceFlux.

increment = 10
next_id = 2
class TMESH(*args, **kwargs)[source]

Bases: TMESH

A representation of the model object Tally.TMESH.

Parameters

  • mesh (mcnpy.Tally.TMESHType) – Mesh for Tally.TMESH.

  • mesh_data (mcnpy.Tally.TMESH.Data) – MeshData for Tally.TMESH.

class CORA(*args, **kwargs)[source]

Bases: CORA

A representation of the model object Tally.TMESH.CORA.

Parameters

  • i_d (mcnpy.Tally.TMESHType) – ID for Tally.TMESH.CORA.

  • coord (iterable of float) – Coord for Tally.TMESH.CORA.

property tmesh
class CORB(*args, **kwargs)[source]

Bases: CORB

A representation of the model object Tally.TMESH.CORB.

Parameters

  • i_d (mcnpy.Tally.TMESHType) – ID for Tally.TMESH.CORB.

  • coord (iterable of float) – Coord for Tally.TMESH.CORB.

property tmesh
class CORC(*args, **kwargs)[source]

Bases: CORC

A representation of the model object Tally.TMESH.CORC.

Parameters

  • i_d (mcnpy.Tally.TMESHType) – ID for Tally.TMESH.CORC.

  • coord (iterable of float) – Coord for Tally.TMESH.CORC.

property tmesh
class DXTRAN(*args, **kwargs)[source]

Bases: TMeshABC, TypeFour, Type

A representation of the model object Tally.TMESH.DXTRAN.

Parameters
increment = 10
next_id = 4
class Data(*args, **kwargs)[source]

Bases: MeshData

A representation of the model object Tally.TMESH.Data.

Parameters

  • options (iterable of mcnpy.Tally.TMESH.Options) – Options for Tally.TMESH.Data.

  • coord (iterable of Object) – Coord for Tally.TMESH.Data.

class EnergyDeposition(*args, **kwargs)[source]

Bases: TypeThree, Type

A representation of the model object Tally.TMESH.EnergyDeposition.

Parameters

  • keywords (iterable of mcnpy.Tmesh3) – Keywords for Tally.TMESH.EnergyDeposition.

  • m_val (iterable of float) – MVal for Tally.TMESH.EnergyDeposition.

  • transformation (mcnpy.Transformation) – Transformation for Tally.TMESH.EnergyDeposition.

increment = 10
next_id = 3
used_ids = {}
class Options(*args, **kwargs)[source]

Bases: MeshOptions

A representation of the model object Tally.TMESH.Options.

Parameters

tally (mcnpy.Tally.TMESHType) – Tally for Tally.TMESH.Options.

class EnergyLimits(*args, **kwargs)[source]

Bases: EnergyLimits

A representation of the model object Tally.TMESH.Options.EnergyLimits.

Parameters

  • lower_limit (float) – LowerLimit for Tally.TMESH.Options.EnergyLimits.

  • upper_limit (float) – UpperLimit for Tally.TMESH.Options.EnergyLimits.

class MF(*args, **kwargs)[source]

Bases: MeshMF

A representation of the model object Tally.TMESH.Options.MF.

Parameters

m_fpairs (iterable of mcnpy.Tally.TMESH.Options.MF.EnergyPairs) – MFpairs for Tally.TMESH.Options.MF.

class EnergyPairs(*args, **kwargs)[source]

Bases: energyPairs

A representation of the model object Tally.TMESH.Options.MF.EnergyPairs.

Parameters

  • energy1 (float) – Energy1 for Tally.TMESH.Options.MF.EnergyPairs.

  • energy2 (float) – Energy2 for Tally.TMESH.Options.MF.EnergyPairs.

class Multiplier(*args, **kwargs)[source]

Bases: MeshMultiplier

A representation of the model object Tally.TMESH.Options.Multiplier.

Parameters

  • sign (mcnpy.Boolean) – Sign for Tally.TMESH.Options.Multiplier.

  • bins (Object) – Bins for Tally.TMESH.Options.Multiplier.

  • total (mcnpy.Boolean) – Total for Tally.TMESH.Options.Multiplier.

  • cumulative (mcnpy.Boolean) – Cumulative for Tally.TMESH.Options.Multiplier.

class Source(*args, **kwargs)[source]

Bases: TMeshABC, TypeTwo, Type

A representation of the model object Tally.TMESH.Source.

Parameters
increment = 10
next_id = 2
class TrackAveraged(*args, **kwargs)[source]

Bases: TMeshABC, TypeOne, Type

A representation of the model object Tally.TMESH.TrackAveraged.

Parameters

  • keywords (iterable of mcnpy.Tmesh1) – Keywords for Tally.TMESH.TrackAveraged.

  • dose_params (mcnpy.Tally.TMESH.TrackAveraged.dParams) – DoseParams for Tally.TMESH.TrackAveraged.

  • mfactinfo (iterable of float) – Mfactinfo for Tally.TMESH.TrackAveraged.

  • transfomation (mcnpy.Transformation) – Transfomation for Tally.TMESH.TrackAveraged.

  • particles (iterable of mcnpy.Particle) – Particles for Tally.TMESH.TrackAveraged.

class dParams(*args, **kwargs)[source]

Bases: dParams

A representation of the model object Tally.TMESH.TrackAveraged.dParams.

Parameters

  • conv_coeff (int) – ConvCoeff for Tally.TMESH.TrackAveraged.dParams.

  • interpolation_method (int) – InterpolationMethod for Tally.TMESH.TrackAveraged.dParams.

  • res_units (int) – ResUnits for Tally.TMESH.TrackAveraged.dParams.

  • norm_factor (float) – NormFactor for Tally.TMESH.TrackAveraged.dParams.

increment = 10
next_id = 1
class Type(*args, **kwargs)[source]

Bases: TMESHType

A representation of the model object Tally.TMESH.Type.

Parameters

  • mesh (mcnpy.MeshType) – Mesh for Tally.TMESH.Type.

  • name (int) – Name for Tally.TMESH.Type.

property mesh