diff --git a/docs/source/publications.rst b/docs/source/publications.rst index 49430d84b..012560a28 100644 --- a/docs/source/publications.rst +++ b/docs/source/publications.rst @@ -62,6 +62,11 @@ Coupling and Multi-physics `_," *Nucl. Sci. Tech.*, **30** (2019). +- April Novak, Paul Romano, Brycen Wendt, Ron Rahaman, Elia Merzari, Leslie + Kerby, Cody Permann, Richard Martineau, and Rachel N. Slaybaugh, "Preliminary + Coupling of OpenMC and Nek5000 within the MOOSE Framework," *Proc. PHYSOR*, + Cancun, Mexico, Apr. 22-26 (2018). + - Jun Chen, Liangzhi Cao, Chuanqi Zhao, and Zhouyu Liu, "`Development of Subchannel Code SUBSC for high-fidelity multi-physics coupling application `_", *Energy Procedia*, **127**, @@ -129,6 +134,10 @@ Geometry and Visualization Miscellaneous ------------- +- Amanda L. Lund and Paul K. Romano, "`Implementation and Validation of Photon + Transport in OpenMC `_", Argonne National + Laboratory, Technical Report ANL/MCS-TM-381 (2018). + - Bruno Merk, Dzianis Litskevich, R. Gregg, and A. R. Mount, "`Demand driven salt clean-up in a molten salt fast reactor -- Defining a priority list `_", *PLOS One*, **13**, @@ -191,6 +200,10 @@ Miscellaneous Multi-group Cross Section Generation ------------------------------------ +- Changho Lee and Yeon Sang Jung, "Verification of the Cross Section Library + Generated Using OpenMC and MC\ :sup:`2`-3 for PROTEUS," *Proc. PHYSOR*, Cancun, + Mexico, Apr. 22-26 (2018). + - Zhaoyuan Liu, Kord Smith, Benoit Forget, and Javier Ortensi, "`Cumulative migration method for computing rigorous diffusion coefficients and transport cross sections from Monte Carlo @@ -454,3 +467,21 @@ Depletion - Kai Huang, Hongchun Wu, Yunzhao Li, and Liangzhi Cao, "Generalized depletion chain simplification based of significance analysis," *Proc. PHYSOR*, Sun Valley, Idaho, May 1-5, 2016. + +-------------------- +Sensitivity Analysis +-------------------- + +- Xingjie Peng, Jingang Liang, Benoit Forget, and Kord Smith, "`Calculation of + adjoint-weighted reactor kinetics parameters in OpenMC + `_", *Ann. Nucl. Energy*, + **128**, 231-235 (2019). + +- Zeyun Wu, Jingang Liang, Xingjie Peng, and Hany S. Abdel-Khalik, "`GPT-Free + Sensitivity Analysis for Monte Carlo Models + `_", *Nucl. Technol.* (2019). + +- Xingjie Peng, Jingang Liang, Abdulla Alhajri, Benoit Forget, and Kord Smith, + "`Development of continuous-energy sensitivity analysis capability in OpenMC + `_", *Ann. Nucl. Energy*, + **110**, 362-383 (2017). diff --git a/docs/source/pythonapi/base.rst b/docs/source/pythonapi/base.rst index f39421b28..8cf65a997 100644 --- a/docs/source/pythonapi/base.rst +++ b/docs/source/pythonapi/base.rst @@ -202,27 +202,20 @@ 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, 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. +convergence during inactive neutron batches. To use CMFD, the +:class:`openmc.cmfd.CMFDRun` class executes OpenMC through the C API, solving +the CMFD system between fission generations and modifying the source weights. +Note that the :mod:`openmc.cmfd` module is not imported by default with the +:mod:`openmc` namespace and needs to be imported explicitly. .. autosummary:: :toctree: generated :nosignatures: :template: myclass.rst - openmc.CMFDMesh - openmc.CMFDRun - -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: - -.. autosummary:: - :toctree: generated - :nosignatures: - :template: myfunction.rst - - openmc.CMFDRun.run + openmc.cmfd.CMFDMesh + openmc.cmfd.CMFDRun +At the minimum, a CMFD mesh needs to be specified in order to run CMFD. Once the +mesh and other optional properties are set, a simulation can be run with CMFD +turned on using :meth:`openmc.cmfd.CMFDRun.run`. diff --git a/openmc/cmfd.py b/openmc/cmfd.py index c13b6991d..03bc22eae 100644 --- a/openmc/cmfd.py +++ b/openmc/cmfd.py @@ -53,7 +53,7 @@ _CURRENTS = { class CMFDMesh(object): - """"A structured Cartesian mesh used for CMFD acceleration. + """A structured Cartesian mesh used for CMFD acceleration. Attributes ---------- @@ -199,14 +199,16 @@ class CMFDRun(object): display : dict Dictionary indicating which CMFD results to output. Note that CMFD k-effective will always be outputted. Acceptable keys are: - * "balance" - Whether to output RMS [%] of the resdiual from the - neutron balance equation on CMFD tallies (bool) - * "dominance" - Whether to output the estimated dominance ratio from - the CMFD iterations (bool) - * "entropy" - Whether to output the *entropy* of the CMFD predicted - fission source (bool) - * "source" - Whether to ouput the RMS [%] between the OpenMC fission - source and CMFD fission source (bool) + + * "balance" - Whether to output RMS [%] of the resdiual from the + neutron balance equation on CMFD tallies (bool) + * "dominance" - Whether to output the estimated dominance ratio from + the CMFD iterations (bool) + * "entropy" - Whether to output the *entropy* of the CMFD predicted + fission source (bool) + * "source" - Whether to ouput the RMS [%] between the OpenMC fission + source and CMFD fission source (bool) + downscatter : bool Indicate whether an effective downscatter cross section should be used when using 2-group CMFD. @@ -215,7 +217,7 @@ class CMFDRun(object): of fission source neutrons on the next OpenMC batch. Defaults to False. cmfd_ktol : float Tolerance on the eigenvalue when performing CMFD power iteration - mesh : openmc.CMFDMesh + mesh : openmc.cmfd.CMFDMesh Structured mesh to be used for acceleration norm : float Normalization factor applied to the CMFD fission source distribution @@ -244,16 +246,17 @@ class CMFDRun(object): ``run_adjoint`` must be true for an adjoint calculation to be perfomed. Options are: - * "physical" - Create adjoint matrices from physical parameters of - CMFD problem - * "math" - Create adjoint matrices mathematically as the transpose of - loss and production CMFD matrices + * "physical" - Create adjoint matrices from physical parameters of + CMFD problem + * "math" - Create adjoint matrices mathematically as the transpose of + loss and production CMFD matrices + indices : numpy.ndarray Stores spatial and group dimensions as [nx, ny, nz, ng] cmfd_src : numpy.ndarray CMFD source distribution calculated from solving CMFD equations entropy : list of floats - "Shannon entropy" from cmfd fission source, stored for each generation + "Shannon entropy" from CMFD fission source, stored for each generation that CMFD is invoked balance : list of floats RMS of neutron balance equations, stored for each generation that CMFD