Baixe SERPENT code learning e outras Manuais, Projetos, Pesquisas em PDF para Introdução à Física Nuclear, somente na Docsity!
Input syntax manual
From Serpent Wiki 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 cell (cell definition) 1.3 coef (coefficient matrix definition) 1.4 dep (depletion history) 1.5 det (detector definition) 1.6 div (divisor definition) 1.7 ene (energy grid definition) 1.8 ftrans (fill transformation) 1.9 fun (function definition) 1.10 ifc (interface file) 1.11 include (read another input file) 1.12 lat (regular lattice definition) 1.13 mat (material definition) 1.14 mesh (mesh plot definition) 1.15 mix (mixture definition) 1.16 nest (nested universe definition)
1.17 particle (particle geometry definition) 1.18 pbed (explicit stochastic (pebble bed) geometry) 1.19 pin (pin geometry definition) 1.20 plot (geometry plot definition) 1.21 sample (Temperature / density data sample definition) 1.22 sens (sensitivity calculation definition) 1.23 solid (irregular 3D geometry definition) 1.24 src (source definition) 1.25 strans (surface transformation) 1.26 surf (surface definition) 1.27 therm and thermstoch (thermal scattering) 1.28 tme (time binning definition) 1.29 trans (transformations) 1.30 transv and transa (velocity and acceleration transformations) 1.31 utrans (universe transformation) 1.32 wwgen (response matrix based importance map solver) 1.33 wwin (weight window mesh definition) 2 Input options 2.1 set acelib 2.2 set adf 2.3 set alb 2.4 set arr 2.5 set bala 2.6 set bc 2.7 set blockdt 2.8 set bralib 2.9 set bumode 2.10 set ccmaxiter 2.11 set ccmaxpop 2.12 set cfe 2.13 set coefpara 2.14 set cmm 2.15 set comfile 2.16 set confi 2.17 set cpd 2.18 set cpop 2.19 set csw 2.20 set dbrc 2.21 set dd 2.22 set declib 2.23 set decomp 2.24 set delnu 2.25 set depout 2.26 set dfsol 2.27 set dix 2.28 set dynsrc 2.29 set dt 2.30 set ecut 2.31 set edepdel
2.81 set rfr 2.82 set rfw 2.83 set root 2.84 set runtme 2.85 set samarium 2.86 set savesrc 2.87 set sca 2.88 set seed 2.89 set sfylib 2.90 set shbuf 2.91 set sie 2.92 set spd 2.93 set srcrate 2.94 set title 2.95 set tcut 2.96 set tpa 2.97 set transnorm 2.98 set transtime 2.99 set trc 2.100 set ufs 2.101 set ures 2.102 set usym 2.103 set U235H 2.104 set wwb 2.105 set xenon 2.106 set xscalc 2.107 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 ] [ var VNAME VAL ] Defines the variations invoked for a branch in the automated burnup sequence. Input values: NAME : branch name
MAT 1 : name of the replaced material MAT 2 : name of the replacing material UNI 1 : name of the replaced universe UNI 2 : name of the replacing universe MAT : name of the material for which density and temperature are adjusted DENS : material density after adjustment (positive entries for atomic, negative entries for mass densities, or "sum" to use the sum of the constituent nuclide densities) TEMP : material temperature after adjustment, or -1 if no adjustment in temperature THERMn : n:th thermal scattering data associated with the material SABLn : name of the n :th S( ) library for temperature below the given value SABHn : name of the n :th S( ) library for temperature above the given value TGT : target universe, surface or cell TRANS : name of the applied transformation OPT : option for setting poison concentrations (0 = set to zero, 1 = use values from restart file) VNAME : variable name VAL : variable value Notes: The branch name identifies the branch in the coefficient matrix of the coef card The input parameters consist of a number variations, which are invoked when the branch is applied. A single branch card may inclued one or several variations. The repm variation can be used to replace one material with another, for example, to change coolant boron concentration. The repu variation can be used to replace one universe with another, for example, to replace empty control rod guide tubes with rodded tubes for control rod insertion in 2D geometries. The stp variation can be used to change material density and temperature. The adjustment is made using the built-in Doppler-broadening preprocessor routine and tabular interpolation for S( ) thermal scattering data. The last three parameters of the stp entry are provided only if the material has thermal scattering libraries attached to it (see the therm card). The tra variation can be used to move or rotate different parts of the geometry, for example, to adjust the position of control rods in 3D geometries. The name of the transformation refers to the unit (universe, cell or surface) entry in the trans card. The xenon and samarium options can be set to enforce the concentrations of fission product poisons Xe-135 and Sm-149 to zero. By default the concentrations are read from the restart file. Variables can be used to pass information into output file, which may be convenient for the post-processing of the data. The branch card is used together with the coef card. For more information, see detailed description on the automated burnup sequence. The replaced material MAT 1 of repm variation is also replaced inside mixtures. This means one can not replace a material with a mixture defined with mix card containing the replaced material (for example replacing pure water defined with mat card by a
Outside cells are allowed only in the root universe. It is important that all space outside the model is defined. The surface list defines the boundaries of the cell by listing the surface names (as provided in the surface card), together with the operator identifiers (nothing for intersection, ":" for union, "-" for complement and "#" for cell complement). Universes are implicitly declared for example by using the UNI 0 key words on cell cards as there is no explicit universe input card. For more information, see detailed description on the universe-based geometry type in Serpent.
coef (coefficient matrix definition)
coef NBU [ BU 1 BU 2 ... ] [ NBR 1 BR1,1 BR1,2 ... ] [ NBR 2 BR2,1 BR2,2 ... ] ... Defines the coefficient matrix for the automated burnup sequence. Input values: NBU : number of burnup points BUn : burnup steps at which the branches are invoked NBRm : number branches in the m :th dimension of the burnup matrix BRm,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. Positive values in the burnup vector are interpreted as (MWd/kgU), negative values are interpreted as time steps in days. The coef card is used together with the branch card For more information, see detailed description on automated burnup sequence.
dep (depletion history)
dep STYPE [ STEP 1 STEP 2 ... ] Defines depletion history with steps and activates depletion calculation mode. Input values: STYPE : step type STEPn : depletion step list The possible step types are:
Type Description Quantity Unit bustep Depletion step Burnup interval MWd/kgHM butot Depletion step Cumulative burnup MWd/kgHM daystep Depletion step Time interval d daytot Depletion step Cumulative time d decstep Decay step Time interval d dectot Decay step Cumulative time d actstep Activation step Time interval d acttot Activation step Cumulative time d Notes: Transport cycle is omitted with the decstep and dectot options. Transport cycle is run only once with the actstep and acttot options. dep pro PTR_REPROC dep bra PTR_BRANCH
det (detector definition)
det NAME [ PART ] [ dr MT MAT ] [ dv VOL ] [ dc CELL ] [ du UNI ] [ dm MAT ] [ dl LAT ] [ dx XMIN XMAX NX ] [ dy YMIN YMAX NY ] [ dz ZMIN ZMAX NZ ] [ dn TYPE MIN 1 MAX 1 N 1 MIN 2 MAX 2 N 2 MIN 3 MAX 3 N 3 ] [ dh TYPE X 0 Y 0 PITCH N 1 N 2 ZMIN ZMAX NZ ] [ dumsh UNI NC CELL 0 BIN 0 CELL 1 BIN 1 ... ] [ de EGRID ] [ di TBIN ] [ ds SURF DIR ] [ dir COSX COSY COSZ ] [ dtl SURF ] [ df FILE FRACTION ] [ dt TYPE PARAM ] [ dhis OPT ] [ dfl FLAG OPT ] [ da MAT FLX ] [ dfet TYPE PARAMS ] Detector definition. The first parameter: PART : particle type (n = neutron, p = photon) is optional in single particle simulations. The remaining parameters are defined by separate key words followed by the input values.
If multiple detector universes are defined, the results are correspondingly divided into multiple bins. Detector material ( dm ): MAT : material name where the detector is scored Notes: If multiple detector materials are defined, the results are correspondingly divided into multiple bins. The material entry defines the volume of integration, which must not be confused with the response material in the dr entry. Detector lattice ( dl ): LAT : lattice name where the detector is scored Notes: The lattice detector automatically divides the results into multiple bins corresponding to the lattice cells. Cartesian mesh detector ( dx , dy and dz ): XMIN : minimum x-coordinate of the detector mesh XMAX : maximum x-coordinate of the detector mesh NX : number of x-bins YMIN : minimum y-coordinate of the detector mesh YMAX : maximum y-coordinate of the detector mesh NY : number of y-bins ZMIN : minimum z-coordinate of the detector mesh ZMAX : maximum z-coordinate of the detector mesh NZ : number of z-bins Notes: The mesh detectors can be used to sub-divide the results into multiple spatial bins. For a Cartesian mesh the division is provided with separate entries in x-, y- and z- locations. Curvilinear mesh detector ( dn ): TYPE : Type of curvilinear mesh - 1 = cylindrical (dimensions r , θ , z ), 2 = spherical (dimensions r , θ , φ ) MINn : Minimum value of coordinate n for the mesh division.
MAXn : Maximum value of coordinate n for the mesh division. Nn : Number of bins in the n coordinate direction (the division will be equal r , not equal volume). Notes: All parameters must be provided, even for one- or two-dimensional curvilinear meshes. The results are not divided by cell volume (difference to MCNP mesh tally). By default, the curvilinear mesh detectors use the global (universe 0) coordinate system for scoring. If the TYPE parameter is given as a negative value (e.g. -1) the lowest level coordinates are used instead. Hexagonal mesh detector ( dh ): TYPE : Type of hexagonal mesh (2 = flat face perpendicular to x-axis, 3 = flat face perpendicular to y-axis) X 0 , Y 0 : coordinates of mesh center PITCH : mesh pitch N 1 , N 1 : mesh size ZMIN : minimum z-coordinate of the detector mesh ZMAX : maximum z-coordinate of the detector mesh NZ : number of z-bins Notes: All parameters must be provided, even for a two-dimensional hexagonal meshes. Unstructured mesh detector ( dumsh ): UNI : universe of the unstructured mesh based geometry NC : number of mesh cell bins included in the output CELLn , BINn : 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:
Super-imposed track-length detector ( dtl ): SURF : surface inside which the detector is scored Notes: This option can be used to apply the track-length estimator for calculating reaction rates inside regions defined by a single surface (sphere, cylinder, cuboid, etc.) The purpose of the track-length detector is to provide better statistics for special applications (activation wire measurements, etc.). The surface is treated separate from the geometry, and its position is always relative to the origin of the root universe. This is the case even if the surface is part of the geometry in another universe. Detector file ( df ): FILE : file name where the scored points are written FRAC : fraction of recorded scores and ascii/binary option (positive value = ascii, negative value = binary) Notes: This option can be used to write the scored points in a file. When used with the surface current detector this option can provide surface source distributions for other calculations. The fraction parameters gives the probability that the score is written in the file and it can be used to reduce the file size in long simulations. Source files can be read using the sf entry of source cards. Special types ( dt ): TYPE : special type (see below) PARAM : additional parameters The types are: -1 = cumulative spectrum -2 = division by energy width -3 = division by lethargy width -4 = sum over cell or material bins -5 = importance weighting -6 = sum over number of scores 2 = multiply result with another detector defined by PARAM 3 = divide result with another detector defined by PARAM Notes:
Types -1, -2 and -3 are used with energy binning. Type -4 can be used to calculate sum over multiple cell or material bins defined using the dc and dm options. By default separate bins are used for each entry. Type 3 can be used to calculate flux-weighted averages (microscopic and macroscopic cross sections, etc.). When the results are multiplied or divided by another detector, the number of bins must be compatible (single value or matching number of bins). History collection option ( dhis ): OPT : option to collect histories (0 = no, 1 = yes) Notes: When this option is set, the batch-wise results are kept and printed in the history output file. Note to developers: statistical tests should be documented Detector flagging ( dfl ): FLAG : flag number (between 1 and 64) OPT : flagging option (0 = reset if scored, 1 = set if scored, -2/2 score if set -3/3 score if not set) Notes: Detector flagging allows limiting detector scores to histories which have already contributed to another score. The first two options reset or set the flag if the detector is scored, respectively. The remaining options test if the flag is set and score the detector accordingly. Positive values apply OR-type logic (detector is scored if any of the associated flags is set/unset) and negative values AND-type logic (detector is scored if all the associated flags are set/unset). Activation detector ( da ): MAT : activated material FLX : flux applied to activation Notes: Activation detector allows performing activation calculation for materials that are not part of the geometry. The flux spectrum applied to neutron irradiation is taken from the detector scores. The absolute flux level can be set using the FLX parameter. If this parameter is set to -1, also the flux magnitude is taken from the detector scores. Requires neutron transport simulation and burnup mode. The material provided with the entry must be burnable, and cannot part of the actual geometry. Volume of the material must be defined using the dv parameter.
Divides a material into a number of sub-zones. Input values: MAT : name of the divided material LVL : geometry level at which the cell-wise division takes place (0 = no division, 1 = last level, 2 = 2nd last level, etc.) NX : number of x-zones XMIN : minimum x-coordinate (cm) XMAX : maximum x-coordinate (cm) NY : number of y-zones YMIN : minimum y-coordinate (cm) YMAX : maximum y-coordinate (cm) NZ : number of z-zones ZMIN : minimum z-coordinate (cm) ZMAX : maximum z-coordinate (cm) NR : number of radial zones RMIN : minimum radial coordinate (cm) RMAX : maximum radial coordinate (cm) NS : number of angular sectors S 0 : zero position of angular division (degrees) Notes: The automated divisor feature can be used to sub-divide burnable materials into depletion zones, but the use is not limited to burnup mode. The spatial sub-division is based on either Cartesian or cylindrical mesh. Volumes of the divided materials must be set manually (see detailed description on the definition of material volumes). Using automated instead of manual depletion zone division saves memory, which may become significant in very large burnup calculation problems (see detailed description on memory usage). For more information see detailed description on automated depletion zone division. The usage of LVL is explained on page automated depletion zone division. If a material is not divided, all occurrences of it are treated as a single depletion zone. For example, if there are multiple fuel pins with same fuel material type, and no div card is present, all pins are depleted as a single pin.
ene (energy grid definition)
ene NAME 1 E 0 E 1 ... ene NAME 2 N Emin Emax ene NAME 3 N Emin Emax
ene NAME 4 GRID Defines an energy grid structure. Input values: NAME : energy grid name Ei : bin boundaries (type 1) N : number of equi-width bins (types 2 ad 3) Emin : minimum energy (types 2 and 3) Emax : maximum energy (types 2 and 3) GRID : name of the pre-defined grid (type 4) Notes: The first input parameter gives the type (1 = arbitrarily defined, 2 = equal energy-width bins, 3 = equal lethargy-width bins, 4 = pre-defined energy group structure). Energy grid structures are used for several purposes, most commonly with detectors. See separate description of pre-defined energy group structures.
ftrans (fill transformation)
See transformations.
fun (function definition)
fun NAME TYPE [ ... ] Defines a function that can be used with detector responses. Input values: NAME : function name TYPE : function type (currently only supported type is 1 = point-wise tabular data) The syntax for type 1 is: fun NAME 1 INTT X 1 F 1 X 2 F 2 ... where: INTT : is the interpolation type (1 = histogram, 2 = lin-lin, 3 = lin-log, 4 = log-lin, 5 = log- log) X 1 F 1 ... : are the tabulated variable-value pairs Notes: The defined function is linked to detector response using response number -100 (syntax: dr -100 NAME ).
lat UNI TYPE X 0 Y 0 NX NY PITCH UNI 1 UNI 2 ... Defines a finite two-dimensional lattice in xy-plane with square or X- or Y-type hexagonal elements. The lattice is infinite in z-direction. Input values: UNI : universe name of the lattice TYPE : lattice type X 0 : x-coordinate of the lattice origin (origin is in the center of the lattice). Y 0 : y-coordinate of the lattice origin (origin is in the center of the lattice). NX : number of lattice elements in x-direction NY : number of lattice elements in y-direction PITCH : lattice pitch UNIn : list of universes filling the lattice positions Possible lattice types are: Type Description 1 Square lattice 2 X-type hexagonal lattice 3 Y-type hexagonal lattice Notes: Number of universes in list of universes must be NX times NY. For square lattices the x coordinate increases from left to right and the y coordinate increases from top to bottom, so the first NX values in the list of universes create the bottommost (minimum y) row from minimum x to maximum x and the last NX values in the list of universes create the topmost (maximum y) values. The line breaks usually given in the list of universes are just for visual help of the user. 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 are easily checked by using the geometry plotter. lat UNI TYPE X 0 Y 0 PITCH UNI 1 Defines an infinite two-dimensional lattice in xy-plane with infinitely repeating square or X- or Y-type hexagonal element. The lattice is infinite in z-direction. UNI : universe name of the lattice TYPE : lattice type X 0 : x-coordinate of the lattice origin Y 0 : y-coordinate of the lattice origin PITCH : lattice pitch 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 comparing with finite hexagonal lattices. lat UNI TYPE X 0 Y 0 NR NS,1 RADIUS 1 THETA 1 UNI1,1 UNI2,1 ... NS,2 RADIUS 2 THETA 2 UNI1,2 UNI2, ... ... Defines a finite two-dimensional circular cluster array lattice in xy-plane. The lattice is infinite in z-direction. UNI : universe name of the lattice TYPE : lattice type X 0 : x-coordinate of the lattice origin Y 0 : y-coordinate of the lattice origin NR : number of rings in the array NS,R : number of sectors in R:th ring RADIUSR : central radius of R:th ring THETAR : angle of rotation of R:th ring in degrees UNIN,R : list of universes filling the sector positions in R:th ring Possible lattice types are: Type Description 4 Circular cluster array Notes: The circular cluster array can be used to define fuel assemblies used for example in AGR, CANDU, MAGNOX and RBMK reactors. It can also be used to define fuel rod layout used for example in TRIGA reactors. lat UNI TYPE X 0 Y 0 NL Z 1 UNI 1 Z 2 UNI 2 ... Defines a finite one-dimensional vertical stack in z-direction. The stack is infinite in xy-plane. UNI : universe name of the lattice TYPE : lattice type X 0 : x-coordinate of the lattice origin
