Ants input manual
The input syntax of Ants is currently completely card based without limit symbols.
Contents
- 1 Input syntax
- 2 Main blocks
- 2.1 Title
- 2.2 Echo
- 2.3 Global
- 2.4 core
- 2.5 fuel
- 2.6 controlrod
- 2.7 hydraulics
- 2.8 iteration
- 2.8.1 conv_crit_keff
- 2.8.2 conv_crit_boron
- 2.8.3 conv_crit_fsrc
- 2.8.4 conv_crit_fsrc_l2
- 2.8.5 conv_crit_flux
- 2.8.6 conv_crit_xenon
- 2.8.7 conv_crit_samarium
- 2.8.8 conv_crit_partial_current
- 2.8.9 num_inner
- 2.8.10 num_cgr
- 2.8.11 max_outer
- 2.8.12 use_cgr
- 2.8.13 use_relaxation
- 2.8.14 use_color
- 2.8.15 use_discontinuity_factor
- 2.8.16 use_wielandt_shift
- 2.8.17 relaxation_factor
- 2.8.18 wielandt_shift_coeff
- 2.8.19 use_ppr
- 2.8.20 xenon_state
- 2.8.21 samarium_state
- 2.8.22 use_normalization
- 2.8.23 use_initial_normalization
- 2.8.24 power
- 2.8.25 flux
- 2.8.26 normalization_type
- 2.8.27 keff
- 2.8.28 boron
- 2.8.29 control_variable
- 2.8.30 use_boron_relaxation
- 2.8.31 boron_relaxation_factor
- 2.9 library
- 2.10 output
- 2.11 start
- 2.12 end
Input syntax
The following general syntax guide lines hold for Ants specific input. For example the HEXBU-3D/MOD5 group constant files follow their respective syntax.
- Ants input supports rest of line comment symbols
!
and//
, and block comments beginning with/*
and ending with*/
. - Blocks beginning and ending with
"
are held together in for example input file paths. - All tokens are separated with either space
,
or tabular characters. - Consecutive input may be repeated using
*
. The token before*
must be a positive integer (the number of repeats). - The input is case insensitive.
- The main block keywords (below) are reserved. In the main blocks, the sub-block keywords (even further below) are reserved.
Main blocks
When the main input file is read, it is tokenized and split into main blocks. Depending on the main block, they might be split into sub-blocks. Currently, the main block keywords are
title
echo
global
core
fuel
controlrod
hydraulics
iteration
library
output
start
end
Title
Set a title for the calculation.
- title [ <title> ]
- <title> : at most one token for the title. If omitted, an empty title will be set.
Echo
Echo something to standard output.
- echo [ <echo> ]
- <echo> : at most one token to be echoed. If omitted, an empty echo will be performed.
Global
Set global calculation parameters. These cards will be processed before any other cards and it is mandatory for them to be set.
Sub-blocks:
-
geometry
-
neutronics
Geometry
Set neutronics solution geometry type.
- global geometry <geometry>
- <geometry>
- square : use rectangular geometry (for example BWR, PWR)
- hexagonal : use hexagonal geometry (for example VVER)
- <geometry>
Neutronics
Set neutronics solution transport type.
- global neutronics <neutronics>
- <neutronics>
- diffusion : solve diffusion equation
- sp3 : solve sp3 equation (not supported)
- <neutronics>
core
fuel
controlrod
hydraulics
iteration
Set iteration parameters.
Sub-blocks:
conv_crit_keff
conv_crit_boron
conv_crit_fsrc
conv_crit_fsrc_l2
conv_crit_flux
conv_crit_xenon
conv_crit_samarium
conv_crit_partial_current
num_inner
num_cgr
max_outer
use_cgr
use_relaxation
use_color
use_discontinuity_factor
use_wielandt_shift
relaxation_factor
wielandt_shift_coeff
use_ppr
xenon_state
samarium_state
use_normalization
use_initial_normalization
power
flux
normalization_type
keff
boron
control_variable
use_boron_relaxation
boron_relaxation_factor
conv_crit_keff
- iteration conv_crit_keff <conv_crit_keff >
- <conv_crit_keff> : convergence criterion for absolute value change of effective multiplication factor between consecutive outer iterations.
conv_crit_boron
- iteration conv_crit_boron <conv_crit_boron >
- <conv_crit_boron > : convergence criterion for absolute value change of boron concentration (ppm) between consecutive outer iterations.
conv_crit_fsrc
- iteration conv_crit_fsrc <conv_crit_fsrc >
- <conv_crit_fsrc > : convergence criterion for maximum of the absolute value of node-wise relative fission source change between consecutive outer iterations.
conv_crit_fsrc_l2
- iteration conv_crit_fsrc_l2 <conv_crit_fsrc_l2 >
- <conv_crit_fsrc_l2 > : convergence criterion for change of L2 norm of node-integrated fission sources between consecutive outer iterations.
conv_crit_flux
- iteration conv_crit_flux <conv_crit_flux >
- <conv_crit_flux > : convergence criterion for maximum of the absolute value of group- and node-wise relative flux source change between consecutive outer iterations.
conv_crit_xenon
conv_crit_samarium
conv_crit_partial_current
num_inner
Set the number of inner iterations per outer iteration.
- iteration num_inner <num_inner>
- <num_inner> : number of inner iterations per outer iteration.
num_cgr
max_outer
use_cgr
use_relaxation
use_color
Use color or consecutive node iteration.
use_discontinuity_factor
use_wielandt_shift
relaxation_factor
wielandt_shift_coeff
use_ppr
xenon_state
samarium_state
use_normalization
use_initial_normalization
power
flux
normalization_type
keff
boron
control_variable
use_boron_relaxation
boron_relaxation_factor
library
Set group constant library parameters.
Sub-blocks:
-
type
-
path
Type
Set group constant library type.
- library type <type>
- <type>
- simple : simple group constant file format
- hexbu-3d/mod5 : HEXBU-3D/MOD5 group constant file format for hexagonal geometry (HEXBU-3D/VVER)
- hexbu-3d/mod5-trab3d : HEXBU-3D/MOD5 group constant file format for rectangular geometry (TRAB3D/BWR/PWR)
- ares : ARES group constant file format for rectangular geometry (not supported)
- <type>
Path
Set group constant library input file path
- library path <path>
- <path> : at most one token for the group constant library input file path. The path is (maybe?) relative to current working directory.
output
start
Start the calculation.
- start