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

Set n_batches and n_max_batches through C API

Browse source
This commit is contained in:
Shikhar Kumar 2020-06-01 18:06:31 -04:00
parent ffe0f0283a
commit 7b4db3279a
4 changed files with 78 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -452,6 +452,16 @@ 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)
Set number of batches and number of max batches
:param int32_t n_batches: Number of batches to simulate
:param int32_t n_batches: Maximum number of batches to simulate (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
.. c:function:: int openmc_simulation_finalize()
Finalize a simulation.