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

Update documentation about C API dependence of CMFD and necessary import statements

Browse source
This commit is contained in:
Shikhar Kumar 2018-12-19 02:24:42 -05:00
parent bb45f220d4
commit c14680c26d
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/source/pythonapi/base.rst
View file

@ -203,7 +203,9 @@ Coarse Mesh Finite Difference Acceleration
CMFD is implemented in OpenMC and allows users to accelerate fission source
convergence during inactive neutron batches. To run CMFD, the CMFDRun class
should be used.
should be used, and :mod:`from openmc import cmfd` should be included at the
top of the Python input file. Additionally, this class has a dependence on the
C API.
.. autosummary::
:toctree: generated