mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-28 06:05:58 -04:00
remove the surface.py first
This commit is contained in:
commit
fbaa780731
65 changed files with 522 additions and 2736 deletions
|
|
@ -1,17 +1,17 @@
|
|||
.. _capi:
|
||||
|
||||
=====
|
||||
C API
|
||||
=====
|
||||
=========
|
||||
C/C++ API
|
||||
=========
|
||||
|
||||
The libopenmc shared library that is built when installing OpenMC exports a
|
||||
number of C interoperable functions and global variables that can be used for
|
||||
in-memory coupling. While it is possible to directly use the C API as documented
|
||||
here for coupling, most advanced users will find it easier to work with the
|
||||
Python bindings in the :py:mod:`openmc.capi` module.
|
||||
in-memory coupling. While it is possible to directly use the C/C++ API as
|
||||
documented here for coupling, most advanced users will find it easier to work
|
||||
with the Python bindings in the :py:mod:`openmc.lib` module.
|
||||
|
||||
.. warning:: The C API is still experimental and may undergo substantial changes
|
||||
in future releases.
|
||||
.. warning:: The C/C++ API is still experimental and may undergo substantial
|
||||
changes in future releases.
|
||||
|
||||
----------------
|
||||
Type Definitions
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ extensions = ['sphinx.ext.autodoc',
|
|||
'sphinx_numfig',
|
||||
'notebook_sphinxext']
|
||||
if not on_rtd:
|
||||
extensions.append('sphinx.ext.imgconverter')
|
||||
extensions.append('sphinxcontrib.rsvgconverter')
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
|
|
|||
|
|
@ -579,7 +579,7 @@ sampled using the leading order term of the Sauter–Gluckstern–Hull
|
|||
distribution,
|
||||
|
||||
.. math::
|
||||
:label: sauter–gluckstern–hull
|
||||
:label: sauter-gluckstern-hull
|
||||
|
||||
p(\mu_{\pm}) = C(1 - \beta_{\pm}\mu_{\pm})^{-2},
|
||||
|
||||
|
|
@ -588,7 +588,7 @@ ratio of the velocity of the charged particle to the speed of light given in
|
|||
:eq:`beta-2`.
|
||||
|
||||
The inverse transform method is used to sample :math:`\mu_{-}` and
|
||||
:math:`\mu_{+}` from :eq:`sauter–gluckstern–hull`, using the sampling formula
|
||||
:math:`\mu_{+}` from :eq:`sauter-gluckstern-hull`, using the sampling formula
|
||||
|
||||
.. math::
|
||||
:label: sample-mu
|
||||
|
|
|
|||
|
|
@ -58,7 +58,8 @@ Coupling and Multi-physics
|
|||
--------------------------
|
||||
|
||||
- Miriam A. Kreher, Benoit Forget, and Kord Smith, "Single-Batch Monte Carlo
|
||||
Multiphysics Coupling," *Proc. M&C*, Portland, Oregon, Aug. 25-29 (2019).
|
||||
Multiphysics Coupling," *Proc. M&C*, 1789-1797, Portland, Oregon, Aug. 25-29
|
||||
(2019).
|
||||
|
||||
- Ze-Long Zhao, Yongwei Yang, and Shuang Hong, "`Application of FLUKA and OpenMC
|
||||
in coupled physics calculation of target and subcritical reactor for ADS
|
||||
|
|
@ -118,7 +119,7 @@ Geometry and Visualization
|
|||
|
||||
- Sterling Harper, Paul Romano, Benoit Forget, and Kord Smith, "Efficient
|
||||
dynamic threadsafe neighbor lists for Monte Carlo ray tracing," *Proc. M&C*,
|
||||
Portland, Oregon, Aug. 25-29 (2019).
|
||||
918-926, Portland, Oregon, Aug. 25-29 (2019).
|
||||
|
||||
- Jin-Yang Li, Long Gu, Hu-Shan Xu, Nadezha Korepanova, Rui Yu, Yan-Lei Zhu, and
|
||||
Chang-Ping Qin, "`CAD modeling study on FLUKA and OpenMC for accelerator
|
||||
|
|
@ -141,6 +142,10 @@ Geometry and Visualization
|
|||
Miscellaneous
|
||||
-------------
|
||||
|
||||
- Shikhar Kumar, Benoit Forget, and Kord Smith, "Analysis of fission source
|
||||
convergence for a 3-D SMR core using functional expansion tallies," *Proc.
|
||||
M&C*, 937-947, Portland, Oregon, Aug. 25-29 (2019).
|
||||
|
||||
- Faisal Qayyum, Muhammad R. Ali, Awais Zahur, and R. Khan, "`Improvements in
|
||||
methodology to determine feedback reactivity coefficients
|
||||
<https://doi.org/10.1007/s41365-019-0588-0>`_," *Nucl. Sci. Tech.*, **30**: 63
|
||||
|
|
@ -496,7 +501,7 @@ Depletion
|
|||
|
||||
- Jose L. Salcedo-Perez, Benoit Forget, Kord Smith, and Paul Romano, "Hybrid
|
||||
tallies to improve performance in depletion Monte Carlo simulations," *Proc.
|
||||
M&C*, Aug. 25-29 (2019).
|
||||
M&C*, 927-936, Portland, Oregon, Aug. 25-29 (2019).
|
||||
|
||||
- Zhao-Qing Liu, Ze-Long Zhao, Yong-Wei Yang, Yu-Cui Gao, Hai-Yan Meng, and
|
||||
Qing-Yu Gao, "`Development and validation of depletion code system IMPC-Burnup
|
||||
|
|
@ -526,6 +531,10 @@ Depletion
|
|||
Sensitivity Analysis
|
||||
--------------------
|
||||
|
||||
- Abdulla Alhajri and Benoit Forget, "Eigenvalue Sensitivity in Monte Carlo
|
||||
Simulations to Nuclear Data Parameters using the Multipole Formalism," *Proc.
|
||||
M&C*, 1895-1906, Portland, Oregon, Aug. 25-29 (2019).
|
||||
|
||||
- Xingjie Peng, Jingang Liang, Benoit Forget, and Kord Smith, "`Calculation of
|
||||
adjoint-weighted reactor kinetics parameters in OpenMC
|
||||
<https://doi.org/10.1016/j.anucene.2019.01.007>`_", *Ann. Nucl. Energy*,
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
--------------------------------------------------
|
||||
:mod:`openmc.capi` -- Python bindings to the C API
|
||||
--------------------------------------------------
|
||||
------------------------------------------------------
|
||||
:mod:`openmc.lib` -- Python bindings to the C/C++ API
|
||||
------------------------------------------------------
|
||||
|
||||
.. automodule:: openmc.capi
|
||||
.. automodule:: openmc.lib
|
||||
|
||||
Functions
|
||||
---------
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ This release of OpenMC adds several major new features: :ref:`depletion
|
|||
<usersguide_depletion>`, photon transport, and support for CAD geometries
|
||||
through DAGMC. In addition, the core codebase has been rewritten in C++14 (it
|
||||
was previously written in Fortran 2008). This makes compiling the code
|
||||
cosiderably simpler as no Fortran compiler is needed.
|
||||
considerably simpler as no Fortran compiler is needed.
|
||||
|
||||
Functional expansion tallies are now supported through several new tally filters
|
||||
that can be arbitrarily combined:
|
||||
|
|
@ -40,6 +40,7 @@ random, non-overlapping configuration of spheres within the region.
|
|||
New Features
|
||||
------------
|
||||
|
||||
- Support for rectilinear meshes through :class:`openmc.RectilinearMesh`.
|
||||
- The :class:`Geometry`, :class:`Materials`, and :class:`Settings` classes now
|
||||
have a ``from_xml`` method that will build an instance from an existing XML
|
||||
file.
|
||||
|
|
@ -54,6 +55,34 @@ New Features
|
|||
- The :mod:`openmc.data` module now supports reading and sampling from ENDF File
|
||||
32 resonance covariance data (`PR 1024
|
||||
<https://github.com/openmc-dev/openmc/pull/1024>`_).
|
||||
- Several new convenience functions/methods have been added:
|
||||
|
||||
- The :func:`openmc.model.cylinder_from_points` function creates a cylinder
|
||||
given two points passing through its center and a radius.
|
||||
- The :meth:`openmc.Plane.from_points` function creates a plane given three
|
||||
points that pass through it.
|
||||
- The :func:`openmc.model.pin` function creates a pin cell universe given a
|
||||
sequence of concentric cylinders and materials.
|
||||
|
||||
------------------
|
||||
Python API Changes
|
||||
------------------
|
||||
|
||||
- All surface classes now have coefficient arguments given as lowercase names.
|
||||
- The order of arguments in surface classes has been changed so that
|
||||
coefficients are the first arguments (rather than the optional surface ID).
|
||||
This means you can now write::
|
||||
|
||||
x = openmc.XPlane(5.0, 'reflective')
|
||||
zc = openmc.ZCylinder(0., 0., 10.)
|
||||
|
||||
- The ``Mesh`` class has been renamed :class:`openmc.RegularMesh`.
|
||||
- The ``get_rectangular_prism`` function has been renamed
|
||||
:func:`openmc.model.rectangular_prism`.
|
||||
- The ``get_hexagonal_prism`` function has been renamed
|
||||
:func:`openmc.model.hexagonal_prism`.
|
||||
- Python bindings to the C/C++ API have been move from ``openmc.capi`` to
|
||||
:mod:`openmc.lib`.
|
||||
|
||||
---------
|
||||
Bug Fixes
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue