FISPACT-II keywords

From FISPACT-II Wiki
Jump to: navigation, search

A run of FISPACT-II is controlled by a sequence of commands given in a user-supplied input file, the anatomy of which is described in the code execution page. This requires a series of keywords to be specified for control, initial and inventory stages. Below are all of the keywords available in the most recent release of FISPACT-II, sorted by their phase and with a short description. Pages for each of the keywords are linked from this table which provide details of how to use each. Please note that as the code develops new keywords are added to allow access to new features while retaining backwards compatibility. For clarity, keywords added or modified since the 3-00-00 distribution are identified with the scheme below.

Release 4.0+ Release 3-20-00+ Release 3-00-00+
FISPACT-II Keywords
Keyword Version Control Initial Invent. Description
ALLDISPEN 3-20-00 Sets the displacement energies (in eV) for all nuclides
ATDISPEN 3-20-00 Sets the displacement energies (in eV) for specified elements
ATOMS 3-00-00 Sets initial conditions and initiates output with inventories and observables. After the ZERO keyword will also output uncertainties
ATWO 3-00-00 Causes output of legal limits for activity in transport of radioactive material
BREMSSTRAHLUNG 3-00-00 Causes output of brehmsstrahlung contributions for specified nuclides
CLEAR 3-00-00 Causes clearance data of radionuclides to be output
CLOBBER 3-00-00 Allows FISPACT-II to overwrite existing output with same name
CNVTYPE 3-20-00 Allows the user to specify formalism for conversion of incident particle spectra
COVARIANCE 3-00-00 Causes cross-channel covariances to be calculated (if present in nuclear data)
CULTAB 3-00-00 Produces additional lines in tab files for specific post-processing tools
CUMFYLD 3-00-00 Allows the cumulative fission yields to be read, rather than the default independent yields
DENSITY 3-00-00 Specifies a density of the material in grams per cubic centimetre
DEPLETION 3-20-00 Causes FISPACT-II to output the uncertainty from all depletion processes for a set of specified nuclides
DOSE 3-00-00 Allows modification of the dose rate values from semi-infinite slab to point sources
END 3-00-00 Terminates the input of the simulation
ENDPULSE 3-00-00 Terminates the PULSE phase in the simulation
ERROR 3-00-00 Allows manual override of error values for uncertainty quantification
FISCHOOSE 3-00-00 Allows the user to select actinides for pathways-based uncertainty - note that this does not affect the use of fission in the inventory simulation
FISPACT 3-00-00 A divider keyword which separates the library data preparation, initialising that process before subsequent actions
FISYIELD 3-00-00 Allows the user to specify which fission yields are read and included in the inventory simulation
FLUX 3-00-00 Used to specify an incident particle flux in particles per square centimetre per second
FUEL 3-00-00 Specification of initial inventory by nuclide, rather than by element (which is done using MASS)
FULLXS 3-00-00 Causes the full, energy-dependent group cross sections to be stored when the library is being collapsed
GENERIC 3-00-00 Produces generic pathways data removing isomeric transitions
GETDECAY 3-00-00 Causes the condense of decay data or reading of a pre-compiled binary file
GETXS 3-20-00 Initiates the collapse of an incident particle spectrum with the cross sections to generate one-group values. Now with the ability to use arbirtary (ebins) incident group structure
GRAPH 3-00-00 Causes the output of summarised graph files and plotting scripts in a variety of possible formats
GROUP 3-00-00 Allows the specification of an output gamma group structure
GRPCONVERT 3-00-00 Causes the conversion of an incident spectrum from one multi group to another
HALF 3-00-00 Causes half-lives of all nuclides to be output at each step
HAZARDS 3-00-00 Reads in ingestion/inhalation doses and outputs contributions from all nuclides at all steps
INDEXPATH 3-00-00 Causes index of nuclides significant pathways to be written out
IRON 3-00-00 Special keyword for low-impurity iron simulation, to remove iron responses and allow high-accuracy impurity analyses
JSON 4.0 Keyword causes the output of a new JSON file in versions 4.0+
LIBVERSION 3-00-00 Controls input data format, allowing legacy EAF data to be used
LIMGRP 3-20-00 Clips the incident particle spectrum at minimum and/or maximum energies, summing into the lowest and/or highest groups
LOGLEVEL 3-00-00 Controls the sophistication of the logging outputs, particularly useful for error identification
LOOKAHEAD 3-00-00 Fine-tunes pathway analyses by searching for long-lived nuclides and including them in post-irradiation dominant lists
MASS 3-00-00 Input inventory specification by element, instead of by nuclide (as done with the FUEL keyword)
MCSAMPLE 4.0 Used in conjunction with SENSITIVITY to change the Monte-Carlo sampling of nuclear data uncertainties. As of version 4.0, this will take non-neutron uncertainty data from full covariance files
MCSEED 3-00-00 Allows specification of random number seeds in Monte-Carlo sensitivity calculations
MIND 3-00-00 Sets a minimum number of nuclides to follow in the simualation
MONITOR 3-00-00 Controls whether or not FISPACT-II will output a description of the execution steps to the terminal
NOCOMP 3-00-00 Causes the elemental composition table to be omitted from the output
NOERROR 3-00-00 Turns off uncertainty from nuclear data files, although manual inclusion of error can be done using ERROR
NOFISS 3-00-00 Stops the use of fission yield data from being processed and then used in the simulation
NOSORT 3-00-00 Removes the output of dominant nuclides and subsequent pathways/uncertainty data
NOSTABLE 3-00-00 Removes stable nuclides from the output files
NOT1 3-00-00 Switches off the output of TAB1
NOT2 3-00-00 Switches off the output of TAB2
NOT3 3-00-00 Switches off the output of TAB3
NOT4 3-00-00 Switches off the output of TAB4
NUCGRAPH 3-20-00 Creates data outputs and plot scripts with break-downs for all individual dominant nuclides (as opposed to integral quantities)
OVER 3-00-00 Allows the manual overriding of cross sections, half-lives and their errors
PARTITION 3-00-00 Allows the partitioning of the inventory by element, making multiple parallel simulations
PATH 3-00-00 Specifies a specific pathway which will be included in the pathways analysis
PATHRESET 3-00-00 Initiates a new pathways search and uncertainty quantification at the post-irradiation step that it is called in
POWER 3-00-00 Causes the incident particle flux to be renormalised to match a specified volumetric power, using full kerma values from the nuclear data
PRINTLIB 3-00-00 Causes the printing of a range of library data, check the keyword options for more guidance
PROBTABLE 3-00-00 Specifies the method of application of self-shielding factors
PROJECTILE 4.0 Selects the incident particle used in the simulations, for example neutron or one of the four other charged particles currently allowed. As of version 4.0, two additional options have been added for triton- and helion- induced reaction data
PULSE 3-00-00 Initiates a set of repeated irradiation steps with given flux and duration, must be ended with ENDPULSE
READGG 3-20-00 Allows the user to specify an output gamma group structure for decay sources
READSF 3-00-00 Causes the reading and use of spontaneous fission yield data
RESULT 3-00-00 Outputs the total number of atoms tracked in pathways analyses for the specified nuclides
ROUTES 3-00-00 A method for specifying a range of pathways between two nuclides for inclusion in the pathways analyses
SAVELINES 3-00-00 Causes spectral lines from the decay data to be stored and can be further printed using the PRINTLIB 5 option
SENSITIVITY 4.0 Causes sensitivity calculations to be performed over a specified set of nuclides and reactions. As of version 4.0, this will take non-neutron uncertainty data from full covariance files
SORTDOMINANT 3-00-00 Controls the number of nuclides to blue included in the dominant lists and used in uncertainty quantification
SPECTRUM 3-00-00 Alternative to ATOMS which suppresses the full inventory output and gives the gamma spectrum
SPEK 3-00-00 Causes calculation of an approximate gamma spectrum for nuclides which have no spectral data
SPLIT 3-00-00 Allows the display of additional gamma and beta heat data in the final summary table
SSFCHOOSE 3-00-00 Selects the set of nuclides for which self-shielding factors will be applied
SSFDILUTION 3-00-00 Allows manual override of dilution values for self-shielding factor calculation in a group-by-group basis
SSFFUEL 3-00-00 Allows the specification of inventory to be used in the calculation of dilutions and self-shielding factors by nuclide (instead of by element, as with SSFMASS)
SSFGEOMETRY 3-00-00 Provides spatial self-shielding using the universal sigmoid curve for foils, wires, spheres and cylinders
SSFMASS 3-00-00 Allows the specification of inventory to be used in the calculation of dilutions and self-shielding factors by element (instead of by nuclide, as with SSFFUEL)
STEP 3-00-00 Performs the same function of ATOMS but suppresses the output data
TAB1 3-00-00 Writes the inventory data (atoms and mass) to a two column TAB1 file for easy post-processing
TAB2 3-00-00 Writes the activity and dose rate from each nuclide to a two column TAB2 file for easy post-processing
TAB3 3-00-00 Writes the ingestion and inhalation dose from each nuclide to a two column TAB3 file for easy post-processing
TAB4 3-00-00 Writes a multi-group gamma spectrum to a TAB4 file
TIME 3-00-00 Sets the time-steps in the simulation and triggers the processing of any keyword actions that have been queued
TOLERANCE 3-00-00 Allows the modification of solver tolerance values
UNCERTAINTY 4.0 Causes the code to perform pathways-based uncertainty quantification and allows manual control of algorithm parameters. As of version 4.0, this will take non-neutron uncertainty data from full covariance files
UNCTYPE 3-00-00 Allows the user to specify the uncertainties used in the simulation, including cross sections and/or half-lives
USEFISSION 3-00-00 Causes fission yields to be included in the inventory matrix
USESPALLATION 4.0 Causes the sp_endf and xs_endf files for specified nuclides to be spliced at a user-supplied energy and recorded in the xs_extra directory before being used in subsequent simulation
USEXSEXTRA 4.0 Causes xsextra folder, typically generated using USESPALLATION, files to be preferentially utilised instead of those within the group cross section library
WALL 3-00-00 Allows the input of a neutron first wall loading in surface power, which will renormalise the incident particle flux
XSTHRESHOLD 3-20-00 Controls the treshold minimum cross section for inclusion required for inclusion in the calculation
ZERO 3-00-00 Resets the time and moves the simulation into the cooling phase, initiates pathways analyses, uncertainty calculations and output of GRAPH data