Difference between revisions of "Ants input manual"

From Kraken Wiki
Jump to: navigation, search
(Title & Echo)
(Main blocks)
Line 10: Line 10:
 
* The main block keywords (below) are reserved. In the main blocks, the sub-block keywords (even further below) are reserved.
 
* The main block keywords (below) are reserved. In the main blocks, the sub-block keywords (even further below) are reserved.
  
== 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 25: Line 25:
 
*<code>end</code>
 
*<code>end</code>
  
=== Title ===
+
== Title ==
 
Set a title for the calculation.
 
Set a title for the calculation.
  
Line 31: Line 31:
 
:: <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.
  
 
: echo [ <echo> ]
 
: echo [ <echo> ]
 
:: <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 ==
 +
Set global calculation parameters. These cards will be processed before any other cards.
 +
 +
Sub-blocks:
 +
* <code>geometry</code>
 +
* <code>neutronics</code>
 +
 +
=== 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)
  
  
 
[[Category:Ants]]
 
[[Category:Ants]]
 
[[Category:Input manuals]]
 
[[Category:Input manuals]]

Revision as of 14:27, 12 February 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 */.
  • 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.

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)