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

Add documentation on torus distance/normal

Browse source
This commit is contained in:
Paul Romano 2021-12-22 08:57:44 -05:00
parent b0fbb4e804
commit a57d7dcd7f
4 changed files with 110 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/io_formats/geometry.rst
View file

@ -26,7 +26,7 @@ Each ``<surface>`` element can have the following attributes or sub-elements:
:type:
The type of the surfaces. This can be "x-plane", "y-plane", "z-plane",
"plane", "x-cylinder", "y-cylinder", "z-cylinder", "sphere", "x-cone",
"y-cone", "z-cone", or "quadric".
"y-cone", "z-cone", "quadric", "x-torus", "y-torus", or "z-torus".
*Default*: None

3
docs/source/io_formats/summary.rst
View file

@ -55,7 +55,8 @@ The current version of the summary file format is 6.0.
:Datasets: - **name** (*char[]*) -- Name of the surface.
- **type** (*char[]*) -- Type of the surface. Can be 'x-plane',
'y-plane', 'z-plane', 'plane', 'x-cylinder', 'y-cylinder',
'z-cylinder', 'sphere', 'x-cone', 'y-cone', 'z-cone', or 'quadric'.
'z-cylinder', 'sphere', 'x-cone', 'y-cone', 'z-cone', 'quadric',
'x-torus', 'y-torus', or 'z-torus'.
- **coefficients** (*double[]*) -- Array of coefficients that define
the surface. See :ref:`surface_element` for what coefficients are
defined for each surface type.