Input syntax manual
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]}.
Contents
- 1 Input cards
- 1.1 branch (branch definition)
- 1.2 casematrix (casematrix definition)
- 1.3 cell (cell definition)
- 1.4 coef (coefficient matrix definition)
- 1.5 datamesh (general data mesh definition)
- 1.6 dep (depletion history)
- 1.7 det (detector definition)
- 1.8 div (divisor definition)
- 1.9 dtrans (detector mesh transformation)
- 1.10 ene (energy grid definition)
- 1.11 ftrans (fill transformation)
- 1.12 fun (function definition)
- 1.13 hisv (history variation matrix definition)
- 1.14 ifc (interface file)
- 1.15 include (read another input file)
- 1.16 lat (regular lattice definition)
- 1.17 mat (material definition)
- 1.18 mesh (mesh plot definition)
- 1.19 mflow (material flow definition)
- 1.20 mix (mixture definition)
- 1.21 nest (nested universe definition)
- 1.22 particle (particle geometry definition)
- 1.23 pbed (explicit stochastic (pebble bed) geometry definition)
- 1.24 phb (pulse-height Gaussian energy broadening definition)
- 1.25 pin (pin geometry definition)
- 1.26 plot (geometry plot definition)
- 1.27 rep (reprocessor definition)
- 1.28 sample (temperature / density data sample definition)
- 1.29 sens (sensitivity calculation definition)
- 1.30 solid (irregular 3D geometry definition)
- 1.31 src (source definition)
- 1.32 strans (surface transformation)
- 1.33 surf (surface definition)
- 1.34 therm and thermstoch (thermal scattering)
- 1.35 tme (time binning definition)
- 1.36 trans (transformations)
- 1.37 transb (burnup transformation)
- 1.38 transv and transa (velocity and acceleration transformations)
- 1.39 umsh (unstructured mesh-based geometry definition)
- 1.40 utrans (universe transformation)
- 1.41 voro (stochastic Voronoi tessellation geometry definition)
- 1.42 wwgen (response matrix based importance map solver)
- 1.43 wwin (weight window mesh definition)
- 2 Input options
- 2.1 set absrate
- 2.2 set acelib
- 2.3 set adf
- 2.4 set alb
- 2.5 set arr
- 2.6 set ba
- 2.7 set bala
- 2.8 set bc
- 2.9 set blockdt
- 2.10 set bralib
- 2.11 set branchless
- 2.12 set bumode
- 2.13 set bunorm
- 2.14 set ccmaxiter
- 2.15 set ccmaxpop
- 2.16 set cdop
- 2.17 set cea
- 2.18 set cfe
- 2.19 set cmm
- 2.20 set coefpara
- 2.21 set combing
- 2.22 set comfile
- 2.23 set confi
- 2.24 set coverxlib
- 2.25 set covlib
- 2.26 set cpd
- 2.27 set cpop
- 2.28 set csw
- 2.29 set dataout
- 2.30 set dbrc
- 2.31 set dd
- 2.32 set declib
- 2.33 set decomp
- 2.34 set delnu
- 2.35 set depmtx
- 2.36 set depout
- 2.37 set deppara
- 2.38 set depstepbunorm
- 2.39 set dfsol
- 2.40 set dix
- 2.41 set dspec
- 2.42 set dt
- 2.43 set dynccfile
- 2.44 set dynsrc
- 2.45 set ecut
- 2.46 set ecutdens
- 2.47 set ecutmat
- 2.48 set eddi
- 2.49 set edepdel
- 2.50 set edepkcorr
- 2.51 set edepmode
- 2.52 set egrid
- 2.53 set ekn
- 2.54 set elcond
- 2.55 set elgas
- 2.56 set elmee
- 2.57 set elspn
- 2.58 set entr
- 2.59 set fininitfile
- 2.60 set fissh
- 2.61 set fissrate
- 2.62 set fissye
- 2.63 set flux
- 2.64 set fluxlimtrc
- 2.65 set fmtx
- 2.66 set forcedt
- 2.67 set fpcut
- 2.68 set fsp
- 2.69 set fum
- 2.70 set gbuf
- 2.71 set gct
- 2.72 set gcu
- 2.73 set gcut
- 2.74 set genrate
- 2.75 set gpop
- 2.76 set gsw
- 2.77 set his
- 2.78 set ifp
- 2.79 set imp
- 2.80 set impl
- 2.81 set inftrk
- 2.82 set inventory
- 2.83 set isobra
- 2.84 set iter alb
- 2.85 set iter nuc
- 2.86 set keff
- 2.87 set lossrate
- 2.88 set lost
- 2.89 set maxsplit
- 2.90 set mbtch
- 2.91 set mcleak
- 2.92 set mcvol
- 2.93 set mdep
- 2.94 set memfrac
- 2.95 set mfpcut
- 2.96 set mfpcutdens
- 2.97 set mfpcutmat
- 2.98 set micro
- 2.99 set minxs
- 2.100 set multilevelgcu
- 2.101 set mvol
- 2.102 set nbuf
- 2.103 set nfg
- 2.104 set nfylib
- 2.105 set ngamma
- 2.106 set nphys
- 2.107 set nps
- 2.108 set opti
- 2.109 set outp
- 2.110 set pbuf
- 2.111 set pcc
- 2.112 set pdatadir
- 2.113 set poi
- 2.114 set pop
- 2.115 set powdens
- 2.116 set power
- 2.117 set ppid
- 2.118 set pport
- 2.119 set ppw
- 2.120 set precsrcf
- 2.121 set precthresh
- 2.122 set printelsp
- 2.123 set printm
- 2.124 set qparam_dbrc
- 2.125 set qparam_tms
- 2.126 set relfactor
- 2.127 set repro
- 2.128 set rfr
- 2.129 set rfw
- 2.130 set rnddec
- 2.131 set root
- 2.132 set roulette
- 2.133 set runtme
- 2.134 set samarium
- 2.135 set savesrc
- 2.136 set sca
- 2.137 set seed
- 2.138 set sfbuf
- 2.139 set sfrate
- 2.140 set sfylib
- 2.141 set shbuf
- 2.142 set sie
- 2.143 set sourcescale
- 2.144 set spa
- 2.145 set spd
- 2.146 set srcrate
- 2.147 set stl
- 2.148 set stlfile
- 2.149 set syscom
- 2.150 set tcut
- 2.151 set title
- 2.152 set tpa
- 2.153 set transmurea
- 2.154 set transnorm
- 2.155 set transtime
- 2.156 set trc
- 2.157 set ttacut
- 2.158 set ttb
- 2.159 set ttbpm
- 2.160 set ufs
- 2.161 set ures
- 2.162 set usym
- 2.163 set U235H
- 2.164 set voidc
- 2.165 set wrnout
- 2.166 set wie
- 2.167 set wwb
- 2.168 set xenon
- 2.169 set xscalc
- 2.170 set xsplot
- 3 References
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_{1} MAT_{2} ] [ repu UNI_{1} UNI_{2} ] [ stp MAT DENS TEMP THERM_{1} SABL_{1} SABH_{1} THERM_{2} SABL_{2} SABH_{2} ... ] [ tra TGT TRANS ] [ xenon OPT ] [ samarium OPT ] [ norm NSF ] [ gcu UNI_{2} ] [ reptrc FILE_{1} FILE_{2} ] [ var VNAME VAL ] [ incl MODFILE ]
Defines the variations invoked for a branch in the automated burnup sequence. The first parameter:
NAME | : branch name |
The remaining parameters are defined by separate key words followed by the input values.
Notes:
- The branch card can be combined with the coef card, hisv card, and casematrix card.
- The branch name identifies the branch BR_{m,i} in the variation matrix defined by the coef card, hisv card, and casematrix card.
- The input parameters consist of a number variations, which are invoked when the branch is applied.
- A single branch card may include one or several variations.
- For more information, see detailed description on the automated burnup sequence.
Variation types:
Branch material variation (repm):
MAT_{1} | : name of the replaced material |
MAT_{2} | : name of the replacing material |
Notes:
- The material variation can be used to replace one material with another, for example, to change coolant boron concentration.
- The material replacement works as if MAT_{1} were created using the mat or mix card of MAT_{2}.
- The name of the material present in the geometry will still be MAT_{1} after the replacement, but the material specification (composition, density, tmp, moder, rgb, etc.) will correspond to MAT_{2}.
- This means that all other input-cards that are linked to a specific material name such as dm entry in the det card, sm entry in the src card, set trc option and/or set iter nuc option can be linked to the original material (MAT_{1}) and they will automatically apply to whatever material MAT_{2} replaces MAT_{1} for the branch calculation.
- The replaced material MAT_{1} is also replaced inside mixtures.
- The replacing material MAT_{2} can not be included in the geometry using other cards than the branch card, from version 2.1.30 and on.
Branch universe variation (repu):
UNI_{1} | : name of the replaced universe |
UNI_{2} | : name of the replacing universe |
Notes:
- The universe 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 name of the universe present in the geometry will still be UNI_{1} after the replacement, but the universe contents will correspond to UNI_{2}.
- This means that all other input-cards that are linked to a specific universe name such as du entry in the det card and/or su entry in the src card can be linked to the original universe (UNI_{1}) and they will automatically apply to whatever universe UNI_{2} replaces UNI_{1} for the branch calculation.
Branch state variation, density/temperature (stp):
MAT | : name of the material for which density and temperature are adjusted |
DENS | : material density after adjustment (positive value = atomic density [in b^{-1}cm^{-1}], negative value = mass density [in g/cm^{3}]) |
TEMP | : material temperature after adjustment [in K] |
THERM_{n} | : n-th thermal scattering data associated with the material |
SABL_{n} | : name of the n-th S(α, β) library for temperature below the given value |
SABH_{n} | : name of the n-th S(α, β) library for temperature above the given value |
Notes:
- The state variation can be used to change material density and temperature.
- There is a special entry for the TEMP parameter:
- "-1": to not adjust temperature
- There are two special entries for the DENS parameter:
- "sum": to define the material density as the sum of the constituent nuclides densities (not supported from version 2.2.0 and on)
- "original": to keep unmodified the material density (introduced in version 2.2.1).
- The adjustment is made using the built-in Doppler-broadening preprocessor routine and tabular interpolation for S(α, β) thermal scattering data.
- The last three parameters of the card are provided only if the material has thermal scattering libraries attached to it (see the therm card).
Branch transformation variation (tra):
TGT | : target universe, surface or cell |
TRANS | : name of the applied transformation |
Notes:
- The transformation 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 TRANS refers to the unit (universe, cell or surface) entry in the trans card.
Branch xenon variation (xenon):
OPT | : option for setting xenon poison concentrations (0 = set to zero, 1 = use values from restart file) |
Notes:
- The xenon variation can be set to enforced the Xe-135 and Xe-135m concentrations and optionally I-135 concentration to zero.
- By default the concentrations are read from the restart file.
- Equilibrium xenon (set xenon option).
- If the calculation is "on", then the option "0" sets I-135, Xe-135 and Xe-135m concentrations to zero.
- If the calculation is "off", then the option "0" sets only Xe-135 and Xe-135m concentrations to zero.
Branch samarium variation (samarium):
OPT | : option for setting samarium poison concentrations (0 = set to zero, 1 = use values from restart file) |
Notes:
- The samarium variation can be set to enforce the Sm-149 concentration and possibly Pm-149 concentration to zero.
- By default the concentrations are read from the restart file.
- Equilibrium samarium (set samarium option):
- If the calculation is "on", then the option "0" sets both Pm-149 and Sm-149 concentrations to zero.
- If the calculation is "off", then the option "0" sets only Sm-149 concentration to zero.
Branch normalization variation (nsf):
NSF | : normalization scaling factor |
Notes:
- The normalization variation can be used to change the normalization.
- The adjustment is made applying the parameter NSF as a multiplicative scaling factor to the given normalization.
Branch group constant variation (gcu):
UNI_{2} | : name of the replacing universe |
Notes:
- The group constant variation can be used to replace the universe for group constant generation.
- The variation is limited to a single-valued GCU-list (see set gcu option).
Branch transport-correction variation (reptrc):
FILE_{1} | : file path of the replaced transport correction curve data |
FILE_{2} | : file path of the replacing transport correction curve data |
Notes:
- The transport-correction variation can be used to replace a transport correction file with another (see set trc option).
Branch variable variation (var):
VNAME | : variable name |
VAL | : variable value |
Notes:
- The variable variation can be used to pass information into the output file, which may be convenient for the post-processing of the data.
Branch user-defined variation (incl):
MODFILE | : file path to an additional/modified input file |
Notes:
- The user-defined variation can be used as a multi-purpose option to modify the base-input via the additional input file MODFILE.
casematrix (casematrix definition)
casematrix CASE_NAME NHIS [ HIS_BR_{1} HIS_BR_{2} ... HIS_BR_{NHIS} ] NBU [ BU_{1} BU_{2} ... BU_{NBU} ] NBR_{1} [ BR_{1,1} BR_{1,2} ... BR_{1,NBR1} ] NBR_{2} [ BR_{2,1} BR_{2,2} ... BR_{1,NBR2} ] ...
Defines the casematrix for the automated burnup sequence. Input values:
CASE_NAME | : name of the casematrix |
NHIS | : number of history variations |
HIS_BR_{k} | : name of the k-th history variation branch |
NBU | : number of burnup points |
BU_{n} | : burnup steps at which the momentary variation branches are invoked (positive value = burnup [in MWd/kg], negative value = time [in d]) |
NBR_{m} | : number branches in the m-th dimension of the burnup matrix |
BR_{m,i} | : name of the i-th branch in the m-th dimension |
Notes:
- The casematrix card performs multiple depletions with NHIS (different) historical variations and performs restarts similar as the coef input card.
- The casematrix card creates a multi-dimensional coefficient matrix (of size NBR_{1} × NBR_{2} × NBR_{3} × ... ).
- 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.
- This is repeated for each different depletion history.
- The casematrix card is used together with the branch card and -casematrix command line option.
- Multiple casematrix cards can be given in a single input file.
- For more information, see detailed description on automated burnup sequence.
cell (cell definition)
cell NAME UNI_{0} MAT [ SURF_{1} SURF_{2} ... ]
Defines a cell. Input values:
NAME | : cell name |
UNI_{0} | : universe where the cell belongs to |
MAT | : material that fills the cell |
SURF_{n} | : surface list |
Notes:
- The cell definition is based on the universe-based geometry type in Serpent.
- Universes are implicitly declared, e.g., by using the UNI_{0} key word on cell cards, as there is no explicit universe input card.
- The surface list defines the boundaries of the cell by listing the surface names (as provided in the surface definition, surf card), together with the operator identifiers (nothing for intersection, ":" for union, "-" for complement and "#" for cell complement).
- The general cell definition (so-called "material cell") have tailored types, defined by special material entries (replacing MAT):
Type Description void region is defined as zero-collision fill UNI_{1} region is filled by another universe, UNI_{1} outside region is not part of the actual geometry ("outside world")
- Outside cells:
- When the particle enters an outside cell, the boundary conditions are applied (see set bc option). It is important that the geometry model is non-re-entrant (convex) when vacuum boundary conditions are used. Delta-tracking might miss the boundary conditions in a re-entrant (concave) outer surface.
- Outside cells are allowed only in the root universe. It is important that all space outside the model is defined.
- Outside cells:
- Cells defined without surfaces are treated as infinite, from version 2.1.32 on.
- 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.
- For more information, see detailed description on the universe-based geometry type in Serpent.
coef (coefficient matrix definition)
coef NBU [ BU_{1} BU_{2} ... ] [ NBR_{1} BR_{1,1} BR_{1,2} ... ] [ NBR_{2} 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 (positive value = burnup [in MWd/kg], negative value = time [in d]) |
NBR_{m} | : number branches in the m-th dimension of the burnup matrix |
BR_{m,i} | : name of the i-th branch in the m-th dimension |
Notes:
- The coef card creates a multi-dimensional coefficient matrix (of size NBR_{1} × NBR_{2} × NBR_{3} × ... ).
- 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.
- The coef card is used together with the branch card.
- For multiple historical variations or historical conditions defined using a branch card, see the casematrix card.
- For more information, see detailed description on automated burnup sequence.
datamesh (general data mesh definition)
datamesh NAME TYPE USE_{LC} [ ... ]
Defines a general data mesh to be used for spacial discretisation. Input values:
NAME | : mesh name |
TYPE | : mesh type |
USE_{LC} | : use lowest level coordinates (1/yes) instead of global coordinates (0/no) for the mesh search |
The remaining parameters are type-dependent.
Notes:
- The general data mesh can be used, e.g., with detectors (dmesh entry in the det card), interfaces (ifc card), sensitivities (opt dmesh entry in the sens card), etc.
- When Serpent makes the mesh search for a specific collision point, it will save the collision mesh cell temporarily so that the cell search is conducted at most once even when scoring multiple estimators using the same mesh.
- The nested data meshes (type 9) take the coordinates' level from the USE_{LC} parameter defined in the nested mesh itself and use it in the subsequent sub-meshes, overriding the USE_{LC} parameter defined on those.
The available general data mesh types are:
The syntax of the available types is as follows:
datamesh NAME 1 USE_{LC} N_{X} X_{MIN} X_{MAX} N_{Y} Y_{MIN} Y_{MAX} N_{Z} Z_{MIN} Z_{MAX}
N_{X} | : number of cells in the x-direction |
X_{MIN} | : mesh lower x-boundary [in cm] |
X_{MAX} | : mesh higher x-boundary [in cm] |
N_{Y} | : number of cells in the y-direction |
Y_{MIN} | : mesh lower y-boundary [in cm] |
Y_{MAX} | : mesh higher y-boundary [in cm] |
N_{Z} | : number of cells in the z-direction |
Z_{MIN} | : mesh lower z-boundary [in cm] |
Z_{MAX} | : mesh higher z-boundary [in cm] |
datamesh NAME 2 USE_{LC} N_{R} R_{MIN} R_{MAX} N_{PHI}
N_{R} | : number of cells in the radial direction |
R_{MIN} | : mesh inner radial boundary [in cm] |
R_{MAX} | : mesh outer radial boundary [in cm] |
N_{PHI} | : number of cells in the polar angle direction |
datamesh NAME 4 USE_{LC} X_{0} Y_{0} PITCH Z_{MIN} Z_{MAX} N_{X} N_{Y} N_{Z}
X_{0} | : mesh horizontal origin x-coordinate [in cm] |
Y_{0} | : mesh horizontal origin y-coordinate [in cm] |
PITCH | : mesh horizontal pitch (equal to cell flat-to-flat width) [in cm] |
Z_{MIN} | : mesh lower z-boundary [in cm] |
Z_{MAX} | : mesh higher z-boundary [in cm] |
N_{X} | : number of cells in the x-direction |
N_{Y} | : number of cells in the y-direction |
N_{Z} | : number of cells in the z-direction |
datamesh NAME 5 USE_{LC} X_{0} Y_{0} PITCH Z_{MIN} Z_{MAX} N_{X} N_{Y} N_{Z}
X_{0} | : mesh horizontal origin x-coordinate [in cm] |
Y_{0} | : mesh horizontal origin y-coordinate [in cm] |
PITCH | : mesh horizontal pitch (equal to cell flat-to-flat width) [in cm] |
Z_{MIN} | : mesh lower z-boundary [in cm] |
Z_{MAX} | : mesh higher z-boundary [in cm] |
N_{X} | : number of cells in the x-direction |
N_{Y} | : number of cells in the y-direction |
N_{Z} | : number of cells in the z-direction |
datamesh NAME 6 USE_{LC} N_{X} N_{Y} N_{Z} X_{1} ... X_{NX+1} Y_{1} ... Y_{NY+1} Z_{1} ... Z_{NZ+1}
N_{X} | : number of cells in the x-direction |
N_{Y} | : number of cells in the y-direction |
N_{Z} | : number of cells in the z-direction |
X_{i} | : N_{X} + 1 mesh boundaries in the x-direction [in cm] |
Y_{i} | : N_{Y} + 1 mesh boundaries in the y-direction [in cm] |
Z_{i} | : N_{Z} + 1 mesh boundaries in the z-direction [in cm] |
datamesh NAME 8 USE_{LC} N_{R} N_{PHI} R_{1} ... R_{NR+1}
N_{R} | : number of cells in the radial direction |
N_{PHI} | : number of cells in the polar angle direction |
R_{i} | : N_{R} + 1 mesh boundaries in the radial direction [in cm] |
datamesh NAME 9 USE_{LC} N_{LEVEL} MESH_{1} ... MESH_{NLEVEL}
N_{LEVEL} | : number of nested levels in this mesh |
MESH_{i} | : sub mesh to use at level i |
dep (depletion history)
dep STYPE [ STEP_{1} STEP_{2} ... ]
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:
- Multiple depletion histories with different step types can be specified in the input, and they will be executed in the input order.
- Depletion calculations (burnup/activation steps) require normalization.
- See: set power, set powdens, set flux, set genrate, set fissrate, set absrate, set lossrate, set srcrate, set sfrate.
- If multiple depletion histories and normalizations are defined in the input, the first normalization will be used with the first depletion history, the second normalization with the second depletion history and so on.
- Note that even though decay calculations (decay steps) disregard the user defined normalization, a normalization has to be defined also for the decay history, if multiple normalizations are defined in the input and there are depletion histories (burnup/activation steps) after the decay calculation.
- If the normalization is set to zero, physical estimates, e.g., detectors will be printed as zero.
- Alternatively, use a very small value to enforce a non-zero normalization.
- Except:
- Radioactive decay source: source rate normalization is carried out automatically based on the total emission rate.
- Decay steps: equivalent, e.g., zero power.
- Activation step, "actstep" and "acttot":
- Transport cycle is run only once and transmutation cross sections are not updated.
- Limitations:
- It must be preceeded by a burnup step.
- It cannot be used with a burnable material radioactive source.
- Burnup is not calculated correctly
- Decay step, "decstep" and "dectot":
- Transport cycle is omitted and transmutation cross sections are not calculated.
- Limitations:
- It cannot preceed activation steps.
- Physical estimates, e.g., detectors will not be printed for the given step (value zero) due to normalization
dep pro REP_NAME STYPE [ STEP_{1} STEP_{2} ... ]
Links a reprocessor to the depletion calculation. Input values:
REP_NAME | : reprocessor name |
STYPE | : step type |
STEP_{n} | : depletion step list |
Notes:
- The reprocessing system or reprocessor controller is defined using the rep card.
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_{1} MAX_{1} N_{1} MIN_{2} MAX_{2} N_{2} MIN_{3} MAX_{3} N_{3} ] [ dn TYPE N_{1} N_{2} N_{3} LIM_{11}...LIM_{1N+1} LIM_{21}...LIM_{2N+1} LIM_{31}...LIM_{3N+1} ] [ dh TYPE X_{0} Y_{0} PITCH N_{1} N_{2} Z_{MIN} Z_{MAX} N_{Z} ] [ dumsh UNI N_{C} CELL_{0} BIN_{0} CELL_{1} BIN_{1} ... ] [ 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 ] [ dphb PHB ] [ dmesh MESH ]
Detector definition. The two first parameters:
NAME | : detector name |
PART | : particle type (n = neutron, p = photon) |
The remaining parameters are defined by separate key words followed by the input values.
Notes:
- The particle type PART is optional in single particle simulations.
- The detectors estimates are integrated values over the space, angle, energy and time domains.
- A detector with an associated discretization in space, angle, energy and/or time turns into multiple bins. Each bin results are correspondingly integrated over the discretization domain.
- A single detector card may include one or several detector types. If multiple detectors are defined, the results are correspondingly divided into multiple bins.
Detector types:
Detector response (dr):
MT | : response number |
MAT | : response associated material name |
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:
- They are associated with microscopic cross sections
- The detector result is independent of the material density.
- Materials associated to 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:
- They are associated with macroscopic cross sections and special types
- The detector result is multiplied by material density
- Positive response numbers:
- 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.
- There is a special entry for the response associated material:
- "void": to allow the response not to be pre-assigned with a specific material.
- When the detector scores in a collision, the cross-section is taken from the material at the collision point.
- Use, e.g., to calculate integral reaction rates over regions composed of multiple materials.
- It only can be used with negative response numbers.
- "void": to allow the response not to be pre-assigned with a specific material.
- By default, Serpent allows a detector to have at most 10,000,000 bins.
Detector volume (dv):
VOL | : volume [in cm^{3}] (3D geometry) or cross-sectional area [in cm^{2}] (2D geometry) |
Notes:
- The results are divided by detector bin-volume (default value: 1.0)
- In the case of surface detectors, VOL represents the surface area [in cm^{2}] (3D geometry) or the surface length [in cm] (2D geometry).
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:
- There is a special entry for the material name:
- "fiss": to score only in fissile region(s)
- 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.
Detector evenly-spaced Cartesian mesh (dx, dy and dz):
X_{MIN} | : minimum x-coordinate of the detector mesh [in cm] |
X_{MAX} | : maximum x-coordinate of the detector mesh [in cm] |
N_{X} | : number of x-bins |
Y_{MIN} | : minimum y-coordinate of the detector mesh [in cm] |
Y_{MAX} | : maximum y-coordinate of the detector mesh [in cm] |
N_{Y} | : number of y-bins |
Z_{MIN} | : minimum z-coordinate of the detector mesh [in cm] |
Z_{MAX} | : maximum z-coordinate of the detector mesh [in cm] |
N_{Z} | : number of z-bins |
Notes:
- The mesh detectors can be used to sub-divide the results into multiple evenly-spaced bins.
- For a Cartesian mesh the division is provided with separate entries in x-, y- and z- locations (dx, dy and dz, respectively).
Detector evenly-spaced curvilinear mesh (dn):
TYPE | : type of curvilinear mesh - 1 = cylindrical (dimensions r, θ, z), 2 = spherical (dimensions r, θ, φ) |
MIN_{n} | : minimum value of n-coordinate for the mesh division [in cm (r, z), in degrees (θ, φ)]. |
MAX_{n} | : maximum value of n-coordinate for the mesh division [in cm (r, z), 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.
- 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.
Detector unevenly-spaced mesh (dn):
TYPE | : type of curvilinear mesh - 3 = unevenly-spaced orthogonal (dimensions x, y, z), 4 = unevenly-spaced cylindrical (dimensions r, θ, z) |
N_{n} | : number of bins in the n-coordinate direction |
LIM_{nm} | : mesh m-boundary in the n-coordinate direction [in cm (r, z), in degrees (θ, φ)]. |
Notes:
- All parameters must be provided, even for one- or two-dimensional meshes.
- By default, the unevenly-spaced 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.
Detector hexagonal mesh (dh):
TYPE | : type of hexagonal mesh (2 = flat face perpendicular to x-axis, 3 = flat face perpendicular to y-axis) |
X_{0}, Y_{0} | : coordinates of mesh center [in cm] |
PITCH | : mesh pitch [in cm] |
N_{1}, N_{2} | : mesh size |
Z_{MIN} | : minimum z-coordinate of the detector mesh [in cm] |
Z_{MAX} | : maximum z-coordinate of the detector mesh [in cm] |
N_{Z} | : number of z-bins |
Notes:
- All parameters must be provided, even for a two-dimensional hexagonal meshes.
Detector unstructured mesh (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 type "4" of ene card.
- The energy boundaries of photon photon pulse-height and photon heat analog detectors are solely defined by the associated energy grid and not limited by the unionized energy grid defining the model.
- That means that analog detectors might collect scores below the physics model minimum energy bound, without a cut-off, if the energy grid sets it.
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.
Detector current / flux surface (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.
- Flux mode:
- 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.
- Current mode:
- Responses are not allowed with current detectors, and with flux detectors, the material name at the collision point has to be specified ("void" is not allowed).
- The use of single-bin mesh and cell detectors is allowed to further define the surface and integration domain of the detector, from version 2.1.32 on.
- 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_{X} | : 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.
Detector super-imposed track-length (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 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 purpose of the track-length detector is to provide better statistics for special applications (activation wire measurements, etc.).
- For more information see the detailed description on delta- and surface-tracking and result estimators.
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.
- 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.
- When used with the surface current detector this option can provide surface source distributions for other calculations.
- Source files can be read using the sf entry of the src card.
Detector special types (dt):
TYPE | : special type (see below) |
PARAM | : additional parameters |
The possible special types are:
Type Description Notes -1 cumulative spectrum use with energy binning (de) -2 division by energy width use with energy binning (de) -3 division by lethargy width use with energy binning (de) -4 sum over cell or material bins use with cell and/or material binning (dc, dm) -5 importance weighting - -6 sum over number of scores - 2 multiply result with another detector defined by PARAM bin-compatibility 3 divide result with another detector defined by PARAM bin-compatibility 4 multiply response function by (local) temperature -
Notes:
- Type "3 can be used to calculate flux-weighted averages (microscopic and macroscopic cross sections, etc.).
Detector history collection flag (dhis):
OPT | : option to switch on (1/yes) or off (0/no) the collection of histories, batch-wise results |
Notes:
- When this option is set, the batch-wise results are printed in the history output file, [input]_stats.m.
- The statistical tests are described in a related report^{[2]}.
- Note to developers: statistical tests should be documented
Detector score 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) |
The possible flagging options are:
Flag Description Notes 0 reset if scored - 1 set if scored - -2/2 score if set 2 (apply OR-type logic), -2 (apply AND-type logic) -3/3 score if not set 3 (apply OR-type logic), -3 (apply AND-type logic)
Notes:
- Detector flagging allows limiting detector scores to histories which have already contributed to another score.
- Scoring logic:
- OR-type logic: detector is scored if any of the associated flags is set/unset
- AND-type logic: detector is scored if all the associated flags are set/unset
Detector activation (da):
MAT | : activated material |
FLX | : flux applied to activation [in 1/cm^{2}s] |
Notes:
- Activation detector allows performing activation calculation for materials that are not part of the geometry.
- Flux applied to activation:
- The flux spectrum applied to neutron irradiation is taken from the detector scores.
- The absolute flux level can be set using the FLX parameter.
- There is a special entry for the FLX parameter:
- "-1": in this case, the flux magnitude is also taken from the detector scores.
- There is a special entry for the FLX parameter:
- Requires neutron transport simulation and burnup mode.
- The detector associated material must be burnable, and cannot part of the actual geometry.
- The volume of the material, aka detector, 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.
Detector Functional Expansion Tally, FET (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 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 with as a linear indexer of
- 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 already have all contributions from the orthonormalization constant pre-included, i.e. from
- Thus, an FET can be simply reconstructed/sampled from the standard functional series as:
- The FETs are based on nonseparable expansions, i.e. fully-convolved cross terms are included
- From version 2.2.0 and on, FET-based detectors follow the standard normalization set in the calculation. The volume standards for detectors are set as default value for FET-based detectors, meaning detectors are not divided by the physical volume (allowing the use of volume detector dv).
- In version 2.2.0, the relative error evaluation associated with FET-based detectors has been revisited.
Detector pulse-height energy broadening (dphb):
PHB | : user-defined (Gaussian) energy broadening for pulse-height detector function name |
Notes:
- User-defined Gaussian energy broadening functions for pulse height detector are defined using the phb card.
Detector spatial integration domain and binning based on a generic data mesh (dmesh):
MESH | : name of the datamesh to use for defining the spatial integration domain and binning for the detector scores |
Notes:
- Output mesh index will be flattened (one dimensional).
div (divisor definition)
div MAT [ sep LVL ] [ subx N_{X} X_{MIN} X_{MAX} ] [ subx N_{X} X_{1} X_{2} ... X_{N+1} ] [ suby N_{Y} Y_{MIN} Y_{MAX} ] [ suby N_{Y} Y_{1} Y_{2} ... Y_{N+1} ] [ subz N_{Z} Z_{MIN} Z_{MAX} ] [ subz N_{Z} Z_{1} Z_{2} ... Z_{N+1} ] [ subr N_{R} R_{MIN} R_{MAX} ] [ subr N_{R} R_{1} R_{2} ... R_{N+1} ] [ subs N_{S} S_{0} ] [ subs N_{S} S_{1} S_{2} ... S_{N+1} ] [ peb PBED N_{UNI} [ UNI_{1} ... UNI_{N} ] ] [ lims FLAG ]
Divides a material into a number of sub-zones. The first parameter:
MAT | : name of the divided material |
The remaining parameters are defined by separate key words followed by the input values.
Notes:
- A single div card may include one or several sub-divisions.
- As general rule:
- if the number of zones associated with a sub-division is positive, the sub-division is equal volume (see below)
- if the number of zones associated with a sub-division is negative, the subdivision is user-defined volume (see below)
- If a material is not divided, all occurrences of it are treated as a single depletion zone (except for depleted materials defined in pin structures: pin-type division).
- The use of automated instead of manual depletion zone division saves memory, which may become significant in very large burnup calculation problems (see set opti).
- The volumes of the divided materials must be set manually (see set mvol option) or automatically, via the Monte Carlo checker-routine (see set mcvol option or -checkvolumes command line option).
- For a more detailed description, check Defining material volumes).
- For more information, see detailed description on automated depletion zone division.
Sub-division types:
Sub-division geometry level (sep):
LVL | : geometry level at which the material-wise division takes place (0 = no division, 1 = last level, 2 = 2nd last level, etc.) |
Notes:
- The sub-division criterion is the geometry level.
- The level number is counted backwards from the last one, i.e. level "1" is the last level.
- Use examples:
- to sub-divide the fuel in large LWR core into separate depletion zones on assembly-, instead of pin-basis.
- to sub-divide HTGR fuel kernels into depletion zones on compact- or pebble-basis.
Sub-division Cartesian mesh, equal volume (subx, suby and subz):
N_{X} | : number of x-zones (positive value) |
X_{MIN} | : minimum x-coordinate [in cm] |
X_{MAX} | : maximum x-coordinate [in cm] |
N_{Y} | : number of y-zones (positive value) |
Y_{MIN} | : minimum y-coordinate [in cm] |
Y_{MAX} | : maximum y-coordinate [in cm] |
N_{Z} | : number of z-zones (positive value) |
Z_{MIN} | : minimum z-coordinate [in cm] |
Z_{MAX} | : maximum z-coordinate [in cm] |
Notes:
- An equal volume sub-division is performed in the given dimension.
- The value of the parameter N_{n} which defines the number of zones in the given dimension must be positive.
- For a Cartesian mesh sub-division, a separate entry in x-, y-, z- directions is provided (subx, suby and subz, respectively).
Sub-division Cartesian mesh, user-defined volume (subx, suby and subz):
N_{X} | : number of x-zones (negative value) |
X_{n} | : x-coordinate boundaries [in cm] |
N_{Y} | : number of y-zones (negative value) |
Y_{n} | : y-coordinate boundaries [in cm] |
N_{Z} | : number of z-zones (negative value) |
Z_{n} | : z-coordinate boundaries [in cm] |
Notes:
- An user-defined volume sub-division is performed in the given dimension.
- The value of the parameter N_{n} which defines the number of zones in the given dimension must be negative.
- For a Cartesian mesh sub-division, a separate entry in x-, y-, z- directions is provided (subx, suby and subz, respectively).
Sub-division cylindrical annular mesh, equal volume (subr):
N_{R} | : number of radial-zones (positive value) |
R_{MIN} | : minimum radial-coordinate [in cm] |
R_{MAX} | : maximum radial-coordinate [in cm] |
Notes:
- An equal volume radial sub-division is performed (annular-type sub-division)
- The value of the parameter N_{R} which defines the number of zones in the given dimension must be positive.
Sub-division cylindrical annular mesh, user-defined volume (subr):
N_{R} | : number of radial-zones (negative value) |
R_{n} | : radial-coordinate boundaries [in cm] |
Notes:
- An user-defined volume radial sub-division is performed (annular-type sub-division)
- The value of the parameter N_{R} which defines the number of zones in the given dimension must be negative.
Sub-division cylindrical sector mesh, equal volume (subs):
N_{S} | : number of angular-zones (negative value) |
S_{0} | : zero position of angular division [in degrees] |
Notes:
- An equal volume angular sub-division is performed (sector-type sub-division)
- The value of the parameter N_{S} which defines the number of zones in the angular dimension must be positive.
Sub-division cylindrical sector mesh, user-defined volume (subs):
N_{S} | : number of angular-zones |
S_{n} | : angular-sector boundaries [in degrees] |
Notes:
- An user-defined volume angular sub-division is performed (sector-type sub-division)
- The value of the parameter N_{S} which defines the number of zones in the angular dimension must be negative.
- The manually-spaced angular-sector boundaries S_{n} must cover the full/360 degrees angular space.
Sub-division pebble-bed structure (peb):
PBED | : stochastic particle / pebble-bed structure |
N_{UNI} | : number of universes to link related to the PBED structure (special case: 0 = link to all) |
UNI_{N} | : list of universes to link (non-zero number of universes) |
Notes:
- The pebble bed-based sub-division divides each item in a pebble bed universe as its own item.
- It features a speed-up on the depletion zone division indexing process with large number of pebble bed structures.
Sub-division limit enforcement (lims):
FLAG | : flag for mapping regions outside (material) limits to divide material: on (1/yes) or off (0/no). The default option is "off" |
dtrans (detector mesh transformation)
Defines detector mesh transformations. Shortcut for "trans d".
Notes:
- The parameters associated with the transformation follow the standard transformation cards syntax without trans TYPE identifier.
- See transformations.
ene (energy grid definition)
ene NAME TYPE [ ... ]
Defines an energy grid structure. Input values:
NAME | : energy grid name |
TYPE | : energy grid type |
The remaining parameters are type-dependent.
The available energy grid structure types are:
Type Description 1 arbitrary defined grid 2 equal energy-width bins 3 equal lethargy-width bins 4 pre-defined energy group structure
The syntax of the available types is as follows:
ene NAME 1 E_{0} E_{1} ...
E_{i} | : bin boundaries [in MeV] in ascending order (E_{i+1} > E_{i}) |
ene NAME 2 N E_{min} E_{max}
N | : number of equi-width bins |
E_{min} | : minimum energy [in MeV] |
E_{max} | : maximum energy [in MeV] |
ene NAME 3 N E_{min} E_{max}
N | : number of equi-width bins |
E_{min} | : minimum energy [in MeV] |
E_{max} | : maximum energy [in MeV] |
ene NAME 4 GRID
GRID | : name of the pre-defined energy group structure |
Notes:
- Energy grid structures are used for several purposes, e.g. with detectors (de entry in the det card).
ftrans (fill transformation)
Defines fill transformations. Shortcut for "trans f".
Notes:
- The parameters associated with the transformation follow the standard transformation cards syntax without trans TYPE identifier.
- 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 |
The remaining input values are type-dependent.
Notes:
- The defined function is linked to detector response using MT -100 (syntax: dr -100 NAME).
- The defined function currently is only supported as a flux-based function, aka, flux multiplier.
The available function types are:
Type Description 1 point-wise tabular data
The syntax for the available types is as follows:
fun NAME 1 INTT X_{1} F_{1} X_{2} F_{2} ...
INTT | : is the interpolation type (1 = histogram, 2 = lin-lin, 3 = lin-log, 4 = log-lin, 5 = log-log) |
X_{i}, F_{i} | : are the tabulated variable-value pairs |
hisv (history variation matrix definition)
hisv [ BU_{1} NBR_{1} BR_{1,1} BR_{1,2} ... BR_{1,NBR1} ] [ BU_{2} NBR_{2} BR_{2,1} BR_{2,2} ... BR_{2,NBR2} ] ...
Defines the history variation matrix for the automated burnup sequence. Input values:
BU_{n} | : burnup steps at which the branches are invoked (positive value = burnup [in MWd/kg], negative value = time [in d]) |
NBR_{n} | : number branches in the n-th burnup step |
BR_{n,i} | : name of the i-th branch in the n-th burnup step |
Notes:
- The automated burnup sequence defined by the hisv card follows the same principle as the coef input card.
- The hisv card performs multiple depletions within a single depletion calculation following the historical variation sequence.
- It performs a restart at each of the listed burnup points, where it applies the variations defined in the listed branches for the given burnup point.
- The hisv card is used together with the branch card.
ifc (interface file)
ifc FILE [ setinmat N_{MAT} MAT_{1} MAT_{2} ... MAT_{NMAT} ] [ setoutmat N_{MAT} MAT_{1} MAT_{2} ... MAT_{NMAT} ]
Links a multi-physics interface file to be used with the current input. The first parameter:
FILE | : path to the multi-physics interface file |
The remaining parameters are defined by separate key words followed by the input values, being optional.
Notes:
- See also Coupled multi-physics calculations.
Optional entries:
Interface input materials (setinmat):
N_{MAT} | : number of input materials to link to the interface |
MAT_{n} | : name of the n-th input material linked to the interface |
Notes:
- It adds the possibility to link multiple input materials to the same interface, i.e. the same interface gives temperatures and densities (density factors) for multiple materials.
- If multiple input materials are linked to the interface using the 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).
- If the interface is not updated, the entry is not eligible.
- If the regular mesh-based interface is used and power is tallied in pin-type objects, the entry is not eligible.
- The option setinmat is referred as setmat up to version 2.1.31.
Interface output materials (setoutmat):
N_{MAT} | : number of output materials to link to the interface |
MAT_{n} | : name of the n-th output material linked to the interface |
Notes:
- It adds the possibility to link multiple output materials to the same interface, i.e. the same interface gives temperatures and densities (density factors) for multiple materials.
- If multiple input materials are linked to the interface using the 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).
- If the interface is not updated, the entry is not eligible.
- If the regular mesh-based interface is used and if power is not tallied on the same mesh, the entry is not eligible.
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 options, it cannot be used to read the values of another card.
- Nested included file paths must refer to the original base input file or current working directory.
lat (regular lattice definition)
lat UNI TYPE [ ... ]
Defines a regular lattice universe. Input values:
UNI | : universe name of the lattice |
TYPE | : lattice type |
The remaining input values are case/type-dependent.
Notes:
- See also Section 3.6 of ^{[1]}.
The available lattice definitions and types (condensed in five cases) are:
Case xy-plane description z-direction description Types I finite 2D lattice with square, hexagonal or triangular elements infinite z-direction 1 = square, 2 = X-type hexagonal, 3 = Y-type hexagonal, 14 = X-type triangular II infinite 2D lattice with square or hexagonal elements infinite z-direction 6 = square, 7 = Y-type hexagonal, 8 = X-type hexagonal III finite 2D lattice circular cluster array infinite z-direction 4 = circular cluster array IV infinite xy-plane finite 1D lattice with vertical stack 9 = vertical stack V finite 3D lattice with square or hexagonal elements finite 3D lattice 11 = cuboid, 12 = X-type hexagonal prism, 13 = Y-type hexagonal prism
The syntax of the available cases is as follows:
Case I: finite 2D lattice in xy-plane with square, X- or Y-type hexagonal, or X-type triangular elements, and infinite in z-direction.
lat UNI TYPE X_{0} Y_{0} N_{X} N_{Y} PITCH UNI_{1} UNI_{2} ...
X_{0} | : x-coordinate of the lattice origin (origin is in the center of the lattice) [in cm]. |
Y_{0} | : y-coordinate of the lattice origin (origin is in the center of the lattice) [in cm]. |
N_{X} | : number of lattice elements in x-direction |
N_{Y} | : number of lattice elements in y-direction |
PITCH | : lattice pitch [in cm] |
UNI_{n} | : list of universes filling the lattice positions |
Possible lattice definitions are:
Type Description 1 Square lattice 2 X-type hexagonal lattice 3 Y-type hexagonal lattice 14 X-type triangular lattice
Notes:
- Number of listed universes universes must be N_{X} × 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.
Case II:
infinite 2D lattice in xy-plane with infinitely repeating square or X- or Y-type hexagonal element, and infinite in z-direction.
lat UNI TYPE X_{0} Y_{0} PITCH UNI_{1}
X_{0} | : x-coordinate of the lattice origin [in cm] |
Y_{0} | : y-coordinate of the lattice origin [in cm] |
PITCH | : lattice pitch [in cm] |
UNI_{1} | : 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.
Case III:
finite 2Dl circular cluster array lattice in xy-plane and infinite in z-direction.
lat UNI TYPE X_{0} Y_{0} N_{R} N_{S,1} RADIUS_{1} THETA_{1} UNI_{1,1} UNI_{2,1} ... N_{S,2} RADIUS_{2} THETA_{2} UNI_{1,2} UNI_{2,2} ... ...
X_{0} | : x-coordinate of the lattice origin [in cm] |
Y_{0} | : y-coordinate of the lattice origin [in cm] |
N_{R} | : number of rings in the array |
N_{S,R} | : number of sectors in R-th ring |
RADIUS_{R} | : central radius of R-th ring [in cm] |
THETA_{R} | : angle of rotation of R-th ring [in degrees] |
UNI_{N,R} | : list of universes filling the sector positions in R-th 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.
Case IV:
infinite lattice in xy-plane, and finite 1D vertical stack in z-direction
lat UNI TYPE X_{0} Y_{0} N_{L} Z_{1} UNI_{1} Z_{2} UNI_{2} ...
X_{0} | : x-coordinate of the lattice origin [in cm] |
Y_{0} | : y-coordinate of the lattice origin [in cm] |
N_{L} | : number of lattice elements in z-direction (number of axial layers) |
Z_{n} | : z-coordinate of the n-th lattice element (lower boundary of the axial layer) [in cm] |
UNI_{n} | : universe name filling the n-th lattice position |
Possible lattice types are:
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}.
Case V:
finite 3D lattice in xyz-space with cuboidal or X- or Y-type hexagonal prism elements
lat UNI TYPE X_{0} Y_{0} Z_{0} N_{X} N_{Y} N_{Z} PITCH_{X} PITCH_{Y} PITCH_{Z} UNI_{1} UNI_{2} ...
X_{0} | : x-coordinate of the lattice origin [in cm] |
Y_{0} | : y-coordinate of the lattice origin [in cm] |
Z_{0} | : z-coordinate of the lattice origin [in cm] |
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 [in cm] |
PITCH_{Y} | : lattice pitch in y-direction [in cm] |
PITCH_{Z} | : lattice pitch in z-direction [in cm] |
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} × N_{Y} × 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 ^{[1]}.
mat NAME DENS [ tmp TEMP ] [ tms TEMP ] [ tft T_{MIN} T_{MAX} ] [ rgb R G B ] [ vol VOL ] [ mass MASS ] [ burn N_{R} ] [ fix ID TEMP ] [ moder THNAME ZA ] NUC_{1} FRAC_{1} [ NUC_{2} FRAC_{2} ] [ ... ]
Material definition. The mandatory parameters are:
NAME | : name of the material |
DENS | : density of the material (positive value = atomic density [in b^{-1}cm^{-1}], negative value = mass density [in g/cm^{3}]) |
NUC_{n} | : Identifier of n-th nuclide in composition |
FRAC_{n} | : fraction of n-th nuclide in composition (positive value = atomic fractions/density, negative values = mass fractions/density) |
The remaining parameters are defined by separate key words followed by the input values, being optional.
Notes:
- There is a special entry for the DENS parameter:
- "sum": to calculate the density from given nuclide fractions
- The nuclide identifier for nuclides with associated cross-sections corresponds to ZZAAA.ID and, for nuclides without associated cross-sections, e.g., decay nuclides, to ZZAAAI.
- The identifiers include Z, the atomic number; A, the mass number of the nuclide; I, the isomeric state (0 = ground state, 1 = metastable state); and ID, the library identifier.
- For more information, see the detailed description on Definitions.
Optional entries:
Material temperature for Doppler-broadening pre-processor (tmp):
TEMP | : temperature of the material [in K] |
Notes:
- It defines the material temperature for Doppler-preprocessor.
Material temperature for on-the-fly temperature treatment (tms):
TEMP | : temperature of the material [in K] |
Notes:
- It defines the material temperature for on-the-fly TMS temperature treatment.
Material temperature for coupled multi-physics calculations (tft):
T_{MIN} | : lower limit for material temperature [in K] |
T_{MAX} | : upper limit for material temperature [in K] |
Notes:
- It sets the temperature limits for material for coupled multi-physics calculations.
- It is used to define the minimum and maximum temperature for the TMS-treatment directly from the interface files (see ifc card).
- For more information, see the detailed description on the Multi-physics interface.
Material RGB-color (rgb):
R | : value for the red channel (between 0 and 255) |
G | : value for the green channel (between 0 and 255) |
B | : value for the blue channel (between 0 and 255) |
Notes:
- It assigns a dedicated RGB-color to the material for the material representation in geometry plots.
- If the entry is not provided, the material color is sampled randomly.
Material volume (vol):
VOL | : volume of the material [in cm^{3}] (3D geometry) or cross-sectional area [in cm^{2}] (2D geometry) |
Notes:
- It defines the material volume.
- Alternatives ways to provide the material volume includes:
- set mvol option, used to define the material volumes manually
- set mcvol option, used to define the material volumes automatically using the Monte Carlo checker routine at runtime.
- -checkvolumes command line option, used to evaluate the material volumes in an independent run.
- For more information, see the detailed description on material volumes definition.
Material mass (mass):
MASS | : mass of the material [in g] |
Notes:
- The material mass can be provided as an alternative to the material volume.
Material depletion flag (burn):
N_{R} | : option to flag the material as burnable (1/yes) or non-burnable (0/no). The default option is "non-burnable" |
Notes:
- In order to deplete the material and include it in the burnup calculation, the flag must be set to "1"
- The depletion zone division should be done using the div card. However,
- if a material is defined within a pin-structure, Serpent, by default if no div card is associated to the material, sub-divides the material in a pin-type level.
- in Serpent 1, the "flag" is interpreted as the number of annular regions (not recommended)
Material library information for nuclides without cross section data and their decay products (fix):
LIB | : library ID (e.g. "09c") for nuclides without cross section data. |
TEMP | : temperature for nuclides without cross section data [in K] |
Notes:
- It defines the library properties: identifier and temperature for the nuclides without cross section data, e.g. decay nuclides, within the material composition.
- Decay products from these nuclides may have cross section data and will inherit the library ID and temperature based on this card.
Material associated thermal-scattering data (moder):
THNAME | : name of the thermal scattering data library |
ZA | : nuclide ZA of the thermal scatterer (e.g. 1001 for H-1). |
Notes:
- It links the thermal-scattering data library for a given nuclide within the material composition.
- The thermal-scattering data library and the associated temperature treatment is defined by the therm card.
- A single material can include multiple "moder" entries to define thermal-scattering libraries form multiple nuclides, such as H-H20 and D-D20 in semi-heavy water.
mesh (mesh plot definition)
mesh ORI XPIX YPIX [ SYM MIN_{1} MAX_{1} MIN_{2} MAX_{2} MIN_{3} MAX_{3} ]
mesh 8 CMAP DET ORI XPIX YPIX [ SYM MIN_{1} MAX_{1} MIN_{2} MAX_{2} MIN_{3} MAX_{3} ]
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 [in cm] |
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 produces a mesh plot of all scores contributing 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 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.
mflow (material flow definition)
mflow NAME NUC_{1} λ_{1} [ NUC_{2} λ_{2} ] [ ... ]
Defines the material flow. Input values:
NAME | : name of the material flow |
NUC_{n} | : identifier of n-th nuclide in composition |
λ_{n} | : reprocessing constant of n-th nuclide in composition [in s^{-1}] |
Notes:
- The nuclide ID should follow the ZAI or ISO format (e.g., 922350 or U-235).
- There is a special entry for the nuclide ID:
- "all": in which case all nuclides are included with the same reprocessing fraction λ.
mix (mixture definition)
mix NAME [ rgb R G B ] [ vol VOL ] [ mass MASS ] MAT_{1} F_{1} MAT_{2} F_{2} ...
Defines a mixture of two or several materials. Mandatory input values:
MAT_{n} | : material name |
F_{n} | : material fraction (positive value = volume fraction, negative value = mass fraction) |
The remaining parameters are defined by separate key words followed by the input values, being optional.
Notes:
- Mixtures can be used to define complicated material definitions consisting of two or more physical materials mixed homogeneously.
- The mixtures are automatically decomposed into standard materials before running the transport simulation.
- Alternatively, the decomposed material compositions can be written into file using the -mix command line option.
- Inherited properties/cards:
- Nuclide specific thermal scattering data (see moder entry in the mat card) is automatically brought from component materials to the mixture.
- Other input option such as set trc, set iter nuc, sens pert matlist are not automatically inherited by the mixture from the components.
- If they are to be applied to the mixture, they should be directly defined using the mixture material name (opposed to component material names) .
- Burnable mixtures are not supported.
Optional entries:
Mixture RGB-color (rgb):
R | : value for the red channel (between 0 and 255) |
G | : value for the green channel (between 0 and 255) |
B | : value for the blue channel (between 0 and 255) |
Notes:
- RGB color coding for material representation in geometry plots.
Mixture volume (vol):
VOL | : volume of the material [in cm^{3}] (3D geometry) or cross-sectional area [in cm^{2}] (2D geometry) |
Mixture mass (mass):
MASS | : mass of the material [in g] |
nest (nested universe definition)
nest UNI_{0} TYPE [ MAT_{1} R_{1} ] [ MAT_{2} R_{2} ] ... [ MAT_{N} ]
nest UNI_{0} [ MAT_{1} TYPE_{1} PARAM_{11} PARAM_{12} ... ] [ MAT_{2} TYPE_{2} PARAM_{21} PARAM_{22} ... ] ... [ MAT_{N} ]
Defines a universe consisting of nested regions. Input values:
UNI_{0} | : universe name |
TYPE | : nested surface type (single surface for all regions) |
MAT_{1} ... MAT_{N} | : material regions |
R_{1} ... R_{N-1} | : outer radii [in cm] |
TYPE_{1} ... 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.
- Special MAT_{i} entry: the material entries can be replaced by "fill UNI_{i}", in which case the region is filled by another universe, UNI_{i}.
- 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 UNI_{0} [ MAT_{1} R_{1} ] [ MAT_{2} R_{2} ] ... [ MAT_{N} ]
Defines a particle universe. Input values:
UNI_{0} | : universe name |
MAT_{1} ... MAT_{N} | : material regions |
R_{1} ... R_{N-1} | : outer radii [in cm] |
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.
- Special MAT_{i} entry: the material entries can be replaced by "fill UNI_{i}", in which case the region is filled by another universe, UNI_{i}.
- 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 definition)
pbed UNI_{0} UNI_{bg} FILE [ OPT ]
Defines a stochastic particle / pebble-bed geometry. Input values:
UNI_{0} | : universe name for the dispersed medium |
UNI_{bg} | : background universe, i.e. universe filling the space between particles / pebbles |
FILE | : input file containing the particle/pebble data |
OPT | : additional options |
The syntax of the file containing the particle/pebble data is:
X_{1} Y_{1} Z_{1} R_{1} UNI_{1} X_{2} Y_{2} Z_{2} R_{2} UNI_{2} ...
where:
X_{n}, Y_{n}, Z_{n} | : are the coordinates [in cm] |
R_{n} | : is the radius [in cm] |
UNI_{n} | : is the universe |
The supported additional options are:
Option Description pow power distribution
Notes:
- Creates a universe (UNI_{0}), 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 -disperse command line option which launches the particle disperser routine.
- Can be used for modelling stochastic particle / pebble-bed geometries in multiple levels.
- If the "pow" (power distribution) option is set, the pebble/particle-wise distribution is written in file [FILE]_pow[bu].m, where "bu" is the burnup step, from version 2.2.1 and on (in previous versions, [FILE].out).
- See also HTGR geometry examples.
phb (pulse-height Gaussian energy broadening definition)
phb NAME TYPE [ ... ]
Defines a user-defined (Gaussian) energy broadening function for pulse-height detector (dphb). Input values:
NAME | : pulse-height (Gaussian) energy broadening function name |
TYPE | : pulse-height function type |
The remaining input values are type-dependent.
The pulse-height funtion types are:
The syntax for the available types is as follows:
phb NAME 1 INTT E_{max,1} R_{1} E_{max,2} R_{2} ...
INTT | : is the interpolation type (currently only supported type is 2 = lin-lin interpolation data) |
E_{max,i}, R_{i} | : are the maximum energy-resolution tabulated pairs [in MeV (energy)] |
Notes:
- Full width at half maximum is calculated as:
- Energies should be given in ascending order.
phb NAME 2 INTT E_{max,1} FWHM_{1} E_{max,2} FWHM_{2} ...
INTT | : is the interpolation type (currently only supported type is 2 = lin-lin interpolation data) |
E_{max,i}, FWHM_{i} | : are the maximum energy-full width at half maximum pairs [in MeV (energy)] |
Notes:
- Energies should be given in ascending order.
phb NAME 3 a b
a, b | : are the parameters to define the energy resolution fit: |
phb NAME 4 a b c
a, b, c | : are the parameters to define the energy full width at half maximum fit: |
pin (pin geometry definition)
pin UNI_{0} [ MAT_{1} R_{1} ] [ MAT_{2} R_{2} ] ... [ MAT_{N} ]
Defines a pin universe. Input values:
UNI_{0} | : universe name |
MAT_{1} ... MAT_{N} | : material regions |
R_{1} ... R_{N-1} | : outer radii [in cm] |
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.
- Special MAT_{i} entry: the material entries can be replaced by "fill UNI_{i}", in which case the region is filled by another universe, UNI_{i}.
- 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_{1} MAX_{1} MIN_{2} MAX_{2} ]
plot TYPE F_{min} F_{max} E XPIX YPIX [ POS MIN_{1} MAX_{1} MIN_{2} MAX_{2} ]
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 [in cm] |
MIN_{1} | : minimum horizontal coordinate of plotted region [in cm] |
MAX_{1} | : maximum horizontal coordinate of plotted region [in cm] |
MIN_{2} | : minimum vertical coordinate of plotted region [in cm] |
MAX_{2} | : maximum vertical coordinate of plotted region [in cm] |
F_{min} | : minimum importance for importance map plots |
F_{max} | : maximum importance for importance map plots |
E | : particle energy for importance map plots [in MeV] |
Notes:
- The TYPE parameter consists of one ('A') or two concatenated values ('AB'):
- The first value ('A') defines the plot plane (yz-plot = 1, "x", xz-plot = 2, "y", xy-plot = 3, "z").
- The second value ('B') defines which boundaries are plotted (0 = no boundaries, 1 = cell boundaries, 2 = material boundaries, 3 = both cell and material boundaries).
- If the second value ('B') is not provided, default value 2 = material boundaries is used.
- The relative dimensions of image size (XPIX, YPIX) should match that of the plotted region. Otherwise the image gets distorted.
- The position parameter POS 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: MIN_{n}, MAX_{n}, define the boundaries of the plotted region (e.g. minimum and maximum x- and y-coordinates for xy-type plot).
- If the coordinates are not provided, the plot is extended to the maximum dimensions of the geometry.
- The second format allows to plot he importance maps read using the wwin card:
- They can be plotted on top of the geometry by setting the second value ('B') of the type parameter for:
- Cell importances: 4 (linear color scheme) or 5 (logarithmic color scheme)
- Source importances: 6 (linear color scheme) or 7 (logarithmic color scheme)
- The input parameters include the minimum and maximum importance (F_{min}, F_{max}) and the particle energy, E.
- If importance maps are provided for both neutrons and photons, they can be plotted by entering positive and negative energy values, respectively.
- If both, minimum and maximum importance values are set to "-1", Serpent automatically adjusts them based on the weight-window mesh data, from version 2.2.0 and on.
- If the calculation fails on providing those minimum and maximum values due to the weight-window evaluation, the values are set by default to (1E-200, 1E+200).
- Note to developers: particle type should be included as an input parameter in importance map plots.
- They can be plotted on top of the geometry by setting the second value ('B') of the type parameter for:
- Material colors:
RGB value Color Description (0, 0, 0) COLOR Outside cell or void-material (0, 255, 0) COLOR No cell found at coordinates (255, 0, 0) COLOR Overlap of multiple cells found at coordinates (255, 0, 255) COLOR Undefined material density factor at coordinates
- Geometry plotter requires compiling the source code with GD Graphics libraries.
- Command line options:
- See also detailed description on geometry plotter.
- The geometry plot produced by the n-th plot-card is written in file [input]_geom[n].png.
rep (reprocessor definition)
rep NAME [ rc SRC TGT MFLOW MODE ] [ rm MAT_{1} MAT_{2} ] [ ru UNI_{1} UNI_{2} ]
Defines the reprocessing controllers. The first parameter:
NAME | : name of the reprocessor. |
The remaining parameters are defined by separate key words followed by the input values.
Notes:
- The reprocessor name identifies the reprocessing regime in the depletion calculation dep card. The syntax corresponds to dep pro NAME.
- Multiple reprocessing controllers/regimes can be defined within the same reprocessor definition.
Reprocessing regime types:
Reprocessing continuos regime (rc):
SRC | : name of the source material, from which the flow is moved |
TGT | : name of the target material, to which the flow is moved |
MFLOW | : name of the material flow |
MODE | : continuous reprocessing mode |
Notes:
- The nuclides identifier of those included in both source SRC and target TGT materials in reprocessors should follow the same format
- ZA.ID or ISO.ID (for nuclides with cross sections) or ZAI (for nuclides without associated cross sections, and adding the fix entry to the mat card).
- For more information, see the detailed description on Nuclide IDs).
- The continuous reprocessing regime works with materials, not universes. Therefore, define the universes associated with those burnable materials as surface-cell type universes.
- The continuous reprocessing regime can be used to define the material flow between the source and the target materials.
- The material flow is defined using the mflow card.
- The continuous reprocessing MODE defines how to incorporate the material flow into the Bateman equations:
MODE Material source Material target Material flow 0 1 2
- MODE 0 : no changes at the source material and adds λN_{0} from the source material to the target material when solving the Bateman equations (N_{0} are initial compositions).
- MODE 1 : subtracts λN from the source material and adds it to the target material when solving the Bateman equations.
- MODE 2 : subtracts λN_{n} from the source material and adds it to the target material when solving the Bateman equations (compositions updated with each burnup step, n).
Reprocessing material regime (rm):
MAT_{1} | : name of the replaced material |
MAT_{2} | : name of the replacing material |
Notes:
- The material reprocessing regime replaces one material with another, MAT_{1} by MAT_{2}.
Reprocessing universe regime (ru):
UNI_{1} | : name of the replaced universe |
UNI_{2} | : name of the replacing universe |
Notes:
- The universe reprocessing regime replaces one universe with another, UNI_{1} by UNI_{2}.
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 [in cm] |
X_{MAX} | : maximum coordinate to sample from in the x-direction [in cm] |
N_{Y} | : number of values to sample in the y-direction. |
Y_{MIN} | : minimum coordinate to sample from in the y-direction [in cm] |
Y_{MAX} | : maximum coordinate to sample from in the y-direction [in cm] |
N_{Z} | : number of values to sample in the z-direction. |
Z_{MIN} | : minimum coordinate to sample from in the z-direction [in cm] |
Z_{MAX} | : maximum coordinate to sample from in the z-direction [in cm] |
Notes:
- The data from each sample is written in a separate output file:
- Default: [input]_sample[n].m, where "n" is the sample number.
- Coupled multi-physics calculation: [input]_sample[n]_iter[i].m, where "i" is the iteration number.
- Burnup calculations: [input]_sample[n]_bstep[bu].m, where "bu" is the burnup step index.
- Coupled multi-physics calculation: [input]_sample[n]_bstep[bu]_iter[i].m
- Time-dependent calculations: [input]_sample[n]_tstep[t].m, where "t" is the time step index
- Coupled multi-physics calculation: [input]_sample[n]_tstep[t]_iter[i].m
- Sampling units:
- Density: positive values = atomic densities [in b^{-1} cm^{-1}], negative value = mass density [in g/cm^{3}].
- Temperature: [in K]
- Materials with no temperature specified either in their mat card or through an interface ifc card definition will show a temperature of 0 K.
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_{0} BGUNI MESH_SPLIT MESH_DIM SZ_{1} SZ_{2} ... SZ_{MESH_DIM} POINTS_FILE FACES_FILE OWNER_FILE NEIGHBOUR_FILE MATERIALS_FILE
Creates an unstructured mesh-based geometry universe. Input values are:
UNI_{0} | : 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 |
Notes:
- For more information on the unstructured mesh based geometry see Unstructured mesh based input.
- For a practical example: Simple umsh 8 cubes input.
solid 2 UNI_{0} BGUNI MESH_SPLIT MESH_DIM SZ_{1} SZ_{2} ... SZ_{MESH_DIM} MODE R0 body BODY_{1} CELL_{1} MAT_{1} file BODY_{1} FILE_{1} SCALE_{1} X_{1} Y_{1} Z_{1} file BODY_{1} FILE_{2} SCALE_{2} X_{2} Y_{2} Z_{2} ... body BODY_{2} CELL_{2} MAT_{2} file BODY_{2} FILE_{3} SCALE_{3} X_{3} Y_{3} Z_{3} file BODY_{2} FILE_{4} SCALE_{4} X_{4} Y_{4} Z_{4} ...
Creates an STL-based geometry universe. Input values are:
UNI_{0} | : 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} |
Notes:
- Special MAT_{i} entry: the material entries can be replaced by "fill UNI_{i}", in which case the region is filled by another universe, UNI_{i}.
- For a practical example: Stanford critical bunny.
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 more information on the unstructured mesh based geometry see Unstructured mesh based input.
- For a practical example: Simple umsh 8 cubes input.
src (source definition)
src NAME [ PART ] [ sw WGT ] [ sc CELL ] [ su UNI ] [ 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 ] [ sa PHI ] [ se E ] [ sb N INTT E_{1} WGT_{1} E_{2} WGT_{2} ... ] [ sr NUC MT ] [ st T_{MIN} T_{MIN} ] [ sf FILE TYPE ] [ si N P_{1} P_{2} ... ] [ sg MAT MODE ]
Source definition. The two first parameters:
NAME | : source name |
PART | : particle type (n = neutron, p = photon) |
The remaining parameters are defined by separate key words followed by the input values.
Notes:
- The particle type PART is optional in single particle simulations.
- A single source card may include one or several source types.
Source types:
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/(vertical) cylinder around the cell (using the sx, sy and sz or sp, srad and sz options, respectively).
- If no spatial distribution is defined, particles are sampled uniformly over the geometry.
Source universe (su):
UNI | : universe inside which the source points are sampled |
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/(vertical) cylinder around the cell (using the sx, sy and sz or sp, srad and sz options, respectively).
- If no spatial distribution is defined, particles are sampled uniformly over the geometry.
Source point (sp):
X, Y, Z, | : coordinates of the source point [in cm] |
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 [in cm] |
Y_{MIN}, Y_{MAX} | : boundaries on Y-axis [in cm] |
Z_{MIN}, Z_{MAX} | : boundaries on Z-axis [in cm] |
R_{MIN}, R_{MAX} | : radial boundaries [in cm] |
Notes:
- Source boundaries are used to define a bounding box/(vertical) 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.
Source surface (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.
- The default behavior is that particles are started in the direction of the outward surface normal.
- Positive and negative surface entries refer to neutrons being emitted in the direction of the positive and negative surface normal, respectively.
- Meaning: positive = outward, negative = inward - same convention as for the surface detectors.
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 angular-aperture (sa):
PHI | : polar angle [in degrees] |
Notes
- The source angular-aperture option can be set to define the semi-aperture with respect a direction.
- The option requires the definition of a unidirectional source (sd).
Source energy (se):
E | : energy of source particles [in MeV] |
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 [in MeV] |
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.
- Here, a simple test input that demonstrates the source spectrum definition.
Source reaction (sr):
NUC | : nuclide name |
MT | : reaction number identifier |
Notes:
- The source reaction determines a distribution function for source energy (for example, ^{235}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 [in s] |
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: [ x y z u v w E wgt t ] .
- Source files can be produced using the df entry of detector cards, or the set csw or set gsw options.
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 |
MODE | : sampling mode (1 = analog, 2 = implicit) |
Notes:
- Radioactive decay source combines material compositions to decay data read from ENDF format^{[3]} libraries and forms the normalized source distribution automatically.
- Radioactive material:
- Sampling mode:
- 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.
- The radiation types included are discrete line and continuum spectra for photon and neutron reactions.
- The radioactive decay source in version 2.1.28 and earlier is limited to photon line spectra.
- The calculation produces an additional output file [input]_gsrc.m or [input]_nsrc.m that contains the gamma/neutron source spectra, respectively.
- See practical example for more information.
strans (surface transformation)
Defines surface transformations. Shortcut for "trans s".
Notes:
- The parameters associated with the transformation follow the standard transformation cards syntax without trans TYPE identifier.
- See transformations.
surf (surface definition)
surf NAME TYPE [ PARAM_{1} PARAM_{2} ... ]
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_{1} LIB_{2}
therm NAME 0 LIB_{1} LIB_{2} LIB_{3} ...
thermstoch NAME TEMP LIB_{1} LIB_{2}
Defines thermal scattering data that can be linked to nuclides using input entry moder in the material cards. 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 [in K] |
Notes:
- On-the-fly thermal motion sampling (TMS) temperature treatment:
- It requires the third value of the therm card to be set to "0"
- The thermal scattering data is automatically interpolated to the local temperature.
- The local temperature is either defined using:
- The thermal scattering libraries LIB_{i} must cover the whole range in which the materials appear in the geometry, i.e. data extrapolation is not supported.
- Interpolation:
- Thermal scattering data is interpolated using the methodology of makxsf code^{[4]}.
- Alternatively, the interpolation can be performed using the stochastic mixing approach with the thermstoch entry.
- This interpolation mode doesn't support on-the-fly interpolation.
- The continuous S(α, β) formalism:
- It is available from version 2.1.32 on.
- The on-the-fly temperature treatment is available from version 2.2.0 and on.
tme (time binning definition)
tme NAME 1 LIM_{1} LIM_{2} ...
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 [in s] |
T_{min} | : minimum time boundary in uniform or log-uniform binning [in s] |
T_{max} | : maximum time boundary in uniform or log-uniform binning [in s] |
Notes:
- 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 [ IDX ] LVL
trans TYPE UNIT [ IDX ] X Y Z
trans TYPE UNIT [ IDX ] X Y Z θ_{x} θ_{y} θ_{z} ORD
trans TYPE UNIT [ IDX ] X Y Z α_{1} α_{2} α_{3} α_{4} α_{5} α_{6} α_{7} α_{8} α_{9} ORD
trans TYPE UNIT [ IDX ] rot X_{0} Y_{0} Z_{0} I J K β
Defines surface, universe, fill, lattice, detector mesh or source transformation. Input values:
TYPE | : type of transformation (S = surface, F = fill, U = universe, L = lattice, D = detector mesh, SR = source) |
UNIT | : surface, cell, universe, lattice, detector mesh or source name to which the transformation is applied |
IDX | : index number of lattice position to which the lattice transformation (type L) is applied |
LVL | : level number in universe level transformation |
X,Y,Z | : translation vector [in cm] |
θ_{x} θ_{y} θ_{z} | : rotation angles with respect to x-, y- and z-axes [in degrees] |
α_{1} ... α_{9} | : coefficients of the rotation matrix |
ORD | : order in which translations and rotations are applied (1 = rotations first, 2 = translations first) |
X_{0},Y_{0},Z_{0} | : origin of vector defining rotation axis [in cm] |
I,J,K | : components of vector defining rotation axis. |
β | : angle around rotation axis defined by a vector [in degrees]. |
The possible transformation types are:
Type Description Notes s surface f fill It is applied in the universe filling the given cell. u universe Special type: level transformation, in which the coordinates in the given universe are obtained relative to geometry level LVL. l lattice It requires to provide the index number IDX of lattice position to which the transformation is applied. d mesh detector It is associated to mesh detectors (such as dx, dy, dz, dh, dn or dmesh, see det card) sr source It is inverted compared to how surface, universe, etc. are handled
Notes:
- Translations: by providing the translation vector.
- By default translations are applied before rotations, and the order can be switched using the ORD parameter.
- Rotations:
- With respect x-/y-/z-axes: 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:
- With respect x-/y-/z-axes: either by providing the three angles with respect to the three coordinate axes, or by defining the rotation matrix.
- where and are the position vectors before and after the operation and coefficients α_{1} ... α_{9} define the 3 by 3 matrix .
- With respect a general axes: using the rot keyword and associated syntax.
- In Serpent 2.1.29, a positive value of β corresponds to rotation to the negative mathematical direction and vice versa.
- Backwards compatibility:
- To preserve backwards compatibility, input parameters "strans", "utrans", "ftrans" and "dtrans" without the following type identifier are also accepted for defining surface, universe, fill and detector mesh transformations, respectively.
- To preserve compatibility with Serpent 1, parameter "trans" without type identifier defines a universe transformation.
transb (burnup transformation)
transb STEP [ <trans> ]
Defines burnup-dependent surface, universe, fill, lattice, detector mesh or source transformation. Input values:
STEP | : depletion step (positive value = burnup [in MWd/kg], negative value = time [in d]) |
<trans> | : list of parameters associated with the transformation |
Notes:
- The parameters associated with the transformation follow the standard transformation cards syntax without trans identifier.
- Standard properties applicable to regular or non-time dependent transformations apply.
- For more information, see detailed description on transformations (trans card).
- Geometry plots associated with burnup transformations are featured from version 2.2.1 and on.
transv and transa (velocity and acceleration transformations)
transv TYPE UNIT [ IDX ] [ tlim T_{0} T_{1} T_{TYPE} ] V_{X} V_{Y} V_{Z}
transa TYPE UNIT [ IDX ] [ tlim T_{0} T_{1} T_{TYPE} ] A_{X} A_{Y} A_{Z}
Defines a time-dependent surface, universe, fill, lattice, detector mesh or source transformation. Input values:
TYPE | : type of transformation (S = surface, F = fill, U = universe, L = lattice, D = detector mesh, SR = source) |
UNIT | : surface, cell, universe, lattice, detector mesh or source name to which the transformation is applied |
IDX | : index number of lattice position to which the lattice transformation (type L) is applied |
T_{0} | : beginning time of the transformation [in s] |
T_{1} | : end time of the transformation [in s] |
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 [in cm/s] |
A_{X},A_{Y},A_{Z} | : initial acceleration vector [in cm/s^{2}] |
Notes:
- Standard properties applicable to regular or non-time dependent transformations apply.
- The transformation is updated at the simulation time-interval boundaries.
- The time-dependent transformation evaluation method option is defined by the set transtime option.
- For practical examples:
umsh (unstructured mesh-based geometry definition)
UNI BGUNI MESH_SPLIT MESH_DIM SZ_{1} SZ_{2} ... SZ_{MESH_DIM} POINTS_FILE FACES_FILE OWNER_FILE NEIGHBOUR_FILE MATERIALS_FILE
Defines an unstructured mesh-based geometry. Input values:
UNI | : universe name for the unstructured mesh-based 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 |
Notes:
- For more information, see the description of the solid description of how to create a 3D unstructured mesh-based universe geometry (solid card, type 1).
utrans (universe transformation)
Defines universe transformations. Shortcut for "trans u".
Notes:
- The parameters associated with the transformation follow the standard transformation cards syntax without trans TYPE identifier.
- See transformations.
voro (stochastic Voronoi tessellation geometry definition)
voro UNI_{0} UNI_{bg} R_{0} -1 NP UNI_{1} VF_{1} [ UNI_{2} VF_{2} ... ]
voro UNI_{0} UNI_{bg} R_{0} FILE
Defines a stochastic Voronoi tessellation geometry. Input values:
UNI_{0} | : universe name for the Voronoi medium |
UNI_{bg} | : background universe name filling all undefined space |
R_{0} | : test radius [in cm] |
NP | : number of seed points |
UNI_{m} | : sub-universe name for the m-th random fragmented polyhedral zone |
VF_{m} | : volume fraction associated to m-th random fragmented polyhedral zone |
FILE | : input file containing the Voronoi data |
The syntax of the file containing the Voronoi seed points data is:
X_{1} Y_{1} Z_{1} UNI_{1} X_{2} Y_{2} Z_{2} UNI_{1} ... X_{N} Y_{N} Z_{N} UNI_{1} X_{N+1} Y_{N+1} Z_{N+1} UNI_{2} ...
where:
X_{n}, Y_{n}, Z_{n} | : seed points coordinates [in cm] |
UNI_{m} | : sub-universe name for the m-th random zone associated to the given seed point |
Notes:
- The input consists of a list of seed points and associated sub-universes filling the Voronoi cells Alternatively, the number of seeds points and volume fractions of each zone can be provided, letting Serpent sample the positions randomly.
- The advantage of the first option is that the distribution can be defined explicitly, taking into account, for example, the varying level of fragmentation closer to the boundaries.
- The cell search and surfaces distances are based on search mesh and local short-list of points to reduce the computational effort.
- The search mesh is conditioned by the test radius, which should enclose the Voronoi polyhedral cells.
- Too small radius may result in geometry errors as some points are excluded from all the search mesh cells in which they should be.
- Too large radius may results in including points in cells that do not actually intersect with the polyhedral boundary.
- The search mesh is conditioned by the test radius, which should enclose the Voronoi polyhedral cells.
- The DENS parameter in the mcvol input option can be switched "on" to compensate the non-preservation of the volume fractions provided as input due to the randomness of the seed points.
- It applies calculated scaling factors to material densities preserving the original masses (scaling factor = volume MC routine / volume given)
wwgen (response matrix based importance map solver)
wwgen NAME LIM NI MOD ERG MSH MIN_{1} MAX_{1} SZ_{1} MIN_{2} MAX_{2} SZ_{2} MIN_{3} MAX_{3} SZ_{3} DET_{1} W_{1} [ DET_{2} W_{2} ... ]
wwgen NAME LIM NI MOD ERG MSH SZ_{1} SZ_{2} SZ_{3} LIM_{11} LIM_{12} ... LIM_{21} LIM_{22} ... LIM_{31} LIM_{32} ... DET_{1} W_{1} [ DET_{2} W_{2} ... ]
wwgen NAME LIM NI MOD ERG MSH X_{0} Y_{0} P NX NY MIN_{3} MAX_{3} SZ_{3} DET_{1} W_{1} [ DET_{2} W_{2} ... ]
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 (n-th coordinate) |
MAX_{n} | : maximum mesh boundary (n-th coordinate) |
SZ_{n} | : number of mesh cells (n-th coordinate) |
LIM_{nm} | : mesh boundary m-th (n-th coordinate) |
X_{0}, Y_{0} | : 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.
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_{1} DF_{1} WWG_{2} DF_{2} ... ] [ wi ITP NI WWG NX NY NZ NLOOP NTRK ISPL NSPL DSPL_{1} SX_{1} SY_{1} SZ_{1} DSPL_{2} SX_{2} SY_{2} SZ_{2} ...]
Defines a weight window mesh for variance reduction. The first parameter:
NAME | : a unique name to identify 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^{[5]}.
- 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.
Weight-window mesh paramters:
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 [in MeV] |
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 .
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 (positive value = atomic density [in b^{-1}cm^{-1}], negative values = mass density [in g/cm^{3}]) |
SZ_{i} | : minimum cell dimension [in cm] |
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 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.
- The DSPL and SZ_{i} 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.
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 absrate
set absrate A [ MAT ]
Sets normalization to total absorption rate. Input values:
F | : number of neutrons absorbed per second [in neutrons/s] |
MAT | : dummy parameter |
Notes:
- Normalization is needed to relate the Monte Carlo reaction rate estimates to a user-given parameter.
- Absorption includes all reactions in which the incident neutron is lost, i.e. all capture reactions and fission.
- The default normalization:
- It is set to unit total loss rate (neutron transport) and to unit total source rate (photon transport).
- In coupled neutron-photon transport simulations the normalization is driven by the neutron normalization.
- For other normalization options, see: set power, set powdens, set flux, set genrate, set fissrate, set lossrate, set srcrate, set sfrate.
- If multiple depletion histories and normalizations are defined in the input, the first normalization will be used with the first depletion history, the second normalization with the second depletion history and so on.
- See also Section 5.8 of ^{[1]}.
set acelib
set acelib LIB_{1} [ LIB_{2} LIB_{3} ... ]
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 [ENF]
Sets parameters for the calculation of assembly discontinuity factors (ADFs) and related net and partial currents. Input values:
UNI | : universe where spatial homogenization is performed |
SURF | : surface enclosing the universe |
SYM | : symmetry option (see separate list) |
ENF | : option to switch on (1/yes) or off (0/no) a non-standard calculation approach. The default option is "off" |
Notes:
- ADFs are calculated in the few-group structure for the group constant generation (see set nfg option).
- The calculation of ADFs is currently allowed only for infinite planes and square and hexagonal prisms.
- Sign moments of net and partial currents are not scored for Y-type infinite/truncated hexagonal prisms.
- Methodology:
- If 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.
- If 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.
- The default behaviour (standard approach) can be changed via the ENF parameter:
- If the flag is "on", it enforces a flat homogeneous flux distribution based on mean heterogeneous flux, skipping the diffusion solver, regardless of net-current value.
- The ENF parameter should be switched on only in rare cases (with understanding of the implications of the calculation setup).
- Setup:
- The surface is treated as super-imposed on the geometry, i.e. its parameters (coordinates) are relative to the root universe (see set root option).
- 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 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.
- The calculation parameters for the diffusion flux solver can be set using the set dfsol option.
- The surface is treated as super-imposed on the geometry, i.e. its parameters (coordinates) are relative to the root universe (see set root option).
- The ADFs are written in:
- [input]_res.m output file: homogenized group constants/ADFs sub-section
- [input].coe ouput file, via the set coefpara option: automated burnup sequence/coefficient matrix output.
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:
- The option enables the calculation of both total albedos (ratio of currents) and partial albedos (response matrix).
- Albedos are calculated in the few-group structure for the group constant generation (see set nfg option).
- Setup:
- The universe is needed only for labelling the results in the output files.
- The surface is treated as super-imposed on the geometry, i.e. its parameters (coordinates) are relative to the root universe (see set root option).
- 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 current direction is given relative to the surface normal vectors.
- The albedo estimates are written in:
- [input]_res.m output file: homogenized group constants/albedos sub-section
- [input].coe ouput file, via the set coefpara option: automated burnup sequence/coefficient matrix output.
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). (default value: 0) |
MODEG | : mode for photons (0 = no reactions included, 1 = include all reactions). (default value: 0) |
Notes:
- Analog reaction rates are calculated by counting sampled events and printed in a separate output file [input]_arr[bu].m, where "bu" is the burnup step.
- For more information, see the detailed description on the reaction rate output file.
set ba
set ba ZAI_{1} ZAI_{2} ...
Defines isotopes handled separately as burnable absorbers. Input values:
ZAI_{n} | : nuclide identifiers (ZAI) |
Notes:
- This input parameter can be used to separate the transmutation chains.
- Some burnup applications require separate treatment for isotopes that are used as burnable absorbers but also produced in fission.
- Isotope handled as the burnable absorber is created by duplicating the original and renaming it as ZAI_{n} + 1000.
- For Gd-155, for example, the fission product isotope would be assigned ZAI 641550 and the burnable absorber ZAI 642550.
- The input parameter defines the entire transmutation chain.
- Listing Gd-isotopes 641540 641550 641560 641570 641580 creates a transmutation path from Gd-154 to Gd-158.
- Listing only the main absorbers (641550 641570) produces a different result, since the capture products of Gd-155 and Gd-157 are lost.
set bala
set bala OPT
Sets OpenMP load balancing on or off. Input values:
OPT | : probability to store particles in common queue (0 = off, non-zero = 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.
- Default value:
- It is "on" with OPT= 1 with weight-window/variance reduction calculations and dynamic/time-dependent calculation modes.
- Otherwise, it is set "off".
- Before version 2.2.0, the default behaviour was always "off".
- When this option is set, the random number sequence is no longer preserved.
set bc
set bc MODE
set bc MODE ALB
set bc MODEX MODEY MODEZ
set bc MODEX MODEY MODEZ ALB
Sets the boundary conditions (BCs). Input values:
MODE | : boundary condition type in all directions |
MODEX | : boundary condition type in x-direction |
MODEY | : boundary condition type in y-direction |
MODEZ | : boundary condition type in z-direction |
ALB | : albedo |
The possible boundary condition types are:
Type Description Notes 1, black vacuum boundary condition(s) the particle is killed 2, reflective repeated (reflective) boundary condition(s) the particle is reflected back into the geometry 3, periodic repeated (periodic) boundary condition(s) the particle is moved to the opposite side of the geometry
Notes:
- The default boundary condition is vacuum in all directions.
- Direction-wise boundary conditions:
- Boundary conditions can be set for all directions at once: MODE.
- Boundary conditions can be set for x-/y-/z- direction separately: MODEX, MODEY, and MODEZ
- Boundary conditions can be defined with albedos by adding one additional parameter in the list, ALB.
- 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):
- They are based on universe transformations, which limits outer boundary to surfaces that form regular lattices (square and hexagonal prisms, rectangles, cubes and cuboids).
- They are applied on the first surface of outside cells (see definition of outside cells in the cell card)
- For universe symmetry options, see the set usym option.
- For more information, see the detailed description on the Boundary conditions.
set blockdt
set blockdt MAT_{1} MAT_{2} ...
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 option) in individual materials.
- The use of delta-tracking can be forced in individual materials using set forcedt option.
- 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_{1} [ LIB_{2} LIB_{3} ... ]
Sets isomeric branching data library file paths. Input values:
LIB_{n} | : library file paths |
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 decay data files in this path if not found at the absolute.
- Isomeric branching data libraries are standard ENDF format^{[3]} 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. In which case, the energy-dependent data read from ENDF format files override the constant ratios.
- See a practical example on how to evaluate branching ratios: example input.
- The isomeric branching data library corresponds to the JEFF-3.1 activation file File:JEFF-3.1 activation file.tgz.
set branchless
set branchless OPT [ WGT_LOW WGT_HIGH ]
Option that enables the branchless collision method for variance reduction. Input values:
OPT | : option to switch calculation on (1/yes) or off (0/no). The default option is "off". |
WGT_LOW | : weight lower-boundary (default value: 0.2) |
WGT_HIGH | : weight upper-boundary (default value: 10.0) |
Notes:
- The branchless algorithm suppresses the variability due to the simultaneous propagation of the several branches associated to a fission event
- The branchless method uses analog scattering combined with forced fission so that after each collision, the neutron is either a scattering neutron or a fission neutron.
- In a non-multiplying method, the branchless method behaves as implicit capture.
- The branchless method sets the following simulation configuration: reaction sampling (set nphys 1 1 1), reaction modes (set impl 0 1 1), and population control (set combing 1), overriding any user-defined option.
- The current implementation does not support the use of the branchless collision method combined with the unresolved resonance probability table sampling (see set ures option).
set bumode
set bumode MODE [ ORDER SSD ]
Sets the burnup calculation mode. Input values:
MODE | : burnup calculation mode (default value: 2 = CRAM) |
ORDER | : CRAM order (default value: 14 = PFD CRAM order 14) |
SSD | : number of substeps for CRAM decay steps (default value: 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:
- Positive values refer to PFD form of CRAM. Negative values of CRAM order mean using IPF form of CRAM with order of the absolute value of the parameter.
- 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.
- The latter, very low flux condition, only applies to calculations not involving continuous reprocessing.
- Positive values of SSD enforce usage of CRAM with given number of substeps. A zero value of SSD enforces usage of TTA.
- The Serpent 1 MODE 3, a variation TTA method, in which cyclic transmutation chains are handled by inducing small variations in the coefficients instead of solving the extended TTA equations, is overwritten by the standard TTA method MODE 1.
set bunorm
set bunorm NORM
Sets the burnup calculation normalization mode if it is not bound to a single material. Input values:
NORM | : burnup calculation normalization mode (1 = all materials, 2 = burnable materials, 3 = non-burnable materials). (default value: 1) |
set ccmaxiter
set ccmaxiter NITER
Sets the maximum number of coupled calculation iterations. Input values:
NITER | : number of iterations (default value: 1 = no iteration) |
Notes:
- The iteration is stopped when either the maximum number of iterations or the maximum active neutron population (set with set ccmaxpop) has been simulated.
- For more information, see the detailed description on Couple multi-physics calculations.
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 (default value: INFTY/1E6) |
Notes:
- 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.
- For more information, see the detailed description on Couple multi-physics calculations.
set cdop
set cdop OPT
Sets the Doppler broadening method for the energy spectrum of the scattered photons. Input values:
OPT | : option to set Doppler broadening method off (0/no) or on (1/yes). The default option is "on". |
Notes:
- If the Doppler broadening method is switched "off", the incoherent scattering function approximation is used for calculating the energy.
- In both cases, the direction of the photon is calculated using the incoherent scattering function.
- The photon transport physics model is described in a related paper^{[6]}
set cea
set cea OPT
Sets the Compton electron angular distribution model on and off. Input values:
OPT | : option to set the Compton electron angular distribution model off (0/no) or on (1/yes). The default option is "on". |
Notes:
- Electron travels in the direction of the momentum transfer vector. This is equal to the free-electron scattering angle when Doppler broadening is not used.
- The photon transport physics model is described in a related paper^{[6]}
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 [in cm] (default value: 20.0) |
TN | : minimum mean time interval for scoring the CFE for neutrons [in s] |
LG | : minimum mean distance for scoring the CFE for photons [in cm] (default value: 20.0) |
TG | : minimum mean time interval for scoring the CFE for photons [in s] |
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.
- 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 methodology is described in a related paper.^{[7]}
- 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:
- Methodology:
- The CMM diffusion coefficients and transport cross sections are reasonable only when they are calculated over entire geometry:
- The homogenized region covers the entire geometry and is surrounded by periodic or reflective boundary conditions.
- This means that e.g. pin cell diffusion coefficients can not be calculated from a 2D fuel assembly calculation.
- The CMM methodology was revised in version 2.1.31 so that the calculated values may be different than with previous versions.
- One may try to approximate the CMM estimates with the transport correction for hydrogen for light water reactor applications (see set trc option).
- The CMM diffusion coefficients and transport cross sections are reasonable only when they are calculated over entire geometry:
- Setup:
- CMM diffusion coefficients and transport cross sections can be calculated also when using implicit capture reactions (see set impl option), from version 2.1.31 and on.
- The calculation of CMM estimates (diffusion coefficients and transport cross sections) might take considerable time. Switch "off" the evaluation if the data is not needed.
- The use of private results array may be recommended when calculating CMM estimates (see set shbuf option).
- The CMM diffusion coefficients CMM_DIFFCOEF and transport cross sections CMM_TRANSPXS estimates are written in:
- [input]_res.m output file: homogenized group constants section - diffusion parameters: for infinite spectrum and critical spectrum.
- [input].coe ouput file, via the set coefpara option: automated burnup sequence/coefficient matrix output.
- The cumulative migration method (CMM) is described in related papers^{[8]}^{[9]}.
set coefpara
set coefpara FMT [ PARAM_{1} PARAM_{2} ... ]
Defines the parameters included in the separate group constant output file [input].coe. Input values:
FMT | : output format, currently used for including or excluding statistical errors (0 = not included, 1 = included). (default value: 0) |
PARAM_{n} | : list of parameters or detectors included in the file |
Notes:
- List of parameters or detectors to include:
- 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 det card.
- The group constant output file [input].coe is produced when the automated burnup sequence is invoked.
set combing
set combing MODE
Option that enables the combing approach for precursors population control as an alternative to Russian roulette and splitting in dynamic source simulations. Input values:
MODE | : combing population-control mode (0 = none, 1 = weight-based, 2 = emission-based). (default value: 0) |
Notes:
- The combing method can achieve variance reduction and save computer time by keeping the population size approximately constant over time steps.
- In super-critical systems, it prevents the population from growing without bound.
- In sub-critical systems, it prevents the population from dying.
- In critical systems, it avoids the divergence of the variance of the population due to fluctuations of fission chains.
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.
- The communication options set comfile, set ppid and set pport are mutually exclusive, aka, multiple signalling modes are not allowed.
- For more information, see the detailed description on 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). The default option is "off" |
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_{1} [ LIB_{2} LIB_{3} ... ]
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^{[10]} (ASCII or binary) |
Notes:
- It enables first-order uncertainty propagation by collapsing the covariance data with the evaluated sensitivities.
- It applies the Sandwich rule:
- where: is the sensitivity vector containing the group sensitivities
- is the covariance matrix containing the group covariances
- where: is the sensitivity vector containing the group sensitivities
- The methodology is described in a related report^{[11]}.
- It requires setting the sensitivity calculation parameters. For more information, see the detailed description on sensitivity calculations.
set covlib
set covlib LIB_{1} [ LIB_{2} LIB_{3} ... ]
Sets plain ASCII multi-group covariance data file paths. Input values:
LIB_{n} | : file paths to multi-group covariance data files in the plain ASCII format (ASCII or binary) |
The syntax of the file containing the covariance data is:
NG E_{1} ... E_{NG+1} NM ZAI_{1,1} MT_{1,1} ZAI_{1,2} MT_{1,2} COV_{1,1,1} ... COV_{1,NG,NG} ... ZAI_{NM,1} MT_{NM,1} ZAI_{NM,2} MT_{NM,2} COV_{NM,1,1} ... COV_{NM,NG,NG}
where:
NG | : number of neutron energy groups |
E_{g} | : energy grid boundaries [in MeV] |
NM | : number of covariance matrixes |
ZAI_{m,n}, MT_{m,n} | : 2 × nuclide (ZAI)-reaction (ENDF reaction MT) pairs defining the m-th covariance matrix |
COV_{m,g,g} | : NG × NG covariance data corresponding to the m-th matrix |
Notes:
- It enables first-order uncertainty propagation by collapsing the covariance data with the evaluated sensitivities.
- It applies the Sandwich rule:
- where: is the sensitivity vector containing the group sensitivities
- is the covariance matrix containing the group covariances
- where: is the sensitivity vector containing the group sensitivities
- The methodology is described in a related report^{[11]}.
- It requires setting the sensitivity calculation parameters. For more information, see the detailed description on sensitivity calculations.
set cpd
set cpd DEPTH [ N_{Z} Z_{MIN} Z_{MAX} ] [ LVL1 LVL2 ]
Sets on the calculation of lattice-wise power distributions to output file [input]_core0.m on. Input values:
DEPTH | : The number of lattice-levels included. |
N_{Z} | : Number of equal sized axial bins into which the lattices are divided (default value: 1) |
Z_{MIN} | : Minimum z-coordinate for the axial division [in cm] (default value: -INFTY) |
Z_{MAX} | : Maximum z-coordinate for the axial division [in cm] (default value: INFTY) |
LVL1 | : User-defined first level where to define the lattice-wise power distribution |
LVL2 | : User-defined second level where to define the lattice-wise power distribution |
Notes:
- The interpretation of the number of levels included is as follows:
- DEPTH 1: includes the first level from the root universe, which "usually" corresponds to the assembly-wise distribution.
- DEPTH 2: includes the first two levels from the root universe, which "usually" corresponds to the assembly- and pin-wise distributions.
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.
- From version 2.2.1 and on, multi-step depletion source files can be generated [FILE]_[bu], where "bu" is the burnup step. Otherwise, simply, [FILE].
set dataout
set dataout TABLE_LIST
Defines the tables included in the nuclear and material data file [input].out. Input values:
TABLE_LIST | : list of tables (default value: all/0) |
Possible list of tables: Possible key-words/variables are:
Key-word Table ID Description 0, all include all available tables 1, nuc_summary Table 1: Summary of nuclide data 2, nuc_readec Table 2: Reaction and decay data 3, nuc_nfy Table 3: Fission yield data only in burnp mode 4, nuc_lostpath Table 4: Lost transmutation paths only in burnup mode 5, mat_summary Table 1: Summary of material compositions 8, allnuc (nuclide) Tables 1-4 9, allmat (material) Tables 1 -1 omit the [input].out file
Notes:
- The output file data is divided into two sections: nuclear data (Tables 1-4) and material data (Table 1). Respectively, they include all the nuclides and their reactions as they are read from the nuclear data libraries, and the material data includes isotopic compositions and densities, as well as volumes and masses if available.
- For more information, see detailed description of the nuclear and material data output.
set dbrc
set dbrc E_{min} E_{max} NUC_{1} [ NUC_{2} ... ]
Enables the use of doppler-broadening rejection correction (DBRC). Input values:
E_{min} | : Minimum energy for DBRC [in MeV] |
E_{max} | : Maximum energy for DBRC [in MeV] |
NUC_{n} | : zero-kelvin nuclide identifiers for which to apply DBRC (e.g. "92238.00c") |
Notes:
- Use of DBRC requires 0 K cross section data.
- See also Section 5.6 of ^{[1]}.
- This input could be given without any nuclides before version 2.1.32. Then DBRC was not used at all.
set dd
set dd MODE [ X_{0} Y_{0} α_{0} ]
Invokes domain decomposition. Input values:
MODE | : decomposition mode (default value: 0) |
X_{0} | : x-coordinate of the domain decomposition origin (centre of the radial division, initial position of the angular division) [in cm] (default value: 0.0) |
Y_{0} | : y-coordinate of the domain decomposition origin (centre of the radial division, initial position of the angular division) [in cm] (default value: 0.0) |
α_{0} | : angular position of the domain decomposition origin [in degrees] (default value: 0.0) |
The possible modes are:
Mode Description Notes 0 none 1 depletion zone indexing-based decomposition not recommended 2 sector-based decomposition X_{0}, Y_{0} and α_{0} are available 3 sector-based + central division decomposition X_{0}, Y_{0} and α_{0} are available, only applicable if MPI-tasks > 4
Notes:
- Domain decomposition works in MPI mode by separating burnable materials into different parallel tasks.
- The number of domains is given by the number of MPI tasks.
- Only burnable materials separated into depletion zones using the sep entry in the div card are decomposed
- Decomposed materials are plotted in domain-specific colors (unless the rgb entry in the mat card is used)
- The domain decomposition methodology is described in a related paper^{[12]}.
- For more information, see the detail description and practical example on the Domain decomposition.
set declib
set declib LIB_{1} [ LIB_{2} LIB_{3} ... ]
Sets the decay data library file paths. Input values:
LIB_{n} | : library file paths |
Notes:
- Decay libraries are standard ENDF format^{[3]} 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.
- From version 2.2.0 and on, a default decay data library directory file can be set by defining environment variable SERPENT_DECLIB.
- This file will be used if no other path is given with set declib.
set decomp
set decomp OPT [ ELEM_{1} ELEM_{2} ... ]
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:
- Default values:
- Criticality source mode: the delayed neutron emission is "on"
- External (static/dynamic) source mode: the delayed neutron emission is "off"
- In time-dependent calculations, driven by the set dynsrc option, precursor based delayed neutron emission is included in the calculation
- "off" at fission, but "on" at delayed nubar in total nubar.
- See separate description of physics options in Serpent for differences to other codes.
set depmtx
set depmtx MODE
Print burnup matrixes to [input]_depmtx_[mat]_[bu]_[ss].m file during burnup calculation, where "bu" is the burnup step and "ss" is the substep. Input values:
MODE | : option to switch on (1/yes) or off (0/no) the printing of burnup matrixes. The default value is "off" |
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.
- The burnup matrix output is named depmtx_[mat][bu].m up to version 2.1.31.
set depout
set depout MODE [STEP]
Controls which burnable material compositions are printed into the binary [input].dep and plain text [input]_dep.m depletion output files in case of divided materials. Input values:
MODE | : value indicating, which materials to output to the [input].dep and [input]_dep.m files (1 = only partials, 2 = only parents, 3 = both). (default value: 2) |
STEP | : value indicating the print-out interval of the [input]_dep.m file (0 = final step, 1 = all steps, 2 = none). (default value: 1) |
Notes:
- Parent materials refer to materials defined by mat cards, and partials to depletion zones created automatically using the div card.
- If the post-processing re-depletion -rdep command line option is desired to print the partial material output (MODE value 1 or 3), the respective MODE value has to be present in the original depletion calculation.
- Print-out interval step option 2 (no [input]_dep.m generation) can be combined with the above-mentioned post-processing re-depletion to suppress the plain text output during the original depletion calculation.
- Combined with the domain decomposition feature (set dd option):
- If the mode is different from 2, it generates multiple depletion files which are named adding _dd[mpiid] (domain decomposition identifier) to the standard file name.
- Each of them contains the partial materials information of the given domain/MPI task.
set deppara
set deppara PARAM_LIST
Defines the material- and isotopic-wise variables included in the depletion output file [input]_dep.m. Input values:
PARAM_LIST | : list of variables (default value: "all") |
Possible key-words/variables are:
Key-word Quantity Output ID Description atom atom density ADENS [in b^{-1}cm^{-1}] mass mass density MDENS [in g/cm^{3}] activity activity A [in Bq] dh decay heat H [in W] sf spontaneous fission rate SF [in fissions/s] gsrc photon emission rate GSRC [in photons/s] ingtox ingestion toxicity ING_TOX [in Sv] inhtox inhalation toxicity INH_TOX [in Sv] all include full-set of variables none exclude full-set of variables
Notes:
- For more information, see detailed description of the burnup calculation output.
set depstepbunorm
set depstepbunorm NORM
Sets the depletion step normalization in burnup calculations based on energy deposition. Input values:
NORM | : depletion step normalization mode based on energy deposition (1 = all materials, 2 = burnable materials) |
Notes
- Default values (see set edepmode):
- For energy deposition modes 0/1: the normalization includes only "burnable" materials - mode 2.
- For energy deposition modes 2/3: the normalization includes "all materials" - mode 1.
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). (default value: 1) |
DC | : type of diffusion coefficient used in the calculation (1 = out-scattering 2 = transport correction). (default value: 1) |
NP | : number of points for trapezoidal integration for homogeneous flux (default value: 100) |
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.
- The option syntax was revised in update 2.1.27 (DC option was added between MODE and NP).
- Deterministic diffusion flux solver use:
- Out-scattering approximation, INF_DIFFCOEF and INF_TRANSPXS.
- Transport correction, TRC_DIFFCOEF and TRC_TRANSPXS. It requires enabling the set trc option.
- For more information, see a detailed description on the built-in diffusion flux solver.
set dix
set dix OPT
Sets double indexing for cross section energy grid look-up on or off. Input values:
MODE | : option to set double indexing on (1/yes) or off (0/no) |
Notes:
- Double indexing 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), see set opti option.
- The methodology is described in related paper^{[13]}
set dspec
set dspec EGRID_{p} EGRID_{n}
Sets the energy grid structure for decay spectra. Input values:
EGRID_{p} | : energy grid structure for photons |
EGRID_{n} | : energy grid structure for neutrons |
Notes:
- The photon/neutron decay spectra is printed in the [input]_gsrc.m or [input]_nsrc.m output file, respectively.
- The energy group spectra only include the contribution from the discrete/line spectra.
- There is a special entry for the energy grid structure, EGRID:
- "-1": instead of providing the energy grid structure, it disables the option for the given particle type.
set dt
set dt NTRSH [ GTRSH ]
Sets probability threshold for delta-tracking. Input values:
NTRSH | : probability threshold for neutrons (default value: 0.9) |
GTRSH | : probability threshold for photons (default value: 0.9) |
Notes:
- Tracking algorithm mode:
- Delta-tracking is used by default for both neutrons and photons
- Switch to surface-tracking happens if the probability of sampling virtual collisions (ratio between material total cross section and the majorant) exceeds the given threshold.
- Probability threshold:
- The 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.
- To enforce delta-tracking mode always: use "1".
- To enforce surface-tracking mode always: use "0"
- 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 option).
- For more information on tracking modes, see the detailed description on delta- and surface-tracking.
set dynccfile
set dynccfile OPT
Option to store precursors and neutrons between time steps in coupled dynamic simulations into a file. Input values:
OPT | : option to switch on (1/yes) or off (0/no) the store/write dynamic data into a file. The default option is "on". |
set dynsrc
set dynsrc PATH [ MODE ]
Links previously generated steady state source distributions to be used in a transient simulation with delayed neutron emission. Input values:
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 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 [in MeV] (default value: -INFTY/"no cut-off") |
EMIN_{p} | : cut-off energy for photons [in MeV] (default value: 1.0E-3) |
Notes:
- 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 ecutdens
set ecutdens DENS_{1} EMIN_{p,1} [ DENS_{2} EMIN_{p,2} ... ]
Sets density-wise minimum energy cut-off for photons. Input values:
DENS_{i} | : mass density [in g/cm^{3}] |
EMIN_{p,i} | : cut-off energy for photons [in MeV] |
Notes:
- Mass densities and energy cut-offs must be given in ascending order.
set ecutmat
set ecutmat MAT_{1} EMIN_{p,1} [ MAT_{2} EMIN_{p,2} ... ]
Sets material-wise minimum energy cut-off for photons. Input values:
MAT_{i} | : material name |
EMIN_{p,i} | : cut-off energy for photons [in MeV] |
set eddi
set eddi OPT
Option that enables the calculation of Eddington factors. Input values:
OPT | : option to switch calculation on (1/yes) or off (0/no). The default option is "off". |
Notes:
- Requires group constant generation to be set on (see set gcu).
set edepdel
set edepdel OPT [ LOCAL_EGD ]
Option to include the energy of delayed components in energy deposition calculations. Input values:
OPT | : include (1/yes) or exclude (0/no) the energy of delayed components in energy deposition estimates (default value: 1) |
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). (default value: 0) |
Notes:
- Delayed components include delayed neutrons, delayed fission gammas and delayed betas.
- 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.
- The energy of delayed neutrons can be excluded using this option only in energy deposition mode "1" (see set edepmode option).
- Option to deposit the energy of the delayed fission gammas with the same distribution as the prompt fission gammas (LOCAL_EGD = 0) does not work in external source simulations and if it is used the energy of the delayed fission gammas is not accounted for.
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 | : option to switch the correction on (1/yes) or off (0/no). The default option is "on". |
Notes:
- The methodology is described in related paper. ^{[14]}
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 (default value: 0) |
E_CAPT | : additional energy release in capture reactions given [in MeVs per fission] (default value: 0.0) |
The possible setting for mode are:
Mode Description Evaluation 0 Constant energy deposition per fission E_{fiss,i} = (Q_{i}/Q_{235}) × H_{235} 1 Local energy deposition based on ENDF MT 458 data E_{fiss,i} = EFR_{i} + ENP_{i} + END_{i} + EGP_{i} + EGD_{i} + EB_{i} + E_{capt} 2 Local photon energy deposition E_{fiss,i} = EFR_{i} + EGP_{i} + EGD_{i} + EB_{i} 3 Coupled neutron-photon transport E_{fiss,i} = EFR_{i} + EB_{i}
Notes:
- The energy deposition modes are described in related paper ^{[14]} which also includes some discussion on the problems in the data used by the energy deposition modes.
- The additional energy release in capture reactions is only used in energy deposition mode "1"
- 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 (file endfb71_edep.tar.gz) containing additional data are required to use these modes.
- KERMA coefficients used in energy deposition modes "2" and "3" are not Doppler-broadened correctly by the built-in preprocessor. See Doppler-broadening preprocessor.
- The energy deposition modes "1", "2" and "3" have been tested mainly in criticality source simulations and one should proceed with caution when using them in other types of calculations such as transient and burnup calculations.
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 [in MeV] |
EMAX | : maximum energy in the grid [in MeV] |
Notes:
- Default values:
- Fractional reconstruction tolerance: 0.0 (transport calculation mode), 5.0E-05 (burnup calculation mode)
- Energy grid boundaries: [1.0E-11, 20.0] (neutrons), [1.0E-03, 100.0] (photons)
- A higher energy grid reconstruction tolerance means lower memory consumption and possibly higher computation speed but also reduced accuracy of the calculation.
- See also Section 5.3 of ^{[1]}.
set ekn
set ekn E
Sets the Klein-Nishina equation to approximate a Compton scattering event. Input values:
E | : energy cut-off for modelling energy and direction of the scattered photon [in MeV] (default value: INFTY/"no cut-off") |
Notes:
- The Klein-Nishina equation is used above E for calculating both the energy and direction of the scattered photon. Below E, the Doppler brodening method is used if switched on. Otherwise, the incoherent scattering function approximation is in use.
- The photon transport physics model is described in a related paper^{[6]}
set elcond
set elcond MAT_{1} COND_{1} [ MAT_{2} COND_{2} ... ]
Sets material-wise conductivity state for electrons in photon transport calculations. Input values:
MAT_{i} | : material name |
COND_{i} | : conductivity state (0 = non-conductor, 1 = conductor, 2 = conduction electron dependent). (default value: 2) |
Notes:
- If the material is set as a conductor and no-conduction electrons are found, the material conductivity state is overwritten to non-conductor.
- For conductivity state 2, conduction electron dependent, establishes that a single element material is a conductor if conduction electrons are found, otherwise is a non-conductor. A compound is always a non-conductor.
set elgas
set elgas MAT_{1} GAS_{1} [ MAT_{2} GAS_{2} ... ]
Sets material-wise phase for electrons in photon transport calculations. Input options:
MAT_{i} | : material name |
GAS_{i} | : phase state (0 = condensed or non-gas, 1 = gas). (default value: 0) |
Notes:
- The default option "0/condensed" only affects mixtures.
- The gas phase does not affect the mean excitation energy of a single material: if set elmee option is set for a material, the material is considered as non-gas.
set elmee
set elmee MAT_{1} MEE_{1} [ MAT_{2} MEE_{2} ... ]
Sets material-wise mean excitation energy for electrons in photon transport calculations. Input values:
MAT_{i} | : material name |
MEE_{i} | : electrons mean excitation energy [in MeV] (default value: -1) |
Notes:
- There is a special entry for the MEE_{i} parameter:
- "-1": mean excitation energy calculated during runtime for compounds and extracted from data for single element materials.
- The maximum mean excitation energy for electrons is 1 MeV.
set elspn
set elspn EGRID_E
Sets the stopping power energy grid size for electrons/positrons in photon transport calculations. Input values:
EGRID_E | : energy grid size (default value: 200) |
Notes:
- The thick-target bremsstrahlung model (see set ttb option) assumes that the energy array is uniformly distributed in a log-energy scale.
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 (default value: 5) |
N_{Y} | : number of mesh cells in y-direction (default value: 5) |
N_{Z} | : number of mesh cells in z-direction (default value: 5) |
X_{MIN} | : minimum mesh boundary in x-direction [in cm] |
X_{MAX} | : maximum mesh boundary in x-direction [in cm] |
Y_{MIN} | : minimum mesh boundary in y-direction [in cm] |
Y_{MAX} | : maximum mesh boundary in y-direction [in cm] |
Z_{MIN} | : minimum mesh boundary in z-direction [in cm] |
Z_{MAX} | : maximum mesh boundary in z-direction [in cm] |
Notes:
- Shannon entropy is used to monitor fission source convergence, in criticality source simulations.
- For more information, see detailed description on fission source convergence.
- The calculation is invoked by setting the generation history record option on the set his option.
- It records the distribution of source points on mesh: [input]_his[n].m, where "n" is the burnup index.
- For more information, see detailed description on the History output.
- If no mesh boundaries are specified, the mesh extends over the entire geometry.
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_{1} E_{1} ZAI_{2} E_{2} ...
Overrides default fission heating values. Input values:
ZAI_{n} | : nuclide identifiers (ZAI) |
E_{n} | : energy deposited per fission [in MeV] (default value: 202.27) |
Notes:
- The energy deposited per fission includes additional energy released in capture reactions when fission neutrons are absorbed.
- The energy release per fission value for other actinides is scaled based the Q-values found in the cross section libraries in reference with the U-235 value set.
- See also set U235H option.
- See also Section 5.8 of ^{[1]}.
set fissrate
set fissrate F [ MAT ]
Sets normalization to fission rate. Input values:
F | : number of fission reactions per second [in 1/s] |
MAT | : dummy parameter |
Notes:
- Normalization is needed to relate the Monte Carlo reaction rate estimates to a user-given parameter.
- The default normalization:
- It is set to unit total loss rate (neutron transport) and to unit total source rate (photon transport).
- In coupled neutron-photon transport simulations the normalization is driven by the neutron normalization
- For other normalization options, see: set power, set powdens, set flux, set genrate, set absrate, set lossrate, set srcrate, set sfrate.
- If multiple depletion histories and normalizations are defined in the input, the first normalization will be used with the first depletion history, the second normalization with the second depletion history and so on.
- See also Section 5.8 of ^{[1]}.
set fissye
set fissye INTT
Sets the energy-dependent interpolation scheme for the fission yields. Input values:
INTT | : energy-dependent interpolation (0 = none, 1 = linear-linear, 2 = histogram). The default option is "1/linear-linear". |
Notes:
- The default option "1/linear-linear" is based on the two-dimensional interpolation scheme dictated by the ENDF data (File 8: Decay and Fission Product Yields - sec. 0.5.2.2)^{[3]}.
- The interpolation is defined by the neutron energy spectrum.
- The option "0/none" excludes the energy-dependency from the fission yields, i.e. single-value defined at the lower limit.
- The option "2/histogram" implies that the function is constant and equal to the value given at the lower limit of the interval (e.g., thermal, epithermal, fast values).
- It is defined in connection with how the data were measured in thermal and fast systems. (Note that the option is under evaluation).
set flux
set flux F [ MAT ]
Sets normalization to total flux. Input values:
F | : flux |
MAT | : dummy parameter |
Notes:
- Normalization is needed to relate the Monte Carlo reaction rate estimates to a user-given parameter.
- The default normalization:
- It is set to unit total loss rate (neutron transport) and to unit total source rate (photon transport).
- In coupled neutron-photon transport simulations the normalization is driven by the neutron normalization.
- For other normalization options, see: set power, set powdens, set genrate, set fissrate, set absrate, set lossrate, set srcrate, set sfrate.
- If multiple depletion histories and normalizations are defined in the input, the first normalization will be used with the first depletion history, the second normalization with the second depletion history and so on.
- See also Section 5.8 of ^{[1]}.
set fluxlimtrc
set fluxlimtrc OPT
Option that enables the calculation of flux limited TRC diffusion coefficients. Input values:
OPT | : option to switch calculation on (1/yes) or off (0/no). The default option is "off". |
Notes:
- In infinite-spectrum calculations the anisotropic component of the non-TRC nuclides/materials is removed
- S1 and SP1 are non-corrected for non-TRC nuclides/materials and below energy limit for TRC nuclides/materials (see set trc option)
set fmtx
set fmtx 1 MAT_{1} MAT_{2} ...
set fmtx 2 UNI_{1} UNI_{2} ...
set fmtx 3 LVL
set fmtx 4 X_{MIN} X_{MAX} N_{X} Y_{MIN} Y_{MAX} N_{Y} Z_{MIN} Z_{MAX} N_{Z}
Set the calculation of fission matrixes. Input values:
MAT_{n} | : material list |
UNI_{n} | : universe list |
LVL | : level number |
X_{MIN} | : minimum x-coordinate mesh boundary [in cm] |
X_{MAX} | : maximum x-coordinate mesh boundary [in cm] |
N_{X} | : number of x-mesh cells |
Y_{MIN} | : minimum y-coordinate mesh boundary [in cm] |
Y_{MAX} | : maximum y-coordinate mesh boundary [in cm] |
N_{Y} | : number of y-mesh cells |
Z_{MIN} | : minimum z-coordinate mesh boundary [in cm] |
Z_{MAX} | : maximum z-coordinate mesh boundary [in cm] |
N_{Z} | : number of z-mesh cells |
Notes:
- There are four options for defining the regions that compose the matrix: 1 = material, 2 = universe, 3 = level, 4 = Cartesian mesh.
- Output values are given in pairs: matrix element and associated relative error, for total, prompt and delayed (analog) fission matrixes.
- The output is printed in file [input]_fmtx[bu].m, where "bu" is the burnup step.
set forcedt
set forcedt MAT_{1} MAT_{2} ...
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 option) in individual materials.
- Use of delta-tracking can be blocked in individual materials using set blockdt option.
- 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
Sets the fission product yield cut-off. Input values:
FPCUT | : fission product yield cut-off (default value: 0.0) |
Notes:
- Fission product yield cut-off acts on cumulative fission yields.
- The FPCUT parameter represents the lower limit for the maximum cumulative yield in each mass chain.
- For example, a value of "1E-2" means that every mass chain (nuclides with same mass number) with all cumulative yields below 1% are discarded from the calculation.
- Setting the 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. Input values:
OPT | : option to switch fission source passing on (1/yes) or off (0/no). The default option is "off". |
NSKIP | : number of inactive generations on subsequent steps |
Notes:
- The fission source at the end of one transport calculation is used as the initial source for the next transport calculation.
- Number of inactive generations is taken from set pop option on the first step and from set fsp option 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 DC LIM TGT ITER INIT ]
Activates fundamental mode calculation for collapsing intermediate multi-group constant data into few-group constants with a critical spectrum. Input values:
ERG | : Intermediate multi-group structure for calculation of the leakage-corrected critical spectrum (default value: Default multi-group structure, 70 energy-groups) |
BTCH | : Micro-group batching option (1 = cycle-wise, 2 = averaged over all criticality cycles) |
MODE | : Critical spectrum calculation mode (default value: 0) |
DC | : Multi-group diffusion coefficients scheme to be used only with MODE = 3 (default value: 1 = out scattering). |
LIM | : Convergence criterion of k_{eff}, evaluated as the absolute value difference of k_{eff} between successive iterations, with MODE = 1, 2, 3 (default value: 1E-7) |
TGT | : Target value for k_{eff} with MODE = 1, 2, 3 (default value: 1.0) |
ITER | : Maximum number of fundamental mode calculation iterations, with MODE = 1, 2, 3 (default value: 25) |
INIT | : First guess for absolute value of critical B^{2}, with MODE = 1, 2, 3 (default value: 1E-6) |
The possible values for mode are:
Mode Description o, O, 0 Old B_{1} calculation (use the same method as before version 2.1.31) b, B, 1 New B_{1} calculation p, P, 2 P_{1} calculation f, F, 3 FM calculation
The possible values for FM mode multi-group diffusion coefficients are:
Notes:
- It invokes the calculation of leakage corrected flux: critical flux, on group constants and produces an additional set of homogenenized group constants ("B1_").
- The output prefix "B1_" is invariant, regardless of the critical spectrum calculation mode.
- The B1 group constant estimates are written in:
- [input]_res.m output file: group constants homogenized in leakage-corrected spectrum sub-section
- [input].coe ouput file, via the set coefpara option: automated burnup sequence/coefficient matrix output.
- Intermediate group structure:
- 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 FM calculation overrides the default 70-group structure used for macroscopic data calculation in infinite spectrum.
- 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.
- Averaging the results over all cycles, BTCH = 2, may improve convergence and speed up the calculation, but all information on statistical errors is lost.
- Calculation modes:
- Before version 2.1.31, the MODE parameter was not read, and the old B_{1} calculation mode was always used regardless of the parameter given here.
- The calculation modes other than the old B_{1} calculation mode were added in version 2.1.31.
- Mode 0 (old B_{1} calculation) might be very slow with a large intermediate multi-group structure (for example with approximately 2000 groups). Modes 1-3 should run much faster.
- Limitations:
- The leakage correction option does not affect the flux spectrum used during burnup calculations.
- Alternatively, use the implicit leakage correction via MC-Fundamental Mode (see set mcleak option), where the all estimates are leakage corrected.
- The set fum and set mcleak options are mutually exclusive.
- The leakage correction option does not affect the flux spectrum used during burnup calculations.
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 FAC defines the buffer size relative to simulated batch size.
- The event bank BNK refers to pre-allocated memory block used to store history data on particle events. It is also controlled via set nbuf and set tpa input options.
- 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 gct
set gct OPT
Option that enables the calculation of group constant statistics tests. Input values:
OPT | : option to switch calculation on (1/yes) or off (0/no). The default option is "off". |
Notes:
- When this option is set, the batch-wise statistical tests are printed in the file [input]_stat.m.
- Requires group constant generation to be set on (see set gcu option).
- For more information:
- The statistical tests are described in a related report^{[2]}.
- The statistics of group constants are documented in a related paper^{[15]}.
- Note to developers: statistical tests should be documented
set gcu
set gcu UNI_{1} [ UNI_{2} UNI_{3} ... ]
Sets the universes for group constant generation. Input values:
UNI_{n} | : universe where group constants are generated (default value: 0 = root universe) |
Notes:
- By default, group constants are generated in the root universe.
- 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.
- There is a special for the UNI_{1} entry:
- "-1": to switch the group constant generation "off" (single entry)
- The group constant generation should be switched "off" when the results are not needed (this may speed up the calculation).
- Note that this will also disable e.g. writing of the [input].coe ouput file.
- The homogenized group constant parameters are written in
- [input]_res.m file (by default): homogenized group constants section.
- [input].coe ouput file, via the set coefpara option: automated burnup sequence/coefficient matrix output.
- The spatial homogenization methodology is described in a related paper^{[16]}.
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 option)
- Generation or time cut-off (see set tcut option) is always needed for neutron external source simulations in super-critical systems.
set genrate
set genrate G [ MAT ]
Sets normalization to fission neutron generation rate. Input values:
G | : number of fission neutrons emitted per second [in neutrons/s] |
MAT | : material in which the fission neutrons are generated. The default is all materials |
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 neutron generation rate in the system.
- The neutron generation rate includes only prompt and delayed neutrons emitted in fission.
- The default normalization:
- It is set to unit total loss rate (neutron transport) and to unit total source rate (photon transport).
- In coupled neutron-photon transport simulations the normalization is driven by the neutron normalization.
- For other normalization options, see: set power, set powdens, set flux, set fissrate, set absrate, set lossrate, set srcrate, set sfrate.
- If multiple depletion histories and normalizations are defined in the input, the first normalization will be used with the first depletion history, the second normalization with the second depletion history and so on.
- See also Section 5.8 of ^{[1]}.
set gpop
set gpop MAX_HIS MAX_POP C
Sets the on-the-fly neutron growing population size algorithm. Input values:
MAX_HIS | : maximum number of histories |
MAX_POP | : maximum population size |
C | : parameter to control the population growth |
Notes:
- The on-the-fly neutron growing population size algorithm is used in criticality calculations to accelerate the fission source convergence.
- The growing algorithm methodology is described in related paper. ^{[17]}
set gsw
set gsw FILE [ OPT ]
Writes secondary photon source points in coupled neutron-photon transport simulation into a file. Input values:
FILE | : file name where the source points are written |
OPT | : option to include (1/yes) or exclude (0/no) secondary photons in transport calculation. The default option is "off". |
Notes:
- Applicable only to coupled neutron-photon transport simulation (invoked using set ngamma).
- Only source points from active cycles are included in criticality source simulations.
- From version 2.2.1 and on, multi-step depletion source files can be generated [FILE]_[bu], where "bu" is the burnup step. Otherwise, simply, [FILE].
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). The default option is "off". |
Notes:
- When invoked, Serpent collects batch-wise data on k_{eff}, fission source entropy etc. and produces a separate file: [input]_his[n].m
- For more information, see the description of the history output.
- Setting the history option also invokes the calculation of fission source (Shannon) entropy.
- The entropy mesh parameters can be adjusted using set entr option.
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). |
Notes:
- Number of generations has to be taken into account when setting number of inactive generations in set pop.
set imp
set imp TYPE G
Defines energy-dependent importances. Input values:
TYPE | : type of dependency (e = energy) |
G | : exponential for adjusting importances (default value: -0.5) |
set imp TYPE r_{1} I_{1} [ r_{2} I_{2} ... ]
Defines geometry-dependent importances for given region(s). Input values:
TYPE | : type of (geometrical) dependency (c = cell, m = material, u = universe) |
r_{n} | : region identifier (cell, material or universe name) |
I_{n} | : importance |
Notes:
- Geometry-dependent importances (only) used for variance reduction
- Only cell (geometry-dependent) type importances supported for now
- Geometry-dependent importances requires using surface-tracking (see set dt)
set impl
set impl ICAPT [ INXN INUBAR ILEAK ]
Sets implicit reaction modes on or off. Input values:
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) |
ILEAK | : option to switch implicit implicit leakage on (1/yes) or off (0/no) |
Notes:
- Group constant generation (see set gcu option) 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.
- Implicit leakage requires group constant generation (see set gcu option) to be set "on".
- 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. Input values:
LOOP_{n} | : number of neutron tracking loops interpreted as a geometry error (default value 1E6) |
ERR_{n} | : flag to terminate neutron tracking when an infinite loop occurs: on (0/no) or off (1/ yes). The default option is "on" |
LOOP_{p} | : number of photon tracking loops interpreted as a geometry error (default value 1E6) |
ERR_{p} | : flag to terminate photon tracking when an infinite loop occurs: on (0/no) or off (1/ yes). The default option is "on" |
Notes:
- Serpent checks for tracking loop length to avoid simulation being stuck in an infinite loop.
- 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 ID_{1} ID_{2} ...
Defines the nuclides or elements to include in the depletion output file [input]_dep.m. Input values:
ID_{n} | : Identifier for nuclide, or element or special entry. |
Notes:
- Besides the nuclides or elements specified, the output includes the sum over all isotopes.
- Nuclides 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).
- For more information, see the detailed description on Nuclide IDs
- Elements are entered using symbol or numerical (U, 92, etc.).
- Special entries include:
Key-word Description all all nuclides accident nuclides with significant health impact & high migration probability in accident conditions^{[18]} 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 ^{[19]} burnupindicators burnup indicators (commonly measured from spent fuel) ^{[19]} 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 ^{[20]} 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 (from Serpent 1) ng noble gases
- The detailed list of nuclides associated with each special entry: Pre-defined inventory lists
set inventory top N PARA
Defines the criterion or variable based on which to include the most significant contributors under that category in the depletion output file [input]_dep.m. Input values:
N | : Number of nuclides |
PARAM | : Parameter name |
Notes:
- The contribution criterion is based on the variables evaluated in the depletion calculation and outputted in the bunurp output.
- The possible key-words/variables are:
Key-word Description mass contribution to mass fraction activity contribution to activity dh contribution to decay heat sf contribution to spontaneous fission rate gsrc contribution to gamma emission rate ingtox contribution to ingestion toxicity inhtox contribution to inhalation toxicity
- For example: "top 10 dh" gives the top 10 contributors to decay heat.
- The special entries and the calculation of top contributors do not work with the re-depletion -rdep command line option.
set isobra
set isobra ZAI_{1} MT_{1} FG_{1} ZAI_{2} MT_{2} FG_{2} ...
Defines constant branching ratios to isomeric states. Input values:
ZAI_{n} | : nuclide identifiers (ZAI) |
MT_{n} | : reaction identifiers (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^{[3]} files defined by the set bralib option overrides the constant ratios.
set iter alb
set iter alb [ CYCLES KEFF F_{X} F_{Y} F_{Z} ]
Option that iterates the albedo boundary conditions given a target k-eff for the evaluation. Input values:
CYCLES | : number of additional inactive cycles to run for the convergence of the iteration (default value: 50) |
KEFF | : target k_{eff} for the iteration (default value: 1.0) |
F_{X} | : albedo factor in x-direction to normalize the albedo leakage rate (default value: 1.0) |
F_{Y} | : albedo factor in y-direction to normalize the albedo leakage rate (default value: 1.0) |
F_{Z} | : albedo factor in z-direction to normalize the albedo leakage rate (default value: 1.0) |
Notes:
- The albedo boundary conditions result from the product of the iterated albedo leakage rate by the albedo factor in each direction.
set iter nuc
set iter nuc CYCLES KEFF N_{ZAI} ZAI_{1} ZAI_{2} ... ZAI_{NZAI} [ N_{MAT} MAT_{1} MAT_{2} ... MAX_{NMAT} ]
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.
- For more information, see the detailed description on the Critical density iteration.
set keff
set keff K_{EFF}
Option to scale fission neutron production in external source simulations. Input values:
K_{EFF} | : Fission neutron production scaling factor (default value: 1.0) |
Notes:
- The k-effective to use for scaling the fission neutron production.
- The inverse of K_{EFF} is used as a multiplicative constant for the nubar, i.e. a value of 2.0 will cut the fission neutron production in half.
- The option affects both prompt and delayed neutron production from fissions.
- In versions prior to 2.1.31, it does not affect delayed neutron precursor production, which cases unexpected an behaviour in Transient simulations that track delayed neutron precursor concentrations.
set lossrate
set lossrate L [ MAT ]
Sets normalization to total loss rate. Input values:
L | : number of lost neutrons per second [in neutrons/s] |
MAT | : dummy parameter |
Notes:
- Normalization is needed to relate the Monte Carlo reaction rate estimates to a user-given parameter.
- Loss rate includes absorption rate and leakage.
- The default normalization:
- It is set to unit total loss rate (neutron transport) and to unit total source rate (photon transport).
- In coupled neutron-photon transport simulations the normalization is driven by the neutron normalization.
- For other normalization options, see: set power, set powdens, set flux, set genrate, set fissrate, set absrate, set srcrate, set sfrate.
- If multiple depletion histories and normalizations are defined in the input, the first normalization will be used with the first depletion history, the second normalization with the second depletion history and so on.
- See also Section 5.8 of ^{[1]}.
set lost
set lost LIM
Option to treat undefined geometry regions as void. Input values:
LIM | : maximum number of collisions allowed in undefined regions (default value: 0) |
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.
- There is a special entry for the number of collisions allowed::
- "-1": if no limit is set
- 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 (default value: 1.0E4) |
MIN | : minimum survival probability in Russian roulette (default value: 1.0E-18) |
Notes:
- It is used with weight-windows (see wwgen card).
set mbtch
set mbtch N
Adjusts the batch used with MPI data transfer. Input values:
N | : batch size in double floats, i.e. 8 bytes (default value: 1E4) |
Notes:
- The batch size determines the division of data blocks in MPI data transfer.
- The value may have some effect on parallel performance.
set mcleak
set mcleak OPT [ ERG ]
Option that enables the implicit leakage correction via MC-Fundamental Mode. Input values:
OPT | : option to switch the calculation on (1/yes) or off (0/no). The default option is "off" |
ERG | : intermediate multi-group structure used for group constant generation (default value: Default multi-group structure, 70 energy-groups) |
Notes:
- Requires group constant generation to be set on (see set gcu option).
- The calculation mode deactivates any other leakage correction option defined in set fum option.
- The Monte Carlo transport process is modified to produce inherently critical spectrum burnup calculations and, therefore, all results estimates are leakage corrected.
- Hence, all physical estimates printed by Serpent are leakage corrected, regardless of the name of the variable (e.g., "INF_" ).
- In brief the methodology is:
- The FM-leakage-modified transport equation is solved with continuous energy Monte Carlo.
- The data is directly tallied to the preferred few-group structure with exception of the diffusion coefficients.
- The diffusion coefficients used in the evaluation are based on a multi-group CMM approach.
- The implicit leakage correction via MC-Fundamental Mode methodology is described in a related paper^{[21]}.
set mcvol
set mcvol NP [ DENS ]
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 |
DENS | : option to set material density adjustment on (1/yes) or off (0/no). The default option is "off" |
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 materials given volumes are overridden by the results given by the checker routine (MC-estimated volume).
- The -checkvolumes command line option can also be used to produce a separate input file for the volume entries (see detailed description on defining material volumes).
- The DENS option enables the adjustment of material densities by the ratio of given and MC-estimated volumes.
- The adjustment is only applied to materials with given volumes.
- Implemented to preserve masses in Voronoi geometries (voro card), but could be also applied to account for thermal expansion.
set mdep
set mdep UNI VOL N MAT_{1} MAT_{2} ... MAT_{N} ZAI_{1} MT_{1} ZAI_{2} MT_{2} ...
Sets parameters for calculating homogenized microscopic cross sections. Input values:
UNI | : universe where universe where homogenized microscopic cross sections are generated |
VOL | : volume of the universe [in cm^{3}] (3D geometry) or cross-sectional area [in cm^{2}] (2D geometry) |
N | : number of materials included in the calculation |
MAT_{1} MAT_{2} ... MAT_{N} | : material names |
ZAI_{i} | : nuclide identifier (ZAI) |
MT_{i} | : ENDF reaction MT |
Notes:
- The option enables the calculation of homogenized few-group microscopic cross sections for the listed nuclides and reactions.
- The cross sections are always calculated in the actual spectrum of the problem, never with the critical spectrum (see set fum option).
- However, if combined with the implicit leakage correction via MC-Fundamental Mode (see set mcleak option), all estimates will be leakage corrected.
- Universe:
- Multiple set mdep cards can be given for a single homogenized universe.
- Materials:
- The listed materials must be enclosed inside the homogenized universe.
- Volumes:
- The calculation requires the material volumes to be correctly defined. For more information, see the detailed description on Defining material volumes.
- The parameter VOL was VR in versions before 2.1.32 (volume ratio of materials included in micro depletion to total homogenized region).
- Nuclide IDs:
- The nuclide identifiers are entered as ZAI, not ZA.
- E.g., the ZAI for U-235 is 922350 and the ZAI for Am-242m is 952421.
- ENDF reactions:
- Reaction rates are calculated to all states by default
- 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.
- Fission reactions corresponding to a specific yield in ENDF can be calculated by adding 1, 2, 3, 4, ... after the reaction MT depending on the fission yield data of the nuclide in the data library.
- E.g., 181 is total fission cross section corresponding to first fission product yield, (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).
- Special entries:
- If the number of materials N is zero, the calculation is carried over all burnable materials.
- If the list of nuclide-reaction pairs (ZAI_{i}-MT_{i}) is substituted by "all", Serpent will generate a micro-depletion output [input]_mdep.inc including all the nuclides and all reactions involved in the calculation at beginning of the simulation aiming to the extract the constant data (stopping the calculation right after).
- The homogenized microscopic estimates are written in:
- [input]_mdx[n].m (for branching: [input]_mdx[n]b[m].m) output file, where "n" is the burnup step index and "m" is the branch index: micro depletion output.
- [input].coe ouput file, by adding MDEP_XS in the set coefpara list: automated burnup sequence/coefficient matrix output.
- The microscopic cross section calculation methodology is described in a related article.^{[22]}
- For practical examples, check the presentation on Microscopic group constants with Serpent^{[23]}.
set memfrac
set memfrac FRAC
Defines the fraction of total system memory Serpent can allocate to its use. Input values:
FRAC | : the fraction of system memory that Serpent is allowed to use (default value: 0.8) |
Notes:
- Serpent tries to read the system total memory from the first line of the file /proc/meminfo
- The fraction can also be set via a SERPENT_MEM_FRAC environmental variable.
- 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.
set mfpcut
set mfpcut MFPMIN_{p}
Sets minimum mean-free-path cut-off for photons. Input values:
MFPMIN_{p} | : cut-off mean-free-path for photons [in cm] |
set mfpcutdens
set mfpcutdens DENS_{1} MFPMIN_{p,1} [ DENS_{2} MFPMIN_{p,2} ... ]
Sets density-wise minimum mean-free-path cut-off for photons. Input values:
DENS_{i} | : mass density [g/cm^{3}] |
MFPMIN_{p,i} | : cut-off mean-free-path for photons [in cm] |
Notes:
- Mass densities and mean-free-paths cut-offs must be given in ascending order.
set mfpcutmat
set mfpcutmat MAT_{1} MFPMIN_{p,1} [ MAT_{2} MFPMIN_{p,2} ... ]
Sets material-wise minimum mean-free-path cut-off for photons. Input values:
MAT_{i} | : material name |
MFPMIN_{p,i} | : cut-off mean-free-path for photons [in cm] |
set micro
set micro ERG [ BTCH ]
Defines the intermediate multi-group structure used for group constant generation. Input values:
ERG | : Intermediate multi-group structure used for group constant generation (default value: Default multi-group structure, 70 energy-groups) |
BTCH | : batch interval (1 = batch-wise, 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.
- In general, the intermediate multi-group structure has more groups than the few-group structure to get reasonable results for leakage corrected group constants and out-scatter diffusion coefficients.
- Averaging the results over all cycles may improve convergence and speed up the calculation, but all information on statistical errors is lost.
set minxs
See set cfe.
set multilevelgcu
set multilevelgcu OPT
Option that enables the generation of group constants in multiple overlapping universes. Input values:
OPT | : option to switch calculation on (1/yes) or off (0/no). The default option is "off" |
set mvol
set mvol MAT_{1} ZONE_{1,1} VOL_{1,1} MAT_{1} ZONE_{1,2} VOL_{1,2} ... MAT_{2} ZONE_{2,1} VOL_{2,1} ...
Sets the volumes of material regions. Input values:
MAT_{m} | : name of m-th material |
ZONE_{m,n} | : index of n-th zone in m-th material |
VOL_{m,n} | : volume of n-th zone in m-th material [in cm^{3}] (3D geometry) or cross sectional area [in cm^{2}] (2D geometry) |
Notes:
- This option is used to define material volumes manually.
- The input card, as a separate file, is also produced when the -checkvolumes command line option is launched, invoking the Monte Carlo checker routine.
- The generated file can be added to the input using the include card.
- 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 "0" for non-burnable materials.
- For burnable materials the indexing starts from "1".
- The corresponding index can be found using the -checkvolumes command line option (listing all materials and their associated indexes)
- Alternative options to define the material volumes are:
- 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. It is also controlled via set gbuf and set tpa input options.
- 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.
- With a large number of neutrons per generation, lowering the factor might be necessary due to excessive memory usage.
- The default values of the factor allows for large fluctuations of the neutron population due to poor statistics, which is seldom an issue with larger neutron populations.
- 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. Input values
ERG | : Name of the few-group structure used for group constant generation (default value: Default 2-group structure, 2 energy-groups) |
set nfg NE
Defines the few-group structure used for group constant generation. (This syntax should not be used anymore). Input values:
NE | : Number of energy groups (1/2/4) corresponding to Serpent 1 default 1-, 2- or 4-group structure. |
set nfg NE E_{NE-1} E_{NE-2} ... E_{1}
Defines the few-group structure used for group constant generation. (This syntax should not be used anymore). Input values:
NE | : Number of energy groups. Must be at least 2 in this format. |
E_{N} | : Energy group boundary value between groups N and N+1 [in MeV]. Values have to be given in ascending order. |
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 few-group structure must be a sub-set of the intermediate multi-group structure.
- The default is a two-group structure with boundary between fast and thermal group set to 0.625 eV (see Default 2-group structure)).
- Serpent uses an intermediate multi-group structure in the calculation. The default structure consists of 70 groups (see Default multi-group structure), and can be changed using the set micro or set fum options.
- 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.
- See also: homogenized group constants output.
- The few-group structure will also be used for example for assembly discontinuity factors and albedos.
set nfylib
set nfylib LIB_{1} [ LIB_{2} LIB_{3} ... ]
Sets the neutron-induced fission yield library file paths. Input values:
LIB_{n} | : library file paths |
Notes:
- Fission yield libraries are standard ENDF format^{[3]} 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.
- From version 2.2.0 and on, a default neutron-induced fission yield library directory file can be set by defining environment variable SERPENT_NFYLIB.
- This file will be used if no other path is given with set nfylib.
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). The default option is "off" |
WMIN | : weight limit for implicit mode (default value: 0.1) |
NMAX | : maximum number of emitted photons in implicit mode (default value: 10) |
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.
- Simulation mode:
- 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.
- 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.
- Analog mode: the average number of secondary photons produced per collision is defined by the ratio of photon production cross section to material total.
- The methodology behind the coupled neutron/gamma transport mode is described in a related paper^{[24]}
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). The default option is "on" |
CAPT | : option to handle capture (0 = not handled, 1 = handled). The default option is "on" |
SCATT | : option to handle scattering (0 = not handled, 1 = handled). The default option is "on" |
Notes:
- 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 (default value: 200) |
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.
- Using the nps card sets the mode to external source simulation.
- Criticality source simulation for neutrons is invoked using the set pop option. (The two cards are mutually exclusive).
- Running an external source simulation requires a source, defined by the src card. Source definition also sets the transported particle type.
- Delayed neutron emission is switched "off" by default in neutron external source simulation.
- Delayed neutrons can be included with the set delnu option.
- 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.
- In transient simulations, where an initial transient source is linked using the set dynsrc option, PP particles are sampled for each time interval.
- Neutron external source simulations:
set opti
set opti MODE
Sets the optimization mode which affects the performance and memory usage. Input values:
MODE | : optimization mode (default value: 4) |
The possible settings for mode are:
MODE Description Usage 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 Suitable 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:
- The mode 4 is essentially the same as the methodology in Serpent 1.
- The methodology behind the optimization modes is described in a related paper^{[25]}.
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 (default value: 50) |
Notes:
- In coupled transient simulations the interval refers to time steps rather than batches.
- Affects files such as [input]_res.m and [input]_det.m as well as mesh plots.
set pbuf
set pbuf FAC
Sets the size of the precursors buffer. Input values:
FAC | : factor (>1) defining the buffer size |
Notes:
- Precursor buffer refers to pre-allocated memory block used to store precursors data.
- This memory is needed for banking/retrieving precursors for the next generation/time-interval.
- The buffer factor defines the buffer size relative to simulated batch/cycle size.
set pcc
set pcc MODE [ SSP SSC ]
set pcc 5 PRED CORR [ SSP SSC ]
Sets the time integration method in burnup calculation. Input values:
MODE | : time integration method (default value: 1) |
PRED | : predictor step integration scheme (0 = constant extrapolation, 1 = linear extrapolation) |
CORR | : corrector step integration scheme (1 = linear interpolation, 2 = quadratic interpolation) |
SSP | : number of substeps for predictor steps (default value: 1) |
SSC | : number of substeps for corrector steps (default value: 1) |
The possible settings for mode are:
Mode Predictor method Corrector method Notes 0, CE Constant extrapolation - Serpent 1 without substeps - "Euler's method" 1, CELI Constant extrapolation Linear interpolation Serpent 1 without substeps - "old predictor-corrector method" 2, LE Linear extrapolation - - 3, LELI Linear extrapolation Linear interpolation - 4, LEQI Linear extrapolation Quadratic interpolation - 5 Constant or linear extrapolation Linear or quadratic interpolation - 6, CECE Constant extrapolation Constant backwards extrapolation -
Notes:
- 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.
- Version 2.2.0 includes the sub-step method for depletion calculations involving continuous reprocessing.
- The custom mode, MODE 5, accepts constant or linear extrapolation for the predictor step and linear or quadratic interpolation for the correct step.
- If linear extrapolation is used, the first time step is always calculated with constant extrapolation.
- If quadratic interpolation is used, the first and second time steps are always calculated with linear interpolation.
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: (photon_data.zip).
- 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). The default option is "off" |
VOL | : volume of the homogenized zone |
XE135M | : option to treat ^{135m}Xe separate from ground state ^{135}Xe (0 = lumped with ^{135}Xe, 1 = separate treatment). (default value: 0) |
Notes:
- Poison cross sections include the fission yields and microscopic and macroscopic absorption cross sections of fission product poisons ^{135}Xe and ^{149}Sm, as well as the fission yields and microscopic absorption cross sections of their precursors.
- The calculation requires setting the decay data library (see set declib option) and the fission yield library (see set nfylib option).
- The volume is required for calculating microscopic absorption cross sections matching macroscopic absorption cross sections with poison nuclide densities smeared to the homogenization volume.
- The calculation requires the material volumes correctly set (see Defining material volumes).
- Parameter VOL was VR (optional) in versions before 2.1.32 (ratio of fuel volume to the volume of the homogenized zone).
- Separate treatment for ^{135m}Xe requires cross sections for this isotope (from version 2.2.0 and on).
- The methodology was revised in version 2.1.32:
- The use of the 'set poi' card to evaluate the fission poison cross sections should be limited to homogenized universes enclosing all fissionable materials.
- Otherwise, use the micro-depletion set mdep input option.
- The methodology follows the same approach as the homogenized microscopic cross section evaluation, described in a related paper^{[22]}
- The poison estimates are written in:
- [input]_res.m output file: homogenized group constants section - poison cross sections: for infinite spectrum and critical spectrum.
- [input].coe ouput file, via the set coefpara option: automated burnup sequence/coefficient matrix output.
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} (default value: 1.0) |
BTCH | : batching interval (default value: 1) |
NEIG | : number of independent parallel eigenvalue calculations (default value: 1) |
Notes:
- Using the pop card sets the mode to criticality source simulation.
- External source simulation is invoked using the set nps option. (The two cards are mutually exclusive).
- Simulation sequence:
- First, run for a number of inactive generations to allow the fission source to converge
- 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.
- Convergence of fission source can be monitored using Shannon entropy (see set his and set entr options).
- Setting an initial guess 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.
- Setting an initial guess value manually may get the simulation going if it terminates on the first generation because of poor initial guess.
- See detailed descriptions on fission source convergence and statistical effects of batching.
- The number of neutrons per generation also affects the memory usage together with set nbuf option.
- With a large value, lowering the buffer size might be necessary for the simulation to be runnable.
- Since IFP based time constants and sensitivity calculations start to collect their event history during the inactive generations, you should take this in account in the number of inactive generations by increasing the number of inactive generations by the number of generations in the event history (IFP chain length or number of latent generations in sensitivity calculations) above the number needed for source convergence.
set powdens
set powdens PDE [ MAT ]
Sets normalization to power density. Input values:
PDE | : power density [in kW/g] (typical value for a LWR: 20E-3 ... 50E-3) |
MAT | : material in which the given power is produced. The default option is all materials. |
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.
- The default normalization:
- It is set to unit total loss rate (neutron transport) and to unit total source rate (photon transport).
- In coupled neutron-photon transport simulations the normalization is driven by the neutron normalization.
- For other normalization options, see: set power, set flux, set genrate, set fissrate, set absrate, set lossrate, set srcrate, set sfrate.
- If multiple depletion histories and normalizations are defined in the input, the first normalization will be used with the first depletion history, the second normalization with the second depletion history and so on.
- See also Section 5.8 of ^{[1]}.
set power
set power P [ MAT ]
Sets normalization to total fission power. Input values:
P | : fission power [in W] |
MAT | : material in which the given power is produced. The default option is all materials. |
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.
- The default normalization:
- It is set to unit total loss rate (neutron transport) and to unit total source rate (photon transport).
- In coupled neutron-photon transport simulations the normalization is driven by the neutron normalization.
- For other normalization options, see: set powdens, set flux, set genrate, set fissrate, set absrate, set lossrate, set srcrate, set sfrate.
- If multiple depletion histories and normalizations are defined in the input, the first normalization will be used with the first depletion history, the second normalization with the second depletion history and so on.
- See also Section 5.8 of ^{[1]}.
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 (theoretical maximum for 64-bit system: 2^{22}) |
Notes:
- Setting up a communication mode will enable the coupled calculation mode.
- The communication options set comfile, set ppid and set pport are mutually exclusive, aka, multiple signalling modes are not allowed.
- For more information, see the detailed description on External coupling
set pport
set pport PORT
Defines the external code port number to be used for communication in the SOCKET-based coupled calculation communications. Input values:
PORT | : user given parent process port |
Notes:
- Setting up a communication mode will enable the coupled calculation mode.
- The communication options set comfile, set ppid and set pport are mutually exclusive, aka, multiple signalling modes are not allowed.
- For more information, see the detailed description on 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:
- Calculation of pin power form factors also requires calculation of assembly discontinuity factors (see set adf option).
- Methodology:
- If the homogenized region is surrounded by reflective boundary conditions (zero net-current), the homogeneous flux becomes flat and equal to the volume-averaged heterogeneous flux.
- If the net currents are non-zero, the homogeneous flux is obtained using the built-in diffusion flux solver.
- The form-factors (are obtained by dividing the pin- and group-wise powers with the corresponding homogeneous diffusion flux.
- However, if the net currents are non-zero, but the sum of the net currents is equal to zero, the volume-averaged heterogeneous flux is used as the homogeneous flux, which is not an accurate approximation.
- This case is for example when modeling hexagonal fuel assemblies with other than 30 or 60 degree symmetries with periodic boundary conditions.
- The form factors are written in:
- [input]_res.m output file: homogenized group constants/PPWs sub-section
- [input].coe ouput file, via the set coefpara option: automated burnup sequence/coefficient matrix output.
set precsrcf
set precsrcf FACTOR
Set number of point-wise precursors to hold in memory in transient simulations. Input values:
FACTOR | : The factor to multiply the number of neutrons per batch to obtain the number of point-wise precursors to hold in memory (default value: 10.0) |
Notes:
- The FACTOR represents a multiplicative factor for the number of neutrons per batch.
- For example, setting FACTOR to 10 when running 1000 neutrons per batch will keep 10000 point-wise precursors in memory.
- The number of point-wise 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 point-wise precursors can lead to undersampling of certain precursor groups or parts of geometry.
- For more information, see the detailed description on Transient simulations.
set precthresh
set precthresh THRESHOLD
Set the weight threshold for creating and storing a new delayed neutron precursor in transient simulations. Input values:
THRESHOLD | : A weight threshold relative to the incoming neutron weight (default value: 1.0) |
Notes:
- 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.
- For more information, see the detailed description on Transient simulations
set printelsp
set printelsp OPT
Prints out the stopping power data for electrons/positions generated by the thick-target bremsstrahlung model. Input values:
OPT | : Option to output the stopping power data from the bremsstrahlung model off (0/no) or on (1/yes), in file [input]_elsp.m. The default option is "off" |
set printm
set printm MODE [ FRAC ]
Print material compositions to [input].bumat[bu] file during burnup calculation, where "bu" is the burnup step. Input values:
MODE | : Set printing on (1/yes) or off (0/no). The default option is "off" |
FRAC | : Optional atomic fraction for printing out decay nuclides, i.e. nuclides with no transport cross sections (default value: 1.0) |
Notes:
- Atomic fraction:
- A value FRAC will print out nuclides whose atomic fraction in the material is greater than or equal to FRAC.
- A FRAC value "0.0" will print out all decay nuclides, while "1.0" will not print out any decay nuclides.
- The feature is outdated and not recommended to be used anymore.
- All information related to the depletion calculations is collected in the depletion output file: [input]_dep.m.
- For restart calculations, use the binary restart files (see set rfw and set rfr options).
set qparam_dbrc
set qparam_dbrc QPARAM
Sets the Q-parameter (confidence interval) for temperature majorants to be used with Doppler-broadening rejection correction (set dbrc option). Input values:
QPARAM | : confidence interval |
Notes:
- The parameter should be adjusted when the DBRC majorant cross section is exceeded frequently
- The default value:
- It is set to 2E-5 for the revisited majorant (default method) and reasonable values are within [1E-5, 1E-4]
- It is set to 3.0 for the traditional majorant and reasonable values are within [1.0, 10.0]
set qparam_tms
set qparam_tms QPARAM
Sets the Q-parameter (confidence interval) for temperature majorants to be used with target motion sampling method (mat card). Input values:
QPARAM | : confidence interval |
Notes:
- The parameter should be adjusted when the DBRC majorant cross section is exceeded frequently
- The default value:
- It is set to 2E-5 for the revisited majorant (default method) and reasonable values are within [1E-5, 1E-4]
- It is set to 3.0 for the traditional majorant and reasonable values are within [1.0, 10.0]
set relfactor
set relfactor FAC
Sets the underrelaxation factor for the power relaxation used in coupled multi-physics calculations. Input values:
FAC | : underrelaxation factor (default value: 1.0) |
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.
- For more information, see the detailed description on Coupled multi-physics calculations.
set repro
set repro MODE
Sets the reproducibility mode in parallel calculations. Input values:
MODE | : reproducibility mode (default value: 1) |
The possible settings for mode are:
Mode Description 0 No reproducibility 1 Reproducibility with OpenMP parallelization 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, which 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. MODE 2 should only be used for debugging.
set rfr
set rfr STEP FILE [ NFILE ]
set rfr idx I FILE [ NFILE ]
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 |
NFILE | : number of restart files (default value: 1) |
Notes:
- This option can be used together with the set rfw feature for applying changes in the modeled system during burnup calculation.
- The step can be identified via burnup/time step or index, first and second syntax respectively.
- Burnup/time step (first syntax):
- Implicit step: positive value = burnup [in MWd/kgU], negative value = time [in d]
- Explicit step: preceding the depletion step value by "bu" or "days", followed by the (positive) value itself: bu STEP [in MWd/kgU], days STEP [in d]
- There is a special entry:
- "continue": it sets the restart at the latest calculated depletion step.
- Number of restart files:
- By default, it reads a single restart file.
- If a non-domain decomposition simulation requires reading the multiple/split restart files from a former one, the number of restart files NFILE should be specified.
- The material depletion zone divisions between the writing and reading simulations should agree too.
- Domain decomposition feature (set dd option), from version 2.1.32:
- The name of the binary restart file is invariant. It corresponds with the standard name of the restart file (without the _dd[MPIID] suffix).
- It reads the multiple/split restart files generated from the domain decomposition calculation.
- The number of domains/MPI tasks should match between the writing and reading simulations.
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 (0 = no, non-zero = yes; with, 1= all nuclides, 2 = transport nuclides). The default option is "off" |
FILE | : name of the binary restart file. The default name is [input].wrk. |
Notes:
- This option can be used together with the set rfr feature for applying changes in the modeled system during burnup calculation.
- Nuclides included:
- OPT 1: all nuclides
- OPT 2: only transport nuclides, option introduced in version 2.2.0
- Domain decomposition feature (set dd option), from version 2.1.32:
- It generates multiple restart files - as many as domains (MPI tasks) are defined
- The files are named adding _dd[mpiid] (domain decomposition identifier) to the standard file name.
set rnddec
set rnddec DEC [ FY DH ]
Option to set decay and fission yield data randomized mode on or off. Input values:
DEC | : option to switch randomized decay constants on (1/yes) or off (0/no). The default option is "off" |
FY | : option to switch randomized fission yields on (1/yes) or off (0/no). The default option is "off" |
DH | : option to switch randomized decay heat on (1/yes) or off (0/no).The default option is "off" |
set root
set root UNI
Sets the root universe. Input values:
UNI | : universe name. The default name is "0" |
Notes:
- Root universe is the universe at the lowest level of the geometry hierarchy, and must always be defined.
- For more information, see the detailed description of the universe-based geometry type in Serpent.
set roulette
set roulette W0 P
Sets parameters for weight cut-off and Russian roulette. Input values:
W0 | : minimum particle weight below which cut-off is applied |
P | : survival probability for Russian roulette (default value: 0.5) |
Notes:
- Weight cut-off is applied after each collision.
- Can be used together with implicit capture, default value: P = 0.001 (see set impl)
set runtme
set runtme T
Sets the maximum running time for the transport simulation. Input values:
T | : wall-clock running time [in 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_{1} MAT_{2} ... ]
Sets equilibrium samarium calculation on or off. Input values:
OPT | : option to set equilibrium samarium calculation on (1/yes) or off (0/no). The default option is "off" |
MAT_{n} | : optional list of materials for which to set the option (on/off). The default option is all fissile materials. |
Notes:
- Setting equilibrium samarium calculation "off" for a list of materials sets it "on" for all other fissile materials.
- Functionality:
- It forces the samarium number density to be in equilibrium with the current flux and samarium absorption level during the transport calculation.
- It is updated according to the batching interval set in the set pop option.
- Having a large batching interval means that the equilibrium concentration may take a large number of cycles to converge.
- The evaluation takes place on depletion zone basis.
- Therefore, the fuel material may require further division into several depletion zones (see div card).
- The equilibrium samarium concentration calculation is meant for special calculation cases, and is not necessary for example to stabilize the burnup calculations. The calculated equilibrium samarium concentration is a true equilibrium value as it does not consider all possible precursors of Sm-149.
- Obtained Pm-149 and Sm-149 concentrations might differ significantly from those obtained without the equilibrium calculation.
- Calculation chain:
- The equilibrium concentrations are calculated only for Pm-149 and Sm-149.
- The equilibrium concentration calculation chain only considers Pm-149 cumulative fission yield, Sm-149 independent fission yield, Pm-149 decay to Sm-149 and Sm-149 absorption. This also means that e.g. Pm-149 production from Pm-148 and Pm-148m is not taken into account.
- Requirements:
- The fission yield library (see set nfylib option) and decay data library (see set declib option).
- Correct evaluation of the material volumes. For more information, see Defining material volumes.
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. Input values:
PATH | : The path of the source file to be created |
PN | : Fraction of tentative neutrons to save (default value: 1.0) |
PP | : Fraction of tentative precursors to save (default value: 1.0) |
N_{X} | : Precursor mesh size in x-direction (default value: 1) |
N_{Y} | : Precursor mesh size in y-direction (default value: 1) |
N_{Z} | : Precursor mesh size in z-direction (default value: 1) |
Notes:
- The tentative fractions for neutrons PN and precursors PP to save only affects the criticality source simulation.
- Before version 2.2.0, if you are getting a warning from function WriteSourceFile "P larger than 1", you should lower the PN value.
- Four source files will be generated [PATH].main, [PATH].prec, [PATH].live and [PATH].precpoints
- Usage:
- In criticality source simulation, the system should be critical and the values will correspond to steady state values.
- In a dynamic simulation, the values will correspond to end-of-simulation values
- For more information, see the detailed description on Transient simulations.
set sca
set sca NI NB MSH MIN_{1} MAX_{1} SZ_{1} MIN_{2} MAX_{2} SZ_{2} MIN_{3} MAX_{3} SZ_{3} [ SUB_{1} SUB_{2} SUB_{3} LIM ]
set sca NI NB MSH X_{0} Y_{0} P NX NY MIN_{3} MAX_{3} SZ_{3} [ SUB_{1} SUB_{2} SUB_{3} LIM ]
Invokes a response matrix solver to obtain an improved source guess for criticality source simulations. Input values:
NI | : Number of outer iterations |
NB | : Number of source batches to collect results |
MSH | : mesh type (1 = Cartesian (x,y,z), 2 = Cylindrical (r,θ,z), 4 = x-type hexagonal, 5 = y-type hexagonal) |
MIN_{n} | : minimum mesh boundary (n-th coordinate) [in cm (x, y, z and r ), in degrees (θ)]. |
MAX_{n} | : maximum mesh boundary (n-th coordinate) [in cm (x, y, z and r ), in degrees (θ)]. |
SZ_{n} | : number of mesh cells (n-th coordinate) |
X_{0}, Y_{0} | : mesh center of hexagonal mesh (currently must be centered at the origin) [in cm] |
P | : hexagonal cell pitch [in cm] |
NX, NY | : hexagonal mesh size |
SUB_{n} | : number of sub-mesh cells (n-th coordinate) [in cm] |
LIM | : convergence criterion (typical value: 1E-12) |
Notes:
- Methodology:
- It produces an improved initial guess to accelerate source convergence in criticality source simulations.
- The solver obtains coupling coefficients required for the response matrix solution from Monte Carlo simulations, and provides a spatial distribution that approximates the converged fission source.
- The methodology is described in a related article.^{[26]}
- Mesh types:
- Cartesian (x,y,z) and cylindrical (r,θ,z) mesh:
- defined by outer mesh boundaries (MIN_{n}, MAX_{n}) and number of mesh cells (SZ_{n}), for each direction.
- Hexagonal mesh:
- (radial binning) defined by mesh center (X_{0}, Y_{0}), cell pitch (P), number of cells in the radial dimensions (NX, NY) - similar to hexagonal lattice.
- (axial binning) defined by outer mesh boundaries (MIN_{n}, MAX_{n}) and number of mesh cells (SZ_{n})
- Cartesian (x,y,z) and cylindrical (r,θ,z) mesh:
- The mesh must be defined slightly larger than the geometry (the mesh boundaries should not coincide with the geometry boundaries).
- The mesh sub-division (SUB_{n}) is used to improve the solution inside mesh cells.
set seed
set seed RNG [ NBTCH ]
Sets the seed value for the random number sequence. Input values:
RNG | : seed value used for the random number sequence (default value: from the system time) |
NBTCH | : starting batch (positive value) or history (negative value) |
set sfbuf
set sfbuf SIZE
Sets the size of the source file buffer including, e.g., criticality source, secondary photon source, detector source or dynamic source modes. Input values:
SIZE | : buffer size |
set sfrate
set sfrate S [ MAT ]
Sets normalization to total spontaneous fission rate. Input values:
S | : number of spontaneous fission reactions per second [in 1/s] |
MAT | : dummy parameter |
Notes:
- Normalization is needed to relate the Monte Carlo reaction rate estimates to a user-given parameter.
- The default normalization:
- It is set to unit total loss rate (neutron transport) and to unit total source rate (photon transport).
- In coupled neutron-photon transport simulations the normalization is driven by the neutron normalization.
- For other normalization options, see: set power, set powdens, set flux, set genrate, set fissrate, set absrate, set lossrate, set srcrate, set sfrate.
- If multiple depletion histories and normalizations are defined in the input, the first normalization will be used with the first depletion history, the second normalization with the second depletion history and so on.
- See also Section 5.8 of ^{[1]}.
set sfylib
set sfylib LIB_{1} [ LIB_{2} LIB_{3} ... ]
Sets the spontaneous fission yield library file paths. Input values:
LIB_{n} | : library file paths |
Notes:
- Spontaneous fission yield libraries are standard ENDF format^{[3]} 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 or shared.
- Private: each thread writes in its own buffer
- 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 | : tolerance (negative value) or maximum number of iterations (positive value) for each burnup step |
Notes:
- The SIE burnup scheme is mainly intended for burnup calculations that develop instabilities using the default predictor corrector methods.
- The SIE burnup scheme cannot be used with decay or activations steps, or zero flux.
- The convergence criteria is set either by the tolerance or the maximum number of iterations.
- If the tolerance is given, ITER < 0, the maximum number of iterations is set to 500.
- If the maximum number iterations is given, ITER > 0, the tolerance is set to 0.0.
set sourcescale
set sourcescale NB SF_{1} SF_{2} ...
Defines a time-interval dependent source scaling factor in dynamic external source calculations (set dynsrc). Input values:
NB | : number of time intervals |
SF_{n} | : time-interval-wise source scaling factor |
Notes:
- The number of time-intervals NB should match the definition of the time-bin structure (see tme card)
set spa
set spa CMAP [ FRAC ]
Sets parameters for the source point animation. Input values:
CMAP | : color map used for plotting the source point animation |
FRAC | : fraction for the color scheme, ratio minimum/maximum (default value: 1.0) |
Notes:
- 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.
set spd
set spd V_{n} V_{p}
Overrides the speed of simulated particles. Input values:
V_{n} | : speed of neutrons [in cm/s] |
V_{p} | : speed of photons [in 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. Input values:
S | : source rate [in particles/s] |
Notes:
- Normalization is needed to relate the Monte Carlo reaction rate estimates to a user-given parameter.
- The default normalization:
- It is set to unit total loss rate (neutron transport) and to unit total source rate (photon transport).
- In coupled neutron-photon transport simulations the normalization is driven by the neutron normalization.
- For other normalization options, see: set powdens, set power, set flux, set genrate, set fissrate, set absrate, set lossrate, set sfrate.
- If multiple depletion histories and normalizations are defined in the input, the first normalization will be used with the first depletion history, the second normalization with the second depletion history and so on.
- See also Section 5.8 of ^{[1]}.
set stl
set stl EXD NLOOP
Sets options for a STL geometry model. Input values:
EXD | : facet uncertainty margin or exclusion distance (default value: 1.0E-05) |
NLOOP | : maximum number of trials (default value: 1000) |
Notes:
- Delta-tracking is enforced by default in STL geometries.
- For more information on tracking modes, see the detailed description on delta- and surface-tracking.
- For more information on STL geometry model, see the solid description of how to create an STL-based universe geometry (solid card, type 2).
- The methodology, application and performance of STL geometries are described in a related paper^{[27]}.
set stlfile
set stlfile OPT
Sets option to read and write STL search mesh into a binary file, [input].smh. Input values:
OPT | : option to switch reading/writing on (1/yes) or off (0/no). The default option is "off" |
Notes
- For more information on STL geometry model, see the solid description of how to create an STL-based universe geometry (solid card, type 2).
- The methodology, application and performance of STL geometries are described in a related paper^{[27]}.
set syscom
set syscom PT COMMAND
Sets option to execute a user-defined system command at given break point. Input values:
PT | : break point (1 = after reading the input, 2 = after reading the cross section data) |
COMMAND | : user-defined system command |
Notes:
- The feature allows to work with compressed cross section data libraries.
- The data is decompressed to be read and compressed back right after (minimizing the disc memory demand).
- This option comes in handy when a large number of cross section data libraries are in use, e.g., in systematic calculations for nuclear data uncertainty evaluation.
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 s] (default value: INFTY/"no cut-off") |
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 option) 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 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 tpa
set tpa [ T_{min} T_{max} TAIL NF BNK ]
Sets parameters for track plot animation. Input values:
T_{min} | : starting time of track plot animation [in s] |
T_{max} | : end time of track plot animation [in s] |
TAIL | : tail length of plotted particles [in cm] |
NF | : number of frames |
BNK | : 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 command line option.
- If the animation option is ommited, the code plots particle tracks in a geometry plot output.
- The routine produces NF frames for each geometry plot named [input]_trck[n]_frame[m].png, where "n" is an index corresponding to the geometry plot and "m" is the frame index.
- The geometry plots are defined with the plot card
- The frames can be converted into a .gif animation using tools like Imagemagick.
- The visualization:
- Particles have a tail to better visualize their movement from one collision to the next.
RGB value Color Description: particle (255, 0, 255) COLOR Neutrons (0, 255, 0) COLOR Photons
- Storing the simulated collision points requires additional memory, determined by the event bank size. It is also controlled via set gbuf and set nbuf input options.
- 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 options).
- 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.
- For more information, see also the detailed description on track plotter and track plot animation.
set transmurea
set transmurea ZAI_{1} MT_{1} ZAI_{2} MT_{2} ...
Overrides the automatically generated transmutation paths with a user-provided list of reactions. Input values:
ZAI_{n} | : nuclide identifier (ZAI) |
MT_{n} | : reaction identifier (ENDF reaction MT). |
Notes:
- This option overrides the default behavior by including only the reactions included on the list.
- The default transmutation chains in burnup calculations are automatically generated based on the available data (and an internal algorithm).
- There is a special entry for the ZAI parameter:
- "all": to include all reactions of the type
- The reactions are given as nuclide identifier - reaction identifier pairs.
- For example, the radiative capture cross section of ^{238}U would be 922380 102.
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 (default value: 1.0) |
Notes:
- The normalization in transient simulations is, by default, the same as in the transient criticality source generation calculation.
- For more information, see the detailed description on Transient simulations.
set transtime
set transtime FLAG
Sets the evaluation method applied to time dependent transformations. Input values:
FLAG | : time dependent transformation evaluation method option (default value: 0) |
Notes:
- Functionality:
- FLAG 0: it evaluates the transformation using the beginning time of the time-interval being simulated (geometry static for each time interval).
- FLAG 1: it evaluates the transformation using the time when the tracking of the neutron being simulated began (geometry static for each neutron lifetime), resulting in a much smoother transformation.
set trc
set trc MAT FILE E_{min} [ ZAI_{1} ZAI_{2} ... ]
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 [in MeV] |
ZAI_{n} | : nuclide identifiers (ZAI) |
The syntax of the file containing the energy-dependent transport correction factor data is:
NE E_{1} ... E_{NE+1} NT T_{1} ... T_{NT} F_{1,1} F_{2,1} ... F_{NE,1} F_{1,2} F_{2,2} ... F_{NE,2} ... F_{1,NT} F_{2,NT} ... F_{NE,NT}
where:
NE | : is the number of energy intervals |
E_{1} ... E_{NE+1} | : are the energy interval boundaries in MeV (in ascending order) |
NT | : is the number of temperatures |
T_{1} ... T_{NT} | : are the temperatures in kelvin (in ascending order) |
F_{1,1} ... F_{NE,NT} | : are the transport correction factors corresponding to each energy interval and temperature |
Notes:
- Methodology:
- 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: .
- 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 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.
- Energy-dependent correction factors:
- , at one or multiple temperatures.
- Histogram interpolation is used between energy interval boundaries and linear interpolation between temperatures.
- The correction is not applied below the minimum energy.
- Constant extrapolation is used below the lowest temperature and above the highest temperature.
- If the number of temperatures is zero, no temperature values should be specified in the input, and the same distribution is applied at every temperature.
- If the number of temperatures is one, the temperature value is read and the same distribution is applied at every temperature.
- The number of energy intervals and the energy interval boundaries do not have to match any other energy group structures in the calculation.
- Cross section correction:
- 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.
- If nuclide identifiers are given, the transport correction is applied only to the total cross sections of these nuclides in the given material.
- The TRC diffusion coefficients TRC_DIFFCOEF and transport cross sections TRC_TRANSPXS estimates are written in:
- [input]_res.m output file: homogenized group constants section - diffusion parameters: for infinite spectrum and critical spectrum.
- [input].coe ouput file, via the set coefpara option: automated burnup sequence/coefficient matrix output.
- Method can not be used for divided or burnable materials for the time being.
set ttacut
set ttacut TTACUT
Sets cut-off for linear chains method (TTA) based on passage. Input values:
TTACUT | : linear chains method (TTA) cut-off (default value: 1.0E-28) |
Notes:
- Setting TTACUT cut-off to a higher value serves as a termination criterion where any chain accounting for less than the fraction TTACUT of the total atomic density is ignored.
set ttb
set ttb OPT
Sets the thick-target bremsstrahlung approximation for modelling electrons and positrons on and off. Input values:
OPT | : option to set thick-target bremsstrahlung approximation off (0/no) or on (1/yes). The default option is "on" |
Notes:
- The photon transport physics model is described in a related paper^{[6]}
set ttbpm
set ttbpm OPT
Sets a separate bremsstrahlung model for positrons. Input values:
OPT | : option to set a separate bremsstrahlung model off (0/no) or on (1/yes). The default option is "on" |
Notes:
- The photon transport physics model is described in a related paper^{[6]}
set ufs
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} Y_{MIN} Y_{MAX} N_{Z} Z_{MIN} Z_{MAX}
Turns on the uniform fission source (UFS) method. Input values:
MODE | : reaction rate for the weighted mesh distribution (1 = total (collision), 2 = flux, 3 = fission) |
ORDER | : exponential factor to adjust the steepness of the distribution |
N_{X} | : number of x-mesh cells |
X_{MIN} | : minimum x-coordinate mesh boundary [in cm] |
X_{MAX} | : maximum x-coordinate mesh boundary [in cm] |
N_{Y} | : number of y-mesh cells |
Y_{MIN} | : minimum y-coordinate mesh boundary [in cm] |
Y_{MAX} | : maximum y-coordinate mesh boundary [in cm] |
N_{Z} | : number of z-mesh cells |
Z_{MIN} | : minimum z-coordinate mesh boundary [in cm] |
Z_{MAX} | : maximum z-coordinate mesh boundary [in cm] |
LAT | : lattice name defining the mesh structure |
Notes:
- The UFS method collects the reaction rate distribution during inactive neutron cycles and adjust the number of emitted fission neutrons during the active cycles by a factor.
- The factor for a given mesh cell i: , where is the distribution and the exponential factor.
- The mesh definition can be characterized as:
- The full-geometry (type 1 definition, 3 parameters)
- Fixed to a lattice (type 2 definition, 4 parameters)
- It fixes the mesh structure in x- and y- directions.
- The lattice can be 2D square or hexagonal type defined in the global coordinate system.
- Delimited within a region by the number of mesh cells and boundaries in x-, y- and z- directions (type 3 definition, 9 parameters)
- By defining the exponential factor ORDER to "1.0", the method results in a relatively uniform distribution of source points.
- Applicability:
- The uniform fission source method only has applicability in criticality calculations.
- An additional mode, MODE 4, has been set to use the uniform fission method coupled with the built-in response matrix solver.
- The mesh definition is carried out by the response matrix mesh (see set sca option).
- The exponential factor is set to 1.0.
- The methodology is described in a related paper^{[28]}.
set ures
set ures OPT [ NUC_{1} NUC_{2} ... ][ DILUCUT ]
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). The default option is "off" |
NUC_{n} | : list of nuclides to which the option is applied to (e.g. "92238.09c"). |
DILUCUT | : infinite dilution cut-off (default value: 1.0E-9) |
Notes:
- Setting unresolved resonance probability table sampling "off" for a list of nuclides will set it "on" for the rest of the nuclides.
- The infinite dilution cut-off DILUCUT defines a limit for atomic fractions, and probability table sampling is used only for nuclides with concentration above this limit.
- See separate description of physics options in Serpent for differences to other codes.
set usym
set usym UNI AX BC X_{0} Y_{0} θ_{0} θ_{w} [ OPT ]
Defines a universe symmetry. Input values:
UNI | : universe name |
AX | : symmetry axis (x-axis = 1, "x", y-axis = 2, "y", z-axis = 3, "z") |
BC | : boundary condition (reflective = 2, "reflective", periodic = 3, "periodic") |
X_{0} | : x-coordinate of the origin [in cm] |
Y_{0} | : y-coordinate of the origin [in cm] |
θ_{0} | : azimuthal position where the symmetry segment starts [in degrees] |
θ_{w} | : width of the segment [in degrees] |
OPT | : option to use actual reflections and translations (1/yes) instead of coordinate transformations (0/no). (default value: 0) |
Notes:
- Usage:
- To simplify construction of complex geometries.
- To reduce the number of burnable material zones when automated depletion zone division is applied (see div card).
- Symmetry application:
- Using coordinate transformations.
- Symmetry not allowed on root universe with repeated boundary conditions (see set bc option).
- The particle position and direction are not affected during tracking.
- Using actual reflections and translations.
- Using coordinate transformations.
- Remember:
- With lattices, to prevent excess memory usage during depletion, the lattice positions overlapped by the symmetry should remain empty of fuel pins, for example.
- It is important to pay attention to the definition of material volumes.
- The supported Serpent 1 syntax-style: set usym UNI SYM [ X_{0} Y_{0} ] allows only quadrant symmetries (SYM = 4) in universe 0 (UNI = 0) centred in origin (X_{0}, Y_{0}) = (0,0).
- 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 [in MeV] (default value: 202.27) |
Notes:
- The fission heating value for other actinides is scaled based the Q-values found in the cross section libraries in reference with the U-235 value set.
- See also set fissh option.
- See also Section 5.8 of ^{[1]}.
set voidc
set voidc OPT
Option that enables removing void cells to accelerate particle tracking in complex geometries with numerous void. Input values:
OPT | : option to switch the removal mode on (1/yes) or off (0/no). The default option is "off" |
set wrnout
set wrnout OPT
Option that enables the generation of a warning-message output file. Input values:
OPT | : option to switch the removal mode on (1/yes) or off (0/no). The default option is "on" |
Notes:
- The warning-message output file [input].wrn collects, as a replica, the errors/warnings/notes printed out in the main (screen) output.
set wie
set wie FRAC_ITER
Option that enables the Wielandt’s method to accelerate the convergence of the fission source by setting the initial fraction iteration condition. Input values:
FRAC_ITER | : initial guess of the probability of banking the neutron (negative value, ]-1, 0[) or the shifted eigenvalue (positive value, [0.5, 3]) |
set wwb
set wwb LO UP [ F ]
Defines the relation between importances and weight-window boundaries. Input values:
LO | : factor relating the lower weight-window boundary to importance (default value: 0.5) |
UP | : factor relating the upper weight-window boundary to importance (default value: 2.0) |
F | : Russian roulette survival probability factor (default value: 1.0) |
Notes:
- Weight window boundaries are inversely proportional to importance. These factors define the coefficients.
- See also the weight window mesh definition, wwin card.
set xenon
set xenon OPT [ MAT_{1} MAT_{2} ... ]
Sets equilibrium xenon calculation on or off. Input values:
OPT | : option to set equilibrium xenon calculation on or off (0 = off/no, non-zero = on/yes; with 1= include only ^{135}Xe, 2 = include ^{135}Xe and ^{135m}Xe). The default option is "off" |
MAT_{n} | : optional list of materials for which to set the option (on/off). The default option is all fissile materials. |
Notes:
- Setting equilibrium xenon calculation "off" for a list of materials sets it "on" for all other fissile materials.
- Functionality:
- It forces the xenon number density to be in equilibrium with the current flux and xenon absorption level during the transport calculation.
- It is updated according to the batching interval set in the set pop option.
- Having a large batching interval means that the equilibrium concentration may take a large number of cycles to converge.
- The evaluation takes place on depletion zone basis.
- Therefore, the fuel material may require further division into several depletion zones (see div card).
- The equilibrium xenon concentration calculation is meant for example to stabilize the burnup calculations (see dep card).
- Calculation chain:
- The equilibrium concentrations are calculated only for I-135 and Xe-135, and optionally for Xe-135m.
- The equilibrium concentration calculation chain only considers I-135 cumulative fission yield, Xe-135 independent fission yield, I-135 decay to Xe-135 and Xe-135 absorption, and optionally Xe-135m independent fission yield, I-135 decay to Xe-135m and Xe-135m decay to Xe-135.
- Requirements:
- The fission yield library (see set nfylib option) and decay data library (see set declib option).
- Correct evaluation of the material volumes. For more information, see Defining material volumes.
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 (see set opti).
- 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.
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 (minimum value: 10). |
E_{min} | : Lower boundary for the energy points [in MeV] |
E_{max} | : Upper boundary for the energy points [in MeV] |
Notes:
- 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.
- ^ Kaltiaisenaho, T. "Statistical tests and the underestimation of variance in Serpent 2." VTT-R-00371-14, VTT Technical Research Centre of Finland, 2014
- ^ Trkov, A., Herman, M. and Brown, D. A. "ENDF-6 Formats Manual." CSEWG Document ENDF-102 / BNL-90365-2009 Rev. 2 (2018)
- ^ Brown, F. B. "The makxsf Code with Doppler Broadening", Los Alamos National Laboratory Tech. Rep., LA-UR-06-7002, Los Alamos, NM, 2006
- ^ Kulesza, J. A. (ed.), “MCNP code version 6.3.0 Theory & User Manual: Appendix A Mesh-Based WWINP, WWOUT, and WWONE File Format,” LA-UR-22-30006, Rev. 1, Los Alamos National Laboratory (2022).
- ^ Kaltiaisenaho, T. "Photon transport physics in Serpent 2 Monte Carlo code." Comp. Phys. Comm., 252 (2020) 107143.
- ^ 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.
- ^ Liu, Z., Smith, K., Forget, B. and Ortensi, J. "Cumulative migration method for computing rigorous diffusion coefficients and transport cross sections from Monte Carlo." Ann. Nuc. Energy, 112 (2016) 126-136
- ^ Liu, Z., Smith, K. and Forget, B. "Group-wise Tally Scheme of Incremental Migration Area for Cumulative Migration Method." In Proceedings of the PHYSOR 2018 (2018) 2512-2523
- ^ Wieselquist, W. A. and Lefebvre, R. A (ed.), "SCALE 6.3.1 User Manual: Sensitivity and Uncertainty Analysis - Appendix 6.3.4.1.6. COVERX format", ORNL/TM-SCALE-6.3.1, UT-Battelle, LLC, Oak Ridge National Laboratory, Oak Ridge, TN (2023)
- ^ Valtavirta, V. "Nuclear data uncertainty propagation to Serpent generated group and time constants", Research report VTT-R-04681-18 (2018).
- ^ Garcia, M., Leppänen, J. and Sanchez-Espinoza, V. "A Collision-based Domain Decomposition scheme for large-scale depletion with the Serpent 2 Monte Carlo code." Ann. Nucl. Energy, 152 (2021) 108026.
- ^ 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.
- ^ Kaltiaisenaho, T. and Leppänen, J. "Analysing the Statistics of Group Constants Generated by Serpent 2 Monte Carlo Code." In proc. PHYSOR 2014, Kyoto, Japan, Sep. 28 - Oct. 3, 2014.
- ^ Leppänen, J., Pusa, M. and Fridman, E., "Overview of methodology for spatial homogenization in the Serpent 2 Monte Carlo code.", Ann. Nucl. Energy, 96 (2016) 126-136
- ^ Dufek, J. and Tuttelberg, K. "Monte Carlo criticality calculations accelerated by a growing neutron population." Ann. Nucl. Energy 94 (2016) 16-21.
- ^ "Chernobyl: Assessment of Radiological and Health Impacts", OECD/NEA2002 (2002)
- ^ "Spent Nuclear Fuel Assay Data for Isotopic Validation", NEA/NSC/WPNCS/DOC(2011)5 (2011)
- ^ "The identification of radionuclides relevant to long-term waste management in th United Kingdom", Nirex Report no. N/105 (2004)
- ^ Valtavirta, V. and Leppänen, J. "A novel Monte Carlo leakage correction for Serpent 2", In proc. ANS M&C 2021. Raleigh, NC, USA. October 3-7, 2021
- ^ Rintala, A., Valtavirta, V. and Leppänen, J. "Microscopic cross section calculation methodology in the Serpent 2 Monte Carlo code." Ann. Nucl. Energy 164 (2021) 108603
- ^ Rintala, A. "Microscopic group constants with Serpent." 10th International Serpent User Group Meeting, Garching, Germany, October 27-30, 2020 UGM 2020
- ^ Leppänen, J., Kaltiaisenaho, T., Valtavirta, V. and Metsälä, M. "Development of a Coupled Neutron / Photon Transport Mode in the Serpent 2 Monte Carlo Code". In proc. M&C 2017, Jeju, Korea, Apr. 16-20, 2017
- ^ 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.
- ^ Leppänen, J. "Acceleration of fission source convergence in the Serpent 2 Monte Carlo code using a response matrix based solution for the initial source distribution." Ann. Nucl. Energy 128 (2019) 63-68
- ^ Leppänen, J., "Methodology, applications and performance of the CAD-based geometry type in the serpent 2 Monte Carlo code.", Ann. Nucl. Energy 176 (2022) 109259
- ^ Bilodid, Y. and Leppänen, J., "Effect of the uniform fission source method on local power variance in full core serpent calculation.", EPJ Web Conf. 247 04024 (2021)