Ants input manual
The input syntax of Ants is currently completely card based without limit symbols.
This input manual is very much incomplete and may contain erroneous information.
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.4.36 axial_dimensions
- 2.4.37 radial_dimensions
- 2.4.38 division_x
- 2.4.39 division_y
- 2.4.40 division_z
- 2.4.41 division_hex
- 2.5 fuel
- 2.6 controlrod
- 2.7 iteration
- 2.7.1 conv_crit_keff
- 2.7.2 conv_crit_boron
- 2.7.3 conv_crit_fsrc
- 2.7.4 conv_crit_fsrc_l2
- 2.7.5 conv_crit_flux
- 2.7.6 conv_crit_xenon
- 2.7.7 conv_crit_samarium
- 2.7.8 conv_crit_partial_current
- 2.7.9 num_inner
- 2.7.10 num_cgr
- 2.7.11 max_outer
- 2.7.12 use_cgr
- 2.7.13 use_cmr
- 2.7.14 use_relaxation
- 2.7.15 use_color
- 2.7.16 use_discontinuity_factor
- 2.7.17 relaxation_factor
- 2.7.18 use_ppr
- 2.7.19 xenon_state
- 2.7.20 samarium_state
- 2.7.21 power
- 2.7.22 flux
- 2.7.23 normalization_type
- 2.7.24 keff
- 2.7.25 boron
- 2.7.26 control_variable
- 2.7.27 use_boron_relaxation
- 2.7.28 boron_relaxation_factor
- 2.8 library
- 2.9 output
- 2.10 start
- 2.11 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*/
. - Characters beginning and ending with
"
are treated as one token. This is useful for example in input file paths or titles. - All tokens are separated with either space
,
or tabular characters. - Consecutive input may be repeated using
*
. The token before*
must be a positive integer, which is the number of repeats. - The input is case insensitive.
- The main block keywords (below) are reserved.
- Keyword
include
is reserved. It triggers the reading of an additional input file in this position. The input file path is given after theinclude
keyword.
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
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.
Sub-blocks:
-
geometry
-
neutronics
Geometry
Set neutronics solution geometry type. Exactly one global geometry card has to be present in the input.
- global geometry <geometry>
- <geometry>
- square : use rectangular geometry (for example BWR, PWR)
- hexagonal : use hexagonal geometry (for example VVER)
- triangular: use triangular geometry with hexagonal fuel assemblies (for example VVER)
- <geometry>
Neutronics
Set neutronics solution transport type. Exactly one global neutronics card has to be present in the input.
- global neutronics <neutronics>
- <neutronics>
- diffusion : solve diffusion equation
- sp3 : solve sp3 equation (not supported yet)
- <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
-
axial_dimensions
-
radial_dimensions
-
division_x
-
division_y
-
division_z
-
division_hex
width_x
Set node size in x direction for all super nodes (unit cm).
- core width_x <width_x>
- <width_x> : x direction size of all super nodes
width_y
Set node size in y direction for all super nodes (unit cm). Not used for hexagonal or triangular geometries.
- core width_y <width_y>
- <width_y> : y direction size of all super nodes
width_xy
Set node size in both x and y directions for all super nodes (unit cm).
- core width_xy <width_xy>
- <width_xy> : x and y direction sizes of all super nodes
width_x_grid
Set column-wise node sizes in the x direction for all super nodes (unit cm). core columns card has to be read before this card is given.
- core width_x_grid <width_x_grid>
- <width_x_grid> : column-wise x direction sizes of all super nodes (number of input: core columns). All values have to be the same value for hexagonal or triangular geometries.
width_y_grid
Set row-wise node sizes in the y direction for all nodes (unit cm). core rows card has to be read before this card is given. Not used for hexagonal or triangular geometries.
- core width_y_grid <width_y_grid>
- <width_y_grid> : row-wise y direction sizes of all super nodes (number of input: core rows)
axial_nodes
Set number of axial super node layers in the z direction for the core. This card determines the number of axial layers in rest of the input.
- core axial_nodes <axial_nodes>
- <axial_nodes> : number of super node axial layers in the z direction in the core
axial_heights
Set axial layer wise super node sizes in the z direction for all super nodes (unit cm). core axial_nodes card has to be read before this card is given.
- core axial_heights <axial_heights>
- <axial_heights> : axial layer wise z direction sizes of all super nodes (number of input: core axial_nodes)
rows
Set number of rows in the x direction for the core. This card determines the number of rows in rest of the input.
- core rows <rows>
- <rows> : number of rows in the x direction in the core
columns
Set number of columns in the y direction for the core. This card determines the number of columns in rest of the input.
- core columns <columns>
- <columns> : number of columns in the y direction in the core
nominal_power
Set the core nominal power (unit W). Currently not used for anything.
- core nominal_power <nominal_power>
- <nominal_power> : core nominal power
radial_boundary_coeff
Set the boundary albedo for all radial directions for all nodes on the radial boundary of the core.
- core radial_boundary_coeff <radial_boundary_coeff>
- <radial_boundary_coeff> : boundary albedo for all radial directions for all nodes on the radial boundary of the core
axial_boundary_coeff
Set the boundary albedo for both axial direction for all nodes on the axial boundary of the core.
- core axial_boundary_coeff <axial_boundary_coeff>
- <axial_boundary_coeff> : boundary albedo for both axial directions for all nodes on the axial boundaries of the core
radial_boundary_coeff_east
Set the boundary albedo for east radial direction for all nodes on the east boundary of the core.
- core radial_boundary_coeff_east <radial_boundary_coeff_east>
- <radial_boundary_coeff_east> : boundary albedo for east radial direction for all nodes on the east boundary of the core
radial_boundary_coeff_north
Set the boundary albedo for north radial direction for all nodes on the north boundary of the core. Not used for hexagonal or triangular geometries.
- core radial_boundary_coeff_north <radial_boundary_coeff_north>
- <radial_boundary_coeff_north> : boundary albedo for north radial direction for all nodes on the east boundary of the core
radial_boundary_coeff_west
Set the boundary albedo for west radial direction for all nodes on the west boundary of the core.
- core radial_boundary_coeff_west <radial_boundary_coeff_west>
- <radial_boundary_coeff_west> : boundary albedo for west radial direction for all nodes on the east boundary of the core
radial_boundary_coeff_south
Set the boundary albedo for south radial direction for all nodes on the south boundary of the core. Not used for hexagonal or triangular geometries.
- core radial_boundary_coeff_south <radial_boundary_coeff_south>
- <radial_boundary_coeff_south> : boundary albedo for south radial direction for all nodes on the east boundary of the core
axial_boundary_coeff_above
Set the boundary albedo for upwards axial direction for all nodes on the upper axial boundary of the core.
- core axial_boundary_coeff_above <axial_boundary_coeff_above>
- <axial_boundary_coeff_above> : boundary albedo for upwards axial direction for all nodes on the upper axial boundary of the core
axial_boundary_coeff_below
Set the boundary albedo for downwards axial direction for all nodes on the bottom axial boundary of the core.
- core axial_boundary_coeff_below <axial_boundary_coeff_below>
- <axial_boundary_coeff_below> : boundary albedo for downwards axial direction for all nodes on the bottom axial boundary of the core
radial_boundary_num_curr
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_in_curr_east
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_in_curr_north
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_in_curr_west
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_in_curr_south
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_in_curr_northeast
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_in_curr_northwest
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_in_curr_southwest
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_in_curr_southeast
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_net_curr_east
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_net_curr_north
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_net_curr_west
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_net_curr_south
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_net_curr_northeast
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_net_curr_northwest
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_net_curr_southwest
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
radial_boundary_net_curr_southeast
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
axial_dimensions
Currently only used with reflector calculations. In future, these might support also some kind of fuel reloading scheme. This card is currently not documented here.
radial_dimensions
Currently only used with reflector calculations. In future, these might support also some kind of fuel reloading scheme. This card is currently not documented here.
division_x
Divide all input nodes (super nodes) into multiple calculation nodes (nodes) in x direction. Not used for hexagonal or triangular geometries.
- core division_x <division_x>
- <division_x> : number of nodes produced in x direction from each input node. The value has to be divisible with factor 2.
division_y
Divide all input nodes (super nodes) into multiple calculation nodes (nodes) in y direction. Not used for hexagonal or triangular geometries.
- core division_y <division_y>
- <division_y> : number of nodes produced in y direction from each input node. The value has to be divisible with factor 2.
division_z
Divide all input nodes (super nodes) into multiple calculation nodes (nodes) in z direction.
- core division_z <division_z>
- <division_z> : number of nodes produced in z direction from each input node.
division_hex
Divide all input nodes (super nodes) into multiple calculation nodes (nodes) in radial plane. Not used for rectangular or hexagonal geometries.
- core division_hex <division_hex>
- <division_hex> : number of nodes produced in radial plane from each input node.
fuel
controlrod
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_cmr
use_relaxation
use_color
use_discontinuity_factor
relaxation_factor
use_ppr
use_mdep
xenon_state
samarium_state
power
flux
nufission_rate
flux_fuel
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 (default 1E-7)
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 (default 1E-2)
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 (default 1E-5)
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 (default 1.0)
conv_crit_flux
- iteration conv_crit_flux <conv_crit_flux>
- <conv_crit_flux> : convergence criterion for maximum of the absolute value of node and group wise relative flux change between consecutive outer iterations (default 1.0)
conv_crit_xenon
- iteration conv_crit_xenon <conv_crit_xenon>
- <conv_crit_xenon> : convergence criterion for maximum of the absolute value of node wise relative Xe-135 density change between consecutive outer iterations (default 1.0)
conv_crit_samarium
- iteration conv_crit_samarium <conv_crit_samarium>
- <conv_crit_samarium> : convergence criterion for maximum of the absolute value of node-wise relative Sm-149 density change between consecutive outer iterations (default 1.0)
conv_crit_partial_current
- iteration conv_crit_partial_current <conv_crit_partial_current>
- <conv_crit_partial_current> : convergence criterion for maximum of the absolute value of node, group, and moment wise relative outgoing physical partial current relative change between consecutive outer iterations (default 1.0)
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 (default 50)
num_cgr
Set the number of coarse group rebalance (CGR) or coarse mesh rebalance (CMR) iterations per outer iteration. CGR/CMR is not used if boron is used as iteration control_variable.
- iteration num_cgr <num_cgr/num_cmr>
- <num_cgr/num_cmr> : number of coarse group rebalance (CGR) or coarse mesh rebalance (CMR) per outer iteration (default 4)
max_outer
Set the maximum number of outer iterations per calculation step. Currently not used for anything.
- iteration max_outer <max_outer>
- <max_outer> : maximum number of outer iterations per calculation step (default huge(0))
use_cgr
Either use or do not 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 (default). Disables use of CMR.
- everything else : coarse group rebalance (CGR) iteration is not used
- <flag>
use_cmr
Either use or do not use coarse mesh rebalance (CMR) iteration during the outer iterations or calculate current effective multiplication factor from current node wise values. CMR is not used if boron is used as iteration control_variable.
- iteration use_cmr <flag>
- <flag>
- 1/y/yes/on/true : coarse mesh rebalance (CMR) iteration is used. Disables use of CGR.
- everything else : coarse mesh rebalance (CMR) iteration is not used (default)
- <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 (default)
- <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 (default)
- everything else : color iteration is not used
- <flag>
use_discontinuity_factor
Either use discontinuity factors in the neutronics solution or not.
- iteration use_discontinuity_factor <flag>
- <flag>
- 1/y/yes/on/true : discontinuity factors are used if given in group constant input (default)
- everything else : discontinuity factors are not used
- <flag>
relaxation_factor
Set the partial current relaxation factor during inner iterations.
- iteration relaxation_factor <relaxation_factor>
- <relaxation_factor> : partial current relaxation factor during inner iterations. The new partial currents are multiplied with this value and added to the old partial currents with 1.0 substracted with this value (default 1.0, i.e. no relaxation even if iteration use_relaxation would be on)
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>
power
flux
normalization_type
Set the variable for normalization to be used for iteration use_normalization or iteration use_initial_normalization.
- iteration normalization_type <variable>
- <variable>
- none : do not normalize neutronics solution
- power : normalize the neutronics solution to total produced neutronics power. The value is given by iteration power (default)
- flux : normalize the neutronics solution to total flux summed over all energy group and nodes. The value is given by iteration flux
- nufission_rate : normalize the neutronics solution to total fission neutron production summed over all groups and nodes. The value is given by iteration nufission_rate
- flux_fuel : normalize the neutronics solution to total flux summed over all groups and only fuel nodes. The value is given by iteration flux_fuel
- <variable>
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)
- <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