Difference between revisions of "Input syntax manual"

Revision as of 15:26, 25 February 2021

Serpent has no interactive user interface. All communication between the code and the user is handled through one or several input files and various output files.

The format of the input file is unrestricted. The file consists of white-space (space, tab or newline) separated words, containing alphanumeric characters(’a-z’, ’A-Z’, ’0-9’, ’.’, ’-’). If special characters or white spaces need to be used within the word (file names, etc.), the entire string must be enclosed within quotes.

The input file is divided into separate data blocks, denoted as cards. The file is processed one card at a time and there are no restrictions regarding the order in which the cards should be organized. The input cards are listed below. Additional options are followed by key word "set". All input cards and options are case-insensitive (note to developers: make it so). Each input card is delimited by the beginning of the next card. It is hence important that none of the parameter strings used within the card coincide with the card identifiers.

The percent-sign ('%') is used to define a comment line. Anything from this character to the end of the line is omitted when the input file is read. Unlike Serpent 1, hashtag ('#') can no longer be used to mark comment lines in Serpent 2 input. The alternative is to use C-style comment sections beginning with "/*" and ending with "*/". Everything between these delimiters is omitted, regardless of the number of newlines or special characters.

This page will contain the whole input syntax of Serpent 2, with links to more detailed descriptions where needed. For reference see also the Serpent 1 input manual^[1].

Input cards

NOTE: Serpent command words are in boldface and input parameters entered by the user in CAPITAL ITALIC. Optional input parameters are enclosed in [ square brackets ], and when the number of values is not fixed, the remaining values are marked with three dots (...).

branch (branch definition)

branch NAME [ repm MAT₁ MAT₂ ]
            [ repu UNI₁ UNI₂ ]
            [ stp MAT DENS TEMP THERM₁ SABL₁ SABH₁ THERM₂ SABL₂ SABH₂ ... ]
            [ tra TGT TRANS ] 
            [ xenon OPT ] 
            [ samarium OPT ] 
            [ var VNAME VAL ]

Defines the variations invoked for a branch in the automated burnup sequence. Input values:

`NAME`	: branch name
`MAT₁`	: name of the replaced material
`MAT₂`	: name of the replacing material
`UNI₁`	: name of the replaced universe
`UNI₂`	: name of the replacing universe
`MAT`	: name of the material for which density and temperature are adjusted
`DENS`	: material density after adjustment (positive entries for atomic, negative entries for mass densities, or "sum" to use the sum of the constituent nuclide densities)
`TEMP`	: material temperature after adjustment, or -1 if no adjustment in temperature
`THERM_n`	: nth thermal scattering data associated with the material
`SABL_n`	: name of the nth S( $\alpha,\beta$ ) library for temperature below the given value
`SABH_n`	: name of the nth S( $\alpha,\beta$ ) library for temperature above the given value
`TGT`	: target universe, surface or cell
`TRANS`	: name of the applied transformation
`OPT`	: option for setting poison concentrations (0 = set to zero, 1 = use values from restart file)
`VNAME`	: variable name
`VAL`	: variable value

Notes:

The branch name identifies the branch in the coefficient matrix of the coef card
The input parameters consist of a number variations, which are invoked when the branch is applied. A single branch card may inclued one or several variations.
The repm variation can be used to replace one material with another, for example, to change coolant boron concentration.
The repu variation can be used to replace one universe with another, for example, to replace empty control rod guide tubes with rodded tubes for control rod insertion in 2D geometries.
The stp variation can be used to change material density and temperature. The adjustment is made using the built-in Doppler-broadening preprocessor routine and tabular interpolation for S( $\alpha,\beta$ ) thermal scattering data.
The last three parameters of the stp entry are provided only if the material has thermal scattering libraries attached to it (see the therm card).
The tra variation can be used to move or rotate different parts of the geometry, for example, to adjust the position of control rods in 3D geometries. The name of the transformation refers to the unit (universe, cell or surface) entry in the trans card.
The xenon and samarium options can be set to enforce the concentrations of fission product poisons Xe-135 and Sm-149 to zero. By default the concentrations are read from the restart file.
Variables can be used to pass information into output file, which may be convenient for the post-processing of the data.
The branch card is used together with the coef card.
For more information, see detailed description on the automated burnup sequence.
The replaced material MAT₁ of repm variation is also replaced inside mixtures. This means one can not replace a material with a mixture defined with mix card containing the replaced material (for example replacing pure water defined with mat card by a mixture of boron and water defined with a mix card containing the same pure water material).
Currently (version 2.1.30) the replacing material MAT₂ of repm variation can not be included in geometry using other cards than the branch card with the repm variation.

cell (cell definition)

cell NAME UNI₀ MAT [ SURF₁ SURF₂ ... ]

Defines a material cell. Input values:

`NAME`	: cell name
`UNI₀`	: universe where the cell belongs to
`MAT`	: material that fills the cell
`SURF_n`	: surface list

cell NAME UNI₀ fill UNI₁ [ SURF₁ SURF₂ ... ]

Defines a filled cell. Input values:

`NAME`	: cell name
`UNI₀`	: universe where the cell belongs to
`UNI₁`	: universe that fills the cell
`SURF_n`	: surface list

cell NAME UNI₀ outside [ SURF₁ SURF₂ ... ]

Defines an outside cell. Input values:

`NAME`	: cell name
`UNI₀`	: universe where the cell belongs to
`SURF_n`	: surface list

Notes:

There are three types of cells: material cells, filled cells and outside cells. Filled cells are identified by providing the key word fill, followed by the universe filling the cell. If the key word is missing, the third entry is interpreted as the material filling the cell. Outside cells are identified by replacing the material name with key word outside.
Void cells can be defined by setting the material name to "void"
When the geometry is set up, the root universe must always be defined. By default the root universe is named "0", and it can be changed with the set root option.
Outside cells are used to define the part of the geometry that does not belong to the model. When the particle enters an outside cell, boundary conditions are applied. It is important that the geometry model is non-re-entrant when vacuum boundary conditions are used.
Outside cells are allowed only in the root universe. It is important that all space outside the model is defined.
The surface list defines the boundaries of the cell by listing the surface names (as provided in the surface card), together with the operator identifiers (nothing for intersection, ":" for union, "-" for complement and "#" for cell complement).
Universes are implicitly declared for example by using the UNI₀ key words on cell cards as there is no explicit universe input card.
For more information, see detailed description on the universe-based geometry type in Serpent.

casematrix (casematrix definition)

coef (coefficient matrix definition)

coef NBU [ BU₁ BU₂ ... ] 
         [ NBR₁ BR_1,1 BR_1,2 ... ]
         [ NBR₂ BR_2,1 BR_2,2 ... ]
         ...

Defines the coefficient matrix for the automated burnup sequence. Input values:

`NBU`	: number of burnup points
`BU_n`	: burnup steps at which the branches are invoked
`NBR_m`	: number branches in the mth dimension of the burnup matrix
`BR_m,i`	: name of the ith branch in the mth dimension

Notes:

The coef card creates a multi-dimensional coefficient matrix (of size NBR₁ $\times$ NBR₂ $\times$ NBR₃ $\times$ ... ). The automated burnup sequence performs a restart for each of the listed burnup points, and loops over the branch combinations defined by the coefficient matrix.
Positive values in the burnup vector are interpreted as (MWd/kgU), negative values are interpreted as time steps in days.
The coef card is used together with the branch card
For more information, see detailed description on automated burnup sequence.

dep (depletion history)

dep STYPE [ STEP₁ STEP₂ ... ]

Defines depletion history with steps and activates depletion calculation mode. Input values:

`STYPE`	: step type
`STEP_n`	: depletion step list

The possible step types are:

Type	Description	Quantity	Unit
`bustep`	Depletion step	Burnup interval	MWd/kgHM
`butot`	Depletion step	Cumulative burnup	MWd/kgHM
`daystep`	Depletion step	Time interval	d
`daytot`	Depletion step	Cumulative time	d
`decstep`	Decay step	Time interval	d
`dectot`	Decay step	Cumulative time	d
`actstep`	Activation step	Time interval	d
`acttot`	Activation step	Cumulative time	d

Notes:

Transport cycle is omitted with the decstep and dectot options.
Transport cycle is run only once with the actstep and acttot options.

dep pro PTR_REPROC

dep bra PTR_BRANCH

det (detector definition)

det NAME [ PART ]
         [ dr MT MAT ] 
         [ dv VOL ]
         [ dc CELL ]
         [ du UNI ]
         [ dm MAT ]
         [ dl LAT ] 
         [ dx X_MIN X_MAX N_X ]
         [ dy Y_MIN Y_MAX N_Y ]
         [ dz Z_MIN Z_MAX N_Z ]
         [ dn TYPE MIN₁ MAX₁ N₁ MIN₂ MAX₂ N₂ MIN₃ MAX₃ N₃ ]
         [ dh TYPE X₀ Y₀ PITCH N₁ N₂ Z_MIN Z_MAX N_Z ]
         [ dumsh UNI N_C CELL₀ BIN₀ CELL₁ BIN₁ ... ]
         [ de EGRID ]
         [ di TBIN ]
         [ ds SURF DIR ]
         [ dir COS_X COS_Y COS_Z ]
         [ dtl SURF ]
         [ df FILE FRACTION ]
         [ dt TYPE PARAM ]
         [ dhis OPT ]
         [ dfl FLAG OPT ]
         [ da MAT FLX ]
         [ dfet TYPE PARAMS ]

Detector definition. The first parameter:

PART : particle type (n = neutron, p = photon)

is optional in single particle simulations. The remaining parameters are defined by separate key words followed by the input values.

Detector response (dr):

`MT`	: response number
`MAT`	: material name or "`void`" if the material at the collision point is used

Notes:

If the detector is assigned with multiple responses, the results are divided correspondingly into separate bins.
The response numbers are ENDF reaction MT's and special reaction types.
Positive response numbers are associated with microscopic cross sections and the result is independent of material density. Materials for microscopic cross sections must consist of a single nuclide.
Microscopic reactions to ground and isomeric states can be calculated by adding "g" or "m" at the end of the reaction number (e.g. 102g and 102m refer to radiative capture to ground and isomeric states, respectively). This option is available only for nuclides with branching ratios.
Negative response numbers are associated with macroscopic cross sections and special types, and the result is multiplied by material density.
The response material in the dr entry must not be confused with the material in the dm entry. The former defines the material for the response function, while the latter determines the volume of integration.
By default, Serpent allows a detector to have at most 10,000,000 bins.

Detector volume (dv):

VOL : volume in cm³ (3D geometry) or cross-sectional area in cm² (2D geometry)

Notes:

The results are divided by detector volume, which is by default set to 1.

Detector cell (dc):

CELL : cell name where the detector is scored

Notes:

If multiple detector cells are defined, the results are correspondingly divided into multiple bins.

Detector universe (du):

UNI : universe name where the detector is scored

Notes:

If multiple detector universes are defined, the results are correspondingly divided into multiple bins.

Detector material (dm):

MAT : material name where the detector is scored

Notes:

If multiple detector materials are defined, the results are correspondingly divided into multiple bins.
The material entry defines the volume of integration, which must not be confused with the response material in the dr entry.

Detector lattice (dl):

LAT : lattice name where the detector is scored

Notes:

The lattice detector automatically divides the results into multiple bins corresponding to the lattice cells.

Cartesian mesh detector (dx, dy and dz):

`X_MIN`	: minimum x-coordinate of the detector mesh
`X_MAX`	: maximum x-coordinate of the detector mesh
`N_X`	: number of x-bins
`Y_MIN`	: minimum y-coordinate of the detector mesh
`Y_MAX`	: maximum y-coordinate of the detector mesh
`N_Y`	: number of y-bins
`Z_MIN`	: minimum z-coordinate of the detector mesh
`Z_MAX`	: maximum z-coordinate of the detector mesh
`N_Z`	: number of z-bins

Notes:

The mesh detectors can be used to sub-divide the results into multiple spatial bins. For a Cartesian mesh the division is provided with separate entries in x-, y- and z- locations.

Curvilinear mesh detector (dn):

`TYPE`	: Type of curvilinear mesh - 1 = cylindrical (dimensions r, θ, z), 2 = spherical (dimensions r, θ, φ)
`MIN_n`	: Minimum value of coordinate n for the mesh division (lengths in cm, angles in degrees).
`MAX_n`	: Maximum value of coordinate n for the mesh division (lengths in cm, angles in degrees).
`N_n`	: Number of bins in the n coordinate direction (the radial division will be equal r, not equal volume).

Notes:

All parameters must be provided, even for one- or two-dimensional curvilinear meshes.
The results are not divided by cell volume (difference to MCNP mesh tally).
By default, the curvilinear mesh detectors use the global (universe 0) coordinate system for scoring. If the TYPE parameter is given as a negative value (e.g. -1) the lowest level coordinates are used instead.

Hexagonal mesh detector (dh):

`TYPE`	: Type of hexagonal mesh (2 = flat face perpendicular to x-axis, 3 = flat face perpendicular to y-axis)
`X₀`, `Y₀`	: coordinates of mesh center
`PITCH`	: mesh pitch
`N₁`, `N₁`	: mesh size
`Z_MIN`	: minimum z-coordinate of the detector mesh
`Z_MAX`	: maximum z-coordinate of the detector mesh
`N_Z`	: number of z-bins

Notes:

All parameters must be provided, even for a two-dimensional hexagonal meshes.

Unstructured mesh detector (dumsh):

`UNI`	: universe of the unstructured mesh based geometry
`N_C`	: number of mesh cell bins included in the output
`CELL_n`, `BIN_n`	: cell-bin index pairs defining the mapping

Notes:

The polyhedral cells in unstructured mesh based geometries are indexed.
This detector option allows collecting results from the cells into an arbitrary number of bins. One or multiple cells can be mapped into a single bin.

Detector energy binning (de):

EGRID : energy grid name

Notes:

The results are divided into multiple energy bins based on the grid structure.
Energy grid structures are defined using the ene card. Pre-defined energy group structures can not be directly used in detectors, they have to be redefined using for example the fourth type of ene card.

Detector time binning (di):

TBIN : time bin structure name

Notes:

The results are divided into multiple time bins.
Time bin structures are defined using the tme card.
Time bin division may require adjusting the average collision distance (set cfe option) to achieve sufficient statistical accuracy.

Surface current / flux detector (ds):

`SURF`	: surface name
`DIR`	: direction with respect to surface normal (-2 = flux, -1 = inward current, 1 = outward current, 0 = net current)

Notes:

With this option the detector calculates the particle flux over or current through a given surface.
The surface flux mode is invoked by setting the direction parameter to -2, otherwise this parameter defines the current direction with respect to surface normal.
Responses are not allowed with current detectors.
The surface is treated separate from the geometry, and its position is always relative to the origin of the root universe. This is the case even if the surface is part of the geometry in another universe.
The results are integrated over the surface area (other detectors integrate over volume).

Detector direction vector (dir):

`COS_Y`	: component of the direction vector parallel to x-axis
`COS_Y`	: component of the direction vector parallel to y-axis
`COS_Z`	: component of the direction vector parallel to z-axis

Notes:

This option multiplies the detector scores with the scalar product between the particle direction of motion and the given direction vector.

Super-imposed track-length detector (dtl):

SURF : surface inside which the detector is scored

Notes:

This option can be used to apply the track-length estimator for calculating reaction rates inside regions defined by a single surface (sphere, cylinder, cuboid, etc.)
The purpose of the track-length detector is to provide better statistics for special applications (activation wire measurements, etc.).
The surface is treated separate from the geometry, and its position is always relative to the origin of the root universe. This is the case even if the surface is part of the geometry in another universe.

Detector file (df):

`FILE`	: file name where the scored points are written
`FRAC`	: fraction of recorded scores and ascii/binary option (positive value = ascii, negative value = binary)

Notes:

This option can be used to write the scored points in a file.
When used with the surface current detector this option can provide surface source distributions for other calculations.
The fraction parameters gives the probability that the score is written in the file and it can be used to reduce the file size in long simulations.
Source files can be read using the sf entry of source cards.

Special types (dt):

`TYPE`	: special type (see below)
`PARAM`	: additional parameters

The types are:

-1	= cumulative spectrum
-2	= division by energy width
-3	= division by lethargy width
-4	= sum over cell or material bins
-5	= importance weighting
-6	= sum over number of scores
2	= multiply result with another detector defined by `PARAM`
3	= divide result with another detector defined by `PARAM`

Notes:

Types -1, -2 and -3 are used with energy binning.
Type -4 can be used to calculate sum over multiple cell or material bins defined using the dc and dm options. By default separate bins are used for each entry.
Type 3 can be used to calculate flux-weighted averages (microscopic and macroscopic cross sections, etc.).
When the results are multiplied or divided by another detector, the number of bins must be compatible (single value or matching number of bins).

History collection option (dhis):

OPT : option to collect histories (0 = no, 1 = yes)

Notes:

When this option is set, the batch-wise results are kept and printed in the history output file.
Note to developers: statistical tests should be documented

Detector flagging (dfl):

`FLAG`	: flag number (between 1 and 64)
`OPT`	: flagging option (0 = reset if scored, 1 = set if scored, -2/2 score if set -3/3 score if not set)

Notes:

Detector flagging allows limiting detector scores to histories which have already contributed to another score.
The first two options reset or set the flag if the detector is scored, respectively. The remaining options test if the flag is set and score the detector accordingly. Positive values apply OR-type logic (detector is scored if any of the associated flags is set/unset) and negative values AND-type logic (detector is scored if all the associated flags are set/unset).

Activation detector (da):

`MAT`	: activated material
`FLX`	: flux applied to activation

Notes:

Activation detector allows performing activation calculation for materials that are not part of the geometry. The flux spectrum applied to neutron irradiation is taken from the detector scores. The absolute flux level can be set using the FLX parameter. If this parameter is set to -1, also the flux magnitude is taken from the detector scores.
Requires neutron transport simulation and burnup mode. The material provided with the entry must be burnable, and cannot part of the actual geometry. Volume of the material must be defined using the dv parameter.
Since the activated material is not part of the physical geometry, this option should be applied only to small samples and other activation calculations in which the isotopic changes do not significantly affect the neutronics.

Functional Expansion Tally detector (dfet):

`TYPE`	: functional expansion type
`PARAMS`	: other options, specific to each functional expansion type `TYPE`

Geometry	`PARAMS`	`TYPE`	Description	Functional Series	Indexing
Cartesian	`X_MIN X_MAX X_ORDER Y_MIN Y_MAX Y_ORDER Z_MIN Z_MAX Z_ORDER`	`1`	Legendre only	$\psi(\xi)_n = P_i(\xi_x) P_j(\xi_y) P_k(\xi_z)$	$n = k + J * \left( i * I + j\right)$
Cylindrical	`R_MAX R_ORDER H_MIN H_MAX H_ORDER H_ORIENTATION`	`2`	..	..	..

Notes:

-1 can be supplied as an ORDER PARAM to use the built-in default values
It is not recommended to configure a single FET detector to span multiple different material regions—use individual detectors for each region instead
Specifics of this implementation:
- The FETs are based on nonseparable expansions, i.e. fully-convolved cross terms are included
  - For example, the Legendre-based Cartesian FET uses $\psi(\xi)_n = P_i(\xi_x) P_j(\xi_y) P_k(\xi_z)$ with $n$ as a linear indexer of $\{i,j,k\}$
  - Due to the properties of orthogonality, these cross terms can be neglected in post-analyses if only separable terms are desired
- A generalization of the Euler formulas for any orthogonal functional series is used
  - The generated FET coefficients $a_n$ already have all contributions from the orthonormalization constant pre-included, i.e. $c_n$ from $\frac{1}{c_n} = \lVert \psi_n \rVert^2 = \int_\Gamma \psi_n^2 \omega_n$
  - Thus, an FET can be simply reconstructed/sampled from the standard functional series as: $F(\xi) = \sum a_n \psi_n(\xi) \omega_n(\xi)$

div (divisor definition)

div MAT [ sep LVL ] 
        [ subx N_X X_MIN X_MAX ]
        [ suby N_Y Y_MIN Y_MAX ]
        [ subz N_Z Z_MIN Z_MAX ]
        [ subr N_R R_MIN R_MAX ] 
        [ subs N_S S₀ ]

Divides a material into a number of sub-zones. Input values:

`MAT`	: name of the divided material
`LVL`	: geometry level at which the cell-wise division takes place (0 = no division, 1 = last level, 2 = 2nd last level, etc.)
`N_X`	: number of x-zones
`X_MIN`	: minimum x-coordinate (cm)
`X_MAX`	: maximum x-coordinate (cm)
`N_Y`	: number of y-zones
`Y_MIN`	: minimum y-coordinate (cm)
`Y_MAX`	: maximum y-coordinate (cm)
`N_Z`	: number of z-zones
`Z_MIN`	: minimum z-coordinate (cm)
`Z_MAX`	: maximum z-coordinate (cm)
`N_R`	: number of radial zones
`R_MIN`	: minimum radial coordinate (cm)
`R_MAX`	: maximum radial coordinate (cm)
`N_S`	: number of angular sectors
`S₀`	: zero position of angular division (degrees)

Notes:

The automated divisor feature can be used to sub-divide burnable materials into depletion zones, but the use is not limited to burnup mode.
The spatial sub-division is based on either Cartesian or cylindrical mesh.
Volumes of the divided materials must be set manually (see detailed description on the definition of material volumes).
Using automated instead of manual depletion zone division saves memory, which may become significant in very large burnup calculation problems (see detailed description on memory usage).
For more information see detailed description on automated depletion zone division.
The usage of LVL is explained on page automated depletion zone division.
If a material is not divided, all occurrences of it are treated as a single depletion zone. For example, if there are multiple fuel pins with same fuel material type, and no div card is present, all pins are depleted as a single pin.

ene (energy grid definition)

ene NAME 1 E₀ E₁ ...

ene NAME 2 N E_min E_max

ene NAME 3 N E_min E_max

ene NAME 4 GRID

Defines an energy grid structure. Input values:

`NAME`	: energy grid name
`E_i`	: bin boundaries (type 1)
`N`	: number of equi-width bins (types 2 ad 3)
`E_min`	: minimum energy (types 2 and 3)
`E_max`	: maximum energy (types 2 and 3)
`GRID`	: name of the pre-defined grid (type 4)

Notes:

The first input parameter gives the type (1 = arbitrarily defined, 2 = equal energy-width bins, 3 = equal lethargy-width bins, 4 = pre-defined energy group structure).
Energy grid structures are used for several purposes, most commonly with detectors.
See separate description of pre-defined energy group structures.

ftrans (fill transformation)

See transformations.

fun (function definition)

fun NAME TYPE [ ... ]

Defines a function that can be used with detector responses. Input values:

`NAME`	: function name
`TYPE`	: function type (currently only supported type is 1 = point-wise tabular data)

The syntax for type 1 is:

fun NAME 1 INTT X₁ F₁ X₂ F₂ ...

where:

`INTT`	: is the interpolation type (1 = histogram, 2 = lin-lin, 3 = lin-log, 4 = log-lin, 5 = log-log)
`X₁ F₁ ...`	: are the tabulated variable-value pairs

Notes:

The defined function is linked to detector response using response number -100 (syntax: dr -100 NAME).

ifc (interface file)

ifc FILE [setmat N_MAT MAT₁ MAT₂ .. MAT_{N_MAT} ]

Links a multi-physics interface file to be used with the current input. Input values:

FILE : path to the multi-physics interface file

The optional cards are explained below.

setmat adds the possibility to link multiple materials to the same interface, i.e. the same interface gives temperatures and densities (density factors) for multiple materials.

`N_MAT`	: number of materials to link to the interface
`MAT_i`	: name of the ith material linked to the interface

Notes:

If multiple materials are linked to the interface using the setmat option, the densities in the interface file must be given as density factors, i.e. relative to the material card density (values between 0 and 1).
See also Coupled multi-physics calculations.

include (read another input file)

include FILE

Reads another input file. Input values:

FILE : name of the input file

Notes:

The include card can be used to simplify the structure of complicated inputs.
The input parser starts reading and processing the new file from the point where the input card is placed. Processing of the original file continues after the new file is completed.
The included file must contain complete input cards and and options, it cannot be used to read the values of another card.

lat (regular lattice definition)

See also Section 3.6 of Serpent 1 User Manual.

lat UNI TYPE X₀ Y₀ N_X N_Y PITCH UNI₁ UNI₂ ...

Defines a finite two-dimensional lattice in xy-plane with square or X- or Y-type hexagonal elements. The lattice is infinite in z-direction. Input values:

`UNI`	: universe name of the lattice
`TYPE`	: lattice type
`X₀`	: x-coordinate of the lattice origin (origin is in the center of the lattice).
`Y₀`	: y-coordinate of the lattice origin (origin is in the center of the lattice).
`N_X`	: number of lattice elements in x-direction
`N_Y`	: number of lattice elements in y-direction
`PITCH`	: lattice pitch
`UNI_n`	: list of universes filling the lattice positions

Possible lattice types are:

Type	Description
1	Square lattice
2	X-type hexagonal lattice
3	Y-type hexagonal lattice

Lattice type 1 indexing example for N_X = N_Y = 3.

Lattice type 2 indexing example for N_X = N_Y = 3.

Lattice type 3 indexing example for N_X = N_Y = 3.

Notes:

Number of universes in list of universes must be N_X times N_Y.
For square lattices the x coordinate increases from left to right and the y coordinate increases from top to bottom, so the first N_X values in the list of universes create the bottommost (minimum y) row from minimum x to maximum x and the last N_X values in the list of universes create the topmost (maximum y) values. Example of the indexing is provided in the attached figure.
The line breaks usually present in the list of universes are only used to help visualizing the universe order for the user. Serpent ignores them when processing the list of universes.
The input of X and Y type hexagonal lattices is similar to each other, only the directions of the x and y axis change. The axis directions can be checked by using the geometry plotter. Examples of the indexing are provided in the attached figures.

lat UNI TYPE X₀ Y₀ PITCH UNI₁

Defines an infinite two-dimensional lattice in xy-plane with infinitely repeating square or X- or Y-type hexagonal element. The lattice is infinite in z-direction.

`UNI`	: universe name of the lattice
`TYPE`	: lattice type
`X₀`	: x-coordinate of the lattice origin
`Y₀`	: y-coordinate of the lattice origin
`PITCH`	: lattice pitch
`UNI₁`	: universe name of the universe filling all lattice positions

Possible lattice types are:

Type	Description
6	Square lattice
7	Y-type hexagonal lattice
8	X-type hexagonal lattice

Notes:

The order of X- and Y-type hexagonal lattice type numbers is reversed when compared with finite hexagonal lattices.

lat UNI TYPE X₀ Y₀ N_R N_S,1 RADIUS₁ THETA₁ UNI_1,1 UNI_2,1 ... N_S,2 RADIUS₂ THETA₂ UNI_1,2 UNI_2,2 ... ...

Defines a finite two-dimensional circular cluster array lattice in xy-plane. The lattice is infinite in z-direction.

`UNI`	: universe name of the lattice
`TYPE`	: lattice type
`X₀`	: x-coordinate of the lattice origin
`Y₀`	: y-coordinate of the lattice origin
`N_R`	: number of rings in the array
`N_S,R`	: number of sectors in Rth ring
`RADIUS_R`	: central radius of Rth ring
`THETA_R`	: angle of rotation of Rth ring in degrees
`UNI_N,R`	: list of universes filling the sector positions in Rth ring

Possible lattice type is:

Type	Description
4	Circular cluster array

Notes:

The circular cluster array can be used to define fuel assemblies used for example in AGR, CANDU, MAGNOX and RBMK reactors. It can also be used to define fuel rod layout used for example in TRIGA reactors.

lat UNI TYPE X₀ Y₀ N_L Z₁ UNI₁ Z₂ UNI₂ ...

Defines a finite one-dimensional vertical stack in z-direction. The stack is infinite in xy-plane.

`UNI`	: universe name of the lattice
`TYPE`	: lattice type
`X₀`	: x-coordinate of the lattice origin
`Y₀`	: y-coordinate of the lattice origin
`N_L`	: number of lattice elements in z-direction (number of axial layers)
`Z_n`	: z-coordinate of the nth lattice element (lower boundary of the axial layer)
`UNI_n`	: universe name filling the nth lattice position

Possible lattice type is:

Type	Description
9	Vertical stack

Notes:

The z-coordinates must be given in ascending order.
Space below the lowest z-coordinate is not defined.
The top layer fills the entire space above the highest z-coordinate.
The number of Z_n-UNI_n pairs must be N_L.

lat UNI TYPE X₀ Y₀ Z₀ N_X N_Y N_Z PITCH_X PITCH_Y PITCH_Z UNI₁ UNI₂ ...

Defines a finite three-dimensional lattice in xyz-space with cuboidal or X- or Y-type hexagonal prism elements.

`UNI`	: universe name of the lattice
`TYPE`	: lattice type
`X₀`	: x-coordinate of the lattice origin
`Y₀`	: y-coordinate of the lattice origin
`Z₀`	: z-coordinate of the lattice origin
`N_X`	: number of lattice elements in x-direction
`N_Y`	: number of lattice elements in y-direction
`N_Z`	: number of lattice elements in z-direction
`PITCH_X`	: lattice pitch in x-direction
`PITCH_Y`	: lattice pitch in y-direction
`PITCH_Z`	: lattice pitch in z-direction
`UNI_n`	: list of universes filling the lattice positions

Possible lattice types are:

Type	Description
11	Cuboidal lattice
12	X-type hexagonal prism lattice
13	Y-type hexagonal prism lattice

Notes:

Number of universes in list of universes must be N_X times N_Y times N_Z.
For hexagonal prism lattices the x- and y-direction pitches must be equal.
The universe indexing is the similar as with lattice types 1-3. The lowermost z-level is given first, and the uppermost z-level is given last.

mat (material definition)

See Chapter 4 of Serpent 1 User Manual.

mat NAME DENS [ tmp TEMP ]
              [ tft T_MIN T_MAX ]
              [ rgb R G B ]
              [ vol VOL ]
              [ burn N_R ]
              [ fix ID TEMP ] 
              [ moder THNAME ZA ]
  NUC₁ FRAC₁ 
[ NUC₂ FRAC₂ ]
[    ...     ]

Mandatory information:

`NAME`	: Name of the material
`DENS`	: Density of the material (positive for atomic, negative for mass density) or `sum` to calculate the density from given nuclide fractions
`NUC₁`	: Identifier of first nuclide in composition, e.g. "92235.03c" or "U-235.03c".
`FRAC₁`	: Fraction of first nuclide in composition, positive values are interpreted as atomic fractions/densities, negative values as mass fractions/densities.

Optional cards:

tmp: Material temperature for Doppler-preprocessor

TEMP : Temperature of the material for Doppler-broadening preprocessor

tft: Temperature limits for material for coupled multi-physics calculations

`T_MIN`	: Lower limit for material temperature
`T_MAX`	: Upper limit for material temperature

rgb: Material color for geometry plots

`R`	: Value for the red channel of geometry plots (between 0 and 255)
`G`	: Value for the green channel of geometry plots (between 0 and 255)
`B`	: Value for the blue channel of geometry plots (between 0 and 255)

vol: Material volume

VOL : Volume of the material in cm³ (3D geometry) or cross-sectional area in cm² (2D geometry)

burn: Flag material for depletion

N_R : Set to 1 in order to deplete material. The depletion zone division should be done using the div-card.

fix: Library information for decay nuclides

`LIB`	: Library ID (e.g. "09c") for nuclides without cross section data.
`TEMP`	: Temperature (in Kelvin) for nuclides without cross section data.

moder: Use thermal scattering data library for a nuclide. The moder entry can be used several times to define thermal scattering libraries for multiple nuclides, such as hydrogen and deuterium in heavy water.

`THNAME`	: Name of the thermal scattering data library defined using the therm card.
`ZA`	: Nuclide ZA of the thermal scatterer (e.g. 1001 for H-1).

Notes:

This description is incomplete for both the descriptions and optional settings.
See defining material volumes and set mvol regarding other ways to set the material volumes for for example burnup calculations.

mesh (mesh plot definition)

mesh ORI XPIX YPIX [ SYM MIN₁ MAX₁ MIN₂ MAX₂ MIN₃ MAX₃ ]

mesh 8 CMAP DET ORI XPIX YPIX [ SYM MIN₁ MAX₁ MIN₂ MAX₂ MIN₃ MAX₃ ]

mesh 10 ORI XPIX YPIX

Produces a png-format mesh plot of various results. Input values:

`ORI`	: orientation with respect to coordinate axes
`XPIX`	: horizontal image size in pixels
`YPIX`	: vertical image size in pixels
`SYM`	: symmetry option (not used in Serpent 2)
`MIN_n MAX_n`	: boundaries of the plotted region
`CMAP`	: color map used for plotting detector scores (positive entry for linear, negative for log-scale)
`DET`	: detector name

Notes:

The first format produces a mesh plot where fission rate and thermal flux distribution are plotted using hot and cold color schemes, respectively. This type of mesh plot is convenient for illustrating the neutronics of thermal systems. The orientation parameter defines the coordinate axis perpendicular to the plot plane: 1 - x-axis (projection on yz-plane); 2 - y-axis (projection on xz-plane); 3 - z-axis (projection on xy-plane).
The second format can be used for plotting scores that contribute to a detector. The additional input parameters are the detector name and the color map used in the plot.
The third format generates a mesh-plot of the temperature distribution. This can be a good way to check the temperature distribution, provided by an external solver, during a coupled calculation.
The color maps are: 1 - hot; 2 - cold; 4 - jet; 5 - black and white; 6 - hsv; 7 - spring; 8 - summer; 9 - autumn; 10 - winter; 11 - green-purple; 12 - purple-orange; 13 - blue-red. Many of these correspond to what is used in Matlab. Logarithmic scale is used if the number is given with a minus sign.
Detector scores are collected in the mesh cells (see the detector card and the list of ENDF reaction MT's and special reaction types for more information). The distribution is scaled according to the minimum and maximum values.
Some special detector types, such as pulse-height detectors and analog photon heating detectors cannot be associated with mesh plots.
The mesh plot always produces results that are integrated over space. If no boundaries are provided, the integration is carried over the entire geometry.
Setting the orientation parameter of a detector mesh plot to 4 produces a plot in cylindrical coordinates. Instead of Cartesian boundaries the entered values are then the radius, angle and axial coordinate.
The symmetry option was used in Serpent 1. The parameter must be provided for Serpent 2 as well, even though it is not used. The value can be set to zero.
Mesh plot produced by the nth mesh-card is written in file [input]_mesh[n].png.

mix (mixture definition)

mix NAME
MAT₁ F₁
MAT₂ F₂
...

Defines a mixture of two or several materials. Input values:

`MAT_n`	: material name
`F_n`	: material fraction (positive values for volume, negative values for mass fractions)

Notes:

Mixtures can be used to define complicated material definitions consisting of two or more physical materials mixed homogeneously.
Serpent decomposes these mixtures into standard materials before running the transport simulation.
The decomposed material compositions can be written into file using the -mix command line option.

nest (nested universe definition)

nest U TYPE
  [ MAT₁ R₁ ] 
  [ MAT₂ R₂ ] 
  ...
  [ MAT_N ]

nest U 
  [ MAT₁ TYPE₁ PARAM₁₁ PARAM₁₂ ... ] 
  [ MAT₂ TYPE₂ PARAM₂₁ PARAM₂₂ ... ] 
   ...
  [ MAT_N ]

Defines a universe consisting of nested regions. Input values:

`U`	: universe name
`TYPE`	: nested surface type (single surface for all regions)
`MAT₁ ... MAT_N`	: material regions
`R₁ ... R_N-1`	: outer radii
`TYPE₁ ... TYPE_N-1`	: nested surface type (different surfaces for each region)
`PARAM_nm ...`	: surface parameters

Notes:

The nest card defines an entire universe consisting of nested material regions. The boundaries are defined by surfaces nested inside each other. The outermost region is infinite.
The material entries can be replaced by fill U₀, in which case the region is filled by another universe.
The first format allows defining nests in which all surfaces are of same type and centred at the origin. Only surfaces that are characterized by a single outer radius are accepted (cylinders, spheres and some regular prisms). The pin and particle definitions are short-hand notations of the nest card.
The second format allows mixing different surface types. In this case all surface parameters need to be provided after the surface type.

particle (particle geometry definition)

particle U
       [ MAT₁ R₁ ] 
       [ MAT₂ R₂ ] 
       ...
       [ MAT_N ]

Defines a particle universe. Input values:

`U`	: universe name
`MAT₁ ... MAT_N`	: material regions
`R₁ ... R_N-1`	: outer radii

Notes:

The particle card defines an entire universe consisting of nested spherical shells. The boundaries are defined by sphere surfaces. The outermost region is radially infinite.
The material entries can be replaced by fill U₀, in which case the region is filled by another universe.
Most typically used for defining TRISO fuel particles.
The particle card is special case of a nested universe type.
See also description of explicit stochastic geometry type.

pbed (explicit stochastic (pebble bed) geometry)

pbed U₀ U_bg FILE [ OPT ]

Defines a stochastic particle / pebble-bed geometry. Input values:

`U₀`	: universe name for the dispersed medium
`U_bg`	: background universe, i.e. universe filling the space between particles / pebbles
`FILE`	: input file containing the particle/pebble data
`OPT`	: additional options (currently only pow to produce power distribution in a separate output file)

The syntax of the file containing the particle/pebble data is:

X₁ Y₁ Z₁ R₁ U₁

X₂ Y₂ Z₂ R₂ U₂

...

Where:

`X_n, Y_n, Z_n`	: are the coordinates
`R_n`	: is the radius
`U_n`	: is the universe

Notes:

Creates a universe (U₀), which is filled with spherical sub-universes for which the coordinates are read from a separate file.
The coordinates can be defined manually, or using the automated disperser routine.
Can be used for modelling stochastic particle / pebble-bed geometries in multiple levels.
If the power distribution option is set, the pebble/particle-wise distribution is written in file [U₀].out.
See also HTGR geometry examples.

pin (pin geometry definition)

pin U
  [ MAT₁ R₁ ] 
  [ MAT₂ R₂ ] 
  ...
  [ MAT_N ]

Defines a pin universe. Input values:

`U`	: universe name
`MAT₁ ... MAT_N`	: material regions
`R₁ ... R_N-1`	: outer radii

Notes:

The pin card defines an entire universe consisting of nested annular material regions. The boundaries are defined by axially infinite cylindrical surfaces. The outermost region is radially infinite.
The material entries can be replaced by fill U₀, in which case the region is filled by another universe.
Most typically used for defining fuel pins, but can also be applied to guide tubes, control rods, etc.
The pin card is special case of a nested universe type.

plot (geometry plot definition)

plot TYPE XPIX YPIX [ POS MIN₁ MAX₁ MIN₂ MAX₂ ]

plot TYPE F_min F_max E XPIX YPIX [ POS MIN₁ MAX₁ MIN₂ MAX₂ ]

Produces a png-format geometry plot. Input values:

`TYPE`	: defines the plot type (orientation and plotting of boundaries)
`XPIX`	: horizontal image size in pixels
`YPIX`	: vertical image size in pixels
`POS`	: position of plot plane
`MIN₁`	: minimum horizontal coordinate of plotted region
`MAX₁`	: maximum horizontal coordinate of plotted region
`MIN₂`	: minimum vertical coordinate of plotted region
`MAX₂`	: maximum vertical coordinate of plotted region
`F_min`	: minimum importance for importance map plots
`F_max`	: maximum importance for importance map plots
`E`	: particle energy for importance map plots

Notes:

The type parameter consists of one or two concatenated values ('AB'):
1. The first value ('A') defines the plot plane (1 = yz, 2 = xz, 3 = xy).
2. The second value ('B') defines which boundaries are plotted (0 = no boundaries, 1 = cell boundaries, 2 = material boundaries, 3 = both). If the second value in is not provided, material boundaries are plotted.
Importance maps read using the wwin card can be plotted on top of the geometry by setting the second value ('B') of the type parameter to 4 (linear color scheme) or 5 (logarithmic color scheme). The input parameters then also include the minimum and maximum importance and the particle energy. If importance maps are provided for both neutrons and photons, they can be plotted by entering positive and negative energy values, respectively.
Each material plotted with different color. The colors are sampled randomly, unless defined using the rgb entry in the material card.
Void is plotted in black and special colors are used to plot geometry errors (red = overlap, green = undefined region).
The position parameter defines the location of the plot plane on the axis perpendicular to it (e.g. z-coordinate for xy-type plot).
The minimum and maximum coordinates define the boundaries of the plotted region (e.g. minimum and maximum x- and y-coordinates for xy-type plot). If these coordinates are not provided, the plot is extended to the maximum dimensions of the geometry.
The relative dimensions of image size in pixels should match that of the plotted region. Otherwise the image gets distorted.
Geometry plotter requires compiling the source code with GD Graphics libraries.
Command line parameter '-plot' stops the execution after the geometry plots are produced. Option '-qp' invokes a quick plot mode, which does not check for overlaps. Option '-noplot' skips the geometry plots altogether.
See also detailed description on geometry plotter.
Geometry plot produced by the nth plot-card is written in file [input]_geom[n].png.
Note to developers: particle type should be included as an input parameter in importance map plots.

sample (Temperature / density data sample definition)

sample  N_X X_MIN X_MAX  N_Y Y_MIN Y_MAX  N_Z Z_MIN Z_MAX

Samples values from the initial material temperatures and densities to a file using a Cartesian grid.

Input values:

`N_X`	: Number of values to sample in the x-direction.
`X_MIN`	: Minimum coordinate to sample from in the x-direction.
`X_MAX`	: Maximum coordinate to sample from in the x-direction.
`N_Y`	: Number of values to sample in the y-direction.
`Y_MIN`	: Minimum coordinate to sample from in the y-direction.
`Y_MAX`	: Maximum coordinate to sample from in the y-direction.
`N_Z`	: Number of values to sample in the z-direction.
`Z_MIN`	: Minimum coordinate to sample from in the z-direction.
`Z_MAX`	: Maximum coordinate to sample from in the z-direction.

Notes:

The data from each sample is written in a separate [input]_sampleN.m file.
Positive values for the density data correspond to atomic densities, while negative values correspond to mass densities.
Materials with no temperature specified either in their mat-card or through an interface definition will show a temperature of 0.

sens (sensitivity calculation definition)

sens pert

sens resp

sens opt

Definitions for the perturbations, responses and options for sensitivity calculations.

solid (irregular 3D geometry definition)

solid 1 UNI BGUNI
MESH_SPLIT MESH_DIM SZ₁ SZ₂ ... SZ_{MESH_DIM}
POINTS_FILE
FACES_FILE
OWNER_FILE
NEIGHBOUR_FILE
MATERIALS_FILE

Creates an unstructured mesh-based geometry universe. Input values are:

`UNI`	: universe name for the irregular geometry
`BGUNI`	: name of the background universe filling all undefined space
`MESH_SPLIT`	: Splitting criterion for the adaptive search mesh (maximum number of geometry cells in search mesh cell)
`MESH_DIM`	: number of levels in the adaptive search mesh
`SZ_i`	: Size of the search mesh at level `i`
`POINTS_FILE`	: Path to the unstructured mesh points file
`FACES_FILE`	: Path to the unstructured mesh faces file
`OWNER_FILE`	: Path to the unstructured mesh owner file
`NEIGHBOUR_FILE`	: Path to the unstructured mesh neighbour file
`MATERIALS_FILE`	: Path to the unstructured mesh materials file

solid 2 UNI BGUNI
MESH_SPLIT MESH_DIM SZ₁ SZ₂ ... SZ_{MESH_DIM}
MODE R0
body BODY₁ CELL₁ MAT₁
file BODY₁ FILE₁ SCALE₁ X₁ Y₁ Z₁
file BODY₁ FILE₂ SCALE₂ X₂ Y₂ Z₂
...
body BODY₂ CELL₂ MAT₂
file BODY₂ FILE₃ SCALE₃ X₃ Y₃ Z₃
file BODY₂ FILE₄ SCALE₄ X₄ Y₄ Z₄
...

Creates an STL-based geometry universe. Input values are:

`UNI`	: universe name for the irregular geometry
`BGUNI`	: name of the background universe filling all undefined space
`MESH_SPLIT`	: Splitting criterion for the adaptive search mesh (maximum number of geometry cells in search mesh cell)
`MESH_DIM`	: number of levels in the adaptive search mesh
`SZ_i`	: Size of the search mesh at level `i`
`MODE`	: Mode for handling the triangulated geometry (1 = "fast", 2 = "safe").
`R0`	: Radius inside which two points of the STL-geometry are joined into one.
`BODY_i`	: Name of solid body `i`
`CELL_i`	: Name of geometry cell `i` linked with body `i`
`MAT_i`	: Material filling cell `i`
`FILE_i`	: Path to a file containing an STL solid model, multiple files can be linked to one body
`SCALE_i`	: Scaling factor for the STL model in `FILE_i`
`X_i`	: Shift in x-direction to the STL model in `FILE_i`
`Y_i`	: Shift in y-direction to the STL model in `FILE_i`
`Z_i`	: Shift in z-direction to the STL model in `FILE_i`

solid 3 
INTERFACE_FILE

Creates an unstructured mesh-based geometry universe with unstructured mesh-based temperature and/or density distributions. Input values are:

INTERFACE_FILE : Path to the interface file containing the rest of the parameters

Notes:

For simple example of a CAD-based geometry, see the Stanford critical bunny.

src (source definition)

src NAME [ PART ]
         [ sw WGT ] 
         [ sc CELL ]
         [ sm MAT ]
         [ sp X Y Z ] 
         [ sx X_MIN X_MAX ]
         [ sy Y_MIN Y_MAX ]
         [ sz Z_MIN Z_MAX ]
         [ srad R_MIN R_MAX ]
         [ ss SURF ]
         [ sd U V W ]   
         [ se E ]
         [ sb N INTT E₁ WGT₁ E₂ WGT₂ ... ]
         [ sr NUC MT ]
         [ st T_MIN T_MIN ]
         [ sf FILE TYPE ]
         [ si N P₁ P₂ ... ]
         [ sg MAT MODE ]

Source definition. The first parameter:

PART : particle type (n = neutron, p = photon)

is optional in single particle simulations. The remaining parameters are defined by separate key words followed by the input values.

Source weight (sw):

WGT : relative source weight

Notes:

When multiple sources are defined, each definition is sampled with equal probability. This probability can be changed by assigning different weights for each source.
The weights are automatically normalized before the calculation is started.

Source cell (sc):

CELL : cell inside which the source points are sampled

Notes:

Setting a source cell is one of the options that can be applied to define the spatial distribution of source particles.
The selection is based on rejection sampling, and if the source cell occupies a small volume of the geometry, the sampling efficiency can be increased by defining a bounding box around the cell using the sx, sy and sz options.
If no spatial distribution is defined, particles are sampled uniformly over the geometry.

Source material (sm):

MAT : material inside which the source points are sampled

Notes:

Setting a source material is one of the options that can be applied to define the spatial distribution of source particles.
The selection is based on rejection sampling, and if the source material occupies a small volume of the geometry, the sampling efficiency can be increased by defining a bounding box around the region using the sx, sy and sz options.
If no spatial distribution is defined, particles are sampled uniformly over the geometry.

Source point (sp):

X, Y, Z, : coordinates of the source point

Notes:

Setting a point source is one of the options that can be applied to define the spatial distribution of source particles.
If no spatial distribution is defined, particles are sampled uniformly over the geometry.

Source boundaries (sx, sy, sz and srad):

`X_MIN`, `X_MAX`	: Boundaries on X-axis
`Y_MIN`, `Y_MAX`	: Boundaries on Y-axis
`Z_MIN`, `Z_MAX`	: Boundaries on Z-axis
`R_MIN`, `R_MAX`	: Radial boundaries

Notes:

Source boundaries are used to define a bounding box/cylinder inside which the source particles are sampled.
The radial boundaries are centered around the point defined by sp and can be used in combination with sz.
Can be used in combination with cell and material sources to increase the sampling efficiency.
If no bounding box is defined, particles are sampled uniformly over the geometry.

Surface source (ss):

SURF : surface on which the source particles are sampled

Notes:

The surface source is currently limited to infinite vertical cylinder (cyl) and sphere (sph) surface types.
Particles are started in the direction of the inward surface normal.

Source direction (sd):

U, V, W, : direction vector of source particles

Notes:

The source direction option can be set to define a unidirectional source.
If no directional dependence is defined, the direction of source particles is sampled isotropically.

Source energy (se):

`E`	: energy of source particles

Notes:

The source energy option can be used to define a monoenergetic source.
The default energy of neutrons and photons is 1 MeV.
This option can also be used together with the source reaction option (sr).

Source energy bins (sb):

`N`	: number of bins
`INTT`	: interpolation (0 = line spectrum, 1 = histogram, 2 = lin-lin, 4 = log-lin)
`E_n`	: upper boundary of the energy bin
`WGT_n`	: weight of the energy bin

Notes:

This option allows defining an arbitrary source spectrum in the form of tabular data.
The bins are entered in the order of ascending energy, and weight of the first bin must be set to zero.
Interpolation is given in a separate parameter from version 2.1.31 on.

Source reaction (sr):

`NUC`	: nuclide name
`MT`	: reaction number

Notes:

The source reaction determines a distribution function for source energy (for example, ²³⁵U fission spectrum can be defined as: sr 92235.09c 18).
The reaction numbers are ENDF reaction MT's, and the data is obtained from standard cross section libraries.
Applies to neutrons only.
When the source energy parameter (se) is defined, the value is used as the energy of the incoming neutrons.

Source time (st):

T_MIN, T_MAX : time boundaries

Notes:

This parameter defines a time interval for the sampled source particles. The starting time is sampled uniformly between the given minimum and maximum.
All source particles are started at time zero by default.

Source file (sf):

`FILE`	: file path to source file
`TYPE`	: file type (-1 = binary, 1 = ASCII)

Notes:

Source files allow defining arbitrary distributions by reading the particle coordinates, direction, energy, weight and time from a file.
Source files can be produced using the df entry of detector cards or the set csw option.

User-defined source routine (si):

`N`	: number of parameters
`P_n`	: parameters passed as arguments into the subroutine

Notes:

This option allows defining an arbitrary source distributions with a user-defined subroutine.
The source parameters are passed as arguments into the subroutine, together, with sampled position, direction energy, weight and time.
For complete description see source file "usersrc.c".
The subroutine may be overwritten with the blank template file when installing updates.

Radioactive decay source (sg):

`MAT`	: material name or -1
`MODE`	: sampling mode (1 = analog, 2 = implicit)

Notes:

Radioactive decay source combines material compositions to decay data read from ENDF format libraries and forms the normalized source distribution automatically.
Material compositions can be defined manually, or read from binary restart files produced by a burnup or activation calculation (see the set rfw and set rfr options).
If the material name is replaced by -1, source points are started from all radioactive materials.
The analog sampling mode preserves the average number of particles produced in radioactive decay, but may lead to poor sampling efficiency in geometries with both low and high-active materials.
The implicit sampling mode preserves the total statistical weight of emitted particles and produces a uniform source distribution over activated materials.
In version 2.1.28 the source is limited to photon line spectra.
The calculation produces an additional output file [input]_gsrc.m that contains the source spectra.
See practical example for more information.

strans (surface transformation)

See transformations.

surf (surface definition)

surf NAME TYPE [ PARAM₁ PARAM₂ ... ]

Defines a surface. Input values:

`NAME`	: is the surface name
`TYPE`	: is the surface type
`PARAM_n`	: are the surface parameters

Notes:

The name is used to identify the surface, for example, in the cell card.
See separate description on surface types.
Surfaces can be moved and rotated using transformations.

therm and thermstoch (thermal scattering)

therm NAME LIB

therm NAME TEMP LIB₁ LIB₂

therm NAME 0 LIB₁ LIB₂ LIB₃ ...

thermstoch NAME TEMP LIB₁ LIB₂

Defines thermal scattering data that can be linked to nuclides using input entry moder in the material cards. When using thermal scattering data together with TMS on-the-fly temperature treatment, the third input value of the therm card is 0. In this case, Serpent interpolates the thermal scattering data automatically to the local temperature, as defined either using the tms input entry in the material definition or via the multi-physics interface.

Input values:

`NAME`	: name of the thermal scattering data
`LIB_i`	: thermal scattering data identifiers as defined in the directory file (acelib)
`TEMP`	: temperature to which the thermal scattering data is interpolated

Notes:

When using on-the-fly interpolation of thermal scattering data, LIB_i must cover the whole temperature range in which the materials appear in the geometry. I.e. extrapolation of the data is not supported.
Thermal scattering data is interpolated using the methodology of makxsf code
The interpolation can be performed using the stochastic mixing approach with thermstoch. This interpolation mode is not available for on-the-fly interpolation.

tme (time binning definition)

tme NAME 1 LIM₁ LIM₂ ...

tme NAME 2 NB T_min T_max

tme NAME 3 NB T_min T_max

Defines a time binning structure. The second entry sets the binning type (1 = arbitrary, 2 = uniform, 3 = log-uniform). Remaining values:

`NAME`	: name of the time binning
`NB`	: number of bins
`LIM_n`	: time bin boundaries in arbitrary binning
`T_min`	: minimum time boundary in uniform or log-uniform binning
`T_max`	: maximum time boundary in uniform or log-uniform binning

Notes:

The entered values are in seconds
The first limit in the arbitrary type (type = 1), is the lower bound of the first bin. The second limit is the upper bound of the first bin and so on.
Time binning is used with detectors and dynamic simulation mode.

trans (transformations)

trans TYPE UNIT LVL

trans TYPE UNIT X Y Z

trans TYPE UNIT X Y Z θ_x θ_y θ_z ORD

trans TYPE UNIT X Y Z α₁ α₂ α₃ α₄ α₅ α₆ α₇ α₈ α₉ ORD

trans TYPE UNIT rot X₀ Y₀ Z₀ I J K β

Defines surface, universe or fill transformation. Input values:

`TYPE`	: type of transformation (S = surface transformation, F = fill transformation, U = universe transformation)
`UNIT`	: surface, cell or universe name to which the transformation is applied
`LVL`	: level number in universe level transformation
`X,Y,Z`	: translation vector
`θ_x θ_y θ_z`	: rotation angles with respect to x-, y- and z-axes (in degrees)
`α₁ ... α₉`	: coefficients of the rotation matrix
`ORD`	: order in which translations and rotations are applied (1 = rotations first, 2 = translations first)
`X₀,Y₀,Z₀`	: Origin of vector defining rotation axis.
`I,J,K`	: Components of vector defining rotation axis.
`β`	: Angle around rotation axis defined by a vector (in degrees). NB: In Serpent 2.1.29 positive values correspond to rotation to the negative mathematical direction and vice versa.

Notes:

Fill transformation is applied in the universe filling the given cell.
Level transformation is a special type of universe transformation, in which the coordinates in the given universe are obtained relative to geometry level LVL.
By default translations are applied before rotations, and the order can be switched using the ORD parameter.
Rotations can be defined either by providing the three angles with respect to the three coordinate axes, or by defining the rotation matrix. In the second case Serpent applies vector multiplication $\vec{r'} = \bold{A} \vec{r}$ where $\vec{r}$ and $\vec{r'}$ are the position vectors before and after the operation and coefficients α₁ ... α₉ define the 3 by 3 matrix $\bold{A}$ .
To preserve backwards compatibility, input parameters "strans", "utrans" and "ftrans" without the following type identifier are also accepted for defining surface, universe and fill transformations, respectively. To preserve compatibility with Serpent 1, parameter "trans" without type identifier defines a universe transformation.

transv and transa (velocity and acceleration transformations)

transv TYPE UNIT [ tlim T₀ T₁ T_TYPE ] V_X V_Y V_Z

transa TYPE UNIT [ tlim T₀ T₁ T_TYPE ] A_X A_Y A_Z

Defines surface, universe or fill transformation. Input values:

`TYPE`	: type of transformation (S = surface transformation, F = fill transformation, U = universe transformation)
`UNIT`	: surface, cell or universe name to which the transformation is applied
`T₀`	: beginning time of the transformation
`T₁`	: end time of the transformation
`T_TYPE`	: transformation type after end time (1 = movement stops, 2 = transformation removed, 3 = initial acceleration and velocity removed, but velocity accumulated due to acceleration remains)
`V_X,V_Y,V_Z`	: Initial velocity vector
`A_X,A_Y,A_Z`	: Initial acceleration vector

Notes:

Fill transformation is applied in the universe filling the given cell.
The transformation is updated at the simulation time-interval boundaries.
See UGM 2016 Moving geometry.
See Rotating Translating STL Bunny.

utrans (universe transformation)

See transformations.

wwgen (response matrix based importance map solver)

wwgen NAME LIM NI MOD ERG MSH 
     MIN₁ MAX₁ SZ₁
     MIN₂ MAX₂ SZ₂
     MIN₃ MAX₃ SZ₃
     DET₁ W₁ [ DET₂ W₂ ... ]

wwgen NAME LIM NI MOD ERG MSH 
     SZ₁ SZ₂ SZ₃  
     LIM₁₁ LIM₁₂ ...
     LIM₂₁ LIM₂₂ ...
     LIM₃₁ LIM₃₂ ...
     DET₁ W₁ [ DET₂ W₂ ... ]

wwgen NAME LIM NI MOD ERG MSH 
     X₀ Y₀   
     P NX NY
     MIN₃ MAX₃ SZ₃
     DET₁ W₁ [ DET₂ W₂ ... ]

Defines the parameters for importance map calculation. Input values:

`NAME`	: a unique name to identify the calculation
`LIM`	: convergence criterion (typical value 1E-12)
`NI`	: maximum number of iterations
`MOD`	: solution mode (1 = single detector, 2 = multiple detectors, 3 = global variance reduction)
`ERG`	: energy group structure (or -1 if no energy dependence is included)
`MSH`	: mesh type (1 = Cartesian, 2 = Cylindrical, 4 = x-type hexagonal, 5 = y-type hexagonal, 6 = unevenly-spaced xyz, 8 = unevenly spaced cylindrical)
`MIN_n`	: minimum mesh boundary (nth coordinate)
`MAX_n`	: maximum mesh boundary (nth coordinate)
`SZ_n`	: number of mesh cells (nth coordinate)
`LIM_nm`	: mth boundary of nth coordinate)
`X₀, Y₀`	: mesh center of hexagonal mesh (currently must be centered at the origin)
`P`	: hexagonal cell pitch
`NX, NY`	: hexagonal mesh size
`DET_i`	: detectors used as target response functions
`W_i`	: weight factors for detector scores

Notes:

The solution mode provides various options on how the responses are used for calculating the importances.
The detector entries can be left out in global variance reduction mode (MOD = 3), in which case the mesh is optimized to uniformly populate the entire geometry.
Cartesian and cylindrical mesh are defined by outer mesh boundaries and number of mesh cells.
Unevenly-spaced meshes are defined by providing the mesh cell boundaries separately.
The coordinate axes 1, 2 and 3 in Cartesian mesh refer to (x,y,z) and in cylindrical mesh to (r,θ,z), with θ given in degrees.
The hexagonal mesh is defined by mesh center, cell pitch, number of cells in the radial dimensions (similar to the hexagonal lattice) and axial binning.
The mesh must be defined slightly larger than the geometry (the mesh boundaries should not coincide with the geometry boundaries).
Source points located on mesh cell boundaries cause fatal errors.
May not work if source distribution is biased with weight.
The importance mesh is printed in file [input].wwd.
Importance (weight window) meshes are read using the wwin card.
See also practical examples on Variance reduction.
This capability is still very much under development. The input syntax may be revised at some point.

wwin (weight window mesh definition)

wwin NAME 
   [ wf FILE FMT ]
   [ wn F X Y Z E ] 
   [ wx C G ] 
   [ wt SB TYPE MIN MAX ]
   [ wi ITP NI WWG₁ DF₁ WWG₂ DF₂ ... ]
   [ wi ITP NI WWG NX NY NZ NLOOP NTRK ISPL NSPL DSPL₁ SX₁ SY₁ SZ₁ DSPL₂ SX₂ SY₂ SZ₂ ...]

Defines a weight window mesh for variance reduction. The first parameter:

NAME : a unique name to identify the mesh

identifies the mesh. The remaining parameters are defined by separate key words followed by the input values.

Notes:

Only works in external source simulation mode.
Importance (weight window) meshes can be generated by running the response matrix based solver, or read in MCNP WWINP format.
Importance maps can be visualized using the geometry plotter.
See also set wwb and set maxsplit for setting options for weight windows, splitting and Russian roulette.
See also practical examples on Variance reduction.
This capability is still very much under development. The input syntax may be revised at some point.

Mesh file (wf):

`FILE`	: file path and name of the importance mesh file
`FMT`	: file format (1 = mesh produced by Serpent importance map generator, 2 = MCNP WWINP format weight window mesh file)

Notes:

By default the importance map is read from the mesh file and used as-is, the additional options are provided for adjustments.
Currently the MCNP format only supports simple mesh types (no sub-mesh).

Mesh normalization (wn):

`F`	: importance for renormalization
`X,Y,Z`	: coordinates of point used for renormalization
`E`	: energy used for renormalization

Notes:

The importances can be renormalized by fixing the value at a given position and energy.

Mesh adjustment (wx):

`C`	: constant multiplier for adjusting importances
`G`	: exponential for adjusting importances

Notes:

The importances can be adjusted by constant multiplier C and exponential factor G such that $F' = CF^G$ .

Types and options (wt):

`SB`	: option to set source biasing on (1/yes) or off (0/no) with Serpent-generated importance maps
`TYPE`	: bounds type for Serpent-generated weight-windows (1 = averaged, 2 = segment-wise)
`MIN`	: minimum truncation limit for importances
`MAX`	: maximum truncation limit for importances

Notes:

Source biasing is currently not available

Weight-window iterations, fixed mesh (wi):

`ITP`	: iteration type (1 = fixed mesh)
`NI`	: number of iterations between Monte Carlo simulation and the response matrix solver
`WWG_i`	: name of the WWG-structure used in the iteration
`DF_i`	: global density factor

Notes:

The fixed mesh option (ITP = 1) allows performing iterations using a single or multiple meshes generated using the response matrix based solver.
The global density factor is a multiplier applied to all material densities.

Weight-window iterations, adaptive mesh (wi):

`ITP`	: iteration type (2 = geometry-based adaptation, 3 = tracking-based adaptation)
`NI`	: number of iterations between Monte Carlo simulation and the response matrix solver
`WWG`	: name of the WWG-structure used in the iteration
`NX`	: number of x-divisions for the adaptive mesh
`NY`	: number of y-divisions for the adaptive mesh
`NZ`	: number of z-divisions for the adaptive mesh
`NLOOP`	: number of outer iteration loops in generation of adaptive mesh
`NTRK`	: number of tracks per loop in generation of adaptive mesh
`ISPL`	: importance split criterion
`NSPL`	: neighbor split criterion
`DSPL_i`	: density split criterion (negative values for mass, positive values for atomic density)
`SZ_i`	: minimum cell dimension

Notes:

The adaptive mesh option (ITP = 2 or 3) starts with a coarse base mesh, and refines the resolution iteratively.
There are two adaptive mesh options. In the geometry-based option (ITP = 2) Serpent covers the geometry with NTRK random tracks and splits cells according to density criteria. In the tracking-based option (ITP = 3) the tracks are started from the source instead. The procedure is repeated NLOOP times.
Cell splitting is defined using the NX, NY and NZ options. For example NX = 2, NY = 2, NZ = 2 results in each cell being split to 8 sub-cells (octree mesh). For 2D meshes the NZ parameter must be set to 1.
Splitting is carried out recursively, until limiting criteria are met. The DSPL parameters define upper density boundaries and minimum cell sizes for stopping the splits.
The importance split criterion defines the maximum relative difference between the importances of two adjacent cells. If the criterion is not met, both cells are split.
The neighbor split criterion defines the maximum number of neighbor allowed for a cell. If the criterion is not met, the cell is split.

Input options

Input options are used to set various calculation parameters that are not included in the main input cards. Each option is identified by key word "set". Optional values are enclosed within square brackets.

set acelib

set acelib LIB₁ [ LIB₂ LIB₃ ... ]

Sets the cross section directory file paths. Input values:

LIB_n : file paths to directory files

Notes:

If the file path contains special characters it is advised to enclose it within quotes.
A default directory path can be set by defining environment variable SERPENT_DATA. The code looks for cross section directory files in this path if not found at the absolute.
A default cross section directory file can be set by defining environment variable SERPENT_ACELIB. This file will be used if no other path is given with set acelib.

set adf

set adf UNI SURF SYM

Sets parameters for the calculation of assembly discontinuity factors (ADFs). Input values:

`UNI`	: universe where spatial homogenization is performed
`SURF`	: surface enclosing the universe
`SYM`	: symmetry option (see separate list)

Notes:

The surface enclosing the universe can be super-imposed (i.e. not part of the geometry definition), but it must enclose the entire universe.
The surface is super-imposed on the geometry, i.e. its parameters (coordinates) are relative to the root universe (default 0)
When the universe is surrounded by zero net-current (reflective) boundary conditions, the ADFs are calculated as the ratios of surface- and volume-averaged heterogeneous flux.
When the net current is non-zero, the calculation is based on the ratio of surface-averaged homogeneous and heterogeneous flux. The homogeneous flux is obtained from a built-in diffusion flux solver.
Calculation parameters for the diffusion flux solver can be set using the set dfsol option.
Calculation of ADFs is currently allowed only for planes and infinite square and hexagonal prisms.
Symmetry options are used to average out the statistical variation in the ADFs, which might otherwise lead to systematic errors in core calculations. It is important that the options are used only when the geometry has the corresponding symmetry.
See separate description of output parameters in the [input]_res.m.
The ADFs can be printed to the group constant output with set coefpara.
ADFs are calculated in the few-group structure used for group constant generation.

set alb

set alb UNI SURF DIR

Sets parameters for calculating albedos. Input values:

`UNI`	: universe where spatial homogenization is performed
`SURF`	: surface for which the albedos are calculated
`DIR`	: current direction (-1 = inward, 1 = outward)

Notes:

When this option is set, Serpent calculates both total albedos (ratio of currents) and partial albedos (response matrix).
The surface enclosing the universe can be super-imposed (i.e. not part of the geometry definition), but it must enclose the entire universe.
The surface is super-imposed on the geometry, i.e. its parameters (coordinates) are relative to the root universe (default 0)
The current direction is given relative to the surface normal vectors
The universe is needed only for labelling the results in the output files.
See separate description of output parameters.
Albedos are calculated in the few-group structure used for group constant generation.

set arr

set arr MODEN [ MODEG ]

Sets analog reaction rate calculation on or off. Input values:

`MODEN`	: mode for neutrons (0 = no reactions included, 1 = include only reactions that affect neutron balance, 2 = include all reactions)
`MODEG`	: mode for photons (0 = no reactions included, 1 = include all reactions)

Notes:

Analog reaction rates are calculated by counting sampled events and printed in a separate output file.
See detailed description on the reaction rate output file.

set bala

set bala OPT

Sets OpenMP load balancing on or off. Input values:

OPT : option (0 = off, 1 = on)

Notes:

Load balancing may improve OpenMP parallel scalability in calculations with significant branching (most typically related to coupled neutron/photon calculations or variance reduction).
The option is off by default.
When this option is set, the random number sequence is no longer preserved.

set bc

set bc MODE

Sets the boundary conditions for all outer boundaries of the geometry. Input values:

MODE : boundary type (1 = vacuum, 2 = reflective, 3 = periodic)

set bc MODE ALB

Sets the boundary conditions with albedo for all outer boundaries of the geometry. Input values:

`MODE`	: boundary type (1 = vacuum, 2 = reflective, 3 = periodic)
`ALB`	: albedo

set bc MODEX MODEY MODEZ

Sets the boundary conditions separately for x-, y- and z-directions. Input values:

`MODEX`	: boundary type in x-direction (1 = vacuum, 2 = reflective, 3 = periodic)
`MODEY`	: boundary type in y-direction (1 = vacuum, 2 = reflective, 3 = periodic)
`MODEZ`	: boundary type in z-direction (1 = vacuum, 2 = reflective, 3 = periodic)

set bc MODEX MODEY MODEZ ALB

Sets the boundary conditions with albedo separately for x-, y- and z-directions. Input values:

`MODEX`	: boundary type in x-direction (1 = vacuum, 2 = reflective, 3 = periodic)
`MODEY`	: boundary type in y-direction (1 = vacuum, 2 = reflective, 3 = periodic)
`MODEZ`	: boundary type in z-direction (1 = vacuum, 2 = reflective, 3 = periodic)
`ALB`	: albedo

Notes:

The boundary conditions can be set either for all directions at once (single parameter) or x-, y- and z-directions separately (three parameters). Albedos are provided by adding one more parameter in the list.
The default boundary condition is vacuum (= 1) in all directions.
Albedo boundary conditions are invoked by multiplying the particle weight with factor ALB each time a reflective or periodic boundary is hit.
Repeated boundary conditions (reflective or periodic) are based on universe transformations, which limits outer boundary to surfaces that form regular lattices (square and hexagonal prisms, rectangles, cubes and cuboids).
Repeated boundary conditions are applied on the first surface of outside cells (see definition of outside cells in the cell card)
For symmetry purposes Serpent provides the universe symmetry option.
For more information, see detailed description on boundary conditions.
The boundary condition type numbers can also be given as strings, with black = 1, reflective = 2 and periodic = 3.

set blockdt

set blockdt MAT₁ MAT₂ ...

Defines the list of materials where delta-tracking is never used. Input values:

MAT_n : material names

Notes:

This option is used to override selection of tracking mode based on the probability threshold (see set dt) in individual materials.
Use of delta-tracking can be forced in individual materials using set forcedt.
For more information on tracking modes, see the detailed description on delta- and surface-tracking.
Note to developers: should have different lists for neutrons and photons?

set bralib

set bralib LIB₁ [ LIB₂ LIB₃ ... ]

Sets isomeric branching data library file paths. Input values:

LIB_n : library file paths

Notes:

Isomeric branching data libraries are standard ENDF format files containing energy-dependent branching ratios. The data is read from ENDF files 9 and 10.
Serpent uses constant branching ratios by default. The default values can be overridden using the set isobra option. Energy-dependent data read read from ENDF format files overrides the constant ratios.
If the file path contains special characters it is advised to enclose it within quotes.
A default directory path can be set by defining environment variable SERPENT_DATA. The code looks for decay data files in this path if not found at the absolute.
See also: example input
Example data from the JEFF-3.1 activation file

set bumode

set bumode MODE [ ORDER SSD ]

Sets the burnup calculation mode. Input values:

`MODE`	: burnup calculation mode
`ORDER`	: CRAM order
`SSD`	: number of substeps for CRAM decay steps (default or 0: use TTA)

The possible settings for mode are:

Mode	Description
`1, tta`	Transmutation Trajectory Analysis (TTA)
`2, cram`	Chebyshev Rational Approximation Method (CRAM)

The CRAM order parameter can only be given when choosing the CRAM mode. The possible settings for CRAM order are:

CRAM order
`2`
`4`
`6`
`8`
`10`
`12`
`14`
`16`
`-16`
`-48`

Notes:

The default setting for the burnup calculation mode is CRAM.
Default value for the CRAM order is 14 resulting in order 14 PFD CRAM.
Negative values of CRAM order mean using IPF form of CRAM with order of the absolute value of the parameter.
Positive values refer to PFD form of CRAM.
Decay calculations (see dep (depletion history)) and burnup calculations with very low flux are always calculated with TTA disregarding this input before version 2.1.32.
Positive values of SSD enforce usage of CRAM with given number of substeps.

set ccmaxiter

set ccmaxiter NITER

Sets the maximum number of coupled calculation iterations. Input values:

NITER : number of iterations.

Notes:

Default maximum number of iterations is 1 (no iteration).
The iteration is stopped when either the maximum number of iterations or the maximum active neutron population (set with set ccmaxpop) has been simulated.
See Coupled multi-physics calculations for further information.

set ccmaxpop

set ccmaxpop CPOP

Sets the maximum total live population to simulate in a coupled calculation. Input values:

CPOP : total active population to simulate.

Notes:

Default maximum population is INFTY/1e6.
The iteration is stopped when either the maximum number of iterations (set with set ccmaxiter) or the maximum active neutron population has been simulated.
Only the population simulated during active cycles is included in this amount.
This is mostly useful if the neutron population per iteration is not constant.
See Coupled multi-physics calculations for further information.

set cfe

set cfe LN [ TN LG TG ]

Defines the minimum mean distance for scoring the collision flux estimator (CFE) for photons and neutrons. Input values:

`LN`	: minimum mean distance for scoring the CFE for neutrons
`TN`	: minimum mean time interval for scoring the CFE for neutrons
`LG`	: minimum mean distance for scoring the CFE for photons
`TG`	: minimum mean time interval for scoring the CFE for photons

Notes:

The use of delta-tracking necessitates the use of CFE for scoring the integral reaction rates. The scoring is based on both real and virtual collision to improve the statistics in low density regions (and short time intervals).
The minimum mean distance is the statistical mean-free-path (mfp) of collisions that contribute to the CFE. Collisions are more frequent if the physical mfp is shorter.
In time-dependent simulations it may be more convenient to define the minimum mean time between two collisions, to get sufficient statistics for short time bins.
The default minimum mean scoring distance is 20 cm for both neutrons and photons. Adjusting the distance affects both statistics and running time, but it should be noted that no studies have been performed on what the optimal value should be.
Only one criterion can be provided for each particle type. If distance is given, time must be set to -1 and vice versa.
For more information on tracking modes and CFE, see the detailed descriptions on delta- and surface-tracking and result estimators.
The collision flux estimator in Serpent is described in an article in Annals of Nuclear energy from 2017.^[2]
In version 2.1.27 and earlier the name of this input option was "set minxs".

set cmm

set cmm OPT

Sets calculation of diffusion coefficients using the cumulative migration method (CMM) on or off. Input values:

OPT : option to switch CMM calculation on (1/yes) or off (0/no)

Notes:

Calculation of diffusion coefficients using CMM might take considerable time. This option allows switching the calculation off if the data is not needed.
The calculation of CMM diffusion coefficients was revised in version 2.1.31 so that the calculated values may be different than with previous versions.
CMM diffusion coefficients can be calculated also when using implicit capture reactions beginning from version 2.1.31.
CMM diffusion coefficients are reasonable only when they are calculated over entire geometry.
- This means that e.g. pin cell diffusion coefficients can not be calculated from a 2D fuel assembly calculation.
- One may try to approximate the CMM diffusion coefficients with TRC diffusion coefficients with transport correction for hydrogen for light water reactor applications.
Using private result array may be recommended when CMM diffusion coefficients are calculated.

set coefpara

set coefpara FMT [ PARAM₁ PARAM₂ ... ]

Defines the parameters included in the separate group constant output file. Input values:

`FMT`	: output format, currently used for including or excluding statistical errors (0 = not included, 1 = included)
`PARAM_n`	: list of parameters or detectors included in the file

Notes:

The group constant output file [input].coe is produced when the automated burnup sequence is invoked.
The available parameters are listed under homogenized group constants in the description of the [input]_res.m output file.
Detectors are identified by the name assigned to them in the detector card.

set comfile

set comfile INFILE OUTFILE

Defines the communication files used in the file-based coupled calculation communications. Input values:

`INFILE`	: Path to inwards communication file (signals to Serpent).
`OUTFILE`	: Path to outwards communication file (signals from Serpent).

Notes:

Setting up a communication mode will enable the coupled calculation mode.
For more information see: External coupling

set confi

set confi OPT

Sets confidentiality flag on or off. Input values:

OPT : option to set confidentiality flag on (1/yes) or off (0/no)

Notes:

This option can be used to label calculations as confidential. If the option is set, text "(CONFIDENTIAL)" is printed in the run-time output next to the calculation title and the value of variable CONFIDENTIAL_DATA in the [input]_res.m output file is set to 1.

set coverxlib

set coverxlib LIB₁ [ LIB₂ LIB₃ ... ]

Sets COVERX-format multi-group covariance data file paths. Input values:

LIB_n : file paths to multi-group covariance data files in the COVERX format (ASCII or binary)

Notes:

If covariance data is linked when running Sensitivity calculations, Serpent will automatically apply the sandwich rule using the calculated sensitivity vectors and propagate the covariance data to uncertainties of the sensitivity responses.

set cpd

set cpd DEPTH [ N_Z Z_MIN Z_MAX ]

Sets on the calculation of lattice-wise power distributions to output file [input]_core0.m on. Input values:

`DEPTH`	: The number of levels included. 1 is the first lattice calculated from universe 0 usually corresponding to assembly-wise distribution. 2 includes the first two levels usually corresponding to the assembly- and pin-wise distributions.
`N_Z`	: Number of equal sized axial bins into which the lattices are divided.
`Z_MIN`	: Minimum z-coordinate for the axial division.
`Z_MAX`	: Maximum z-coordinate for the axial division.

Notes:

The default values for N_Z, Z_MIN and Z_MAX are 1, -INFTY and INFTY, respectively.

set cpop

set cpop NPG NGEN NSKIP [ NSKIP2 ]

Sets parameters for simulated neutron population for corrector neutron transport solutions in burnup calculation. Typically used with the SIE burnup scheme. Input values

`NPG`	: number of neutrons per generation
`NGEN`	: number of active generations
`NSKIP`	: number of inactive generations
`NSKIP2`	: number of inactive generations on further iterations for the same burnup point

Notes:

As the SIE burnup scheme executes the corrector step multiple times for each burnup step, combining the results from each iteration, it may be a good idea to run more iterations with less active neutron histories per iteration.

set csw

set csw FILE

Writes source points in criticality source simulation into a file. Input values:

FILE : file name where the source points are written

Notes:

Only source points from active cycles are included.

set dbrc

set dbrc E_min E_max NUC₁ [ NUC₂ ... ]

Enables the use of doppler-broadening rejection correction (DBRC). Input values:

`E_min`	: Minimum energy for DBRC
`E_max`	: Maximum energy for DBRC
`NUC_n`	: Nuclide identifiers for which to apply DBRC to, with 0 K cross section data, e.g. "92238.00c"

Notes:

This description is not complete.
Use of DBRC requires 0 K cross section data.
See also Section 5.6 of Serpent 1 User Manual.
This input could be given without any nuclides before version 2.1.32. Then DBRC was not used at all.

set dd

set dd MOD

Invokes domain decomposition. Input values

MOD : decomposition mode (0 = none, 1 = simple, 2 = sector, 3 = sector + center)

Notes:

Domain decomposition works in MPI mode by separating burnable materials into different parallel tasks.
Number of domains is given by the number of MPI tasks
Only burnable materials separated into depletion zones using the "div sep" option are decomposed
MOD = 1 decomposes the geometry based on the automatically assigned depletion zone indexes (not recommended).
MOD = 2 decomposes the zones into sectors and MOD = 3 adds a central zone if the number of domains is greater than 4.
Decomposed materials are plotted in domain-specific colors (unless the rgb option in the material card is used)
See practical example for more information.

set declib

set declib LIB₁ [ LIB₂ LIB₃ ... ]

Sets the decay data library file paths. Input values:

LIB_n : library file paths

Notes:

Decay libraries are standard ENDF format files containing decay data.
If the file path contains special characters it is advised to enclose it within quotes.
A default directory path can be set by defining environment variable SERPENT_DATA. The code looks for decay data files in this path if not found at the absolute.

set decomp

set decomp OPT [ ELEM₁ ELEM₂ ... ]

Decomposes elemental entries in material cards into isotopes. Input values:

`OPT`	: option to include (1) or exclude (0) elements from decomposed list
`ELEM_n`	: element names

Notes:

Elemental entries are identifed from zero A in ZA.
The decomposition is based on built-in isotope fractions.
If the list is not provided, all elemental entries are decomposed.

set delnu

set delnu OPT

Sets delayed neutron emission on or off. Input values:

OPT : option to switch delayed neutron emission on (1/yes) or off (0/no)

Notes:

Delayed neutron emission is on by default in neutron criticality source and off by default in external source simulation mode.
See separate description of physics options in Serpent for differences to other codes.

set depmtx

set depmtx MODE

Print burnup matrixes to depmtx_[mat][step].m file during burnup calculation.

MODE : Set printing on (1/yes) or off (0/no).

Notes:

With non-constant predictor, this option will stop the simulation up to version 2.1.31.
With multiple substeps, only the last one is kept after the simulation up to version 2.1.31.

set depout

set depout MODE

Controls which burnable material compositions are printed into the [input]_dep.m output file in case of divided materials. Input values:

MODE : value indicating, which materials to output to the [input]_dep.m file (1 = only partials, 2 = only parents, 3 = both)

Notes:

Parent materials refer to materials defined by mat cards, and partials to depletion zones created automatically using the div card.
Default is 2 (only parents).

set dfsol

set dfsol MODE [ DC NP ]

Options for homogeneous diffusion flux solver. Input values:

`MODE`	: boundary conditions for solver (1 = include net currents at boundary surfaces and corners, 2 = include only surface currents)
`DC`	: type of diffusion coefficient used in the calculation (1 = INF_DIFFCOEF, 2 = TRC_DIFFCOEF)
`NP`	: number of points for trapezoidal integration for homogeneous flux

Notes:

This input option is used to control how the deterministic diffusion flux solver used to obtain assembly discontinuity factors (set adf) and pin power distributions (set ppw) is run.
Default mode is 1 (include both surfaces and corners in solution).
Default diffusion coefficient is INF_DIFFCOEF, option 2 requires the set trc option.
Default number of points for trapezoidal integration is 100.
See also separate description of the built-in diffusion flux solver.
The format was revised in update 2.1.27 (DC option was added between MODE and NP).

set dix

set dix OPT

Sets double indexing for cross section energy grid look-up on or off:

MODE : option to set double indexing on (1/yes) or off (0/no)

Notes:

Double indexing^[3] is a method to speed-up the cross section look-up when energy grid unionization is not used for microscopic data.
The method can be used only in optimization modes 1 and 3 (modes 2 and 4 are based on energy grid unionization).

set dynsrc

set dynsrc PATH [ MODE ]

Links previously generated steady state source distributions to be used in a transient simulation with delayed neutron emission.

`PATH`	: The path of the previously generated source file (without the `.main` suffix)
`MODE`	: Precursor tracking mode (0 = mesh based, 1 = point-wise)

Notes:

Four source files will be required PATH.main, PATH.prec, PATH.live and PATH.precpoints

set dt

set dt NTRSH [ GTRSH ]

Sets probability threshold for delta-tracking. Input values:

`NTRSH`	: probability threshold for neutrons
`GTRSH`	: probability threshold for photons

Notes:

Serpent uses delta-tracking by default for both neutrons and photons, but switches to surface-tracking if the probability of sampling virtual collisions (ratio between material total cross section and the majorant) exceeds the given threshold.
Default probability threshold for both particle types is 0.9, i.e. delta-tracking is used if the ratio between total cross section and majorant is above 0.1.
set dt 1 means that delta-tracking is always used and set dt 0 that it is never used.
Use of delta-tracking can be enforced or blocked in individual materials using the set forcedt and set blockdt options
Integral reaction rates are scored using the collision estimator of neutron flux, which has a few adjustable parameters (see set cfe).
For more information on tracking modes, see the detailed description on delta- and surface-tracking.

set ecut

set ecut EMIN_n EMIN_p

Sets minimum energy cut-off for neutrons and photons. Input values:

`EMIN_n`	: cut-off energy for neutrons (MeV)
`EMIN_p`	: cut-off energy for photons (MeV)

Notes:

The default cut-of energy for photons is 1 keV. Neutron energy cut-off is switched off by default.
Using energy cut-off for neutrons may lead to non-physical results, since fission and up-scattering may not be accurately modeled.
Versions 2.1.27 and earlier include only photon energy cut-off, which is now the second input parameter.

set eddi

set eddi OPT

Switches on the calculation of Eddington factors. Input values:

OPT : option to switch calculation on (1) or off (0)

Notes:

Requires group constant generation to be set on.

set edepdel

set edepdel OPT [ LOCAL_EGD ]

Option to include the energy of delayed components in energy deposition calculations. Input values:

`OPT`	: include (1) or exclude (0) the energy of delayed components in energy deposition estimates
`LOCAL_EGD`	: deposit the energy of the delayed fission gammas to fission sites (1) or with the same distribution as the prompt fission gammas (0) (this option is used only in energy deposition mode 3)

Notes:

Delayed components include delayed neutrons, delayed fission gammas and delayed betas.
The energy of delayed neutrons can be excluded using this option only in energy deposition mode 1.
The energy of the delayed components is deposited at the time of fission so the time dependence of the energy deposition is not accounted for properly in transient simulations.
Default options are to include delayed components (1) and to deposit the energy of the delayed fission gammas with the same distribution as the prompt fission gammas (0).

set edepkcorr

set edepkcorr OPT

Option to apply correction for energy deposition estimates when simulating non-critical systems with criticality source mode. Input values:

OPT : apply (1) or do not apply (0) correction

Notes:

The methodology is described in related paper. ^[4]

set edepmode

set edepmode MODE [ E_CAPT ]

Sets energy deposition mode for energy deposition calculations. Input values:

`MODE`	: energy deposition mode (0, 1, 2 or 3)
`E_CAPT`	: additional energy release in capture reactions given in MeVs per fission (used only in energy deposition mode 1)

Notes:

The energy deposition modes are described in related paper. ^[4].
The choice of energy deposition mode affects also the normalization of the results, if normalization to total power or power density is used.
Energy deposition modes 1, 2 and 3 require data which is not available in the standard ACE-format cross section files used by Serpent. Separately distributed ACE-files containing additional data are required to use these modes.
Default option is 0 which corresponds to the methodology used before version 2.1.31.

set egrid

set egrid TOL [ EMIN EMAX ]

Sets the unionized energy grid reconstruction parameters. Input values:

`TOL`	: fractional reconstruction tolerance
`EMIN`	: minimum energy in the grid (MeV)
`EMAX`	: maximum energy in the grid (MeV)

Notes:

The default fractional reconstruction tolerance is 0.0 in transport calculation mode and 5E-5 in burnup calculation mode.
A higher energy grid reconstruction tolerance means lower memory consumption and possibly higher computation speed but also reduced accuracy of the calculation.
The default minimum energy is 1E-11 MeV.
The default maximum energy is 20.0 MeV.
See also Section 5.3 of Serpent 1 User Manual.

set entr

set entr N_X N_Y N_Z [ X_MIN X_MAX Y_MIN Y_MAX Z_MIN Z_MAX ]

Defines the mesh structure used for calculating fission source entropy. Input values:

`N_X`	: number of mesh cells in x-direction
`N_Y`	: number of mesh cells in y-direction
`N_Z`	: number of mesh cells in z-direction
`X_MIN`	: minimum mesh boundary in x-direction
`X_MAX`	: maximum mesh boundary in x-direction
`Y_MIN`	: minimum mesh boundary in y-direction
`Y_MAX`	: maximum mesh boundary in y-direction
`Z_MIN`	: minimum mesh boundary in z-direction
`Z_MAX`	: maximum mesh boundary in z-direction

Notes:

Shannon entropy is used to monitor fission source convergence by recording the distribution of source points on mesh.
The calculation is invoked by setting the generation history record option on (set his).
The default mesh size is 5x5x5, extending over the entire geometry.
Monitoring fission source convergence make sense only in criticality source mode.
For more information, see detailed description on fission source convergence.

set fininitfile

set fininitfile FILEPATH

Links a file containing an initial fuel behavior solution used as a starting point for a coupled calculation with the FINIX fuel behavior module. Input values:

FILEPATH : path to the file

Notes:

The file should be a type 6 fuel behavior interface containing a previous solution from a coupled FINIX calculation.
The axial and radial nodalization as well as the included fuel rods should be the same in the file as in the calculation.

set fissh

set fissh ZAI₁ E₁ ZAI₂ E₂ ...

Overrides default fission heating values. Input values:

`ZAI_n`	: nuclide identifiers (ZAI)
`E_n`	: energy deposited per fission in MeV

Notes:

The energy deposited per fission includes additional energy released in capture reactions when fission neutrons are absorbed.
By default the energy release per U-235 fission is set to 202.27 MeV, and the values for other actinides scaled based the Q-values found in the cross section libraries.
See also set U235H.
See also Section 5.8 of Serpent 1 User Manual.

set forcedt

set forcedt MAT₁ MAT₂ ...

Defines the list of materials where delta-tracking is always used. Input values:

MAT_n : material names

Notes:

This option is used to override selection of tracking mode based on the probability threshold (see set dt) in individual materials.
Use of delta-tracking can be blocked in individual materials using set blockdt.
For more information on tracking modes, see the detailed description on delta- and surface-tracking.
Note to developers: should have different lists for neutrons and photons?

set fpcut

set fpcut FPCUT

Fission product yield cut-off FPCUT acts on cumulative fission yields, and the given number is the lower limit for the maximum cumulative yield in each mass chain. So "set fpcut 1E-2" means that every mass chain (nuclides with same mass number) with all cumulative yields below 1% are discarded from the calculation.

The cut-off is set to zero by default. Setting the FPCUT cut-off to a higher value (~1E-4 or so) is an effective way to reduce the number of nuclides in the calculation, but at some point it will start affecting the results.

set fsp

set fsp OPT NSKIP

Sets fission source passing between two transport simulations in burnup or coupled calculation. The fission source at the end of one transport calculation is used as the initial source for the next transport calculation.

`OPT`	: option to switch fission source passing on (1/yes) or off (0/no)
`NSKIP`	: number of inactive generations on subsequent steps

Notes:

Fission source passing is turned off by default.
Number of inactive generations is taken from set pop card on the first step and from set fsp on all later steps.

set fum

set fum ERG [ BTCH MODE LIM ]

set fum ERG [ BTCH MODE LIM TGT ITER INIT ]

set fum ERG [ BTCH MODE DIFF LIM TGT ITER INIT ]

Activates fundamental mode calculation for collapsing intermediate multi-group constant data into few-group constants with a critical spectrum.

`ERG`	: Intermediate multi-group structure for calculation of the leakage-corrected critical spectrum
`BTCH`	: When set to 2, results are averaged over all criticality cycles
`MODE`	: Critical spectrum calculation type (default 0, i.e. old B₁ calculation)
`DIFF`	: Multi-group diffusion coefficients to be used with FM fundamental mode calculation (default value INF_DIFFCOEF). This value is not read with other modes.
`LIM`	: Convergence criterion of k_eff in fundamental mode calculation calculated as the absolute value difference of k_eff between successive iterations (default value 1E-7)
`TGT`	: Target value for fundamental mode k_eff (default value 1.0, not used with the old B₁ calculation mode)
`ITER`	: Maximum number of fundamental mode calculation iterations (default value 25, not used with the old B₁ calculation mode)
`INIT`	: First guess for absolute value of critical B² (default value 1E-6, not used with the old B₁ calculation mode)

The possible values for mode are:

Mode	Description
`o, O, 0`	Old B₁ calculation (use the same method as before version 2.1.31)
`b, B, 1`	New B₁ calculation
`p, P, 2`	P₁ calculation
`f, F, 3`	FM calculation

The possible values for FM mode multi-group diffusion coefficients are:

Mode	Description
`1`	Use out-scattering diffusion coefficients
`2`	Use transport corrected diffusion coefficients
`3`	Use cumulative migration method diffusion coefficients

Notes:

When invoked, Serpent applies a fundamental mode leakage correction on group constants and produces a second set of output parameters.
Before version 2.1.31, the mode parameter was not read, and the old B₁ calculation mode was always used regardless of the parameter given here.
The group constants are named with B1_ prefix, but they are calculated with fundamental mode calculation type defined with the mode parameter.
The multi-group structure may be an energy grid defined using the ene card or a name of a pre-defined energy group structure.
Setting the fundamental mode calculation overrides the default 70-group structure used for macroscopic data calculation in infinite spectrum.
Averaging the results over all cycles may improve convergence and speed up the calculation, but all information on statistical errors is lost.
This option does not effect the flux spectrum used during burnup calculations.
The calculation modes other than the old B₁ calculation mode were added in version 2.1.31.
The descriptions of the other methods than the old B₁ method will be presented later in a publication.
Note that in general the intermediate multi-group structure should have more groups than the few-group structure to get reasonable results for leakage corrected group constants and out-scatter diffusion coefficients.

set gbuf

set gbuf FAC [ BNK ]

Sets the size of photon buffer and event bank. Input values:

`FAC`	: factor (> 1) defining the buffer size
`BNK`	: event bank size

Notes:

Photon buffer refers to pre-allocated memory block used to store photon particle data. This memory is needed for putting secondary photons in que, etc..
The buffer factor defines the buffer size relative to simulated batch size.
The event bank refers to pre-allocated memory block used to store history data on particle events. This bank is used only with certain special options, such as importance detectors and track plotter.
The default values depend on simulation mode, and there is no need to adjust the values unless the calculation terminates with an error.
Note to developers: event bank is now the same for both neutrons and photons.

set gcu

set gcu UNI₁ [ UNI₂ UNI₃ ... ]

Sets the universes for group constant generation. Input values:

UNI_n : universe where group constants are generated or -1 to switch group constant generation off.

Notes:

Group constants are by default generated in the root universe (universe 0).
Group constant generation should be switched off when the results are not needed (this may speed up the calculation).
See separate description of output parameters.
Super-imposed group constant generation universes (i.e. not part of the geometry definition) should not be used so that they cover (partly or totally) the same geometry region as some other group constant generation universe (super-imposed or part of the geometry definition), if group constants are generated only on a single geometry level.

set gcut

set gcut GMAX

Sets generation cut-off for neutrons. Input values:

gmax : number of simulated generations before cut-off

Notes:

The generation cut-off can be used in neutron external source simulations, to limit the length of fission chains.
Applicable only to neutron external source simulation (invoked using set nps)
Generation or time cut-off (set tcut) is always needed for neutron external source simulations in super-critical systems.

set his

set his OPT

Sets batch history record on or off. Input values:

OPT : option to switch batch history record on (1/yes) or off (0/no)

Notes:

When invoked, Serpent collects batch-wise data on k_eff, fission source entropy etc. and produces a separate output file.
Setting the history option also invokes the calculation of fission source (Shannon) entropy. The entropy mesh parameters can be adjusted using set entr.

set ifp

set ifp GEN

Sets the number of generations to use for calculating the iterated fission probability. Input values:

GEN : Number of generations. Default value 15.

set imp

set imp TYPE r₁ I₁ [ r₂ I₂ ... ]

Defines importances for geometry regions. Input values:

`TYPE`	: type of the region (c = cell, m = material, u = universe)
`r_n`	: region identifier (cell, material or universe name)
`I_n`	: importance

Notes:

Used for variance reduction
Only cell importances supported for now
Requires using surface-tracking (see set dt)

set impl

set impl ICAPT [ INXN INUBAR ]

Sets implicit reaction modes on or off.

`ICAPT`	: option to switch implicit capture reactions on (1/yes) or off (0/no)
`INXN`	: option to switch implicit nxn reactions on (1/yes) or off (0/no)
`INUBAR`	: number of fission neutrons to emit in each fission (nonzero = implicit treatment, 0 = analog treatment)

Notes:

Group constant generation requires implicit nxn reactions to be set on.
If an implicit nubar is given, the weights of the fission neutrons are scaled to conserve the physical number of fission neutrons.
See separate description of physics options in Serpent for differences to other codes.

set inftrk

set inftrk LOOP_n [ ERR_n LOOP_p ERR_p ]

Sets parameters for terminating infinite tracking loops.

`LOOP_n`	: number of neutron tracking loops interpreted as a geometry error
`ERR_n`	: flag to terminate neutron tracking when an infinite loop occurs (0 = no, 1 = yes)
`LOOP_p`	: number of photon tracking loops interpreted as a geometry error
`ERR_p`	: flag to terminate photon tracking when an infinite loop occurs (0 = no, 1 = yes)

Notes:

Serpent checks for tracking loop length to avoid simulation being stuck in an infinite loop. The simulation is terminated by default if no material is found after the particle has been moved forward 1000000 times.
Long loops can occur by chance in complicated geometries, and this parameter allows continuing the simulation without terminating with error message.
Even if the problem can be solved by switching the infinite loop error off, it is advised to check the geometry for possible errors.

set inventory

set inventory MAT₁ MAT₂ ...

set inventory top N PARA

Specifies which nuclides or elements to include in the [input]_dep.m output file. Input values:

`MAT_n`	: Nuclide or element to include
`N`	: Number of nuclides
`PARAM`	: Parameter name

Notes:

MAT can be: an isotope, element, or a special entry.
Isotopes are entered using element symbol and mass number (e.g U-235, Am-242m, etc.) or ZAI (922350, 952421, etc.). In the ZAI format the last digit refers to the isomeric state (0 = ground state, 1 = isomeric state).
Elements are entered using symbol or numerical (U, 92, etc.). The output includes the sum over all isotopes.
Special entries include:
- "all" -- All nuclides.
- "accident" -- Nuclides with significant health impact & high migration probability in accident conditions. Source Chernobyl: Assessment of Radiological and Health Impact
- "actinides" -- Actinides (Z>88) for which cross section data are found in JEFF-3.1.1
- "burnupcredit" -- Nuclides commonly considered in burnup credit criticality analyses for PWR fuels [1]
- "burnupindicators" -- Burnup indicators (commonly measured from spent fuel) [2]
- "cosi6" -- Inventory list used by the COSI6 code (excluding lumped fission products)
- "lanthanides" -- Lanthanides (56<Z<72) for which cross section data are found in JEFF-3.1.1
- "longterm" -- Relevant radionuclides in long-term waste analyses ^[5]
- "minoractinides" -- Minor actinides (actinides - thorium - uranium - plutonium) for which cross section data are found in JEFF-3.1.1
- "fp" -- Fission products
- "dp" -- Actinide decay products
- "ng" -- Noble gases
The second syntax allows listing the most significant contributors to a given result. The parameters are:
- "mass" -- contribution to mass fraction
- "activity" -- contribution to activity
- "sf" -- contribution to spontaneous fission rate
- "gsrc" -- contribution to gamma emission rate
- "dh" -- contribution to decay heat
- "ingttox" -- contribution to ingestion toxicity
- "inhtox" -- contribution to inhallation toxicity
for example "top 10 dh" gives the top 10 contributors to decay heat.
Since most significant contributors may change over time, the output may contain more nuclides than is requested in the input card.
The calculation of top contributors does not work with the "-rdep" command line option.

set isobra

set isobra ZAI₁ MT₁ FG₁
           ZAI₂ MT₂ FG₂
           ...

Defines constant branching ratios to isomeric states. Input values:

`ZAI_n`	: nuclide identifiers (ZAI)
`MT_n`	: ENDF reaction MT
`FG_n`	: fraction of reactions leading to the ground state of the product nuclide

Notes:

Serpent uses constant branching ratios by default. This option overrides the default values.
Energy-dependent data read read from ENDF format files defined by the set bralib overrides the constant ratios.

set iter nuc

set iter nuc CYCLES KEFF N_ZAI ZAI₁ ZAI₂ ... ZAI_{N_ZAI} [ N_MAT MAT₁ MAT₂ ... MAX_{N_MAT} ]

`CYCLES`	: number of additional inactive cycles to run for the convergence of the iteration
`KEFF`	: target k_eff for the iteration
`N_ZAI`	: number of different nuclides (ZAI) included in the iteration
`ZAI_i`	: the ZAI of the nuclide to be included in the iteration (e.g. 50100 for boron 10 ground state)
`N_MAT`	: number of different materials included in the iteration (optional parameter)
`MAT_i`	: the name of the material to be included in the iteration

Notes:

If a list of materials is not given, all materials that contain the included nuclides are included in the iteration.
The initial density of the nuclides to be iterated should be larger than zero.
The critical density iteration only works for nuclides that have a reactivity effect mainly through neutron absorption.
- Specifically, critical densities of fissile, moderating or reflecting nuclides cannot be reliably iterated using this card.
The atomic density of the nuclides is updated according to the batching interval set in the set pop option.
- Having a large batching interval means that the atomic density may take a large number of cycles to converge.

See Critical density iteration.

set keff

set keff K_EFF

Option to scale fission neutron production in external source simulations.

K_EFF : The k-effective to use for scaling the fission neutron production. Inverse of K_EFF will be used as a multiplicative constant for the nubar, i.e. a value of 2.0 will cut the fission neutron production in half. Default value is 1.

Notes:

Affects both prompt and delayed neutron production from fissions.
In versions prior to 2.1.31: does not affect delayed neutron precursor production, which will cause unexpected behaviour in Transient simulations that track delayed neutron precursor concentrations.

set lost

set lost LIM

Option to treat undefined geometry regions as void. Input values:

LIM : maximum number of collisions allowed in undefined regions or -1 if no limit is set.

Notes:

This option allows the calculation to proceed even if the geometry routine encounters undefined cells.
The option is intended, for example, for complex geometries in which the boundaries of adjacent cells may not fully coincide.
When the option is set, the number of lost particles is printed in variable LOST_PARTICLES in the [input]_res.m output file.
The option should not be used to get away with errors in incomplete or poorly defined geometries.

set maxsplit

set maxsplit MAX MIN

Sets limiting values for splitting and Russian roulette. Input values:

`MAX`	: maximum number of splits
`MIN`	: minimum survival probability in Russian roulette

Notes:

Used with weight-windows (see weight window mesh definition).

set mbtch

set mbtch N

Adjusts the batch used with MPI data transfer. Input values:

`N`	: batch size in double floats (8 bytes)

Notes:

The batch size determines the division of data blocks in MPI data transfer. The value may have some effect on parallel performance.
The batch size is set to 10000 by default.

set mcvol

set mcvol NP

Runs the Monte Carlo volume-checker routine to set material volumes before running the transport simulation. Input values:

`NP`	: number of points sampled in the geometry

Notes:

The Monte Carlo based volume calculation routine works by sampling random points in the geometry, and counting the number of hits in every material.
When invoked, all material volumes are overridden by the results given by the checker routine.
The volume checker can also be used to produce a separate input file for the volume entries (see detailed description on defining material volumes).

set mdep

set mdep UNI VOL N MAT₁ MAT₂ ... MAT_N 
         ZAI₁ MT₁
         ZAI₂ MT₂
         ...

Sets parameters for calculating homogenized microscopic cross sections. Input values:

`UNI`	: universe where spatial homogenization is performed
`VOL`	: volume of the homogenized zone
`N`	: number of materials included in the calculation
`MAT₁ MAT₂ ... MAT_N`	: material names
`ZAI_i`	: nuclide identifier (ZAI)
`MT_i`	: ENDF reaction MT

Notes:

When this option is set, Serpent calculates multi-group microscopic cross sections for the listed nuclides and reactions.
The results are printed in a separate output file.
The results can be included in the group constant output by adding MDEP_XS in the set coefpara list.
If the number of materials is zero, the calculation is carried over all burnable materials.
The listed materials must be enclosed inside the homogenized universe.
Transmutation reactions to ground and isomeric states can be calculated by adding 'g' and 'm' after the reaction MT (e.g. 102m is the capture cross section corresponding to daughter nuclide being in isomeric state). Reaction rates are calculated to all states by default.
Fission reactions corresponding to a specific yield in ENDF can be calculated by adding 1, 2, 3, 4, ... after the reaction MT (e.g. 181 is total fission cross section corresponding to first fission product yield) depending on the fission yield data of the nuclide in the data library. This parameter was different before 2.1.32.
Sum of all capture reactions can be obtained using MT 101
Some actinides are missing the total fission channel, and setting the MT to 18 produces sum over MT's 19, 20, 21 and 38 (from version 2.1.29 on).
The nuclide identifiers are entered as ZAI, not ZA. For example, the ZAI for U-235 is 922350 and the ZAI for Am-242m is 952421.
Parameter VOL was VR in versions before 2.1.32 (volume ratio of materials included in micro depletion to total homogenized region).
Multiple set mdep cards can be given for a single homogenization universe.

set micro

set micro ERG [ BTCH ]

Defines the intermediate multi-group structure used for group constant generation.

`ERG`	: Intermediate multi-group structure used for group constant generation
`BTCH`	: When set to 2, results are averaged over all criticality cycles

Notes:

Serpent uses an intermediate multi-group structure to calculate homogenized few-group constants. This input parameter is used to override the default 70-group structure used in the calculation.
The multi-group structure may be an energy grid defined using the ene card or a name of a pre-defined energy group structure.
Averaging the results over all cycles may improve convergence and speed up the calculation, but all information on statistical errors is lost.
Note that in general the intermediate multi-group structure should have more groups than the few-group structure to get reasonable results for leakage corrected group constants and out-scatter diffusion coefficients.

set memfrac

set memfrac FRAC

Defines the fraction of total system memory Serpent can allocate to its use. If the fraction is exceeded, the simulation will abort. This is mainly to avert the use of swap-memory, which can make the system unresponsive. Input values:

FRAC : the fraction of system memory that Serpent is allowed to use (between 0 and 1)

Notes:

The default fraction is 0.8.
The fraction can also be set via a SERPENT_MEM_FRAC environmental variable.
Serpent tries to read the system total memory from the first line of the file /proc/meminfo

set minxs

See set cfe.

set mvol

set mvol MAT₁ ZONE_1,1 VOL_1,1
         MAT₁ ZONE_1,2 VOL_1,2
         ...
         MAT₂ ZONE_2,1 VOL_2,1
         ...

Sets the volumes of material regions. Input values:

`MAT_m`	: name of material m
`ZONE_m,n`	: index of zone n in material m
`VOL_m,n`	: volume of zone n in material m

Notes:

This option is used to define material volumes manually. The input card is also produced when the Monte Carlo based volume checker routine is invoked.
The zone index is related to automated depletion zone division, invoked by the div card. If no division is used, the index must be set to zero for non-burnable materials. For burnable materials the indexing starts from 1. If no division is used, the corresponding index can be found using the Monte Carlo based volume checker routine.
Another option to define material volumes is to use the vol entry in the material card.
For more infomation, see detailed description on the definition of material volumes.

set nbuf

set nbuf FAC [ BNK ]

Sets the size of neutron buffer and event bank. Input values:

`FAC`	: factor (> 1) defining the buffer size
`BNK`	: event bank size

Notes:

Neutron buffer refers to pre-allocated memory block used to store neutron particle data. This memory is needed for banking fission neutrons for the next generation and putting secondary neutrons in que.
The buffer factor defines the buffer size relative to simulated batch size.
The event bank refers to pre-allocated memory block used to store history data on particle events. This bank is used only with certain special options, such as importance detectors and track plotter.
The default values depend on simulation mode, and there is no need to adjust the values unless the calculation terminates with an error.
Note to developers: event bank is now the same for both neutrons and photons.

set nfg

set nfg ERG

Defines the few-group structure used for group constant generation.

ERG : Few-group structure used for group constant generation

Notes:

The few-group structure may be an energy grid defined using the ene card or a name of a pre-defined energy group structure.
The default is a two-group structure with boundary between fast and thermal group set to 0.625 eV.
Serpent uses an intermediate multi-group structure in the calculation. The default structure consists of 70 groups, and can be changed using the set micro or set fum options.
Note that in general the intermediate multi-group structure should have more groups than the few-group structure to get reasonable results for leakage corrected group constants and out-scatter diffusion coefficients.
The few-group structure must be a sub-set of the intermediate multi-group structure.
See also: group constant output.
The few-group structure will also be used for example for assembly discontinuity factors and albedos.

set nfylib

set nfylib LIB₁ [ LIB₂ LIB₃ ... ]

Sets the neutron-induced fission yield library file paths. Input values:

LIB_n : library file paths

Notes:

Fission yield libraries are standard ENDF format files containing neutron-induced fission yield data.
If the file path contains special characters it is advised to enclose it within quotes.
A default directory path can be set by defining environment variable SERPENT_DATA. The code looks for fission yield data files in this path if not found at the absolute.

set ngamma

set ngamma MODE WMIN NMAX

Sets the coupled neutron-photon transport simulation on. Input values:

`MODE`	: simulation mode (0 = off, 1 = analog, 2 = implicit)
`WMIN`	: weight limit for implicit mode
`NMAX`	: maximum number of emitted photons in implicit mode

Notes:

This input card invokes the production of prompt gammas in neutron reactions. The coupled simulation mode requires that both neutron and photon data libraries are defined.
In analog mode, the average number of secondary photons produced per collision is defined by the ratio of photon production cross section to material total. Each emitted photon assumes the weight of the incident neutron.
The implicit mode can be used to produce more photons by allowing variation in their statistical weight. The weight limit defines the minimum allowed weight of emitted photons. This method is close to what is used in MCNP.
Both calculation modes produce photons in all collisions without any correlation to the sampled reaction mode.
The MODE option was incorrectly described until Dec. 12, 2017.

set nphys

set nphys FISS [ CAPT SCATT ]

Option to set reaction modes for neutrons on and off. Input values:

`FISS`	: option to handle fission (0 = not handled, 1 = handled)
`CAPT`	: option to handle capture (0 = not handled, 1 = handled)
`SCATT`	: option to handle scattering (0 = not handled, 1 = handled)

Notes:

All reaction modes are handled by default.
If fission is switched off, it is handled as capture.

set nps

set nps PP [ BTCH TBI ]

Sets parameters for simulated particle population in external source mode. Input values:

`PP`	: total number of particles
`BTCH`	: number of batches
`TBI`	: time binning for dynamic mode

Notes:

The total number of particles is divided by the given number of batches to give the number of particles per batch.
Default number of batches is 200.
Using the nps card sets the mode to external source simulation. Criticality source simulation for neutrons is invoked using set pop.
If time binning is provided, the simulation is run in the dynamic mode with sequential population control. The bin structure is defined using the tme card.
Running an external source simulation requires a source, defined by the src card. Source definition also sets the transported particle type.
Neutron external source simulations are limited to sub-critical systems, unless dynamic mode, time cut-off (set tcut) or generation cut-off (set gcut) is invoked.
Neutron external source simulations in multiplying systems may require adjusting the neutron buffer (set nbuf).
Delayed neutron emission is switched off by default in neutron external source simulation (for compatibility with MCNP). Delayed neutrons can be included with set delnu.
In transient simulations, where an initial transient source is linked using the set dynsrc option, PP particles are sampled for each time interval.

set opti

set opti MODE

Sets the optimization mode which affects the performance and memory usage. Input values:

MODE : optimization mode

The possible settings for mode are:

Mode	Description
`1`	Minimum optimization and small memory usage. Suitable for very large burnup calculation problems involving tens or hundreds of thousands of depletion zones.
`2`	Good performance in burnup calculations involving several thousand depletion zones. Suitable for research reactor applications, but not the best choice for group constant generation.
`3`	Similar to mode 4, but lower memory demand. CPU time required by burnup and processing routines increases steeply along with the number of depletion zones, which makes the mode better suited for small burnup calculation problems.
`4`	Maximum performance at the cost of memory usage. Suitable for group constant generation and 2D assembly burnup calculations with a limited number of depletion zones.

Notes:

Default value for the optimization mode is 4.
The mode 4 is essentially the same as the methodology in Serpent 1.
The methodology is described in a paper presented in PHYSOR 2012^[6].

set outp

set outp INT

Sets the interval (in cycles) for writing simulation output to files. Input values:

INT : number of cycles after which the output-files are updated

Notes:

Default value is 50.
In coupled transient simulations the interval refers to time steps rather than batches. By default, the output is written after every 50th time step.
Affects files such as [input]_res.m and [input]_det.m as well as mesh plots.

set pcc

set pcc MODE [ SSP SSC ]

Sets the time integration method in burnup calculation. Input values:

`MODE`	: time integration method
`SSP`	: number of substeps for predictor steps
`SSC`	: number of substeps for corrector steps

The possible settings for mode are:

Mode	Predictor method	Corrector method
`0, CE`	Constant extrapolation	-
`1, CELI`	Constant extrapolation	Linear interpolation
`2, LE`	Linear extrapolation	-
`3, LELI`	Linear extrapolation	Linear interpolation
`4, LEQI`	Linear extrapolation	Quadratic interpolation
`6, CECE`	Constant extrapolation	Constant backwards extrapolation

Notes:

Mode 0 is also known as "Euler's method".
Mode 1 is also known as the "old predictor-corrector method".
Modes 0 and 1 without substeps corresponds to the methods used in Serpent 1.
The default numbers of predictor and corrector substeps are 1 for applicable methods.
Number of substeps could not be given for constant predictor or corrector before 2.1.32.
Decay calculations were always calculated with single substep disregarding this input before 2.1.32.
The first burnup step extrapolation is always constant and with only single substeps before 2.1.32.

set pdatadir

set pdatadir DIR

Sets the file path for auxiliary photon data. Input values:

DIR : file path for directory where the data is located

Notes:

Serpent uses auxiliary data files for the modelling of photon interaction physics.
For more information, see instructions on setting up the data libraries.

set poi

set poi OPT [ VOL XE135M ]

Switches the calculation of poison cross sections on or off. Input values:

`OPT`	: option to switch the calculation of poison cross sections on (1/yes) or off (0/no)
`VOL`	: volume of the homogenized zone
`XE135M`	: option to treat ^135mXe separate from ground state ¹³⁵Xe (0 = lumped with ¹³⁵Xe, 1 = separate treatment)

Notes:

Poison cross sections include the fission yields and microscopic and macroscopic absorption cross sections of fission product poisons ¹³⁵Xe and ¹⁴⁹Sm, as well as their precursors. The data is part of the homogenized group constant output.
The calculation requires setting the decay and fission yield library file paths.
The calculation requires the material volumes to be correctly set.
The volume is required for calculating microscopic absorption cross sections matching macroscopic absorption cross sections with poison nuclide densities smeared to the homogenization volume.
Separate treatment for ^135mXe requires cross sections for this isotope.
Parameter VOL was VR in versions before 2.1.32 (ratio of fuel volume to the volume of the homogenized zone).

set pop

set pop NPG NGEN NSKIP [ K0 BTCH NEIG ]

Sets parameters for simulated neutron population in criticality source mode. Input values:

`NPG`	: number of neutrons per generation
`NGEN`	: number of active generations
`NSKIP`	: number of inactive generations
`K0`	: initial guess for k_eff
`BTCH`	: batching interval (default value is 1 generation per batch)
`NEIG`	: number of independent parallel eigenvalue calculations (default is 1)

Notes:

The simulation is first run for a number of inactive generations to allow the fission source to converge. This is followed by a number of active generations, during which the results are collected. The statistics are divided in batches, and by default each generation forms its own batch.
Using the pop card sets the mode to criticality source simulation. External source simulation is invoked using set nps.
Convergence of fission source can be monitored using Shannon entropy (input parameters set his and set entr).
Initial guess for k_eff is 1.0 by default. Setting the value manually may get the simulation going if it terminates on the first generation because of poor initial guess. The value does not affect fission source convergence.
See detailed descriptions on fission source convergence and statistical effects of batching.
The number of neutrons per generation also affects the memory usage of the code together with set nbuf.

set power

set power P [ MAT ]

Sets normalization to total fission power

`P`	: fission power (in W)
`MAT`	: material in which the given power is produced

Notes:

Normalization is needed to relate the Monte Carlo reaction rate estimates to a user-given parameter.
If the material name is omitted, the value corresponds to total fission power produced in the system.
Neutron transport simulations are by default normalized to unit total loss rate.
Photon transport simulations are by default normalized to unit total source rate.
For other normalization options, see: set powdens, set flux, set genrate, set fissrate, set absrate, set lossrate, set srcrate, set sfrate.
See also Section 5.8 of Serpent 1 User Manual.

set powdens

set powdens PDE [ MAT ]

Sets normalization to power density

`PDE`	: power density (in kW/g)
`MAT`	: material in which the given power is produced

Notes:

Normalization is needed to relate the Monte Carlo reaction rate estimates to a user-given parameter.
If the material name is omitted, the value corresponds to average power density produced in the system.
Neutron transport simulations are by default normalized to unit total loss rate.
Photon transport simulations are by default normalized to unit total source rate.
For other normalization options, see: set power, set flux, set genrate, set fissrate, set absrate, set lossrate, set srcrate, set sfrate.
See also Section 5.8 of Serpent 1 User Manual.

set ppid

set ppid PID

Defines the external code process identifier (PID) number to be used for communication in the POSIX-based coupled calculation communications. Input values:

PID : Process identifier (PID) of the (parent) process that Serpent should communicate with.

Notes:

Setting up a communication mode will enable the coupled calculation mode.
For more information see: External coupling

set ppw

set ppw UNI LAT

Turns on the calculation of pin powers and pin power form factors. Input values:

`UNI`	: The universe where the pin power distribution is calculated.
`LAT`	: The lattice where the calculation is performed.

Notes:

See separate description of output parameters in the [input]_res.m.
The form factors can be printed to the group constant output with set coefpara.
Calculation of pin power form factors also requires calculation of assembly discontinuity factors using set adf.

set precsrcf

set precsrcf FACTOR

Set number of pointwise precursors to hold in memory in transient simulations. A multiplicative factor for the number of neutrons per batch, i.e. setting FACTOR to 10 when running 1000 neutrons per batch will keep 10000 pointwise precursors in memory.

FACTOR : The factor to multiply the number of neutrons per batch to obtain the number of pointwise precursors to hold in memory.

Notes:

Default value is 10.
The number of pointwise precursors held in memory is controlled to the requested number at time interval boundaries. The physical number of precursors is conserved.
Storing a too low of a number of pointwise precursors can lead to undersampling of certain precursor groups or parts of geometry.

set precthresh

set precthresh THRESHOLD

Set the weight threshold for creating and storing a new delayed neutron precursor in transient simulations.

THRESHOLD : A weight threshold relative to the incoming neutron weight.

Notes:

Default value is 1.
If the weight of the delayed neutron precursor would be below the threshold, Russian roulette is played to either increase the weight to the threshold or not store the precursor at all.
Setting a lower threshold stores more precursors with lower weight whereas a higher threshold stores fewer precursors with higher weight.

set printm

set printm MODE [ FRAC ]

Print material compositions to [input].bumat[step] file during burnup calculation.

`MODE`	: Set printing on (1/yes) or off (0/no).
`FRAC`	: Optional atomic fraction for printing out decay nuclides (nuclides with no transport cross sections). Value 0.0 will print out all decay nuclides, while 1.0 will not print out any decay nuclides. Value `FRAC` will print out nuclides whose atomic fraction in the material is greater than or equal to FRAC.

Notes:

Nuclides without transport data are excluded from the output by default.

set relfactor

set relfactor FAC

Sets the underrelaxation factor for the power relaxation used in coupled multi-physics calculations. Input values:

FAC : underrelaxation factor

Notes:

Setting the underrelaxation factor to 0, disables power relaxation altogether. The power distribution written to the output-files will be unrelaxed and only based on the most recent iteration.

set repro

set repro MODE

Sets the reproducibility mode in parallel calculations. Input values:

MODE : reproducibility mode

The possible settings for mode are:

Mode	Description
`0`	No reproducibility
`1`	Reproducibility with OpenMP parallelization (default value)
`2`	Reproducibility with MPI and hybrid OpenMP / MPI parallelization

Notes:

The reproducibility in OpenMP parallelization means that the random number sequences are the same in spite of parallelization. This requires that the histories are calculated always in the same order. This is achieved by sorting the fission banks between batches. With large neutron populations per batches the sorting takes a substantial amount of time which might affect the obtained parallel calculation scalability.
The reproducibility is often a requirement for debugging the program.

set rfr

set rfr STEP FILE

set rfr idx I FILE

Reads material compositions from a binary restart file. Input values:

`STEP`	: burnup step from which the compositions are obtained
`I`	: burnup step index from which the compositions are obtained
`FILE`	: name of the binary restart file

Notes:

Positive values for step are interpreted as burnup units (MWd/kgU) and negative values as time units (days)
This option can be used together with the set rfw feature for applying changes in the modeled system during burnup calculation

set rfw

set rfw OPT [ FILE ]

Writes material compositions in burnup calculation into a binary restart file. Input values:

`OPT`	: option to switch writing on (1/yes) or off (0/no)
`FILE`	: name of the binary restart file. Default value `[input].wrk`.

Notes:

Restart file writing is switched off by default.
This option can be used together with the set rfr feature for applying changes in the modeled system during burnup calculation

set root

set root UNI

Sets the root universe. Input values:

UNI : universe name

Notes:

Root universe is the universe at the lowest level of the geometry hierarchy, and must always be defined. By default the root is set to "0".
For more information, see detailed description on the universe-based geometry type in Serpent.

set roulette

set roulette W0 P

Sets parameters for weight cut-off and Russian roulette.

`W0`	: minimum particle weight below which cut-off is applied
`P`	: survival probability for Russian roulette

Notes:

Weight cut-off is applied after each collision.
Can be used together with implicit capture (see set impl option).

set runtme

set runtme T

Sets the maximum running time for the transport simulation. Input values:

`T`	: wall-clock running time (minutes)

Notes:

When defined, the transport simulation is terminated after the maximum time is reached.
Setting the parameter does not override the set pop or set nps option.

set samarium

set samarium OPT [ MAT₁ MAT₂ ... ]

Sets equilibrium samarium calculation on or off:

`OPT`	: option to set equilibrium samarium calculation on (1/yes) or off (0/no)
`MAT₁ MAT₂ ...`	: optional list of materials for which to set the option (on/off). Default is all fissile materials. Setting equilibrium samarium calculation off for a list of materials sets it on for all other fissile materials.

Notes:

The equilibrium concentration is calculated on depletion zone basis. You may want to divide your fuel material into depletion zones
The equilibrium concentration calculation requires the material volumes to be correctly set.
The equilibrium concentration calculation requires the fission yield and decay libraries.
The equilibrium concentration of samarium is updated according to the batching interval set in the set pop card. Having a large batching interval means that the equilibrium concentration may take a large number of cycles to converge.

set savesrc

set savesrc PATH [ PN PP N_X N_Y N_Z ]

Sets up the creation of an initial source to be used in a dynamic simulation with delayed neutron emission.

`PATH`	: The path of the source file to be created
`PN`	: Fraction of tentative neutrons to save (default 1.0). Only affects criticality source simulations.
`PP`	: Fraction of tentative precursors to save (default 1.0). Only affects criticality source simulations.
`N_X`	: Precursor mesh size in x-direction (default 1)
`N_Y`	: Precursor mesh size in y-direction (default 1)
`N_Z`	: Precursor mesh size in z-direction (default 1)

Notes:

Four source files will be generated PATH.main, PATH.prec, PATH.live and PATH.precpoints
If used in criticality source simulation, the system should be critical and the values will correspond to steady state values.
If used in a dynamic simulation, the values will correspond to end-of-simulation values
If you are getting a warning from function WriteSourceFile "P larger than 1", you should lower the PN value.
See Transient simulations.

set sca

set sca NI NB MSH 
     MIN₁ MAX₁ SZ₁
     MIN₂ MAX₂ SZ₂
     MIN₃ MAX₃ SZ₃
     [ SUB₁ SUB₂ SUB₃ LIM ]

set sca NI NB MSH 
    X₀ Y₀   
    P NX NY
    MIN₃ MAX₃ SZ₃
    [ SUB₁ SUB₂ SUB₃ LIM ]

Invokes a response matrix solver to obtain an improved source guess for criticality source simulations.

`NI`	: Number of outer iterations
`NB`	: Number of source batches to collect results
`MSH`	: mesh type (1 = Cartesian, 2 = Cylindrical, 4 = x-type hexagonal, 5 = y-type hexagonal, 6 = unevenly-spaced xyz, 8 = unevenly spaced cylindrical)
`MIN_n`	: minimum mesh boundary (nth coordinate)
`MAX_n`	: maximum mesh boundary (nth coordinate)
`SZ_n`	: number of mesh cells (nth coordinate)
`X₀, Y₀`	: mesh center of hexagonal mesh (currently must be centered at the origin)
`P`	: hexagonal cell pitch
`NX, NY`	: hexagonal mesh size
`SUB_n`	: number of sub-mesh cells (nth coordinate)
`LIM`	: convergence criterion (typical value 1E-12)

Notes:

The solver is used to accelerate fission source convergence.
Cartesian and cylindrical mesh are defined by outer mesh boundaries and number of mesh cells.
Unevenly-spaced meshes are defined by providing the mesh cell boundaries separately.
The coordinate axes 1, 2 and 3 in Cartesian mesh refer to (x,y,z) and in cylindrical mesh to (r,θ,z), with θ given in degrees.
The hexagonal mesh is defined by mesh center, cell pitch, number of cells in the radial dimensions (similar to the hexagonal lattice) and axial binning.
The mesh must be defined slightly larger than the geometry (the mesh boundaries should not coincide with the geometry boundaries).
Sub-division is used to improve the solution inside mesh cells.
The methodology is still under development, and the input syntax may change in future updates.

set seed

set seed RNG

Sets the seed value for the random number sequence. Input values:

RNG : seed value used for the random number sequence

Notes:

By default, Serpent gets the RNG seed from system time. This option overrides the value.

set sfylib

set sfylib LIB₁ [ LIB₂ LIB₃ ... ]

Sets the spontaneous fission yield library file paths. Input values:

LIB_n : library file paths

Notes:

Spontaneous fission yield libraries are standard ENDF format files containing spontaneous fission yield data.
If the file path contains special characters it is advised to enclose it within quotes

set shbuf

set shbuf [ OPT_BUF OPT_RES2 ]

Option to use a shared or private scoring buffer or results array. Input values:

`OPT_BUF`	: use shared (1/yes) or private (0/no) scoring buffer (BUF, default private)
`OPT_RES2`	: use shared (1/yes) or private (0/no) results array (RES2, default shared)

Notes:

Serpent stores scores in a temporary buffer, which in OpenMP parallel mode can be either private (each thread writes in its own buffer) or shared (all threads write in same buffer using atomic operations). Using private buffers increases memory usage to some extent, but it should improve scalability since no barriers need to be set to protect memory.
Memory consumption of shared RES2 is usually larger than that of shared BUF.

set sie

set sie ITER

Chooses the Stochastic Implicit Euler burnup scheme to be used for the burnup calcualtion. Input values:

ITER : number of iterations for each burnup step

Notes:

The SIE burnup scheme is mainly intended for burnup calculations that develop instabilities using the default predictor corrector methods.

set spd

set spd V_n V_p

Overrides the speed of simulated particles. Input values:

V_n	: speed of neutrons (cm/s)
V_p	: speed of photons (cm/s)

Notes:

This option is intended for adjusting particle speeds for better visualization in track plot animations.
Adjusting the speed (obviously) results in incorrect estimates for all time constants.
Exceeding the speed of light causes a fatal error in debug mode.

set srcrate

set srcrate S

Sets normalization to total source rate.

`S`	: source rate (in particles per second)

Notes:

Normalization is needed to relate the Monte Carlo reaction rate estimates to a user-given parameter.
Neutron transport simulations are by default normalized to unit total loss rate.
Photon transport simulations are by default normalized to unit total source rate.
For other normalization options, see: set powdens, set power set flux, set genrate, set fissrate, set absrate, set lossrate, set sfrate.
See also Section 5.8 of Serpent 1 User Manual.

set title

set title NAME

Sets a title for the calculation. Input values:

NAME : title used for the calculation

Notes:

The title is printed in the run-time output. If the title is not set, the input file name is printed instead.

set tcut

set tcut T_max

Sets time cut-off for neutrons and photons. Input values:

T_max : time limit for simulated particle histories (in seconds)

Notes:

The time cut-off can be used in both neutron and photon external source simulations, to limit the length of particle histories.
Time or generation cut-off (set gcut) is always needed for neutron external source simulations in super-critical systems.
Time cut-off is automatically set in the dynamic external source simulation mode.
Note to developers: this should take independent values for photons and neutrons

set tpa

set tpa T_min T_max TAIL NF EVB

Sets parameters for track plot animation. Input values:

`T_min`	: starting time of track plot animation (in seconds)
`T_max`	: end time of track plot animation (in seconds)
`TAIL`	: tail length of plotted particles (in cm)
`NF`	: number of frames
`EVB`	: event bank size

Notes:

The track plot animation works with the geometry plotter by creating a number of frames that visualize the motion of particles through the geometry.
The track plotter is invoked using the "-tracks N" command line option, where N is the number of simulated particle histories (if the set tpa option is not defined, the code plots particle tracks in a geometry plot output).
The routine produces NF frames [input]_trck[n]_frame[m].png, where [input] is the input file name, [n] is an index corresponding to the geometry plot and [m] is the frame index. The frames can be converted into a gif animation using tools like Imagemagick.
The plotted particles have a tail to better visualize their movement from one collision to the next. The length of this tail is given in centimeters (similar to geometry dimensions). Neutrons are plotted in magenta, photons are plotted in green.
Storing the simulated collision points requires additional memory, determined by the event bank size. If the given size is insufficient the calculation is terminated with an error message ("Event bank is empty").
Producing track plot animations may require adjusting the particle buffers (set nbuf and set gbuf).
The calculation may require a lot of memory for storing the complete simulated histories in neutron-multiplying systems or when particles are split by variance reduction.
Motion of thermal and fast neutrons cannot be captured simultaneously because of the several orders of magnitude difference in their speed. Thermal systems are best visualized by enforcing all neutrons to travel at the same speed using the set spd option.
See also detailed description on track plotter and track plot animation.

set transmurea

set transmurea ZAI₁ MT₁ ZAI₂ MT₂ ...

Overrides the automatically generated transmutation paths with a user-provided list of reactions. Input values:

`ZAI_n`	: nuclide identifier.
`MT_n`	: reaction identifier (ENDF reaction MT).

Notes:

The transmutation chains in burnup calculation are by default generated automatically. This option overrides the behavior by including only the reactions included on the list.
The reactions are given as nuclide identifier - reaction identifier pairs, for example, the radiative capture cross section of ²³⁸U would be 922380 102.
The nuclide ID can be replaced with "all", in which case all reactions of the type are included.

set transnorm

set transnorm FACTOR

Multiplies the normalization from a transient source linked with set dynsrc by a factor. Input values:

FACTOR : factor to multiply the normalization with.

Notes:

The normalization in transient simulations is, by default, same as in the transient source generation calculation.
See separate description of transient simulations.

set transtime

set transtime FLAG

Choose how time dependent transformations are actually evaluated. Input values:

`FLAG`	: Possible values 0/1:
	With 0, time dependent transformations are evaluated using the beginning time of the time-interval being simulated (geometry static for each time interval).
	With 1, time dependent transformations are evaluated using the time when the tracking of the neutron being simulated began (geometry static for each neutron lifetime).

Notes:

The default option is 0 (geometry static for each time interval).
Option 1 generally results in a much smoother transformation.

set trc

set trc MAT FILE E_min [ ZAI₁ ZAI₂ ... ]

Defines transport correction for the calculation of transport cross section and diffusion coefficient. Input values:

`MAT`	: material to which the correction is applied
`FILE`	: file path to correction curve data
`E_min`	: minimum energy above which the correction is applied
`ZAI_n`	: nuclide identifiers (ZAI)

Notes:

The method calculates transport cross sections by multiplying material total cross sections by a user-defined energy-dependent transport correction ratio before collapsing the energy variable. These transport cross sections are used for calculating diffusion coefficients as $D = 1/3\Sigma_\mathrm{tr}$ .
If the correction ratios are properly defined, the transport cross section is equivalent with the in-scattering approximation.
The out-scattering approximation of transport cross section is used for materials without defined correction ratios and energies below the given minimum energy.
The produced homogenized cross sections are written in variables TRC_TRANSPXS and TRC_DIFFCOEF in the [input]_res.m and [input].coe output files.
See separate description of correction factor file format.
If nuclide identifiers are given the transport correction is applied only to the total cross sections of these nuclides in the given material. In this case the correction should also be given as the ratio of the sum of transport cross sections of these nuclides and the sum of total cross sections of these nuclides. Otherwise the correction is applied to the total cross section of the material.
Method can not be used for divided or burnable materials for the time being.

set ufs

Turns on the uniform fission source method.

set ufs MODE ORDER N_X N_Y N_Z

set ufs MODE ORDER LAT N_Z Z_MIN Z_MAX

set ufs MODE ORDER N_X X_MIN X_MAX N_Y X_MIN X_MAX N_Z Z_MIN Z_MAX

Notes:

See Serpent forum topic on UFS method.

set ures

set ures OPT [ NUC₁ NUC₂ ... ]

Sets unresolved resonance probability table sampling on or off. Input values:

`OPT`	: option to switch probability table sampling on (1/yes) or off (0/no)
`NUC_n`	: list of nuclides to which the option is applied to. Setting unresolved resonance probability table sampling off for a list of nuclides will set it on for the rest of the nuclides.

Notes:

Probability table sampling is switched off by default
Note to developers: add description of dilution cut-off
See separate description of physics options in Serpent for differences to other codes.

set usym

set usym UNI AX BC X₀ Y₀ θ₀ θ_w [ OPT ]

Defines a universe symmetry. Input values:

`UNI`	: universe name
`AX`	: symmetry axis (1 = x, 2 = y, 3 = z)
`BC`	: boundary condition (2 = reflective, 3 = periodic)
`X₀`	: x-coordinate of the origin
`Y₀`	: y-coordinate of the origin
`θ₀`	: azimuthal position where the symmetry segment starts (degrees)
`θ_w`	: width of the segment (degrees)
`OPT`	: option to use actual reflections and translations instead of coordinate transformations

Notes:

Universe symmetries can be used to simplify construction of complex geometries.
Symmetries can also be used to reduce the number of burnable material zones when automated depletion zone division is applied.
When symmetries are used, it is important to pay attention to the definition of material volumes.
When using symmetries together with lattices, the lattice positions overlapped by the symmetry should remain empty of fuel pins for example to prevent excess memory usage during depletion calculations.
Universe symmetries are applied by default using coordinate transformations. This means that the particle position and direction are not affected during tracking. This behavior can be overridden by setting the last option to 1.
The values of surface current and flux detectors and values produced by for example by set adf cards might not be correct when using actual reflections and transformations.
For more information, see examples on universe symmetries.

set U235H

set U235H U235_FISSE

Sets the U-235 fission heating value. Input values:

U235_FISSE : fission heating value of U-235 (MeV)

Notes:

By default the U-235 fission heating value is set to 202.27 MeV and the values for other actinides scaled based the Q-values found in the cross section libraries.
See also set fissh.
See also Section 5.8 of Serpent 1 User Manual.

set wwb

set wwb LO UP

Defines the relation between importances and weight-window boundaries. Input values:

`LO`	: factor relating the lower weight-window boundary to importance
`UP`	: factor relating the upper weight-window boundary to importance

Notes:

Weight window boundaries are inversely proportional to importance. These factors define the coefficients.
Default values are LO = 0.5, UP = 2.0.
See also weight window mesh definition.

set xenon

set xenon OPT [ MAT₁ MAT₂ ... ]

Sets equilibrium xenon calculation on or off:

`OPT`	: option to set equilibrium xenon calculation on (1/yes) or off (0/no)
`MAT₁ MAT₂ ...`	: optional list of materials for which to set the option (on/off). Default is all fissile materials. Setting equilibrium xenon calculation off for a list of materials sets it on for all other fissile materials.

Notes:

The equilibrium xenon concentration calculation forces the xenon number density to be in equilibrium with the current flux and xenon absorption level during the transport calculation.
The equilibrium xenon concentration calculation is meant for example to stabilize the burnup calculations.
The equilibrium concentration is calculated on depletion zone basis. You may want to divide your fuel material into depletion zones
The equilibrium concentration calculation requires the material volumes to be correctly set.
The equilibrium concentration calculation requires the fission yield and decay libraries.
The equilibrium concentration of xenon is updated according to the batching interval set in the set pop card. Having a large batching interval means that the equilibrium concentration may take a large number of cycles to converge.

set xscalc

set xscalc MODE

Calculation mode for transmutation cross sections. Input values:

MODE : Calculation mode (1 = direct tallies, 2 = spectrum-collapse)

Notes:

This parameter controls the way transmutation cross sections are calculated in burnup mode. In spectrum-collapse mode these cross sections are calculated after the transport simulation, using a fine-group spectrum collected for each material.
The spectrum-collapse mode leads to improved performance, but also increased memory footprint per depletion zone.
The option is automatically set when using optimization modes, and it is not recommended to be defined manually.
Many of the old example input files set spectrum collapse method on, which overrides the behaviour in lower optimization modes.
See also set opti.

set xsplot

set xsplot NP E_min E_max

Prints cross section data to [input]_xs0.m file. Input values:

`NP`	: Number of energy points to print.
`E_min`	: Lower boundary for the energy points.
`E_max`	: Upper boundary for the energy points.

The cross sections will be printed out at NP logarithmically spaced points between the energy boundaries.

References

^ Leppänen, J. "Serpent – a Continuous-energy Monte Carlo Reactor Physics Burnup Calculation Code." User manual, June 18, 2015.
^ Leppänen, J. "On the use of delta-tracking and the collision flux estimator in the Serpent 2 Monte Carlo particle transport code." Ann. Nucl. Energy 105 (2017) 161-167.
^ Leppänen, J. "Two practical methods for unionized energy grid construction in continuous-energy Monte Carlo neutron transport calculation." Ann. Nucl. Energy 36 (2009) 878-885.
^ Tuominen, R., Valtavirta, V. and Leppänen, J. "New energy deposition treatment in the Serpent 2 Monte Carlo transport code." Ann. Nucl. Energy 129 (2019) 224-232.
^ "The identification of radionuclides relevant to long-term waste management in th United Kingdom", Nirex Report no. N/105 (2004)
^ Leppänen, J. and Isotalo, A. "Burnup calculation methodology in the Serpent 2 Monte Carlo code." In proc. PHYSOR 2012, Knoxville, TN, Apr. 15-20, 2012.

[manual-1] Leppänen, J. "Serpent – a Continuous-energy Monte Carlo Reactor Physics Burnup Calculation Code." User manual, June 18, 2015.

[cfe-2] Leppänen, J. "On the use of delta-tracking and the collision flux estimator in the Serpent 2 Monte Carlo particle transport code." Ann. Nucl. Energy 105 (2017) 161-167.

[dix-3] Leppänen, J. "Two practical methods for unionized energy grid construction in continuous-energy Monte Carlo neutron transport calculation." Ann. Nucl. Energy 36 (2009) 878-885.

[edep-4] Tuominen, R., Valtavirta, V. and Leppänen, J. "New energy deposition treatment in the Serpent 2 Monte Carlo transport code." Ann. Nucl. Energy 129 (2019) 224-232.

[5] "The identification of radionuclides relevant to long-term waste management in th United Kingdom", Nirex Report no. N/105 (2004)

[opti-6] Leppänen, J. and Isotalo, A. "Burnup calculation methodology in the Serpent 2 Monte Carlo code." In proc. PHYSOR 2012, Knoxville, TN, Apr. 15-20, 2012.

[1]

[2]

[3]

[4]

[5]

[6]

@@ Line 157: / Line 157: @@
 *Universes are implicitly declared for example by using the <tt>''UNI<sub>0</sub>''</tt> key words on cell cards as there is no explicit universe input card.
 *For more information, see detailed description on the [[universe-based geometry type in Serpent]].
+=== casematrix (casematrix definition)<span id="casematrix"></span> ===
 === coef (coefficient matrix definition)<span id="coef"></span> ===

Difference between revisions of "Input syntax manual"

Revision as of 15:26, 25 February 2021

Contents

Input cards

branch (branch definition)

cell (cell definition)

casematrix (casematrix definition)

coef (coefficient matrix definition)

dep (depletion history)

det (detector definition)

div (divisor definition)

ene (energy grid definition)

ftrans (fill transformation)

fun (function definition)

ifc (interface file)

include (read another input file)

lat (regular lattice definition)

mat (material definition)

mesh (mesh plot definition)

mix (mixture definition)

nest (nested universe definition)

particle (particle geometry definition)

pbed (explicit stochastic (pebble bed) geometry)

pin (pin geometry definition)

plot (geometry plot definition)

sample (Temperature / density data sample definition)

sens (sensitivity calculation definition)

solid (irregular 3D geometry definition)

src (source definition)

strans (surface transformation)

surf (surface definition)

therm and thermstoch (thermal scattering)

tme (time binning definition)

trans (transformations)

transv and transa (velocity and acceleration transformations)

utrans (universe transformation)

wwgen (response matrix based importance map solver)

wwin (weight window mesh definition)

Input options

set acelib

set adf

set alb

set arr

set bala

set bc

set blockdt

set bralib

set bumode

set ccmaxiter

set ccmaxpop

set cfe

set cmm

set coefpara

set comfile

set confi

set coverxlib

set cpd

set cpop

set csw

set dbrc

set dd

set declib

set decomp

set delnu

set depmtx

set depout

set dfsol

set dix

set dynsrc

set dt

set ecut

set eddi

set edepdel

set edepkcorr

set edepmode

set egrid

set entr

set fininitfile

set fissh

set forcedt