Revision as of 08:32, 29 April 2019 (view source) Antti Rintala (talk | contribs) (→‎Core) ← Older edit		Revision as of 08:41, 29 April 2019 (view source) Antti Rintala (talk | contribs) (→‎Core) Newer edit →
Line 138:		Line 138:
	=== axial_nodes ===		=== axial_nodes ===
		+	Set number of axial 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 axial layers in the z direction in the core
		+
	=== axial_heights ===		=== axial_heights ===
		+	Set axial layer wise node sizes in the z direction for all 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 nodes (number of input: core axial_nodes)
		+
	=== rows ===		=== 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 ===		=== 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 ===		=== nominal_power ===
	=== radial_boundary_coeff ===		=== radial_boundary_coeff ===
		+	Set the boundary albedo for all radial directions for all nodes on the 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 boundary of the core
		+
	=== axial_boundary_coeff ===		=== axial_boundary_coeff ===
	=== radial_boundary_coeff_east ===		=== 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 ===		=== radial_boundary_coeff_north ===
		+	Set the boundary albedo for north radial direction for all nodes on the north boundary of the core.
		+
		+	: 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 ===		=== 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 ===		=== radial_boundary_coeff_south ===
		+	Set the boundary albedo for south radial direction for all nodes on the south boundary of the core.
		+
		+	: 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 ===		=== axial_boundary_coeff_above ===
	=== axial_boundary_coeff_below ===		=== axial_boundary_coeff_below ===

---

Revision as of 08:41, 29 April 2019

The input syntax of Ants is currently completely card based without limit symbols.

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.

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
• perturbation

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)

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)

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 nodes (unit cm).

core width_x <width_x>

<width_x> : x direction size of all nodes

width_y

Set node size in y direction for all nodes (unit cm).

core width_y <width_y>

<width_y> : y direction size of all nodes

width_xy

Set node size in both x and y directions for all nodes (unit cm).

core width_xy <width_xy>

<width_xy> : x and y direction sizes of all nodes

width_x_grid

Set column-wise node sizes in the x direction for all 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 nodes (number of input: core columns)

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.

core width_y_grid <width_y_grid>

<width_y_grid> : row-wise y direction sizes of all nodes (number of input: core rows)

axial_nodes

Set number of axial 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 axial layers in the z direction in the core

axial_heights

Set axial layer wise node sizes in the z direction for all 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 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

radial_boundary_coeff

Set the boundary albedo for all radial directions for all nodes on the 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 boundary of the core

axial_boundary_coeff

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.

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.

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

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 node- and group-wise relative flux change between consecutive outer iterations.

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 concentration change between consecutive outer iterations.

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 concentration change between consecutive outer iterations.

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

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

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

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

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)

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)

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)

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

end