Difference between revisions of "Ants input manual"

From Kraken Wiki
Jump to: navigation, search
(→‎normalization_type)
Line 3: Line 3:
 
This input manual is very much incomplete and may contain erroneous information.
 
This input manual is very much incomplete and may contain erroneous information.
  
−
== Input syntax ==
+
== Main input file ==
 +
 
 +
==== 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.
 
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 <code>!</code> and <code>//</code>, and block comments beginning with <code>/*</code> and ending with <code>*/</code>.
 
* Ants input supports rest of line comment symbols <code>!</code> and <code>//</code>, and block comments beginning with <code>/*</code> and ending with <code>*/</code>.
Line 13: Line 15:
 
* Keyword <code>include</code> is reserved. It triggers the reading of an additional input file in this position. The input file path is given after the <code>include</code> keyword.
 
* Keyword <code>include</code> is reserved. It triggers the reading of an additional input file in this position. The input file path is given after the <code>include</code> keyword.
  
−
= Main blocks =
+
=== 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
 
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
 
*<code>title</code>
 
*<code>title</code>
Line 27: Line 29:
 
*<code>end</code>
 
*<code>end</code>
  
−
== Title ==
+
=== Title ===
 
Set a title for the calculation.
 
Set a title for the calculation.
  
Line 33: Line 35:
 
:: <title> : at most one token for the title. If omitted, an empty title will be set.
 
:: <title> : at most one token for the title. If omitted, an empty title will be set.
  
−
== Echo ==
+
=== Echo ===
 
Echo something to standard output.
 
Echo something to standard output.
  
Line 39: Line 41:
 
:: <echo> : at most one token to be echoed. If omitted, an empty echo will be performed.
 
:: <echo> : at most one token to be echoed. If omitted, an empty echo will be performed.
  
−
== Global ==
+
=== Global ===
 
Set global calculation parameters. These cards will be processed before any other cards.
 
Set global calculation parameters. These cards will be processed before any other cards.
  
Line 46: Line 48:
 
* <code>neutronics</code>
 
* <code>neutronics</code>
  
−
=== Geometry ===
+
==== Geometry ====
 
Set neutronics solution geometry type. Exactly one global geometry card has to be present in the input.
 
Set neutronics solution geometry type. Exactly one global geometry card has to be present in the input.
  
Line 55: Line 57:
 
::* triangular: use triangular geometry with hexagonal fuel assemblies (for example VVER)
 
::* triangular: use triangular geometry with hexagonal fuel assemblies (for example VVER)
  
−
=== Neutronics ===
+
==== Neutronics ====
 
Set neutronics solution transport type. Exactly one global neutronics card has to be present in the input.
 
Set neutronics solution transport type. Exactly one global neutronics card has to be present in the input.
  
Line 63: Line 65:
 
::* sp3 : solve sp3 equation (not supported yet)
 
::* sp3 : solve sp3 equation (not supported yet)
  
−
== Core ==
+
=== Core ===
 
Set core parameters.
 
Set core parameters.
  
Line 109: Line 111:
 
* <code>division_hex</code>
 
* <code>division_hex</code>
  
−
=== width_x ===
+
==== width_x ====
 
Set node size in x direction for all super nodes (unit cm).
 
Set node size in x direction for all super nodes (unit cm).
  
Line 115: Line 117:
 
:: <width_x> : x direction size of all super nodes
 
:: <width_x> : x direction size of all super nodes
  
−
=== width_y ===
+
==== width_y ====
 
Set node size in y direction for all super nodes (unit cm). Not used for hexagonal or triangular geometries.
 
Set node size in y direction for all super nodes (unit cm). Not used for hexagonal or triangular geometries.
  
Line 121: Line 123:
 
:: <width_y> : y direction size of all super nodes
 
:: <width_y> : y direction size of all super nodes
  
−
=== width_xy ===
+
==== width_xy ====
 
Set node size in both x and y directions for all super nodes (unit cm).
 
Set node size in both x and y directions for all super nodes (unit cm).
  
Line 127: Line 129:
 
:: <width_xy> : x and y direction sizes of all super nodes
 
:: <width_xy> : x and y direction sizes of all super nodes
  
−
=== width_x_grid ===
+
==== 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.
 
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.
  
Line 133: Line 135:
 
:: <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_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 ===
+
==== 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.
 
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.
  
Line 139: Line 141:
 
:: <width_y_grid> : row-wise y direction sizes of all super nodes (number of input: core rows)
 
:: <width_y_grid> : row-wise y direction sizes of all super nodes (number of input: core rows)
  
−
=== axial_nodes ===
+
==== 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.
 
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.
  
Line 145: Line 147:
 
:: <axial_nodes> : number of super node axial layers in the z direction in the core
 
:: <axial_nodes> : number of super node axial layers in the z direction in the core
  
−
=== axial_heights ===
+
==== 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.
 
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.
  
Line 151: Line 153:
 
:: <axial_heights> : axial layer wise z direction sizes of all super nodes (number of input: core axial_nodes)
 
:: <axial_heights> : axial layer wise z direction sizes of all super 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.
 
Set number of rows in the x direction for the core. This card determines the number of rows in rest of the input.
  
Line 157: Line 159:
 
:: <rows> : number of rows in the x direction in the core
 
:: <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.
 
Set number of columns in the y direction for the core. This card determines the number of columns in rest of the input.
  
Line 163: Line 165:
 
:: <columns> : number of columns in the y direction in the core
 
:: <columns> : number of columns in the y direction in the core
  
−
=== nominal_power ===
+
==== nominal_power ====
 
Set the core nominal power (unit W). Currently not used for anything.
 
Set the core nominal power (unit W). Currently not used for anything.
  
Line 169: Line 171:
 
:: <nominal_power> : core nominal power
 
:: <nominal_power> : core nominal power
  
−
=== radial_boundary_coeff ===
+
==== radial_boundary_coeff ====
 
Set the boundary albedo for all radial directions for all nodes on the radial boundary of the core.
 
Set the boundary albedo for all radial directions for all nodes on the radial boundary of the core.
  
Line 175: Line 177:
 
:: <radial_boundary_coeff> : boundary albedo for all radial directions for all nodes on the radial boundary of the core (default 0.0)
 
:: <radial_boundary_coeff> : boundary albedo for all radial directions for all nodes on the radial boundary of the core (default 0.0)
  
−
=== axial_boundary_coeff ===
+
==== axial_boundary_coeff ====
 
Set the boundary albedo for both axial direction for all nodes on the axial boundary of the core.
 
Set the boundary albedo for both axial direction for all nodes on the axial boundary of the core.
  
Line 181: Line 183:
 
:: <axial_boundary_coeff> : boundary albedo for both axial directions for all nodes on the axial boundaries of the core (default 0.0)
 
:: <axial_boundary_coeff> : boundary albedo for both axial directions for all nodes on the axial boundaries of the core (default 0.0)
  
−
=== 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.
 
Set the boundary albedo for east radial direction for all nodes on the east boundary of the core.
  
Line 187: Line 189:
 
:: <radial_boundary_coeff_east> : boundary albedo for east radial direction for all nodes on the east boundary of the core
 
:: <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. Not used for hexagonal or triangular geometries.
 
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.
  
Line 193: Line 195:
 
:: <radial_boundary_coeff_north> : boundary albedo for north radial direction for all nodes on the north boundary of the core
 
:: <radial_boundary_coeff_north> : boundary albedo for north radial direction for all nodes on the north 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.
 
Set the boundary albedo for west radial direction for all nodes on the west boundary of the core.
  
Line 199: Line 201:
 
:: <radial_boundary_coeff_west> : boundary albedo for west radial direction for all nodes on the west boundary of the core
 
:: <radial_boundary_coeff_west> : boundary albedo for west radial direction for all nodes on the west 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. Not used for hexagonal or triangular geometries.
 
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.
  
Line 205: Line 207:
 
:: <radial_boundary_coeff_south> : boundary albedo for south radial direction for all nodes on the south boundary of the core
 
:: <radial_boundary_coeff_south> : boundary albedo for south radial direction for all nodes on the south boundary of the core
  
−
=== radial_boundary_coeff_northeast ===
+
==== radial_boundary_coeff_northeast ====
 
Set the boundary albedo for northeast radial direction for all nodes on the northeast boundary of the core. Not used for rectangular geometries.
 
Set the boundary albedo for northeast radial direction for all nodes on the northeast boundary of the core. Not used for rectangular geometries.
  
Line 211: Line 213:
 
:: <radial_boundary_coeff_northeast> : boundary albedo for northeast radial direction for all nodes on the northeast boundary of the core
 
:: <radial_boundary_coeff_northeast> : boundary albedo for northeast radial direction for all nodes on the northeast boundary of the core
  
−
=== radial_boundary_coeff_northwest ===
+
==== radial_boundary_coeff_northwest ====
 
Set the boundary albedo for northwest radial direction for all nodes on the northwest boundary of the core. Not used for rectangular geometries.
 
Set the boundary albedo for northwest radial direction for all nodes on the northwest boundary of the core. Not used for rectangular geometries.
  
Line 217: Line 219:
 
:: <radial_boundary_coeff_northwest> : boundary albedo for northwest radial direction for all nodes on the northwest boundary of the core
 
:: <radial_boundary_coeff_northwest> : boundary albedo for northwest radial direction for all nodes on the northwest boundary of the core
  
−
=== radial_boundary_coeff_southwest ===
+
==== radial_boundary_coeff_southwest ====
 
Set the boundary albedo for southwest radial direction for all nodes on the southwest boundary of the core. Not used for rectangular geometries.
 
Set the boundary albedo for southwest radial direction for all nodes on the southwest boundary of the core. Not used for rectangular geometries.
  
Line 223: Line 225:
 
:: <radial_boundary_coeff_southwest> : boundary albedo for southwest radial direction for all nodes on the southwest boundary of the core
 
:: <radial_boundary_coeff_southwest> : boundary albedo for southwest radial direction for all nodes on the southwest boundary of the core
  
−
=== radial_boundary_coeff_southeast ===
+
==== radial_boundary_coeff_southeast ====
 
Set the boundary albedo for southeast radial direction for all nodes on the southeast boundary of the core. Not used for rectangular geometries.
 
Set the boundary albedo for southeast radial direction for all nodes on the southeast boundary of the core. Not used for rectangular geometries.
  
Line 229: Line 231:
 
:: <radial_boundary_coeff_southeast> : boundary albedo for southeast radial direction for all nodes on the southeast boundary of the core
 
:: <radial_boundary_coeff_southeast> : boundary albedo for southeast radial direction for all nodes on the southeast boundary of the core
  
−
=== axial_boundary_coeff_above ===
+
==== axial_boundary_coeff_above ====
 
Set the boundary albedo for upwards axial direction for all nodes on the upper axial boundary of the core.
 
Set the boundary albedo for upwards axial direction for all nodes on the upper axial boundary of the core.
  
Line 235: Line 237:
 
:: <axial_boundary_coeff_above> : boundary albedo for upwards axial direction for all nodes on the upper axial boundary of the core
 
:: <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 ===
+
==== axial_boundary_coeff_below ====
 
Set the boundary albedo for downwards axial direction for all nodes on the bottom axial boundary of the core.
 
Set the boundary albedo for downwards axial direction for all nodes on the bottom axial boundary of the core.
  
Line 241: Line 243:
 
:: <axial_boundary_coeff_below> : boundary albedo for downwards axial direction for all nodes on the bottom axial boundary of the core
 
:: <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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== 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.
 
Only intended for reflector calculations and are to be replaced with Cerberus/KrakenTools methods. These cards are currently not documented here.
  
−
=== axial_dimensions ===
+
==== 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.
 
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 ===
+
==== 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.
 
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 ===
+
==== division_x ====
 
Divide all input nodes (super nodes) into multiple calculation nodes (nodes) in x direction. Not used for hexagonal or triangular geometries.
 
Divide all input nodes (super nodes) into multiple calculation nodes (nodes) in x direction. Not used for hexagonal or triangular geometries.
  
Line 304: Line 306:
 
:: <division_x> : number of nodes produced in x direction from each input node. The value has to be divisible with factor 2.
 
:: <division_x> : number of nodes produced in x direction from each input node. The value has to be divisible with factor 2.
  
−
=== division_y ===
+
==== division_y ====
 
Divide all input nodes (super nodes) into multiple calculation nodes (nodes) in y direction. Not used for hexagonal or triangular geometries.
 
Divide all input nodes (super nodes) into multiple calculation nodes (nodes) in y direction. Not used for hexagonal or triangular geometries.
  
Line 310: Line 312:
 
:: <division_y> : number of nodes produced in y direction from each input node. The value has to be divisible with factor 2.
 
:: <division_y> : number of nodes produced in y direction from each input node. The value has to be divisible with factor 2.
  
−
=== division_z ===
+
==== division_z ====
 
Divide all input nodes (super nodes) into multiple calculation nodes (nodes) in z direction.
 
Divide all input nodes (super nodes) into multiple calculation nodes (nodes) in z direction.
  
Line 316: Line 318:
 
:: <division_z> : number of nodes produced in z direction from each input node.
 
:: <division_z> : number of nodes produced in z direction from each input node.
  
−
=== division_hex ===
+
==== division_hex ====
 
Divide all input nodes (super nodes) into multiple calculation nodes (nodes) in radial plane. Not used for rectangular or hexagonal geometries.
 
Divide all input nodes (super nodes) into multiple calculation nodes (nodes) in radial plane. Not used for rectangular or hexagonal geometries.
  
Line 322: Line 324:
 
:: <division_hex> : number of nodes produced in radial plane from each input node.
 
:: <division_hex> : number of nodes produced in radial plane from each input node.
  
−
== fuel ==
+
=== fuel ===
  
 
Describe fuel and reflector material distributions and state variable distributions in geometry.
 
Describe fuel and reflector material distributions and state variable distributions in geometry.
Line 344: Line 346:
 
* <code>zdf_below</code>
 
* <code>zdf_below</code>
  
−
=== type ===
+
==== type ====
  
 
Add fuel or reflector element type.
 
Add fuel or reflector element type.
Line 354: Line 356:
 
:: <subs> : fuel type identifiers for constructing a possibly radially asymmetrical fuel assembly. Not used for hexagonal geometry. The input for rectangular geometry is the fuel type identifiers for NW, NE, SW, SE quarters of the element and the input for triangular geometry is the fuel type identifiers for NW, NE, W, E, SW, SE sixths of the element. See also Ants/doc/square_df_rotation.txt. Either subs or nodes has to be specified.
 
:: <subs> : fuel type identifiers for constructing a possibly radially asymmetrical fuel assembly. Not used for hexagonal geometry. The input for rectangular geometry is the fuel type identifiers for NW, NE, SW, SE quarters of the element and the input for triangular geometry is the fuel type identifiers for NW, NE, W, E, SW, SE sixths of the element. See also Ants/doc/square_df_rotation.txt. Either subs or nodes has to be specified.
  
−
=== load ===
+
==== load ====
  
 
Specify fuel load map.
 
Specify fuel load map.
Line 361: Line 363:
 
:: <identifiers> : a list of fuel or reflector element identifiers (number of input: core rows*core columns). An identifier "0" is used to represent an empty location. The map runs fastest in the x direction (columns) and then y direction (rows) such that the first row is the northernmost row and the last row is the southernmost row. For hexagonal maps (used in hexagonal and triangular geometry) the row wrap is interpreted such that the first entry on each row is located in the southeast direction of the first hexagon entry on the previous row.
 
:: <identifiers> : a list of fuel or reflector element identifiers (number of input: core rows*core columns). An identifier "0" is used to represent an empty location. The map runs fastest in the x direction (columns) and then y direction (rows) such that the first row is the northernmost row and the last row is the southernmost row. For hexagonal maps (used in hexagonal and triangular geometry) the row wrap is interpreted such that the first entry on each row is located in the southeast direction of the first hexagon entry on the previous row.
  
−
=== rotation ===
+
==== rotation ====
  
 
Specify fuel and control element radial rotation map.
 
Specify fuel and control element radial rotation map.
Line 385: Line 387:
 
* See also Ants/doc/square_df_rotation.txt
 
* See also Ants/doc/square_df_rotation.txt
  
−
== controlrod ==
+
=== controlrod ===
  
 
Describe control element distributions in geometry.
 
Describe control element distributions in geometry.
Line 395: Line 397:
 
* <code>individual</code>
 
* <code>individual</code>
  
−
=== type ===
+
==== type ====
  
 
Add control element type.
 
Add control element type.
Line 407: Line 409:
 
:: <subs>        : control elemenent type identifiers for constructing a possibly radially asymmetrical control element. Not used for hexagonal geometry. The input for rectangular geometry is the controlrod element type identifiers for NW, NE, SW, SE quarters of the element and the input for triangular geometry is the controlrod element type identifiers for NW, NE, W, E, SW, SE sixths of the element. See also Ants/doc/square_df_rotation.txt. Either subs or nodes has to be specified.
 
:: <subs>        : control elemenent type identifiers for constructing a possibly radially asymmetrical control element. Not used for hexagonal geometry. The input for rectangular geometry is the controlrod element type identifiers for NW, NE, SW, SE quarters of the element and the input for triangular geometry is the controlrod element type identifiers for NW, NE, W, E, SW, SE sixths of the element. See also Ants/doc/square_df_rotation.txt. Either subs or nodes has to be specified.
  
−
=== position ===
+
==== position ====
  
 
Specify control element position map.
 
Specify control element position map.
Line 414: Line 416:
 
:: <identifiers> : a list of control element identifiers (number of input: core rows*core columns). An identifier "0" is used to represent an empty location. The map runs fastest in the x direction (columns) and then y direction (rows) such that the first row is the northernmost row and the last row is the southernmost row. For hexagonal maps (used in hexagonal and triangular geometry) the row wrap is interpreted such that the first entry on each row is located in the southeast direction of the first hexagon entry on the previous row.
 
:: <identifiers> : a list of control element identifiers (number of input: core rows*core columns). An identifier "0" is used to represent an empty location. The map runs fastest in the x direction (columns) and then y direction (rows) such that the first row is the northernmost row and the last row is the southernmost row. For hexagonal maps (used in hexagonal and triangular geometry) the row wrap is interpreted such that the first entry on each row is located in the southeast direction of the first hexagon entry on the previous row.
  
−
=== group ===
+
==== group ====
  
 
Specify control element group related variables
 
Specify control element group related variables
Line 427: Line 429:
 
:: <height> : height of the control element group
 
:: <height> : height of the control element group
  
−
== iteration ==
+
=== iteration ===
 
Set iteration parameters.
 
Set iteration parameters.
  
Line 463: Line 465:
 
*<code>boron_relaxation_factor</code>
 
*<code>boron_relaxation_factor</code>
  
−
=== conv_crit_keff ===
+
==== conv_crit_keff ====
 
: iteration conv_crit_keff  <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_keff> : convergence criterion for absolute value change of effective multiplication factor between consecutive outer iterations (default 1E-7)
  
−
=== conv_crit_boron ===
+
==== conv_crit_boron ====
 
: iteration conv_crit_boron <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_boron > : convergence criterion for absolute value change of boron concentration (ppm) between consecutive outer iterations (default 1E-2)
  
−
=== conv_crit_fsrc ===
+
==== conv_crit_fsrc ====
 
: iteration conv_crit_fsrc <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 > : 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 ===
+
==== conv_crit_fsrc_l2 ====
 
: iteration conv_crit_fsrc_l2 <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_fsrc_l2 > : convergence criterion for change of L2 norm of node-integrated fission sources between consecutive outer iterations (default 1.0)
  
−
=== conv_crit_flux ===
+
==== conv_crit_flux ====
 
: iteration conv_crit_flux <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_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 ===
+
==== conv_crit_xenon ====
 
: iteration conv_crit_xenon <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_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 ===
+
==== conv_crit_samarium ====
 
: iteration conv_crit_samarium <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_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 ===
+
==== conv_crit_partial_current ====
 
: iteration conv_crit_partial_current <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)
 
:: <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 ===
+
==== num_inner ====
 
Set the number of inner iterations per outer iteration.
 
Set the number of inner iterations per outer iteration.
  
Line 501: Line 503:
 
:: <num_inner> : number of inner iterations per outer iteration (default 50)
 
:: <num_inner> : number of inner iterations per outer iteration (default 50)
  
−
=== num_cgr ===
+
==== 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 [[#control_variable|iteration control_variable]].
 
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 [[#control_variable|iteration control_variable]].
  
Line 507: Line 509:
 
:: <num_cgr/num_cmr> : number of coarse group rebalance (CGR) or coarse mesh rebalance (CMR) per outer iteration (default 4)
 
:: <num_cgr/num_cmr> : number of coarse group rebalance (CGR) or coarse mesh rebalance (CMR) per outer iteration (default 4)
  
−
=== max_outer ===
+
==== max_outer ====
 
Set the maximum number of outer iterations per calculation step. Currently not used for anything.
 
Set the maximum number of outer iterations per calculation step. Currently not used for anything.
  
Line 513: Line 515:
 
:: <max_outer> : maximum number of outer iterations per calculation step (default huge(0))
 
:: <max_outer> : maximum number of outer iterations per calculation step (default huge(0))
  
−
=== use_cgr ===
+
==== 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 [[#control_variable|iteration control_variable]].
 
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 [[#control_variable|iteration control_variable]].
  
Line 521: Line 523:
 
::* everything else : coarse group rebalance (CGR) iteration is not used
 
::* everything else : coarse group rebalance (CGR) iteration is not used
  
−
=== use_cmr ===
+
==== 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 [[#control_variable|iteration control_variable]].
 
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 [[#control_variable|iteration control_variable]].
  
Line 529: Line 531:
 
::* everything else : coarse mesh rebalance (CMR) iteration is not used (default)
 
::* everything else : coarse mesh rebalance (CMR) iteration is not used (default)
  
−
=== use_relaxation ===
+
==== use_relaxation ====
 
Either use partial current relaxation during inner iterations or not. Relaxation coefficient is given with [[#relaxation_factor|iteration relaxation_factor]].
 
Either use partial current relaxation during inner iterations or not. Relaxation coefficient is given with [[#relaxation_factor|iteration relaxation_factor]].
  
Line 537: Line 539:
 
::* everything else : relaxation is not used (default)
 
::* everything else : relaxation is not used (default)
  
−
=== use_color ===
+
==== 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.
 
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.
  
Line 545: Line 547:
 
::* everything else : color iteration is not used
 
::* everything else : color iteration is not used
  
−
=== use_discontinuity_factor ===
+
==== use_discontinuity_factor ====
 
Either use discontinuity factors in the neutronics solution or not.
 
Either use discontinuity factors in the neutronics solution or not.
  
Line 553: Line 555:
 
::* everything else : discontinuity factors are not used
 
::* everything else : discontinuity factors are not used
  
−
=== relaxation_factor ===
+
==== relaxation_factor ====
 
Set the partial current relaxation factor during inner iterations.
 
Set the partial current relaxation factor during inner iterations.
  
Line 559: Line 561:
 
:: <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 multiplied with (1.0 minus relaxation_factor) (default 1.0, i.e. no relaxation even if [[#use_relaxation|iteration use_relaxation]] would be on)
 
:: <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 multiplied with (1.0 minus relaxation_factor) (default 1.0, i.e. no relaxation even if [[#use_relaxation|iteration use_relaxation]] would be on)
  
−
=== use_ppr ===
+
==== use_ppr ====
−
=== xenon_state ===
+
==== xenon_state ====
 
Set node-wise Xe-135 concentration state for calculation.
 
Set node-wise Xe-135 concentration state for calculation.
  
Line 570: Line 572:
 
::* 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)
 
::* 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 ===
+
==== samarium_state ====
 
Set node-wise Sm-149 concentration state for calculation.
 
Set node-wise Sm-149 concentration state for calculation.
  
Line 580: Line 582:
 
::* 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)
 
::* 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)
  
−
=== power ===
+
==== power ====
−
=== flux ===
+
==== flux ====
−
=== normalization_type ===
+
==== normalization_type ====
  
 
Set the variable to which the neutronics solution is normalized or disable normalization.
 
Set the variable to which the neutronics solution is normalized or disable normalization.
Line 594: Line 596:
 
::* flux_fuel      : normalize the neutronics solution to total flux summed over all groups and only fuel nodes. The value is given by [[#flux_fuel|iteration flux_fuel]]
 
::* flux_fuel      : normalize the neutronics solution to total flux summed over all groups and only fuel nodes. The value is given by [[#flux_fuel|iteration flux_fuel]]
  
−
=== keff ===
+
==== keff ====
 
Set the effective multiplication factor initial value for keff [[#control_variable|iteration control_variable]] or value for other control variables.
 
Set the effective multiplication factor initial value for keff [[#control_variable|iteration control_variable]] or value for other control variables.
  
Line 600: Line 602:
 
:: <keff> effective multiplication factor initial value or value
 
:: <keff> effective multiplication factor initial value or value
  
−
=== boron ===
+
==== boron ====
 
Set the boron concentration (ppm) initial value for boron [[#control_variable|iteration control_variable]] or global concentration value for other control variables.
 
Set the boron concentration (ppm) initial value for boron [[#control_variable|iteration control_variable]] or global concentration value for other control variables.
  
Line 606: Line 608:
 
:: <boron> boron concentration initial value or value
 
:: <boron> boron concentration initial value or value
  
−
=== control_variable ===
+
==== control_variable ====
 
Set the control variable for critical variable iteration.
 
Set the control variable for critical variable iteration.
  
Line 615: Line 617:
 
::* boron: iterate a critical global boron concentration. [[#use_cgr|CGR]] or [[#use_cmr|CMR]] is not used. The method for estimating the critical boron concentration currently depends on the group constant model. See also [[#use_boron_relaxation|iteration use_boron_relaxation]] and [[#boron_relaxation_factor|iteration boron_relaxation_factor]].
 
::* boron: iterate a critical global boron concentration. [[#use_cgr|CGR]] or [[#use_cmr|CMR]] is not used. The method for estimating the critical boron concentration currently depends on the group constant model. See also [[#use_boron_relaxation|iteration use_boron_relaxation]] and [[#boron_relaxation_factor|iteration boron_relaxation_factor]].
  
−
=== use_boron_relaxation ===
+
==== use_boron_relaxation ====
 
Either use relaxation of the critical boron concentration or not.
 
Either use relaxation of the critical boron concentration or not.
  
Line 623: Line 625:
 
::* everything else : critical boron concentration relaxation is not used
 
::* everything else : critical boron concentration relaxation is not used
  
−
=== boron_relaxation_factor ===
+
==== boron_relaxation_factor ====
 
Set the critical boron concentration relaxation factor during outer iterations.
 
Set the critical boron concentration relaxation factor during outer iterations.
  
Line 629: Line 631:
 
:: <relaxation_factor> : critical boron concentration relaxation factor during outer iterations. The new boron concentration is multiplied with this value and added to the old boron concentration multiplied with (1.0 minus relaxation_factor) (default 0.5)
 
:: <relaxation_factor> : critical boron concentration relaxation factor during outer iterations. The new boron concentration is multiplied with this value and added to the old boron concentration multiplied with (1.0 minus relaxation_factor) (default 0.5)
  
−
== library ==
+
=== library ===
 
Set group constant library parameters.
 
Set group constant library parameters.
  
Line 636: Line 638:
 
* <code>path</code>
 
* <code>path</code>
  
−
=== type ===
+
==== type ====
 
Set group constant library type.
 
Set group constant library type.
  
Line 645: Line 647:
 
::* hexbu-3d/mod5-trab3d : HEXBU-3D/MOD5 group constant file format for rectangular geometry (TRAB3D/BWR/PWR)
 
::* hexbu-3d/mod5-trab3d : HEXBU-3D/MOD5 group constant file format for rectangular geometry (TRAB3D/BWR/PWR)
  
−
=== path ===
+
==== path ====
 
Set group constant library input file path
 
Set group constant library input file path
  
Line 651: Line 653:
 
:: <path> : at most one token for the group constant library input file path. The path is (maybe?) relative to current working directory.
 
:: <path> : at most one token for the group constant library input file path. The path is (maybe?) relative to current working directory.
  
−
== output ==
+
=== output ===
−
== start ==
+
=== start ===
 
Start the calculation.
 
Start the calculation.
  
 
: start
 
: start
  
−
== end ==
+
=== end ===
  
 
End the calculation.
 
End the calculation.
  
 
: end
 
: end
 +
 +
== Group constant files ==
 +
=== HEXBU-3D/MOD5 ===
 +
 +
=== Simple ===
  
 
[[Category:Ants]]
 
[[Category:Ants]]
 
[[Category:Input manuals]]
 
[[Category:Input manuals]]

Revision as of 09:04, 10 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.

Contents

Main input file

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>
<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>
<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 (default 0.0)

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 (default 0.0)

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 north 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 west 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 south boundary of the core

radial_boundary_coeff_northeast

Set the boundary albedo for northeast radial direction for all nodes on the northeast boundary of the core. Not used for rectangular geometries.

core radial_boundary_coeff_northeast <radial_boundary_coeff_northeast>
<radial_boundary_coeff_northeast> : boundary albedo for northeast radial direction for all nodes on the northeast boundary of the core

radial_boundary_coeff_northwest

Set the boundary albedo for northwest radial direction for all nodes on the northwest boundary of the core. Not used for rectangular geometries.

core radial_boundary_coeff_northwest <radial_boundary_coeff_northwest>
<radial_boundary_coeff_northwest> : boundary albedo for northwest radial direction for all nodes on the northwest boundary of the core

radial_boundary_coeff_southwest

Set the boundary albedo for southwest radial direction for all nodes on the southwest boundary of the core. Not used for rectangular geometries.

core radial_boundary_coeff_southwest <radial_boundary_coeff_southwest>
<radial_boundary_coeff_southwest> : boundary albedo for southwest radial direction for all nodes on the southwest boundary of the core

radial_boundary_coeff_southeast

Set the boundary albedo for southeast radial direction for all nodes on the southeast boundary of the core. Not used for rectangular geometries.

core radial_boundary_coeff_southeast <radial_boundary_coeff_southeast>
<radial_boundary_coeff_southeast> : boundary albedo for southeast radial direction for all nodes on the southeast 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

Describe fuel and reflector material distributions and state variable distributions in geometry.

Sub-blocks:

  • type
  • assembly
  • load
  • rotation
  • burnup
  • hmod
  • tfu
  • bor
  • dmo
  • dmo_out
  • tmo
  • xen
  • sam
  • zdf_above
  • zdf_below

type

Add fuel or reflector element type.

fuel type <identifier> [description <description> nodes <nodes> subs <subs>]
<identifier> : name of the fuel type to be used for example in fuel load
<description> : description of the fuel type. Currently not used for anything. Optional.
<nodes> : material identifiers for each axial super node of the fuel beginning from the bottom of the core and ending at the top of the core (number of input: core axial_nodes). Includes possible axial reflector nodes. Reflector nodes are specified using "-" character before the material identifier, without a separating space. Either nodes or subs has to be specified.
<subs> : fuel type identifiers for constructing a possibly radially asymmetrical fuel assembly. Not used for hexagonal geometry. The input for rectangular geometry is the fuel type identifiers for NW, NE, SW, SE quarters of the element and the input for triangular geometry is the fuel type identifiers for NW, NE, W, E, SW, SE sixths of the element. See also Ants/doc/square_df_rotation.txt. Either subs or nodes has to be specified.

load

Specify fuel load map.

fuel load <identifiers>
<identifiers> : a list of fuel or reflector element identifiers (number of input: core rows*core columns). An identifier "0" is used to represent an empty location. The map runs fastest in the x direction (columns) and then y direction (rows) such that the first row is the northernmost row and the last row is the southernmost row. For hexagonal maps (used in hexagonal and triangular geometry) the row wrap is interpreted such that the first entry on each row is located in the southeast direction of the first hexagon entry on the previous row.

rotation

Specify fuel and control element radial rotation map.

fuel rotation <rotations>
<rotations> : a list of rotations (number of input: core rows*core columns). An identifier "0" is used to represent an empty location. The map runs fastest in the x direction (columns) and then y direction (rows) such that the first row is the northernmost row and the last row is the southernmost row. For hexagonal maps (used in hexagonal and triangular geometry) the row wrap is interpreted such that the first entry on each row is located in the southeast direction of the first hexagon entry on the previous row.
  • Rectangular geometry:
  • E or 1: East direction of the assembly faces east
  • N or 2: East direction of the assembly faces north
  • W or 3: East direction of the assembly faces west
  • S or 4: East direction of the assembly faces south
  • -E or 5: Assembly is flipped such that north and south are interchanged and then east direction of the assembly faces east
  • -N or 6: Assembly is flipped such that north and south are interchanged and then east direction of the assembly faces north
  • -W or 7: Assembly is flipped such that north and south are interchanged and then east direction of the assembly faces west
  • -S or 8: Assembly is flipped such that north and south are interchanged and then east direction of the assembly faces south
  • Hexagonal and triangular geometry:
  • E or 1: East direction of the assembly faces east
  • NE or 2: East direction of the assembly faces north-east
  • NW or 3: East direction of the assembly faces north-west
  • W or 4: East direction of the assembly faces west
  • SW or 5: East direction of the assembly faces south-west
  • SE or 6: East direction of the assembly faces south-east
  • See also Ants/doc/square_df_rotation.txt

controlrod

Describe control element distributions in geometry.

Sub-blocks:

  • type
  • position
  • group
  • individual

type

Add control element type.

controlrod type <identifier> [description <description> parts <parts> lengths <lengths> nodes <nodes> subs <subs>]
<identifier>  : name of the control element type to be used for example in controlrod position
<description> : description of the control element type. Currently not used for anything. Optional.
<parts>  : number of parts of the control element absorber
<lengths>  : lengths of the parts of the control element absorber (number of input: controlrod type parts, unit cm)
<nodes>  : material identifiers for each axial super node and control element absorber part of the control element beginning from the bottom of the core and ending at the top of the core (number of input: core axial_nodes*controlrod type parts). Includes possible axial reflector nodes. Reflector nodes are specified using "-" character before the material identifier, without a separating space. Fastest running index is the axial layer and the slowest index is the control element type. The input means that for a specific axial layer of the core, the corresponding material identifier is used if the specific control element absorber part is present in the axial node. Either nodes or subs has to be specified.
<subs>  : control elemenent type identifiers for constructing a possibly radially asymmetrical control element. Not used for hexagonal geometry. The input for rectangular geometry is the controlrod element type identifiers for NW, NE, SW, SE quarters of the element and the input for triangular geometry is the controlrod element type identifiers for NW, NE, W, E, SW, SE sixths of the element. See also Ants/doc/square_df_rotation.txt. Either subs or nodes has to be specified.

position

Specify control element position map.

controlrod position <identifiers>
<identifiers> : a list of control element identifiers (number of input: core rows*core columns). An identifier "0" is used to represent an empty location. The map runs fastest in the x direction (columns) and then y direction (rows) such that the first row is the northernmost row and the last row is the southernmost row. For hexagonal maps (used in hexagonal and triangular geometry) the row wrap is interpreted such that the first entry on each row is located in the southeast direction of the first hexagon entry on the previous row.

group

Specify control element group related variables

controlrod group [load <identifiers> height <identifier> <unit> <height>]
<identifiers> : a list of control element group identifiers (number of input: core rows*core columns). An identifier "0" is used to represent an empty location. The map runs fastest in the x direction (columns) and then y direction (rows) such that the first row is the northernmost row and the last row is the southernmost row. For hexagonal maps (used in hexagonal and triangular geometry) the row wrap is interpreted such that the first entry on each row is located in the southeast direction of the first hexagon entry on the previous row.
<identifier> : identifier of the control element group of which height is specified
<unit> : unit of the height
  • cm: cm from the bottom of the core (including possible axial reflectors)
  • node: number of full node positions from the bottom of the core (including possible axial reflectors).
  • percentage: relative fraction of the full core height (including possible axial reflectors) in percent from the bottom of the core (including possible axial reflectors).
<height> : height of the control element group

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

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)

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)

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

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

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 multiplied with (1.0 minus relaxation_factor) (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)

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)

power

flux

normalization_type

Set the variable to which the neutronics solution is normalized or disable normalization.

iteration normalization_type <variable>
<variable>
  • none  : do not normalize the 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

keff

Set the effective multiplication factor initial value for keff iteration control_variable or value for other control variables.

iteration keff <keff>
<keff> effective multiplication factor initial value or value

boron

Set the boron concentration (ppm) initial value for boron iteration control_variable or global concentration value for other control variables.

iteration boron <boron>
<boron> boron concentration initial value or value

control_variable

Set the control variable for critical variable iteration.

iteration control_variable <variable>
<variable>
  • none : do not iterate a criticality parameter in the neutronics solution
  • keff : iterate a critical effective multiplication factor. Value is calculated during the CGR or CMR iterations, if one is used, or with a direct balance method otherwise.
  • boron: iterate a critical global boron concentration. CGR or CMR is not used. The method for estimating the critical boron concentration currently depends on the group constant model. See also iteration use_boron_relaxation and iteration boron_relaxation_factor.

use_boron_relaxation

Either use relaxation of the critical boron concentration or not.

iteration use_boron_relaxation <flag>
<flag>
  • 1/y/yes/on/true : critical boron concentration relaxation is used (default). See also iteration boron_relaxation_factor.
  • everything else : critical boron concentration relaxation is not used

boron_relaxation_factor

Set the critical boron concentration relaxation factor during outer iterations.

iteration boron_relaxation_factor <relaxation_factor>
<relaxation_factor> : critical boron concentration relaxation factor during outer iterations. The new boron concentration is multiplied with this value and added to the old boron concentration multiplied with (1.0 minus relaxation_factor) (default 0.5)

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)

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

End the calculation.

end

Group constant files

HEXBU-3D/MOD5

Simple

Retrieved from "https://serpent.vtt.fi/kraken/index.php?title=Ants_input_manual&oldid=1246"