crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 14:15:42 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Update docs

Browse source
This commit is contained in:
Shikhar Kumar 2020-06-01 21:25:34 -04:00
parent 6e7f524561
commit a9d0b127b7
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/source/capi/index.rst
View file

@ -266,12 +266,12 @@ Functions
:return: Return status (negative if an error occurs)
:rtype: int
.. c:function:: int openmc_get_n_batches(int* n_batches, int* n_max_batches)
.. c:function:: int openmc_get_n_batches(int* n_batches, bool get_max_batches)
Get number of batches to simulate
:param int* n_batches: Number of batches to simulate
:param int* n_max_batches: Maximum number of batches to simulate (only relevant when triggers are used)
:param int* get_max_batches: Whether to return `n_batches` or `n_max_batches` (only relevant when triggers are used)
:return: Return status (negative if an error occurred)
:rtype: int
@ -461,12 +461,12 @@ Functions
:return: Return status (negative if an error occurs)
:rtype: int
.. c:function:: int openmc_set_n_batches(int32_t n_batches, int32_t n_max_batches, int32_t add_statepoint_batch)
.. c:function:: int openmc_set_n_batches(int32_t n_batches, bool set_max_batches, bool add_statepoint_batch)
Set number of batches and number of max batches
:param int32_t n_batches: Number of batches to simulate
:param int32_t n_max_batches: Maximum number of batches to simulate (only relevant when triggers are used)
:param bool set_max_batches: Whether to set `settings::n_max_batches` or `settings::n_batches` (only relevant when triggers are used)
:param bool add_statepoint_batch: Whether to add `n_batches` to `settings::statepoint_batch`
:return: Return status (negative if an error occurred)
:rtype: int