Revision as of 15:58, 8 June 2020

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.

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 , comma , 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 the include 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>

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)

Neutronics

Set neutronics solution transport type. Exactly one global neutronics card has to be present in the input.

global neutronics <neutronics>

diffusion : solve diffusion equation
sp3 : solve sp3 equation (not supported yet)

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