Enumerated Types (Enums)

While not strictly required to use other MCNPy classes, Enums provide convenient ways to input many of MCNP’s symbols and keyword arguments. For example, one can use mcnpy.Particle.POSITIVE_MUON or '!' when choosing a particle type.

class mcnpy.BoundaryType(value)

Bases: Enum

An enumeration.

REFLECTIVE = '*'

VACUUM = None

WHITE = '+'

class mcnpy.LibraryQuantity(value)

Bases: Enum

An enumeration.

ALPHA = 'A'

DEUTERON = 'O'

DOSIMETRY = 'Y'

ELECTRON = 'E'

HELION = 'S'

NEUTRON_CONTINUOUS = 'C'

NEUTRON_DISCRETE = 'D'

NEUTRON_N_CONTINUOUS = 'NC'

NEUTRON_PHOTON_MULTIGROUP = 'M'

PHOTOATOMIC = 'P'

PHOTONUCLEAR = 'U'

PROTON = 'H'

TRITON = 'R'

class mcnpy.PartisnSolverAcceleration(value)

Bases: Enum

An enumeration.

DSA = 'DSA'

NO = 'NO'

TSA = 'TSA'

class mcnpy.EmbeddedGeometryMeshFormat(value)

Bases: Enum

An enumeration.

ABAQUS = 'ABAQUS'

LNK3DNT = 'LNK3DNT'

MCNPUM = 'MCNPUM'

class mcnpy.EmbeddedGeometryDebug(value)

Bases: Enum

An enumeration.

ECHOMESH = 'ECHOMESH'

class mcnpy.EmbeddedGeometryFiletype(value)

Bases: Enum

An enumeration.

ASCII = 'ASCII'

BINARY = 'BINARY'

class mcnpy.EmbeddedGeometryOverlap(value)

Bases: Enum

An enumeration.

AVERAGE = 'AVERAGE'

ENTRY = 'ENTRY'

EXIT = 'EXIT'

class mcnpy.MTypeOptions(value)

Bases: Enum

An enumeration.

FLUX = 'FLUX'

ISOTOPIC = 'ISOTROPIC'

POP = 'POP'

POPULATION = 'POPULATION'

REACTION = 'REACTION'

SOURCE = 'SOURCE'

TRACKS = 'TRACKS'

class mcnpy.SabNuclide(value)

Bases: Enum

An enumeration.

Al27 = 'AL27'

BENZENE = 'BENZ'

BeO = 'BEO'

Be_IN_BeO = 'BE-O'

Be_METAL = 'BE'

DEUTERIUM_IN_HEAVY_WATER = 'HWTR'

Fe56 = 'FE56'

GRAPHITE = 'GRPH'

H_IN_LIGHT_WATER = 'LWTR'

H_IN_LIQUID_METHANE = 'LMETH'

H_IN_POLYETHELENE = 'POLY'

H_IN_SOLID_METHANE = 'SMETH'

H_IN_ZrH = 'H-ZR'

ORTHO_DEUTERIUM = 'DORTHO'

ORTHO_H = 'HORTHO'

O_IN_BeO = 'O-BE'

O_IN_UO2 = 'O2-U'

PARA_DEUTERIUM = 'DPARA'

PARA_H = 'HPARA'

Si_AND_O_IN_SiO2 = 'SIO2'

U238_IN_UO2 = 'U-O2'

Zr_IN_ZrH = 'ZR-H'

class mcnpy.MultigroupTransportMode(value)

Bases: Enum

An enumeration.

ADJOINT = 'A'

FORWARD = 'F'

class mcnpy.DelayedParticles(value)

Bases: Enum

An enumeration.

ALL = 'ALL'

ALPHA = 'A'

BETA = 'E'

GAMMA = 'P'

NEUTRON = 'N'

NONE = 'NONE'

POSITRON = 'F'

class mcnpy.ActivationDelayedNeutronData(value)

Bases: Enum

An enumeration.

BOTH = 'BOTH'

LIBRARY = 'LIBRARY'

MODEL = 'MODEL'

PROMPT = 'PROMPT'

class mcnpy.ActivationDelayedGammaData(value)

Bases: Enum

An enumeration.

LINES = 'LINES'

MG = 'MG'

NONE = 'NONE'

class mcnpy.CorrUncorr(value)

Bases: Enum

An enumeration.

CORRELATE = 'CORRELATE'

NONFISS_COR = 'NONFISS_COR'

class mcnpy.TransportMultipleCoulombScattering(value)

Bases: Enum

An enumeration.

FNAL1 = 'FNAL1'

FNAL2 = 'FNAL2'

GAUSSIAN = 'GAUSSIAN'

OFF = 'OFF'

class mcnpy.TransportNuclearReactions(value)

Bases: Enum

An enumeration.

ATTENUATE = 'ATTEN'

OFF = 'OFF'

ON = 'ON'

REMOVE = 'REMOVE'

class mcnpy.TransportNuclearElasticScattering(value)

Bases: Enum

An enumeration.

OFF = 'OFF'

ON = 'ON'

class mcnpy.MagneticFieldType(value)

Bases: Enum

An enumeration.

DIPOLE = 'CONST'

QUADRUPOLE = 'QUAD'

QUADRUPOLE_FRINGE_FIELD = 'QUADFF'

class mcnpy.DependentDistribution(value)

Bases: Enum

An enumeration.

AREA = 'FARA'

AXIS = 'FAXS'

CELL = 'FCEL'

COOKIE = 'FCCC'

COSINE = 'FDIR'

EFFICIENCY = 'FEFF'

ENERGY = 'FERG'

EXTENT = 'FEXT'

NORMAL = 'FNRM'

PARTICLE = 'FPAR'

POSITION = 'FPOS'

RADIAL = 'FRAD'

SURFACE = 'FSUR'

TIME = 'FTME'

TRANSPORT = 'FTR'

VECTOR = 'FVEC'

WEIGHT = 'FWGT'

X = 'FX'

Y = 'FY'

Z = 'FZ'

class mcnpy.DependentDistributionPos(value)

Bases: Enum

An enumeration.

AREA = 'FARA'

AXIS = 'FAXS'

CELL = 'FCEL'

COOKIE = 'FCCC'

COSINE = 'FDIR'

EFFICIENCY = 'FEFF'

ENERGY = 'FERG'

EXTENT = 'FEXT'

NORMAL = 'FNRM'

PARTICLE = 'FPAR'

POSITION = 'FPOS'

RADIAL = 'FRAD'

SURFACE = 'FSUR'

TIME = 'FTME'

TRANSPORT = 'FTR'

VECTOR = 'FVEC'

WEIGHT = 'FWGT'

X = 'FX'

Y = 'FY'

Z = 'FZ'

class mcnpy.SourceInfoOption(value)

Bases: Enum

An enumeration.

DISCRETE = 'L'

HISTOGRAM = 'H'

PROBABILITIES = 'A'

class mcnpy.SourceProbabilityOption(value)

Bases: Enum

An enumeration.

CELL_PROBABILITIES = 'V'

CUMULATIVE_PROBABILITIES = 'C'

PARTICLE_WEIGHTS = 'W'

PROBABILITIES = 'D'

class mcnpy.SrcKeyword(value)

Bases: Enum

An enumeration.

BIAS = 'SB'

INFO = 'SI'

PROBABILITY = 'SP'

class mcnpy.VerticalSrcOptions(value)

Bases: Enum

An enumeration.

CELL_PROBABILITIES = 'V'

CUMULATIVE_PROBABILITIES = 'C'

DISCRET = 'L'

HISTOGRAM = 'H'

PARTICLE_WEIGHTS = 'W'

PROBABILITIES = 'A'

class mcnpy.DependentSourceDistributionOption(value)

Bases: Enum

An enumeration.

DISCRETE = 'L'

HISTOGRAM = 'H'

class mcnpy.CriticalityOptionsSensitivityProfile(value)

Bases: Enum

An enumeration.

MCTAL = 'MCTAL'

class mcnpy.FAxis(value)

Bases: Enum

An enumeration.

X = 'FX'

Y = 'FY'

Z = 'FZ'

class mcnpy.TallyQuantity(value)

Bases: Enum

An enumeration.

ANGLE = 'C'

DIRECT = 'D'

ENERGY = 'E'

GEOMETRY = 'F'

MULTIPLER = 'M'

SEGMENT = 'S'

TIME = 'T'

USER = 'U'

class mcnpy.Interpolation(value)

Bases: Enum

An enumeration.

LINEAR = 'LIN'

LOG = 'LOG'

class mcnpy.TTreatment(value)

Bases: Enum

An enumeration.

COINCIDENCE_CAPTURE = 'CAP'

COMPTON_IMAGE_TALLY = 'COM'

DET_SCORE_CELL = 'ICD'

ELECTRON_CURRENT_TALLY = 'ELC'

FIRST_FISSION_TALLY = 'FFT'

FIXED_REF = 'FRV'

GAUSSIAN_BROADENING = 'GEB'

HI_RESIDUAL_ISOTOPES = 'RES'

LET = 'LET'

MULTIGROUP_USER_BINS = 'PTT'

NUM_COLLISIONS = 'INC'

POINT_DET_SAMPLING = 'PDS'

PULSE_HEIGHT_TALLY = 'PHL'

RECEIVER_OP_CHAR = 'ROC'

SAMPLE_INDEX_SRC_DIST = 'SCX'

SPECIFIED_SRC_DIST = 'SCD'

TALLY_TAGGING = 'TAG'

TIME_CONVOLUTION = 'TMC'

class mcnpy.CriticalitySensitivityType(value)

Bases: Enum

An enumeration.

XS = 'XS'

class mcnpy.Tmesh1(value)

Bases: Enum

An enumeration.

DEPOSITION = 'PEDEP'

FLUX = 'FLUX'

POPULATION = 'POPUL'

TRACKS = 'TRAKS'

class mcnpy.Tmesh3(value)

Bases: Enum

An enumeration.

IONIZATION = 'DE'

NON_TRACKED = 'EDLCT'

RECOIL = 'RECOIL'

TOTAL = 'TOTAL'

TRACKLENGTH = 'TLEST'

class mcnpy.MeshType(value)

Bases: Enum

An enumeration.

CYLINDRICAL = 'CMESH'

RECTANGULAR = 'RMESH'

SPHERICAL = 'SMESH'

class mcnpy.TallyMeshGeometry(value)

Bases: Enum

An enumeration.

CARTESIAN = 'XYZ'

CYLINDRICAL = 'RZT'

class mcnpy.TallyMeshFormat(value)

Bases: Enum

An enumeration.

COLUMNS = 'COL'

COLUMNS_WITH_VOLUMES = 'COLUMNS_WITH_VOLUMES'

IJ = 'IJ'

IK = 'IK'

JK = 'JK'

NONE = 'NONE'

class mcnpy.TallyQuantityType(value)

Bases: Enum

An enumeration.

FLUX = 'FLUX'

SOURCE = 'SOURCE'

class mcnpy.ForceOff(value)

Bases: Enum

An enumeration.

FORCE = 'FORCE'

OFF = 'OFF'

class mcnpy.ParticleTrackFormat(value)

Bases: Enum

An enumeration.

ASCII = 'ASC'

ASCII_OVERWRITE = 'AOV'

BINARY = 'BIN'

BINARY_OVERWRITE = 'BOV'

class mcnpy.ParticleTrackWrite(value)

Bases: Enum

An enumeration.

ALL = 'ALL'

POSITIONS = 'POS'

class mcnpy.ParticleTrackEvent(value)

Bases: Enum

An enumeration.

BANK = 'BNK'

CAPTURE = 'CAP'

COLLISION = 'COL'

SOURCE = 'SRC'

SURFACE = 'SUR'

TERMINATION = 'TER'

class mcnpy.ParticleTrackFilterQuantity(value)

Bases: Enum

An enumeration.

CELL = 'ICL'

DETERMINISTIC_TRANSPORT_SPHERE = 'IDX'

ENERGY = 'ERG'

GEOMETRY_LEVEL = 'LEV'

IMPORTANCE_ELECTRON = 'IMP3'

IMPORTANCE_NEUTRON = 'IMP1'

IMPORTANCE_PHOTON = 'IMP2'

LATTICE_I = 'III'

LATTICE_J = 'JJJ'

LATTICE_K = 'KKK'

NUM_COLLISIONS = 'NCP'

SPARE1 = 'SPARE1'

SPARE2 = 'SPARE2'

SPARE3 = 'SPARE3'

SPEED = 'VEL'

SURFACE = 'JSU'

TIME = 'TME'

U = 'U'

V = 'V'

W = 'W'

WEIGHT = 'WGT'

X = 'X'

Y = 'Y'

Z = 'Z'

class mcnpy.ParameterCommand(value)

Bases: Enum

An enumeration.

ALL = 'ALL'

COPLOT = 'COPLOT'

class mcnpy.FixedVariable(value)

Bases: Enum

An enumeration.

CELL_SURF_DET = 'F'

COSINE = 'C'

ENERGY = 'E'

FIRST_LAT_INDEX = 'I'

MULT = 'M'

SECOND_LAT_INDEX = 'J'

SEGMENT = 'S'

THIRD_LAT_INDEX = 'K'

TIME = 'T'

TOT_VS_DIRECT = 'D'

USER_DEF = 'U'

class mcnpy.TallyFluctuationList(value)

Bases: Enum

An enumeration.

CUMULATIVE_TALLY = 'T'

FOM = 'F'

LARGEST_TALLIES = 'L'

MEAN = 'M'

NUM_FRACTION = 'N'

PROBABILITY = 'P'

REL_ERROR = 'E'

SLOPE = 'S'

VOV_FUNCTION = 'V'

class mcnpy.LogLin(value)

Bases: Enum

An enumeration.

LINEAR = 'LIN'

LOG = 'LOG'

class mcnpy.FileAccess(value)

Bases: Enum

An enumeration.

DIRECT = 'DIRECT'

DIRECT_SHORT = 'D'

SEQUENTIAL = 'SEQUENTIAL'

SEQUENTIAL_SHORT = 'S'

class mcnpy.FileFormat(value)

Bases: Enum

An enumeration.

FORMATTED = 'FORMATTED'

FORMATTED_SHORT = 'F'

UNFORMATTED = 'UNFORMATTED'

UNFORMATTED_SHORT = 'U'

class mcnpy.DensityUnit(value)

Bases: Enum

An enumeration.

A_BCM = '+'

G_CM3 = '-'

class mcnpy.FractionUnit(value)

Bases: Enum

An enumeration.

ATOM = '+'

WEIGHT = '-'

class mcnpy.AngleUnit(value)

Bases: Enum

An enumeration.

COSINES = None

DEGREES = '*'

class mcnpy.CurrentUnit(value)

Bases: Enum

An enumeration.

MEV = '*'

PARTICLES = None

class mcnpy.FluxUnit(value)

Bases: Enum

An enumeration.

MEV_CM2 = '*'

PARTICLES_CM2 = None

class mcnpy.DepositionUnit(value)

Bases: Enum

An enumeration.

JERKS_G = '*'

MEV_G = None

class mcnpy.PulseUnit(value)

Bases: Enum

An enumeration.

MEV = '*'

PULSES = None

class mcnpy.Axis(value)

Bases: Enum

An enumeration.

X = 'X'

Y = 'Y'

Z = 'Z'

class mcnpy.YesNo(value)

Bases: Enum

An enumeration.

NO = 'NO'

YES = 'YES'

class mcnpy.PositiveNegative(value)

Bases: Enum

An enumeration.

NEGATIVE = '-'

POSITIVE = '+'

class mcnpy.Particle(value)

Bases: Enum

An enumeration.

ALPHA = 'A'

ANTI_ELECTRON_NEUTRINO = '<'

ANTI_LAMBDA_BARYON = 'B'

ANTI_MUON_NEUTRINO = '>'

ANTI_NEGATIVE_SIGMA_BARYON = '~'

ANTI_NEUTRAL_XI_BARYON = 'C'

ANTI_NEUTRON = 'Q'

ANTI_OMEGA_BARYON = '@'

ANTI_POSITIVE_SIGMA_BARYON = '_'

ANTI_PROTON = 'G'

BACKGROUND = 'BG'

BACKGROUND_NEUTRONS = 'BN'

BACKGROUND_PHOTONS = 'BP'

COSMIC = 'CR'

COSMIC_ALPHAS = 'C2004'

COSMIC_IRON = 'C26056'

COSMIC_NITROGEN = 'C7014'

COSMIC_PROTONS = 'C1001'

COSMIC_SILICON = 'C14028'

DEUTERON = 'D'

ELECTRON = 'E'

ELECTRON_NEUTRINO = 'U'

HEAVY_IONS = '#'

HELION = 'S'

KAON_LONG = '^'

KAON_SHORT = '%'

LAMBDA_BARYON = 'L'

MUON_NEUTRINO = 'V'

NEGATIVE_KAON = '?'

NEGATIVE_MUON = '|'

NEGATIVE_PION = '*'

NEGATIVE_SIGMA_BARYON = '-'

NEGATIVE_XI_BARYON = 'Y'

NEUTRAL_PION = 'Z'

NEUTRON = 'N'

OMEGA_BARYON = 'O'

PHOTON = 'P'

POSITIVE_KAON = 'K'

POSITIVE_MUON = '!'

POSITIVE_PION = '/'

POSITIVE_SIGMA_BARYON = '+'

POSITIVE_XI_BARYON = 'W'

POSITRON = 'F'

PROTON = 'H'

SPONTAENOUS_PHOTON = 'SP'

SPONTANEOUS_FISSION = 'SF'

TRITION = 'T'

XI_BARYON = 'X'

class mcnpy.SourceParticleCategory(value)

Bases: Enum

An enumeration.

ALPHA = 'A'

ANTI_ELECTRON_NEUTRINO = '<'

ANTI_LAMBDA_BARYON = 'B'

ANTI_MUON_NEUTRINO = '>'

ANTI_NEGATIVE_SIGMA_BARYON = '~'

ANTI_NEUTRAL_XI_BARYON = 'C'

ANTI_NEUTRON = 'Q'

ANTI_OMEGA_BARYON = '@'

ANTI_POSITIVE_SIGMA_BARYON = '_'

ANTI_PROTON = 'G'

BACKGROUND = 'BG'

BACKGROUND_NEUTRONS = 'BN'

BACKGROUND_PHOTONS = 'BP'

COSMIC = 'CR'

COSMIC_ALPHAS = 'C2004'

COSMIC_IRON = 'C26056'

COSMIC_NITROGEN = 'C7014'

COSMIC_PROTONS = 'C1001'

COSMIC_SILICON = 'C14028'

DEUTERON = 'D'

ELECTRON = 'E'

ELECTRON_NEUTRINO = 'U'

HEAVY_IONS = '#'

HELION = 'S'

KAON_LONG = '^'

KAON_SHORT = '%'

LAMBDA_BARYON = 'L'

MUON_NEUTRINO = 'V'

NEGATIVE_KAON = '?'

NEGATIVE_MUON = '|'

NEGATIVE_PION = '*'

NEGATIVE_SIGMA_BARYON = '-'

NEGATIVE_XI_BARYON = 'Y'

NEUTRAL_PION = 'Z'

NEUTRON = 'N'

OMEGA_BARYON = 'O'

PHOTON = 'P'

POSITIVE_KAON = 'K'

POSITIVE_MUON = '!'

POSITIVE_PION = '/'

POSITIVE_SIGMA_BARYON = '+'

POSITIVE_XI_BARYON = 'W'

POSITRON = 'F'

PROTON = 'H'

SPONTAENOUS_PHOTON = 'SP'

SPONTANEOUS_FISSION = 'SF'

TRITION = 'T'

XI_BARYON = 'X'

class mcnpy.Boolean(value)

Bases: Enum

An enumeration.

FALSE = 0

ONE = 1

TRUE = 1

ZERO = 0