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

Make sure prism functions are in documentation

Browse source
This commit is contained in:
Paul Romano 2017-02-17 06:53:32 -06:00
parent 698efb04e2
commit aeffb739ec
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/source/pythonapi/index.rst
View file

@ -115,15 +115,17 @@ Many of the above classes are derived from several abstract classes:
openmc.Region
openmc.Lattice
One function is also available to create a hexagonal region defined by the
intersection of six surface half-spaces.
Two helpers function are also available to create rectangular and hexagonal
prisms defined by the intersection of four and six surface half-spaces,
respectively.
.. autosummary::
:toctree: generated
:nosignatures:
:template: myfunction.rst
openmc.make_hexagon_region
openmc.get_hexagonal_prism
openmc.get_rectangular_prism
Constructing Tallies
--------------------