Source code documentation for MocDown

MocDown.AssertFileExists(fileName)[source]

Assert that a file exists.

class MocDown.Class[source]

Empty class.

class MocDown.Coordinate(x, y)[source]

Contain an abscissa and ordinate.

GetX()[source]

Return abscissa.

GetY()[source]

Return ordinate.

MocDown.CopyFile(pathOne, pathTwo, display=True)[source]

Copy a file, overwriting its destination.

class MocDown.DepletionCalculation(arguments, isPickleTransmute=False)[source]

Depletion calculation, held in memory during operation.

CleanUpFiles(tmpDir=None)[source]

Remove transmute files.

Deplete()[source]

Execute MocDown depletion.

GetArguments()[source]

Return MocDown.py input arguments.

GetBurnCells()[source]

Return cells which are depleted.

GetBurnMode()[source]

Return ORIGEN2 string for flux or power mode.

GetBurnRate()[source]

Return system total flux or power for current depletion step.

GetCellNumber2BurnRate()[source]

Return dictionary mapping cell to flux or power for current depletion step.

GetCellNumber2Micros()[source]

Return dictionary mapping cell to one-group microscopic cross-sections for current depletion step.

GetCellNumber2OrigenCalculation()[source]

Return cell ORIGEN calculuation for current depletion step.

GetCellNumber2Zam2Moles()[source]

Return dictionary mapping cell to isotope to moles for current depletion step.

GetCellNumberBurnRate(cellNumber)[source]

Return cell flux or power for current depletion step.

GetCellNumberDecayPower(cellNumber, offset=0)[source]

Return cell decay power for current depletion step.

GetCellNumberThermalPower(transportOutputFile, cellNumber, includeDecayHeat=True)[source]

Return cell thermal power for current depletion step.

GetCoolantDensityCalculations()[source]

Return cell coolant density calculuations for current depletion step.

GetDefaultDecayLibrary()[source]

Return ORIGEN2 default decay library.

GetDefaultPhotonLibrary()[source]

Return ORIGEN2 default photon library.

GetDefaultXsLibrary()[source]

Return ORIGEN2 default one-group microscopic cross-section library.

GetDepletionCalculationPickle()[source]

Return depletion I/O object for entire calculation.

GetDepletionStep(offset=0)[source]

Return index of current depletion step.

GetDepletionStepFlux()[source]

Return system total flux for current depletion step.

GetDepletionStepPickle(offset=0)[source]

Return depletion I/O object for current step.

GetDepletionStepPower()[source]

Return system total power for current depletion step.

GetDepletionStepTimeInterval()[source]

Return time duration of current depletion step.

GetDepletionString()[source]

Return string for current depletion step.

GetDisplayFiles()[source]

Return if file operations are verbose.

GetEitherUpdate()[source]

Return if coolant densities or fuel temperatures are coupled.

GetFileName(extension=None, withoutTH=False)[source]

Return MCNP input filename for current depletion step.

GetForceDecayTransport()[source]

Return if transport is to be performed even when it is not needed for transmutation.

GetFuelTemperatureCalculations()[source]

Return cell fuel temperature calculuations for current depletion step.

GetIncludeDecayHeat()[source]

Return if decay heat is to be considered.

GetIsDecayStep()[source]

Return if current depletion step entails decay.

GetIsLesserMcnp()[source]

Return if MCNP version is 5.1.51 or earlier.

GetIsOrigen2()[source]

Return if ORIGEN version is 2.2.

GetIsPickleTransmute()[source]

Return if current depletion step is to be transmuted using pickles.

GetIsRestart()[source]

Return if current depletion step is in restart mode.

GetIsVerbose()[source]

Return if warnings are verbose.

GetLib2Zams()[source]

Return dictionary mapping ORIGEN2 sub-library to its isotopes present.

GetLibZamExcite(lib, zam)[source]

Return excited fraction states for isotope of a ORIGEN2 sublibrary.

GetLibZams(lib)[source]

Return isotopes present in a ORIGEN2 sub-library.

GetMaterialNumber2Zaid()[source]

Return dictionary mapping single-isotope material to isotope.

GetMaterialNumberZaid(materialNumber)[source]

Return isotope for a single-isotope material.

GetOrigen2Lib2Mts()[source]

Return dictionary mapping ORIGEN2 sub-library to MT #s.

GetOrigen2LibMts(lib)[source]

Return ORIGEN2 sub-library MT #s.

GetOriginalTransportFile()[source]

Return object for initial MCNP input file.

GetParameter(key)[source]

Return mocdown input file parameter for a key.

GetParameters()[source]

Return mocdown input file parameters.

GetPreviousCoolantDensityCalculations()[source]

Return previously performed coolant density calculations.

GetPreviousFuelTemperatureCalculations()[source]

Return previously performed fuel temperature calculations.

GetTransmuteTallyNumber()[source]

Return MCNP tally number used for transmutation constants.

GetTransportIteration()[source]

Return index of transport iterations.

GetXsDirZaids()[source]

Return list of isotopes present in MCNP xsdir.

GetZa2WattsPerMole()[source]

Return dictionarty mapping isotope to its decay heat per mole.

IncrementDepletionStep()[source]

Increment index for depletion step.

IncrementTransportIteration()[source]

Increment index of transport iterations.

MultiplicationFactor()[source]

Return characteristic multiplication factor.

MultiplicationFactorSigma()[source]

Return characteristic multiplication factor standard deviation.

PickleDepletionStep(transportOutputFile)[source]

Serialized current depletion step.

PopulateDepletionSteps()[source]

Populate derived depletion parameters.

PrepareDepletion()[source]

Populate default depletion parameters.

PrepareTransmute(transportOutputFile, cell, tmpDir='./')[source]

Prepare transmute calculation.

PrepareTransport(transportFile=None)[source]

Write MCNP input file for current depletion step.

ProcessFuel()[source]

Dummy fuel processing.

ResetTransportIteration()[source]

Reset index of transport iterations.

Transmute(cell, tmpDir='./', currentDir='')[source]

Execute ORIGEN2.

TransmuteThread(cellNumber, transportOutputFile, currentDir)[source]

Execute transmute concurrently for a cell.

TransmuteThreads(transportOutputFile, currentDir)[source]

Execute transmute concurrently for each cell.

Transport()[source]

Execute transport.

TransportConvergence()[source]

Iterate transport calculations until convergence for current depletion step.

TryUnpickle()[source]

Attempt to read a pickle file for current depletion step.

UnpickleDepletionStep()[source]

Un-serialized current depletion step.

UpdateCoolantDensitys(transportOutputFile)[source]

Dummy coolant density calculation.

UpdateFuelTemperatures(transportOutputFile)[source]

Dummy fuel temperature calculation.

class MocDown.DepletionCalculationPickle(args)[source]

Pickle for depletion calculation.

GetBurnCells()[source]

Return cells which are depleted.

GetCellNumberVolume(cellNumber)[source]

Return volume of a cell.

GetDecayPowers()[source]

Return list of system total decay powers.

GetDepletionStepTimeEnds()[source]

Return start and end points of depletion steps.

GetDepletionStepTimeIntervals()[source]

Return durations of depletion steps.

GetFIMAs()[source]

Return list of FIMAs.

GetFileName()[source]

Return filename.

GetFissionPowers()[source]

Return list of system total fission powers.

GetMultiplicationFactorSigmas()[source]

Return list of multiplication factors standard deviations.

GetMultiplicationFactors()[source]

Return list of multiplication factors.

GetOrigenFluxes()[source]

Return list of system total ORIGEN fluxes.

GetOrigenPowers()[source]

Return list of system total ORIGEN powers.

GetParameter(key)[source]

Return mocdown input file parameter for a key.

GetParameters()[source]

Return mocdown input file parameters.

GetPowerCells()[source]

Return list of cells which are dense enough to provide power.

GetPromptPowers()[source]

Return list of system total prompt powers.

GetScalarFluxes()[source]

Return list of cells which might provide power.

GetSourceRates()[source]

Return list of system total neutron source rates.

GetThermalPowers()[source]

Return list of system total thermal powers.

GetZa2Masses()[source]

Get list of dictionaries mapping isotope to mass.

GetZa2Moles(cellNumbers=None, endOfCycle=False)[source]

Override dicionary mapping isotope to moles.

Save(baseName, display)[source]

Save to file.

class MocDown.DepletionStepPickle(*args)[source]

Pickle for depletion step.

GetBurnCells()[source]

Return cells which are depleted.

GetCellNumber2DecayPower()[source]

Return dictionary mapping cell to decay power for this depletion step.

GetCellNumber2NextDecayPower()[source]

Return dictionary mapping cell to decay power for next depletion step.

GetCellNumberBurnRate(cellNumber)[source]

Return cell flux or power for this depletion step.

GetCellNumberDecayPower(cellNumber)[source]

Return cell decay power for this depletion step.

GetCellNumberFissionPower(cellNumber)[source]

Return cell fission power for this depletion step.

GetCellNumberMicros(cellNumber)[source]

Return one-group microscopic cross-sections of a cell for this depletion step.

GetCellNumberOrigenCalculation(cellNumber)[source]

Return cell ORIGEN calculuation for this depletion step.

GetCellNumberOrigenFlux(cellNumber)[source]

Return cell ORIGEN flux for this depletion step.

GetCellNumberOrigenPower(cellNumber)[source]

Return cell ORIGEN power for this depletion step.

GetCellNumberPromptPower(cellNumber)[source]

Return cell prompt power for this depletion step.

GetCellNumberScalarFlux(cellNumber)[source]

Return cell MCNP flux for this depletion step.

GetCellNumberTAPE10(cellNumber)[source]

Return ORIGEN TAPE10 of a cell for the depletion step.

GetCellNumberTAPE4(cellNumber)[source]

Return ORIGEN TAPE4 of a cell for this depletion step.

GetCellNumberTAPE5(cellNumber)[source]

Return ORIGEN TAPE5 of a cell for this depletion step.

GetCellNumberTAPE6(cellNumber)[source]

Return ORIGEN TAPE6 of a cell for this depletion step.

GetCellNumberTAPE7(cellNumber)[source]

Return ORIGEN TAPE7 of a cell for this depletion step.

GetCellNumberTAPE9(cellNumber)[source]

Return ORIGEN TAPE9 of a cell for this depletion step.

GetCellNumberThermalPower(cellNumber)[source]

Return cell thermal power for this depletion step.

GetCellNumberVolume(cellNumber)[source]

Return cell volume.

GetCellNumberZaid2MassDensity(cellNumber)[source]

Return dictionary mapping isotope to mass density of a cell for this depletion step.

GetCellNumberZaid2NumberDensity(cellNumber)[source]

Return dictionary mapping isotope to number density of a cell for this depletion step.

GetCellNumberZam2Moles(cellNumber)[source]

Return dictionary mapping isotope to moles of a cell for this depletion step.

GetCoolantDensityCalculations()[source]

Return cell coolant density calculuations for this depletion step.

GetDepletionStepTimeEnds()[source]

Return start and end points of depletion steps.

GetDepletionStepTimeIntervals()[source]

Return durations of depletion steps.

GetFileName()[source]

Return filename.

GetFuelTemperatureCalculations()[source]

Return cell fuel temperature calculuations for this depletion step.

GetMevPerFission()[source]

Return effective MeV per fission for this depletion step.

GetMultiplicationFactor()[source]

Return multiplication factor for this depletion step.

GetMultiplicationFactorSigma()[source]

Return multiplication factor standard deviation for this depletion step.

GetNeutronsPerFission()[source]

Return effective neutrons per fission for this depletion step.

GetParameter(key)[source]

Return mocdown input file parameter for a key.

GetParameters()[source]

Return mocdown input file parameters.

GetPowerCells()[source]

Return list of cells which are dense enough to provide power.

GetSourceRate()[source]

Return system total neutron source rate for this depletion step.

GetTransportInputRaw()[source]

Return text from MCNP output file for this depletion step.

GetTransportOutputRaw()[source]

Return text from MCNP input file for this depletion step.

MocDown.DoGnuPlot(fileName, keepPlt=False)[source]

Execute gnuplot and convert the resulting eps to png and pdf.

MocDown.ExistsAndNewer(pathOne, pathTwo)[source]

Return if file exists and is newer.

MocDown.ImportLibraries(mocDownInputFile)[source]

Import supplementary libraries.

MocDown.InterpretArguments()[source]

Initiate argument parser and add custom arguments.

MocDown.IsZaReactionNumberOfInterest(za, reactionNumber)[source]

Return if a reaction is of interested for an isotope.

MocDown.Isotope2Zam(isotope)[source]

Convert isotope string -> ZAm.

MocDown.MakeDirectory(directoryName, display=True)[source]

Make directory.

MocDown.MakeTemporaryDirectory(display=True)[source]

Make temporary directory.

class MocDown.MaterialComposition(materialDensity, isotope2Fraction)[source]

Derive compositions from arbitary isotopic mixtures.

class MocDown.McnpCard(raw)[source]

A single card in an MCNP input file.

GetNumber()[source]

Return number.

GetRaw()[source]

Return text.

GetRegex()[source]

Return compiled regular expression for this instance.

Populate()[source]

Dummy method.

class MocDown.McnpCell(raw)[source]

MCNP celsurface card.

GetFillUniverse()[source]

Return universe which fills.

GetHeavyMetalMT()[source]

Return metric tonnes of heavy metal.

GetImportance()[source]

Return importance.

GetLatticeType()[source]

Return lattice type.

GetMass()[source]

Return grams.

GetMassDensity()[source]

Return grams per cubic centimeter.

GetMaterialDensity()[source]

Return grams per cubic centimeter or atoms per barn centimeter.

GetMaterialDensityRegex()[source]

Return compiled material density regular expression.

GetMaterialNumber()[source]

Return material number.

GetMoles()[source]

Return moles.

GetNumberDensity()[source]

Return atoms per barn centimeter.

GetSuffix()[source]

Return most prominent nuclear library suffix.

GetSurfaceNumbers()[source]

Return list of surface numbers.

GetTemperature()[source]

Return MeV.

GetTemperatureRegex()[source]

Return compiled temperature regular expression.

GetUniverse()[source]

Return universe.

GetVolume()[source]

Return cubic centimeters.

GetZa2Moles()[source]

Return dictionary mapping isotope to moles.

GetZaid2AtomFraction()[source]

Return dictionary mapping isotope to atom fraction.

GetZaid2MassDensity()[source]

Return dictionary mapping isotope to grams per cubic centimeter.

GetZaid2NumberDensity()[source]

Return dictionary mapping isotope to atoms per barn centimeter.

GetZaid2WeightFraction()[source]

Return dictionary mapping isotope to weight fraction.

GetZaidMass(zaid)[source]

Return grams for an isotope.

GetZaidMassDensity(zaid)[source]

Return grams per cubic centimeter for an isotope.

GetZaidMoles(zaid)[source]

Return moles for an isotope.

GetZaidNumberDensity(zaid)[source]

Return atoms per barn centimeter for an isotope.

GetZaids()[source]

Return list of isotopes.

Populate()[source]

Populate.

class MocDown.McnpCellEnergyDepositionTally(raw)[source]

MCNP cell energy deposition tally.

class MocDown.McnpCellFissionEnergyDepositionTally(raw)[source]

MCNP cell fission energy deposition tally.

class MocDown.McnpCellFluxMultiplierTally(raw)[source]

MCNP cell flux tally with multiplier.

CrackBin(tallyBin)[source]

Helper for parsing multiplier bins.

GetMultiplierBins()[source]

Return multiplier bins.

PopulateMultiplierBins(cells)[source]

Construct multiplier bins.

PopulateSpaces(tallys)[source]

Attach inherited particles and spaces.

class MocDown.McnpCellFluxTally(raw)[source]

MCNP cell flux tally.

class MocDown.McnpCellPulseHeightTally(raw)[source]

MCNP cell pulse height tally.

class MocDown.McnpDetectorMultiplierTally(raw)[source]

MCNP detector tally.

class MocDown.McnpDetectorTally(raw)[source]

MCNP detector tally.

class MocDown.McnpInputFile(fileName, outputRaw=None)[source]

MCNP input file parser.

AppendNewputCard(card)[source]

Append a card to input.

Block2SingleLineCards(raw)[source]

Return card blocks with newlines and continuations stripped.

FindCell(cellNumber)[source]

Find a cell by cell number.

FindCellMaterial(cellNumber)[source]

Find a cell material by cell number.

FindCellSurfaces(cellNumber)[source]

Find cell surfaces by cell number.

FindLeafCells(cells)[source]

Find cells contained within a cell.

FindMaterial(materialNumber)[source]

Find a material by material number.

FindRootCells(cells)[source]

Find cells which contain a cell.

FindSingleZaidMaterialNumber(zaid)[source]

Find material number which contains a single isotope.

GetAngles()[source]

Return angle cards.

GetCellBlock()[source]

Return block of cell cards.

GetCellCards()[source]

Return list of cell cards.

GetCellNumber2Paths()[source]

Return dictionary mapping cell to hierarchical path.

GetCellNumberDecayPower(cellNumber, za2WattsPerMole)[source]

Return decay power for a cell.

GetCellNumberPaths(cellNumber)[source]

Return hierarchical path for a cell.

GetCellNumbers()[source]

Return list of cell numbers.

GetCells()[source]

Return list of cells.

GetDataBlock()[source]

Return block of data cards.

GetDataCards()[source]

Return list of data cards.

GetEnergys()[source]

Return energy cards.

GetFileName()[source]

Return filename.

GetFissionCells()[source]

Return list of cells which contain fissile isotopes.

GetHeavyMetalMT()[source]

Return syystem total metric tonnes of heavy metal.

GetInputRaw()[source]

Return text.

GetInputRawWithoutComments()[source]

Return text without comments.

GetIsCoupled()[source]

Return if photons are considered.

GetIsKcode()[source]

Return if it is a criticality problem.

GetIsMultiplyRootedLeafCell(leafCell)[source]

Return if a cell appears in multiple root cells.

GetIsUpdated()[source]

Return if input cards have been added or modified.

GetMaterialNumbers()[source]

Return list of material numbers.

GetMaterials()[source]

Return list of materials.

GetMode()[source]

Return particle mode (n, p, or np).

GetMultiplyRootedLeafCell(leafCell)[source]

Return path for a cell which appears in multiple root cells.

GetMultiplyRootedLeafCells()[source]

Return dictionary mapping cell to path for cells which appear in multiple root cells.

GetNamedCard(cardName)[source]

Return list of named cards for a variety.

GetNamedCards()[source]

Return dictionary of named cards.

GetNewputFileName(depletionStep)[source]

Return file name for new input.

GetNewputRaw()[source]

Return new input text.

GetOutputRaw()[source]

Return text for associated output.

GetPowerCells()[source]

Return list of cells which are dense enough to provide power.

GetSurfaceBlock()[source]

Return block of surface cards.

GetSurfaceCards()[source]

Return list of surface cards.

GetSurfaces()[source]

Return list of surface cards.

GetTallyIndices(mnemonic)[source]

Return spaces for a tally type mnemonic.

GetTallyType2Indices()[source]

Return dictionary mapping tally type mnemonic to spaces.

GetTallys(mnemonic=None)[source]

Return list of tally cards.

GetZa2Moles()[source]

Return dictionary mapping isotope to system total moles.

Populate()[source]

Populate.

PopulateCellHeirarchy()[source]

Determine hierarchy of cells.

PopulateCellMaterialAttributes()[source]

Populate the many named data card types.

PopulateDataCards()[source]

Populate the many named data card types.

PopulateInputBlocks()[source]

Extract cell, surface, and data blocks.

PopulateTallyIndices()[source]

Populate lists of spaces which are tallied.

PopulateTallySpecifics()[source]

Attach modifiers to tallys.

ReplaceNamedNewputCard(oldCardName, newCard)[source]

Modify an existing named card.

ReplaceNewputCard(oldCard, newCard)[source]

Modify an existing card.

Report(arguments)[source]

Offer summary or diagnostic reports to stdout.

ResetNewput()[source]

Revert new input text to original text.

class MocDown.McnpMaterial(raw)[source]

MCNP material card.

GetIsSingleIsotope()[source]

Return if only one isotope is contained.

GetZa(index=0)[source]

Return first isotope.

GetZaid2Fraction()[source]

Return dictionary mapping isotope to abundance.

GetZaids()[source]

Return list of isotopes.

GetZas()[source]

Return list of isotopes.

Populate()[source]

Populate.

class MocDown.McnpOutputFile(fileName)[source]

MCNP output file parser.

GetCellNumberFissionPower(cellNumber)[source]

Return fission power for a cell.

GetCellNumberFissionRate(cellNumber, mnemonic='fm4')[source]

Return fission rate for a cell.

GetCellNumberMicroscopicCrossSection(cellNumber, materialNumber, reactionNumber)[source]

Derive one-group microscopic cross-section for a cell, isotope, and reaction.

GetCellNumberOrigenPower(cellNumber, isOrigen2)[source]

Return ORIGEN power for a cell.

GetCellNumberParticlePower(cellNumber, mnemonic='f6')[source]

Return prompt power for a cell.

GetCellNumberQPower(cellNumber, qMethod)[source]

Return power for a cell using a number of reaction Q-values.

GetCellNumberReactionRate(cellNumber, materialNumber, reactionNumber, mnemonic='fm4', forMicro=False, doFloat=False)[source]

Derive reaction rate for a cell, isotope, and reaction.

GetCellNumberScalarFlux(cellNumber, mnemonic='f4')[source]

Derive scalar flux for a cell.

GetCellNumberTrackLengthVolume(cellNumber, mnemonic='f4')[source]

Derive track length and volume for a cell.

GetFileName()[source]

Return filename.

GetIsUpdated()[source]

Return if an update is warranted.

GetMcnpInputFile()[source]

Return MCNP input file derived from output text.

GetMevPerFission()[source]

Return effective MeV per fission.

GetMultiplicationFactor()[source]

Return multiplication factor.

GetMultiplicationFactorRV()[source]

Return multiplication factor random variable.

GetMultiplicationFactorSigma()[source]

Return multiplication factor standard deviation.

GetNeutronsPerFission()[source]

Return effective neutrons per fission.

GetOutputRaw()[source]

Return text.

GetSourceRate(realSourceRate=False)[source]

Return system total neutron source rate.

Populate()[source]

Populate.

PopulateMcnpInputFileMethods()[source]

Populate methods derived from MCNP input.

PopulateMultiplicationResults()[source]

Populate multiplication factor results.

PopulateSourceRate(sourceRate)[source]

Attach system total neutron source rate.

PopulateTallyResults()[source]

Populate tally results.

Report(arguments)[source]

Offer summary or diagnostic reports to stdout.

WritePhysicalQuantity(fileName, getter, headerFormat, tallyResults, downSample)[source]

Offer summary or diagnostic reports to file.

class MocDown.McnpSurface(raw)[source]

MCNP surface card.

GetMnemonic()[source]

Return surface type mnemonic.

Populate()[source]

Populate.

class MocDown.McnpSurfaceCurrentTally(raw)[source]

MCNP surface current tally.

class MocDown.McnpSurfaceFluxTally(raw)[source]

MCNP surface flux tally.

class MocDown.McnpTally(raw)[source]

MCNP generic tally card.

GetEnergys()[source]

Return energy bins.

GetMnemonic()[source]

Return tally type mnemonic.

GetParticles()[source]

Return particles.

GetResultString()[source]

Return result text.

GetSpaceType()[source]

Return surface or cell, according to tally type mnemonic.

GetSpaces()[source]

Return list of spaces.

GetTallyResults(*args)[source]

Return an indexed tally result.

Populate()[source]

Populate input-related metrics.

PopulateAngles(angles)[source]

Attach angle bins.

PopulateEnergys(energys)[source]

Attach energy bins.

PopulateGenerics()[source]

Generic population input-related metrics.

PopulateResults(resultString)[source]

Parse and populate tally output text.

PopulateSpaces()[source]

Attach spaces.

class MocDown.MocDownInputFile(arguments)[source]

Parser for mocdown input file.

GetConverter(key)[source]

Return parameter parser for a key.

GetConverters()[source]

Return custom parameter parsers.

GetFileName()[source]

Return filename.

GetInputRaw()[source]

Return text from file.

GetKeyValueValues()[source]

Parse and return key value pairs.

GetLibraryParametersConverters()[source]

Return default values and parsing functions for custom parameters.

GetParameter(key)[source]

Return mocdown input file parameter for a key.

GetParameters()[source]

Return mocdown input file parameters.

Populate()[source]

Construct parameter mapping.

MocDown.MoveFile(pathOne, pathTwo, display=True)[source]

Move file.

MocDown.NumericStringKey(string)[source]

Return hash from numerics in a string.

class MocDown.OrigenCalculation(suffix, cellVolume, directory='')[source]

ORIGEN2 calculation.

AttachMicros(micros)[source]

Attach one-group microscopic cross-sections.

GetBurnup()[source]

Return exposure accrued.

GetDecayPower(za2WattsPerMole)[source]

Return decay power.

GetDirectory()[source]

Return working directory.

GetFlux()[source]

Return flux magnitude.

GetMassDensity()[source]

Return cell total grams per cubic centimeter.

GetMicros()[source]

Return one-group microscopic cross-sections.

GetMoles()[source]

Return cell total moles.

GetNumberDensity()[source]

Return cell total atoms per barn centimeter.

GetPower()[source]

Return transmute power.

GetSuffix()[source]

Return nuclear library suffix.

GetTAPE10()[source]

Return TAPE10.

GetTAPE4()[source]

Return TAPE4.

GetTAPE5()[source]

Return TAPE5.

GetTAPE6()[source]

Return TAPE6.

GetTAPE7()[source]

Return TAPE7.

GetTAPE9()[source]

Return TAPE9.

GetTableTotal(tableNumber)[source]

Return sum of a reported table.

GetVolume()[source]

Return cubic centimeters.

GetZaid2AbsorptionFraction()[source]

Return dictionary mapping isotope to fractional absorption.

GetZaid2AtomFraction()[source]

Return dictionary mapping isotope to atom fission.

GetZaid2FissionFraction()[source]

Return dictionary mapping isotope to fractional fission.

GetZaid2MassDensity()[source]

Return dictionary mapping isotope to grams per cubic centimeter.

GetZaid2Moles()[source]

Return dictionary mapping isotope to moles.

GetZaid2NumberDensity()[source]

Return dictionary mapping isotope to atoms per barn centimeter.

GetZaid2WeightFraction()[source]

Return dictionary mapping isotope to weight fission.

GetZaidTableNumber2Value(tableNumber)[source]

Return result table for a table number.

Populate()[source]

Populate.

MocDown.PrintNow(sep, *arguments)[source]

Print to stdout immediately.

MocDown.QCaptureOrigenS(ZA)[source]

Return Q-capture of ORIGEN-S.

MocDown.QFissionMCNP(ZA)[source]

Return Q-fission of MCNP.

MocDown.QFissionMonteburns2(ZA)[source]

Return Q-fission of MONTEBURNS2.

MocDown.QFissionOrigen2(ZA)[source]

Return Q-fission of ORIGEN2.

MocDown.QFissionOrigenS(ZA)[source]

Return Q-fission of ORIGEN-S.

class MocDown.RandomVariable(expected, uncertainty, isStd=False, isVar=False)[source]

Statistical random variable.

GetElements()

Return expected value.

GetExp()[source]

Return expected value.

GetRelStd()[source]

Return relative standard deviation.

GetRelVar()[source]

Return relative variance.

GetRelativeUncertaintys()

Return relative standard deviation.

GetRelativeVariances()

Return relative variance.

GetStd()[source]

Return standard deviation.

GetTotalElement()

Return expected value.

GetTotalRelativeUncertainty()

Return relative standard deviation.

GetVar()[source]

Return variance.

MocDown.ReadFile(fileName, display=True, size=-1)[source]

Read and return ascii file.

MocDown.ReadTransportFile(fileName)[source]

Read MCNP input or output file.

MocDown.ReadXsDir(path=None, display=True)[source]

Find, read, and return xsdir file.

class MocDown.RecycleCalculation(arguments)[source]

Recycle calculation, held in memory during operation.

ArchiveRecycle()[source]

Move files from previous recycling step to a folder.

GetArguments()[source]

Return runtime arguments.

GetDisplayFiles()[source]

Return if file operations are verbose.

GetIsPickleTransmute()[source]

Return if current depletion step is to be transmuted using pickles.

GetParameter(key)[source]

Return mocdown input file parameter for a key.

GetParameters()[source]

Return mocdown input file parameters.

GetRecycleIndex()[source]

Return index of current recycling step.

GetRecycleString()[source]

Return string for current recycling step.

IncrementRecycleIndex()[source]

Increment index of recycling iterations.

IsotopicsHaveConverged(transportOne, transportTwo)[source]

Return if isotopics of subsequent cycles have converged.

MultiplicationHasConverged(depletionOne, depletionTwo)[source]

Return if multiplication of subsequent transport cycles have converged.

PrepareRecycle(transportFile, finale=False)[source]

Populate default recycling parameters.

Recycle()[source]

Execute MocDown recycling.

MocDown.RemoveDirectory(directoryName, display=True)[source]

Remove directory.

MocDown.RemoveFile(fileName, display=True)[source]

Remove file.

MocDown.RemoveTree(directoryName, display=True)[source]

Remove directory tree.

MocDown.SafeDivide(numerator, denominator)[source]

Safely divide two quantities.

MocDown.Slope(points)[source]

Determine the slope of a set of points using a simple linear regression.

Symbolically link files.

class MocDown.TallyResult(*args)[source]

MCNP tally parser.

GetElements()[source]

Return energy bin values.

GetEnergyBinMeans()[source]

Return energy bin means.

GetEnergyPerBins()[source]

Return unit energy per energy bin.

GetEnergys()[source]

Return energy bin boundaries.

GetLethargyPerBins()[source]

Return unit lethargy per energy bin.

GetNormPerLethargys()[source]

Return normalized per unit lethargy.

GetPerBins()

Return energy bin values.

GetPerEnergys()[source]

Return per unit energy.

GetPerLethargys()[source]

Return per unit lethargy.

GetRelativeUncertaintys()[source]

Return relative standard deviations for each energy bin.

GetRelativeVariances()[source]

Return relative variances for each energy bin.

GetTotalElement()[source]

Return total.

GetTotalRelativeUncertainty()[source]

Return total relative variance.

GetTotalUncertainty()[source]

Return total standard deviation.

GetTotalVariance()[source]

Return total variance.

GetUncertaintys()[source]

Return standard deviations for each energy bin.

GetVariances()[source]

Return variances for each energy bin.

HalfSample(doAverage=False)[source]

Downsample energy bins by one half.

MocDown.UniqueDigits(numberOfDigits, forbiddenNumbers)[source]

Find a unique integer, given a number of digits and container of forbidden integers.

MocDown.Warning(warningMessage)[source]

Display warning messages.

MocDown.WordArrange(words, format='', columnNumber=80, prefix='', indent=5)[source]

Arrange words of a given format within columns.

MocDown.WriteCsvFile(fileName, *iterables)[source]

Write .csv file.

MocDown.WriteFile(fileName, raw, display=True)[source]

Write ascii file.

MocDown.Za2Isotope(za, texFormat=False)[source]

Convert ZA -> isotope string.

MocDown.Za2MolarMass(xsDir)[source]

Extract molar mass for a given Z,A from xsdir.

MocDown.Za2Zam(za)[source]

Convert ZA -> ZAm.

MocDown.ZaIsActinide(za)[source]

Return if isotope is an actinide.

MocDown.Zaid2Id(zaid)[source]

Extract temperature ID from ZAID.

MocDown.Zaid2Isotope(zaid, texFormat=False)[source]

Convert a zaid string into an isotope string.

MocDown.Zaid2MolarMass(zaid)[source]

Extract molar mass for a given ZAID from xsdir.

MocDown.Zaid2Temperature(xsDir)[source]

Extract temperature for a given ZAID from xsdir.

MocDown.Zaid2Za(zaid)[source]

Convert ZAID -> ZA.

MocDown.Zaid2Zam(zaid)[source]

Convert ZAID -> ZAm.

MocDown.Zam2Za(zam)[source]

Convert ZAm -> ZA.

MocDown.Zam2Zaid(zam, suffix)[source]

Convert ZAm -> ZAID.

Previous topic

Theory and user’s manual for MocDown

Next topic

Source code documentation for MocDown extensions

This Page