diff --git a/docs/source/capi/index.rst b/docs/source/capi/index.rst new file mode 100644 index 000000000..f3cdbb840 --- /dev/null +++ b/docs/source/capi/index.rst @@ -0,0 +1,34 @@ +.. _capi: + +===== +C API +===== + +.. c:function:: int openmc_find(double* xyz, int rtype) + + Return the ID of the cell/material containing a given point + + :param xyz: Cartesian coordinates + :type xyz: double[3] + :param rtype: Which ID to return (1=cell, 2=material) + :type rtype: int + :rtype: int + +.. c:function:: void openmc_init(int intracomm) + + Initialize OpenMC + + :param intracomm: MPI intracommunicator + :type intracomm: int + +.. c:function:: void openmc_finalize() + + Finalize a simulation + +.. c:function:: void openmc_reset() + + Resets all tally scores + +.. c:function:: void openmc_run() + + Run a simulation diff --git a/docs/source/conf.py b/docs/source/conf.py index c3434914b..95930fedb 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -25,8 +25,9 @@ except ImportError: MOCK_MODULES = ['numpy', 'numpy.polynomial', 'numpy.polynomial.polynomial', - 'h5py', 'pandas', 'uncertainties', 'openmoc', - 'openmc.data.reconstruct'] + 'numpy.ctypeslib', 'scipy', 'scipy.sparse', 'scipy.interpolate', + 'scipy.integrate', 'scipy.optimize', 'scipy.special', 'h5py', + 'pandas', 'uncertainties', 'openmoc', 'openmc.data.reconstruct'] sys.modules.update((mod_name, MagicMock()) for mod_name in MOCK_MODULES) import numpy as np diff --git a/docs/source/index.rst b/docs/source/index.rst index ce4a5f6f8..00b09db9e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -36,6 +36,7 @@ free to send a message to the User's Group `mailing list`_. usersguide/index devguide/index pythonapi/index + capi/index io_formats/index publications license