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

Add some documentation for the new MeshSpatial class.

Browse source
This commit is contained in:
Patrick Shriwise 2022-12-30 07:21:11 -06:00
parent 580096d423
commit 8657123bac
2 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/source/pythonapi/stats.rst
View file

@ -57,6 +57,7 @@ Spatial Distributions
openmc.stats.SphericalIndependent
openmc.stats.Box
openmc.stats.Point
openmc.stats.MeshSpatial
.. autosummary::
:toctree: generated

4
docs/source/usersguide/settings.rst
View file

@ -187,7 +187,9 @@ The spatial distribution can be set equal to a sub-class of
:class:`openmc.stats.CartesianIndependent`. To independently specify
distributions using spherical or cylindrical coordinates, you can use
:class:`openmc.stats.SphericalIndependent` or
:class:`openmc.stats.CylindricalIndependent`, respectively.
:class:`openmc.stats.CylindricalIndependent`, respectively. Meshes can also be
used to represent spatial distributions with :class:`openmc.stats.MeshSpatial`
by specifying a mesh and source strengths for each mesh element.
The angular distribution can be set equal to a sub-class of
:class:`openmc.stats.UnitSphere` such as :class:`openmc.stats.Isotropic`,