Difference between revisions of "Ants input manual"

From Kraken Wiki
Jump to: navigation, search
(iteration)
(core)
Line 60: Line 60:
 
::* sp3 : solve sp3 equation (not supported)
 
::* sp3 : solve sp3 equation (not supported)
  
== core ==
+
== Core ==
 +
Set core parameters.
 +
 
 +
Sub-blocks:
 +
* <code>width_x</code>
 +
* <code>width_y</code>
 +
* <code>width_xy</code>
 +
* <code>width_x_grid</code>
 +
* <code>width_y_grid</code>
 +
* <code>axial_nodes</code>
 +
* <code>axial_heights</code>
 +
* <code>rows</code>
 +
* <code>columns</code>
 +
* <code>nominal_power</code>
 +
* <code>radial_boundary_coeff</code>
 +
* <code>axial_boundary_coeff</code>
 +
* <code>radial_boundary_coeff_east</code>
 +
* <code>radial_boundary_coeff_north</code>
 +
* <code>radial_boundary_coeff_west</code>
 +
* <code>radial_boundary_coeff_south</code>
 +
* <code>axial_boundary_coeff_above</code>
 +
* <code>axial_boundary_coeff_below</code>
 +
* <code>radial_boundary_num_curr</code>
 +
* <code>radial_boundary_in_curr_east</code>
 +
* <code>radial_boundary_in_curr_north</code>
 +
* <code>radial_boundary_in_curr_west</code>
 +
* <code>radial_boundary_in_curr_south</code>
 +
* <code>radial_boundary_in_curr_northeast</code>
 +
* <code>radial_boundary_in_curr_northwest</code>
 +
* <code>radial_boundary_in_curr_southwest</code>
 +
* <code>radial_boundary_in_curr_southeast</code>
 +
* <code>radial_boundary_net_curr_east</code>
 +
* <code>radial_boundary_net_curr_north</code>
 +
* <code>radial_boundary_net_curr_west</code>
 +
* <code>radial_boundary_net_curr_south</code>
 +
* <code>radial_boundary_net_curr_northeast</code>
 +
* <code>radial_boundary_net_curr_northwest</code>
 +
* <code>radial_boundary_net_curr_southwest</code>
 +
* <code>radial_boundary_net_curr_southeast</code>
 +
 
 +
=== width_x ===
 +
=== width_y ===
 +
=== width_xy ===
 +
=== width_x_grid ===
 +
=== width_y_grid ===
 +
=== axial_nodes ===
 +
=== axial_heights ===
 +
=== rows ===
 +
=== columns ===
 +
=== nominal_power ===
 +
=== radial_boundary_coeff ===
 +
=== axial_boundary_coeff ===
 +
=== radial_boundary_coeff_east ===
 +
=== radial_boundary_coeff_north ===
 +
=== radial_boundary_coeff_west ===
 +
=== radial_boundary_coeff_south ===
 +
=== axial_boundary_coeff_above ===
 +
=== axial_boundary_coeff_below ===
 +
=== radial_boundary_num_curr ===
 +
=== radial_boundary_in_curr_east ===
 +
=== radial_boundary_in_curr_north ===
 +
=== radial_boundary_in_curr_west ===
 +
=== radial_boundary_in_curr_south ===
 +
=== radial_boundary_in_curr_northeast ===
 +
=== radial_boundary_in_curr_northwest ===
 +
=== radial_boundary_in_curr_southwest ===
 +
=== radial_boundary_in_curr_southeast ===
 +
=== radial_boundary_net_curr_east ===
 +
=== radial_boundary_net_curr_north ===
 +
=== radial_boundary_net_curr_west ===
 +
=== radial_boundary_net_curr_south ===
 +
=== radial_boundary_net_curr_northeast ===
 +
=== radial_boundary_net_curr_northwest ===
 +
=== radial_boundary_net_curr_southwest ===
 +
=== radial_boundary_net_curr_southeast ===
 +
 
 
== fuel ==
 
== fuel ==
 
== controlrod ==
 
== controlrod ==

Revision as of 15:00, 12 February 2019

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

Contents

Input syntax

The following general syntax guide lines hold for Ants specific input. For example the HEXBU-3D/MOD5 group constant files follow their respective syntax.

  • Ants input supports rest of line comment symbols ! and //, and block comments beginning with /* and ending with */.
  • Blocks beginning and ending with " are held together in for example input file paths.
  • All tokens are separated with either space , comma , or tabular characters.
  • Consecutive input may be repeated using *. The token before * must be a positive integer (the number of repeats).
  • The input is case insensitive.
  • The main block keywords (below) are reserved. In the main blocks, the sub-block keywords (even further below) are reserved.

Main blocks

When the main input file is read, it is tokenized and split into main blocks. Depending on the main block, they might be split into sub-blocks. Currently, the main block keywords are

  • title
  • echo
  • global
  • core
  • fuel
  • controlrod
  • hydraulics
  • iteration
  • library
  • output
  • start
  • end

Title

Set a title for the calculation.

title [ <title> ]
<title> : at most one token for the title. If omitted, an empty title will be set.

Echo

Echo something to standard output.

echo [ <echo> ]
<echo> : at most one token to be echoed. If omitted, an empty echo will be performed.

Global

Set global calculation parameters. These cards will be processed before any other cards and it is mandatory for them to be set.

Sub-blocks:

  • geometry
  • neutronics

Geometry

Set neutronics solution geometry type.

global geometry <geometry>
<geometry>
  • square : use rectangular geometry (for example BWR, PWR)
  • hexagonal : use hexagonal geometry (for example VVER)

Neutronics

Set neutronics solution transport type.

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

width_x

width_y

width_xy

width_x_grid

width_y_grid

axial_nodes

axial_heights

rows

columns

nominal_power

radial_boundary_coeff

axial_boundary_coeff

radial_boundary_coeff_east

radial_boundary_coeff_north

radial_boundary_coeff_west

radial_boundary_coeff_south

axial_boundary_coeff_above

axial_boundary_coeff_below

radial_boundary_num_curr

radial_boundary_in_curr_east

radial_boundary_in_curr_north

radial_boundary_in_curr_west

radial_boundary_in_curr_south

radial_boundary_in_curr_northeast

radial_boundary_in_curr_northwest

radial_boundary_in_curr_southwest

radial_boundary_in_curr_southeast

radial_boundary_net_curr_east

radial_boundary_net_curr_north

radial_boundary_net_curr_west

radial_boundary_net_curr_south

radial_boundary_net_curr_northeast

radial_boundary_net_curr_northwest

radial_boundary_net_curr_southwest

radial_boundary_net_curr_southeast

fuel

controlrod

hydraulics

iteration

Set iteration parameters.

Sub-blocks:

  • conv_crit_keff
  • conv_crit_boron
  • conv_crit_fsrc
  • conv_crit_fsrc_l2
  • conv_crit_flux
  • conv_crit_xenon
  • conv_crit_samarium
  • conv_crit_partial_current
  • num_inner
  • num_cgr
  • max_outer
  • use_cgr
  • use_relaxation
  • use_color
  • use_discontinuity_factor
  • use_wielandt_shift
  • relaxation_factor
  • wielandt_shift_coeff
  • use_ppr
  • xenon_state
  • samarium_state
  • use_normalization
  • use_initial_normalization
  • power
  • flux
  • normalization_type
  • keff
  • boron
  • control_variable
  • use_boron_relaxation
  • boron_relaxation_factor

conv_crit_keff

iteration conv_crit_keff <conv_crit_keff >
<conv_crit_keff> : convergence criterion for absolute value change of effective multiplication factor between consecutive outer iterations.

conv_crit_boron

iteration conv_crit_boron <conv_crit_boron >
<conv_crit_boron > : convergence criterion for absolute value change of boron concentration (ppm) between consecutive outer iterations.

conv_crit_fsrc

iteration conv_crit_fsrc <conv_crit_fsrc >
<conv_crit_fsrc > : convergence criterion for maximum of the absolute value of node-wise relative fission source change between consecutive outer iterations.

conv_crit_fsrc_l2

iteration conv_crit_fsrc_l2 <conv_crit_fsrc_l2 >
<conv_crit_fsrc_l2 > : convergence criterion for change of L2 norm of node-integrated fission sources between consecutive outer iterations.

conv_crit_flux

iteration conv_crit_flux <conv_crit_flux >
<conv_crit_flux > : convergence criterion for maximum of the absolute value of group- and node-wise relative flux source change between consecutive outer iterations.

conv_crit_xenon

conv_crit_samarium

conv_crit_partial_current

num_inner

Set the number of inner iterations per outer iteration.

iteration num_inner <num_inner>
<num_inner> : number of inner iterations per outer iteration.

num_cgr

max_outer

use_cgr

use_relaxation

use_color

Use color or consecutive node iteration.

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

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