Source

class mcnpy.CriticalitySource(*args, **kwargs)[source]

Bases: CriticalitySource, SourceSetting

A representation of the model object CriticalitySource.

Parameters

histories (float) – Histories for CriticalitySource.
j_histories (str) – J_histories for CriticalitySource.
keff_guess (float) – KeffGuess for CriticalitySource.
j_keff_guess (str) – J_keffGuess for CriticalitySource.
skip_cycles (float) – SkipCycles for CriticalitySource.
j_skip_cycles (str) – J_skipCycles for CriticalitySource.
cycles (float) – Cycles for CriticalitySource.
j_cycles (str) – J_cycles for CriticalitySource.
source_point_count (int) – SourcePointCount for CriticalitySource.
j_source_point_count (str) – J_sourcePointCount for CriticalitySource.
normalize_tallies (str) – NormalizeTallies for CriticalitySource.
j_normalize_tallies (str) – J_normalizeTallies for CriticalitySource.
max_cycles (int) – MaxCycles for CriticalitySource.
j_max_cycles (str) – J_maxCycles for CriticalitySource.
average_by_cycles (str) – AverageByCycles for CriticalitySource.
j_average_by_cycles (str) – J_averageByCycles for CriticalitySource.

class mcnpy.CriticalitySourcePoints(*args, **kwargs)[source]

Bases: CriticalitySourcePoints, SourceSetting

A representation of the model object CriticalitySourcePoints.

Parameters: points (iterable of mcnpy.Point) – Points for CriticalitySourcePoints.

class mcnpy.CriticalityOptions(*args, **kwargs)[source]

Bases: CriticalityOptions, SourceSetting

A representation of the model object CriticalityOptions.

Parameters

outer_cycles (int) – OuterCycles for CriticalityOptions.
kinetics (mcnpy.YesNo) – Kinetics for CriticalityOptions.
precursor (mcnpy.YesNo) – Precursor for CriticalityOptions.
sensitivity_profile (mcnpy.CriticalityOptionsSensitivityProfile) – SensitivityProfile for CriticalityOptions.
fmat (mcnpy.YesNo) – Fmat for CriticalityOptions.
fmat_skip (int) – Fmat_skip for CriticalityOptions.
fmat_ncyc (int) – Fmat_ncyc for CriticalityOptions.
fmat_space (int) – Fmat_space for CriticalityOptions.
fmat_accel (mcnpy.YesNo) – Fmat_accel for CriticalityOptions.
fmat_reduce (mcnpy.YesNo) – Fmat_reduce for CriticalityOptions.
fmat_nx (int) – Fmat_nx for CriticalityOptions.
fmat_ny (int) – Fmat_ny for CriticalityOptions.
fmat_nz (int) – Fmat_nz for CriticalityOptions.

class mcnpy.Source(*args, **kwargs)[source]

Bases: Source, SourceSetting

A representation of the model object Source.

Parameters

dependent_cel (mcnpy.DependentDistributionPos) – The cells distribution is a function of dependent_cel.
cells (iterable of mcnpy.SourceCell) – Cells for Source.
dependent_sur (mcnpy.DependentDistributionPos) – The surfaces distribution is a function of dependent_sur.
surface (mcnpy.Tally.Bin.UnarySurfaceBin) – Surface for Source.
surfaces (mcnpy.Distributions) – Surface distribution for Source.
dependent_erg (mcnpy.DependentDistribution) – The energies distribution is a function of dependent_erg.
energy (float) – Kinetic energy for Source.
energies (mcnpy.Distributions) – Energy distribution for Source.
dependent_tme (mcnpy.DependentDistribution) – The times distribution is a function of dependent_tme.
time (float) – Time (in shakes) for Source.
times (mcnpy.Distributions) – Time distribution for Source.
dependent_dir (mcnpy.DependentDistribution) – The cosines distribution is a function of dependent_dir.
cosine (float) – Cosine of the angle between vector and the particle’s direction of flight.
cosines (mcnpy.Distributions) – Cosine (angular) distribution for Source.
dependent_vec (mcnpy.DependentDistribution) – The vectors distribution is a function of dependent_vec.
vector (mcnpy.Point) – Reference vector for cosine.
vectors (mcnpy.Distributions) – Vectors for Source.
dependent_nrm (mcnpy.DependentDistribution) – The directions distribution is a function of dependent_nrm.
direction (float) – Sign of the surface normal.
directions (mcnpy.Distributions) – Distribution of surface normals for Source.
dependent_pos (mcnpy.DependentDistributionPos) – The positions distribution is a function of dependent_pos.
position (mcnpy.Point) – Position reference point.
points (mcnpy.Distributions) – Position distribution for Source.
volumer (str) – Volumer for Source.
dependent_rad (mcnpy.DependentDistributionPos) – The radial_distances distribution is a function of dependent_rad.
radial_distance (float) – Radial distance of the position from position or axis.
radial_distances (mcnpy.Distributions) – RadialDistances for Source.
dependent_ext (mcnpy.DependentDistributionPos) – The extents distribution is a function of dependent_ext.
extent (float) – For a volume source, the distance from position along axis. For a surface source, the cosine of angle from axis.
extents (mcnpy.Distributions) – Distribution of extents for Source.
dependent_axs (mcnpy.DependentDistributionPos) – The axes distribution is a function of dependent_axs.
axis (mcnpy.Point) – Reference vector for extent and radial_distance.
axes (mcnpy.Distributions) – Distribution of axes for Source.
dependent_x (mcnpy.DependentDistributionPos) – The x_coords distribution is a function of dependent_x.
x_coord (float) – X-coordinate of the position.
x_coords (mcnpy.Distributions) – Distribution of x-coordinates.
dependent_y (mcnpy.DependentDistributionPos) – The y_coords distribution is a function of dependent_y.
y_coord (float) – Y-coordinate of the position.
y_coords (mcnpy.Distributions) – Distribution of y-coordinates.
dependent_z (mcnpy.DependentDistributionPos) – The z_coords distribution is a function of dependent_z.
z_coord (float) – Z-coordinate of the position.
z_coords (mcnpy.Distributions) – Distribution of z-coordinates.
dependent_ccc (mcnpy.DependentDistributionPos) – The cookie_cutter_cells distribution is a function of dependent_ccc.
cookie_cutter_cell (mcnpy.Cell) – CookieCutterCell for Source.
cookie_cutter_cells (mcnpy.Distributions) – Distribution of CookieCutterCells for Source.
dependent_ara (mcnpy.DependentDistribution) – The areas distribution is a function of dependent_ara.
area (float) – Area of surface.
areas (mcnpy.Distributions) – Distribution of surface areas for Source.
dependent_wgt (mcnpy.DependentDistribution) – The weights distribution is a function of dependent_wgt.
weight (float) – Particle weight for Source.
weights (mcnpy.Distributions) – Distribution of particle weights for Source.
dependent_tr (mcnpy.DependentDistribution) – The transformations distribution is a function of dependent_tr.
transformation (mcnpy.Transformation) – Source particle transformation for Source.
transformations (mcnpy.Distributions) – Distribution of source particle transformations for Source.
dependent_eff (mcnpy.DependentDistribution) – The rejection_efficiencies distribution is a function of dependent_eff.
rejection_efficiency (float) – Rejection efficiency for Source.
rejection_efficiencies (mcnpy.Distributions) – Distribution of rejection efficiencies for Source.
dependent_par (mcnpy.DependentDistribution) – The particles distribution is a function of dependent_par.
particles (mcnpy.Distributions) – Distribution of source particles for Source.
normalize (boolean) – Source particle weight normalization.
particle (mcnpy.SourceParticleCategory or mcnpy.SourceParticle) – Source particle for Source. Refer to mcnpy.SourceParticleCategory for a list of accepted particle types. Heavy ions may also be specified symbolically or by ZAID. E.g. uranium-235 could be specified as “u235”, “U235”, or 92235. U[235] is also valid if U from mcnpy.elements has been imported.
month (int) – Month for Source.
day (int) – Day for Source.
year (int) – Year for Source.
lattitude (float) – Lattitude for Source.
longitude (float) – Longitude for Source.
altitude (float) – Altitude for Source.
x_beam_emittance (float) – XBeamEmittance for Source.
y_beam_emittance (float) – YBeamEmittance for Source.
beam_distance (float) – BeamDistance for Source.
x_beam_aperature (float) – XBeamAperature for Source.
y_beam_aperature (float) – YBeamAperature for Source.
u (float) – U for Source.

property area

property areas

property axes

property axis

property cells

property cosine

property cosines

property direction

property directions

property energies

property energy

property extent

property extents

property particle

property particles

property points

property position

property radial_distance

property radial_distances

property rejection_efficiencies

property rejection_efficiency

property surface

property surfaces

property time

property times

property transformation

property transformations

property vector

property vectors

property weight

property weights

property x_coord

property x_coords

property y_coord

property y_coords

property z_coord

property z_coords

class mcnpy.SourceParticle(*args, **kwargs)[source]

Bases: SourceParticle

A representation of the model object SourceParticle.

Parameters

particle (mcnpy.SourceParticleCategory) – Particle for SourceParticle.
ion (str) – Ion for SourceParticle.

property ion

property particle

class mcnpy.SourceInfo(*args, **kwargs)[source]

Bases: SourceInfo, SourceSetting, Distribution

A representation of the model object SourceInfo.

Parameters

name (int) – Name for SourceInfo.
option (mcnpy.SourceInfoOption) – Option for SourceInfo.
values (iterable of float) – Values for SourceInfo.

class Cells(*args, **kwargs)[source]

Bases: SourceInfoCells, SourceSetting

A representation of the model object SourceInfo.Cells.

Parameters

cells (mcnpy.Tally.Bin.CellBins) – Cells for SourceInfo.Cells.
u_m_cells (iterable of str) – UMCells for SourceInfo.Cells.

class Distributions(*args, **kwargs)[source]

Bases: SourceInfoDistributions, SourceSetting

A representation of the model object SourceInfo.Distributions.

Parameters: distributions (iterable of Object) – Distributions for SourceInfo.Distributions.

class Particles(*args, **kwargs)[source]

Bases: SourceInfoParticles, SourceSetting

A representation of the model object SourceInfo.Particles.

Parameters: particles (iterable of mcnpy.SourceParticle) – Particles for SourceInfo.Particles.

class mcnpy.SourceProbability(*args, **kwargs)[source]

Bases: SourceProbability, SourceSetting, Distribution

A representation of the model object SourceProbability.

Parameters

name (int) – Name for SourceProbability.
option (mcnpy.SourceProbabilityOption) – Option for SourceProbability.
values (iterable of float) – Values for SourceProbability.

class Function(*args, **kwargs)[source]

Bases: SourceProbabilityFunction, SourceSetting, Distribution

A representation of the model object SourceProbability.Function.

Parameters

function (str) – Function for SourceProbability.Function.
a (float) – A for SourceProbability.Function.
b (float) – B for SourceProbability.Function.

evaporation(a=1.2895)[source]: Evaporation energy spectrum of the form $\color{eqn}p(E) = CE e^{-E/a}$ .

exp_decay(a=1.0)[source]: Exponential decay of the form $\color{eqn}\alpha(t) = \alpha_{0}(1/2)^{t/a}$ , $\color{eqn}a$ is the half-life in shakes.

exponential(a=0.0)[source]: Exponential of the form $\color{eqn}p(\mu) = ce^{a|\mu|}$ , $\color{eqn}a$ is the width in MeV and $\color{eqn}b$ is the average energy in MeV.

gaussian(a, b=0.0)[source]: Gaussian distribution of time or position of the form $\color{eqn}p(t) = c e^{-(1.6651092(t-b)/a)^{2}}$ , $\color{eqn}a$ is the width at the half maximum and $\color{eqn}b$ is the mean. Units of shakes for time and units of cm for position.

gaussian_fusion(a=-0.01, b=-1.0)[source]: Gaussian fusion spectrum of the form $\color{eqn}p(E) = C e^{-((E-b)/a)^{2}}$ , $\color{eqn}a$ is the width in MeV and $\color{eqn}b$ is the average energy in MeV.

maxwell(a=1.2895)[source]: Maxwell fission energy spectrum of the form $\color{eqn}p(E) = CE^{1/2} e^{-E/a}$ , $\color{eqn}a$ is temperature in MeV.

muir_fusion(a=-0.01, b=-1.0)[source]: Muir velocity Gaussian fusion spectrum of the form $\color{eqn}p(E) = C e^{-(E^{1/2}-b^{1/2})/a)^{2}}$ , $\color{eqn}a$ is the width in MeV^1/2 and $\color{eqn}b$ is the energy in MeV corresponding to the average speed.

power(a)[source]: Power law of the form $\color{eqn}p(x) = c |x|^{a}$ .

watt(a=0.965, b=2.29)[source]: Watt fission spectrum of the form $\color{eqn}p(E) = C e^{-E/a} sinh(bE)^{1/2}$ .

class mcnpy.SourceBias(*args, **kwargs)[source]

Bases: SourceBias, SourceSetting, Distribution

A representation of the model object SourceBias.

Parameters

name (int) – Name for SourceBias.
option (mcnpy.SourceProbabilityOption) – Option for SourceBias.
values (iterable of float) – Values for SourceBias.

class Function(*args, **kwargs)[source]

Bases: SourceBiasFunction, SourceSetting, Distribution

A representation of the model object SourceBias.Function.

Parameters

function (str) – Function for SourceBias.Function.
a (float) – A for SourceBias.Function.
b (float) – B for SourceBias.Function.

exponential(a=0.0)[source]: Exponential of the form $\color{eqn}p(\mu) = ce^{a|\mu|}$ , $\color{eqn}a$ is the width in MeV and $\color{eqn}b$ is the average energy in MeV.

power(a)[source]: Power law of the form $\color{eqn}p(x) = c |x|^{a}$ .

class mcnpy.SourceComment(*args, **kwargs)[source]

Bases: SourceComment, SourceSetting

A representation of the model object SourceComment.

Parameters

distribution (mcnpy.Distribution) – Distribution for SourceComment.
comment (iterable of str) – Comment for SourceComment.

class mcnpy.EntropyMesh(*args, **kwargs)[source]

Bases: EntropyMesh, SourceSetting

A representation of the model object EntropyMesh.

Parameters

nx (int) – Nx for EntropyMesh.
x0 (float) – X0 for EntropyMesh.
x1 (float) – X1 for EntropyMesh.
ny (int) – Ny for EntropyMesh.
y0 (float) – Y0 for EntropyMesh.
y1 (float) – Y1 for EntropyMesh.
nz (int) – Nz for EntropyMesh.
z0 (float) – Z0 for EntropyMesh.
z1 (float) – Z1 for EntropyMesh.

class mcnpy.Depletion(*args, **kwargs)[source]

Bases: Depletion, SourceSetting

A representation of the model object Depletion.

Parameters

times (iterable of float) – Times for Depletion.
power_fraction (iterable of float) – PowerFraction for Depletion.
materials (iterable of mcnpy.Depletion.Material) – Materials for Depletion.
power (float) – Power for Depletion.
omitted_isotopes (mcnpy.Depletion.OmittedIsotopes) – OmittedIsotopes for Depletion.
min_atom_fraction (float) – MinAtomFraction for Depletion.
cinder_convergence (float) – CinderConvergence for Depletion.
q_multiplier (float) – QMultiplier for Depletion.
tier (int) – Tier for Depletion.
high_energy_physics (str) – HighEnergyPhysics for Depletion.
volumes (iterable of float) – Volumes for Depletion.
material_modification (str) – MaterialModification for Depletion.
fill_modification (str) – FillModification for Depletion.

class Material(*args, **kwargs)[source]

Bases: DepletionMaterial, SourceSetting

A representation of the model object Depletion.Material.

Parameters

power_only (mcnpy.Boolean) – PowerOnly for Depletion.Material.
material (mcnpy.Material) – Material for Depletion.Material.

class OmittedIsotopes(*args, **kwargs)[source]

Bases: DepletionOmittedIsotopes, SourceSetting

A representation of the model object Depletion.OmittedIsotopes.

Parameters

material (mcnpy.Material) – Material for Depletion.OmittedIsotopes.
isotopes_count (int) – IsotopesCount for Depletion.OmittedIsotopes.
isotopes (iterable of str) – Isotopes for Depletion.OmittedIsotopes.

class mcnpy.SourceCell(*args, **kwargs)[source]

Bases: SourceCell, SourceSetting

A representation of the model object SourceCell.

Parameters

z_cell (int) – ZCell for SourceCell.
coordinates (str) – Coordinates for SourceCell.
cell (mcnpy.Tally.Bin.UnaryCellBin) – Cell for SourceCell.
distribution (mcnpy.Distribution) – Distribution for SourceCell.

property cell

property distribution

property z_cell

class mcnpy.SourceDist(*args, **kwargs)[source]

Bases: SourceDist, SourceSetting

A representation of the model object SourceDist.

Parameters: distribution (mcnpy.Distribution) – Distribution for SourceDist.

class mcnpy.SourceID(*args, **kwargs)[source]

Bases: SourceID, SourceSetting, Distribution

A representation of the model object SourceID.

Parameters

keyword (mcnpy.SrcKeyword) – Keyword for SourceID.
name (int) – Name for SourceID.

class mcnpy.SurfaceSource[source]

Bases: object

class Read(*args, **kwargs)[source]

Bases: SurfaceSourceRead, SourceSetting

A representation of the model object SurfaceSource.Read.

Parameters

surfaces_old (iterable of mcnpy.Surface) – SurfacesOld for SurfaceSource.Read.
fission_cells (iterable of mcnpy.Cell) – FissionCells for SurfaceSource.Read.
surfaces_new (iterable of mcnpy.Surface) – SurfacesNew for SurfaceSource.Read.
collision (str) – Collision for SurfaceSource.Read.
weight (float) – Weight for SurfaceSource.Read.
transformation (mcnpy.Transformation) – Transformation for SurfaceSource.Read.
transformations (mcnpy.Distribution) – Transformations for SurfaceSource.Read.
psc (float) – Psc for SurfaceSource.Read.
axis (mcnpy.Vector) – Axis for SurfaceSource.Read.
cosines (mcnpy.Distribution) – Cosines for SurfaceSource.Read.
angular_threshold (float) – AngularThreshold for SurfaceSource.Read.
cylindrical_window (mcnpy.SurfaceSource.ReadCylindricalWindow) – CylindricalWindow for SurfaceSource.Read.

class ReadCylindricalWindow(*args, **kwargs)[source]

Bases: SurfaceSourceReadCylindricalWindow

A representation of the model object SurfaceSource.ReadCylindricalWindow.

Parameters

radius (float) – Radius for SurfaceSource.ReadCylindricalWindow.
z0 (float) – Z0 for SurfaceSource.ReadCylindricalWindow.
z1 (float) – Z1 for SurfaceSource.ReadCylindricalWindow.

class Write(*args, **kwargs)[source]

Bases: SurfaceSourceWrite, SourceSetting

A representation of the model object SurfaceSource.Write.

Parameters

crossings (iterable of mcnpy.SurfaceSource.WriteCrossing) – Crossings for SurfaceSource.Write.
symmetry (str) – Symmetry for SurfaceSource.Write.
particles (iterable of mcnpy.Particle) – Particles for SurfaceSource.Write.
fission_cells (iterable of mcnpy.Cell) – FissionCells for SurfaceSource.Write.

class WriteCrossing(*args, **kwargs)[source]

Bases: SurfaceSourceWriteCrossing

A representation of the model object SurfaceSource.WriteCrossing.

Parameters

direction (mcnpy.PositiveNegative) – Direction for SurfaceSource.WriteCrossing.
surface (mcnpy.Surface) – Surface for SurfaceSource.WriteCrossing.
from_cells (iterable of mcnpy.SurfaceSource.WriteFromCell) – FromCells for SurfaceSource.WriteCrossing.

class WriteFromCell(*args, **kwargs)[source]

Bases: SurfaceSourceWriteFromCell

A representation of the model object SurfaceSource.WriteFromCell.

Parameters

direction (mcnpy.PositiveNegative) – Direction for SurfaceSource.WriteFromCell.
cell (mcnpy.Cell) – Cell for SurfaceSource.WriteFromCell.

class mcnpy.Distribution(*args, **kwargs)[source]

Bases: Distribution

A representation of the model object Distribution.

class mcnpy.Distributions(*args, **kwargs)[source]

Bases: Distributions

A representation of the model object Distributions.

Parameters: distributions (iterable of mcnpy.Distribution) – Distributions for Distributions.

class mcnpy.DependentSource[source]

Bases: object

class Cells(*args, **kwargs)[source]

Bases: DependentSourceCells

A representation of the model object DependentSource.Cells.

Parameters: cells (mcnpy.Tally.Bin.CellBins) – Cells for DependentSource.Cells.

class Distribution(*args, **kwargs)[source]

Bases: DependentSourceDistribution, SourceSetting, Distribution

A representation of the model object DependentSource.Distribution.

Parameters

name (int) – Name for DependentSource.Distribution.
option (mcnpy.DependentSource.DistributionOption) – Option for DependentSource.Distribution.
values (iterable of float) – Values for DependentSource.Distribution.

class DistributionBins(*args, **kwargs)[source]

Bases: DependentSourceDistributionBins

A representation of the model object DependentSource.DistributionBins.

Parameters

bins (iterable of float) – Bins for DependentSource.DistributionBins.
distributions (iterable of mcnpy.ZeroDist) – Distributions for DependentSource.DistributionBins.

class DistributionMatches(*args, **kwargs)[source]

Bases: DependentSourceDistributionMatches

A representation of the model object DependentSource.DistributionMatches.

Parameters

independent (iterable of float) – Independent for DependentSource.DistributionMatches.
dependent (iterable of float) – Dependent for DependentSource.DistributionMatches.

class Distributions(*args, **kwargs)[source]

Bases: DependentSourceDistributions

A representation of the model object DependentSource.Distributions.

Parameters: distributions (iterable of mcnpy.Distribution) – Distributions for DependentSource.Distributions.

class Particles(*args, **kwargs)[source]

Bases: DependentSourceParticles

A representation of the model object DependentSource.Particles.

Parameters: particles (iterable of mcnpy.SourceParticle) – Particles for DependentSource.Particles.

class Volumer(*args, **kwargs)[source]

Bases: DependentSourceVolumer

A representation of the model object DependentSource.Volumer.

Parameters: u_m_cells (iterable of str) – UMCells for DependentSource.Volumer.

class mcnpy.NestedDistribution(*args, **kwargs)[source]

Bases: NestedDistribution

A representation of the model object NestedDistribution.

Parameters: distributions (iterable of mcnpy.SourceDist) – Distributions for NestedDistribution.

class mcnpy.ZeroDist(*args, **kwargs)[source]

Bases: ZeroDist

A representation of the model object ZeroDist.

Parameters: dist (mcnpy.Distribution) – Dist for ZeroDist.