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.4.1 width_x
- 2.4.2 width_y
- 2.4.3 width_xy
- 2.4.4 width_x_grid
- 2.4.5 width_y_grid
- 2.4.6 axial_nodes
- 2.4.7 axial_heights
- 2.4.8 rows
- 2.4.9 columns
- 2.4.10 nominal_power
- 2.4.11 radial_boundary_coeff
- 2.4.12 axial_boundary_coeff
- 2.4.13 radial_boundary_coeff_east
- 2.4.14 radial_boundary_coeff_north
- 2.4.15 radial_boundary_coeff_west
- 2.4.16 radial_boundary_coeff_south
- 2.4.17 axial_boundary_coeff_above
- 2.4.18 axial_boundary_coeff_below
- 2.4.19 radial_boundary_num_curr
- 2.4.20 radial_boundary_in_curr_east
- 2.4.21 radial_boundary_in_curr_north
- 2.4.22 radial_boundary_in_curr_west
- 2.4.23 radial_boundary_in_curr_south
- 2.4.24 radial_boundary_in_curr_northeast
- 2.4.25 radial_boundary_in_curr_northwest
- 2.4.26 radial_boundary_in_curr_southwest
- 2.4.27 radial_boundary_in_curr_southeast
- 2.4.28 radial_boundary_net_curr_east
- 2.4.29 radial_boundary_net_curr_north
- 2.4.30 radial_boundary_net_curr_west
- 2.4.31 radial_boundary_net_curr_south
- 2.4.32 radial_boundary_net_curr_northeast
- 2.4.33 radial_boundary_net_curr_northwest
- 2.4.34 radial_boundary_net_curr_southwest
- 2.4.35 radial_boundary_net_curr_southeast
- 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
Set core parameters.
Sub-blocks:
-
width_x
-
width_y
-
width_xy
-
width_x_grid
-
width_y_grid
-
axial_nodes
-
axial_heights
-
rows
-
columns
-
nominal_power
-
radial_boundary_coeff
-
axial_boundary_coeff
-
radial_boundary_coeff_east
-
radial_boundary_coeff_north
-
radial_boundary_coeff_west
-
radial_boundary_coeff_south
-
axial_boundary_coeff_above
-
axial_boundary_coeff_below
-
radial_boundary_num_curr
-
radial_boundary_in_curr_east
-
radial_boundary_in_curr_north
-
radial_boundary_in_curr_west
-
radial_boundary_in_curr_south
-
radial_boundary_in_curr_northeast
-
radial_boundary_in_curr_northwest
-
radial_boundary_in_curr_southwest
-
radial_boundary_in_curr_southeast
-
radial_boundary_net_curr_east
-
radial_boundary_net_curr_north
-
radial_boundary_net_curr_west
-
radial_boundary_net_curr_south
-
radial_boundary_net_curr_northeast
-
radial_boundary_net_curr_northwest
-
radial_boundary_net_curr_southwest
-
radial_boundary_net_curr_southeast
width_x
width_y
width_xy
width_x_grid
width_y_grid
axial_nodes
axial_heights
rows
columns
nominal_power
radial_boundary_coeff
axial_boundary_coeff
radial_boundary_coeff_east
radial_boundary_coeff_north
radial_boundary_coeff_west
radial_boundary_coeff_south
axial_boundary_coeff_above
axial_boundary_coeff_below
radial_boundary_num_curr
radial_boundary_in_curr_east
radial_boundary_in_curr_north
radial_boundary_in_curr_west
radial_boundary_in_curr_south
radial_boundary_in_curr_northeast
radial_boundary_in_curr_northwest
radial_boundary_in_curr_southwest
radial_boundary_in_curr_southeast
radial_boundary_net_curr_east
radial_boundary_net_curr_north
radial_boundary_net_curr_west
radial_boundary_net_curr_south
radial_boundary_net_curr_northeast
radial_boundary_net_curr_northwest
radial_boundary_net_curr_southwest
radial_boundary_net_curr_southeast
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
Set the number of coarse group rebalance (CGR) iterations per outer iteration. CGR is not used if boron is used as iteration control_variable.
- iteration num_cgr <num_cgr >
- <num_cgr > : number of coarse group rebalance (CGR) per outer iteration
max_outer
use_cgr
Either use coarse group rebalance (CGR) iteration during the outer iterations or calculate current effective multiplication factor from current node-wise values. CGR is not used if boron is used as iteration control_variable.
- iteration use_cgr <flag>
- <flag>
- 1/y/yes/on/true : coarse group rebalance (CGR) iteration is used
- everything else : coarse group rebalance (CGR) iteration is not used
- <flag>
use_relaxation
Either use partial current relaxation during inner iterations or not. Relaxation coefficient is given with iteration relaxation_factor.
- iteration use_relaxation <flag>
- <flag>
- 1/y/yes/on/true : relaxation is used
- everything else : relaxation is not used
- <flag>
use_color
Either use color iteration during the inner iterations or iterate one node at a time in the node indexing order. Two or four color iteration schemes will be used for rectangular and hexagonal geometries, respectively.
- iteration use_color <flag>
- <flag>
- 1/y/yes/on/true : color iteration is used
- everything else : color iteration is not used
- <flag>
use_discontinuity_factor
use_wielandt_shift
relaxation_factor
wielandt_shift_coeff
use_ppr
xenon_state
Set node-wise Xe-135 concentration state for calculation.
- iteration xenon_state <state>
- <state>
- zero: node-wise Xe-135 concentration will be set to zero
- fixed : node-wise Xe-135 concentration will stay the value it is before initiating the calculation
- equilibrium : node-wise Xe-135 concentration will be set to the equilibrium value calculated to match the current node power level. The value will depend on the used group constant model.
- dynamic: node-wise Xe-135 concentration will be calculated using time dependent equations. The value will depend on the used group constant model. (Not supported)
- <state>
samarium_state
Set node-wise Sm-149 concentration state for calculation.
- iteration samarium_state <state>
- <state>
- zero: node-wise Sm-149 concentration will be set to zero
- fixed : node-wise Sm-149 concentration will stay the value it is before initiating the calculation
- equilibrium : node-wise Sm-149 concentration will be set to the equilibrium value calculated to match the current node power level. The value will depend on the used group constant model.
- plus_promethium: node-wise Sm-149 concentration will be set to the equilibrium value of Sm-149 plus equilibrium concentration of Pm-149 (as if all Pm-149 has decayed to Sm-149) The value will depend on the used group constant model. (Not supported)
- <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