crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-26 05:05:30 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Updated input docs with cell, lattice and material label descriptor

Browse source
This commit is contained in:
Will Boyd 2015-04-23 22:06:52 -04:00
parent f6d8cb779a
commit d64ca1816e
1 changed files with 31 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/source/usersguide/input.rst
View file

@ -709,11 +709,10 @@ Each ``<surface>`` element can have the following attributes or sub-elements:
*Default*: None
:label:
An optional string label to easily identify the surface in summary
output files. This string is limited to 52 characters for formatting
purposes.
An optional string label to identify the surface in summary output
files. This string is limited to 52 characters for formatting purposes.
*Default*: None
*Default*: ""
:type:
The type of the surfaces. This can be "x-plane", "y-plane", "z-plane",
@ -795,6 +794,12 @@ Each ``<cell>`` element can have the following attributes or sub-elements:
*Default*: None
:label:
An optional string label to identify the cell in summary output files.
This string is limmited to 52 characters for formatting purposes.
*Default*: ""
:universe:
The ``id`` of the universe that this cell is contained in.
@ -860,6 +865,12 @@ the following attributes or sub-elements:
:id:
A unique integer that can be used to identify the lattice.
:label:
An optional string label to identify the lattice in summary output
files. This string is limited to 52 characters for formatting purposes.
*Default*: ""
:dimension:
Two or three integers representing the number of lattice cells in the x- and
y- (and z-) directions, respectively.
@ -919,6 +930,12 @@ the following attributes or sub-elements:
:id:
A unique integer that can be used to identify the lattice.
:label:
An optional string label to identify the hex_lattice in summary output
files. This string is limited to 52 characters for formatting purposes.
*Default*: ""
:n_rings:
An integer representing the number of radial ring positions in the xy-plane.
Note that this number includes the degenerate center ring which only has one
@ -996,6 +1013,12 @@ Each ``material`` element can have the following attributes or sub-elements:
:id:
A unique integer that can be used to identify the material.
:label:
An optional string label to identify the material in summary output
files. This string is limited to 52 characters for formatting purposes.
*Default*: ""
:density:
An element with attributes/sub-elements called ``value`` and ``units``. The
``value`` attribute is the numeric value of the density while the ``units``
@ -1099,9 +1122,10 @@ and ``<assume_separate>``.
The ``<tally>`` element accepts the following sub-elements:
:label:
This is an optional sub-element specifying the name of this tally to be used
for output purposes. This string is limited to 52 characters for formatting
purposes.
An optional string label to identify the tally in summary output
files. This string is limited to 52 characters for formatting purposes.
*Default*: ""
:filter:
Specify a filter that restricts contributions to the tally to particles