crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-24 12:05:32 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Address @paulromano and @smharper comments

Browse source
This commit is contained in:
Shikhar Kumar 2018-12-11 18:00:06 -05:00
parent b4a2687af9
commit 2874b4a2f9
10 changed files with 782 additions and 959 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -201,6 +201,10 @@ Various classes may be created when performing tally slicing and/or arithmetic:
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.
.. autosummary::
:toctree: generated
:nosignatures:
@ -209,33 +213,6 @@ Coarse Mesh Finite Difference Acceleration
openmc.CMFDMesh
openmc.CMFDRun
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. The following properties can be set through the CMFDRun class:
.. autosummary::
:toctree: generated
:nosignatures:
:template: myfunction.rst
openmc.CMFDRun.cmfd_begin
openmc.CMFDRun.dhat_reset
openmc.CMFDRun.cmfd_display
openmc.CMFDRun.cmfd_downscatter
openmc.CMFDRun.cmfd_feedback
openmc.CMFDRun.cmfd_ktol
openmc.CMFDRun.cmfd_mesh
openmc.CMFDRun.norm
openmc.CMFDRun.cmfd_adjoint_type
openmc.CMFDRun.cmfd_power_monitor
openmc.CMFDRun.cmfd_run_adjoint
openmc.CMFDRun.cmfd_shift
openmc.CMFDRun.cmfd_stol
openmc.CMFDRun.cmfd_spectral
openmc.CMFDRun.cmfd_reset
openmc.CMFDRun.cmfd_write_matrices
openmc.CMFDRun.gauss_seidel_tolerance
At the minimum, a CMFD mesh needs to be specified in order to run CMFD. Once
these properties are set, an OpenMC simulation can be run with CMFD turned on
with the function: