From c14680c26dd1f66a890beb18f023d806607ab2cd Mon Sep 17 00:00:00 2001 From: Shikhar Kumar Date: Wed, 19 Dec 2018 02:24:42 -0500 Subject: [PATCH] Update documentation about C API dependence of CMFD and necessary import statements --- docs/source/pythonapi/base.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/pythonapi/base.rst b/docs/source/pythonapi/base.rst index d3c53d173..f39421b28 100644 --- a/docs/source/pythonapi/base.rst +++ b/docs/source/pythonapi/base.rst @@ -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