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/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/C++ API is still experimental and may undergo substantial changes in future releases.
.. c:type:: Bank
Attributes of a source particle.
.. c:member:: double wgt
Weight of the particle
.. c:member:: double xyz[3]
Position of the particle (units of cm)
.. c:member:: double uvw[3]
Unit vector indicating direction of the particle
.. c:member:: double E
Energy of the particle in eV
.. c:member:: int delayed_group
If the particle is a delayed neutron, indicates which delayed precursor
group it was born from. If not a delayed neutron, this member is zero.
.. c:function:: int openmc_calculate_volumes() Run a stochastic volume calculation :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_cell_get_fill(int32_t index, int* type, int32_t** indices, int32_t* n) Get the fill for a cell :param int32_t index: Index in the cells array :param int* type: Type of the fill :param int32_t** indices: Array of material indices for cell :param int32_t* n: Length of indices array :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_cell_get_id(int32_t index, int32_t* id) Get the ID of a cell :param int32_t index: Index in the cells array :param int32_t* id: ID of the cell :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_cell_get_temperature(int32_t index, const int32_t* instance, double* T)
Get the temperature of a cell
:param int32_t index: Index in the cells array
:param int32_t* instance: Which instance of the cell. If a null pointer is passed, the temperature
of the first instance is returned.
:param double* T: temperature of the cell
:return: Return status (negative if an error occurred)
:rtype: int
.. c:function:: int openmc_cell_get_density(int32_t index, const int32_t* instance, double* density)
Get the density of a cell
:param int32_t index: Index in the cells array
:param int32_t* instance: Which instance of the cell. If a null pointer is passed, the density
multiplier of the first instance is returned.
:param double* density: Density of the cell in [g/cm3]
:return: Return status (negative if an error occurred)
:rtype: int
.. c:function:: int openmc_cell_set_fill(int32_t index, int type, int32_t n, const int32_t* indices) Set the fill for a cell :param int32_t index: Index in the cells array :param int type: Type of the fill :param int32_t n: Length of indices array :param indices: Array of material indices for cell :type indices: const int32_t* :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_cell_set_id(int32_t index, int32_t id) Set the ID of a cell :param int32_t index: Index in the cells array :param int32_t id: ID of the cell :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_cell_set_temperature(index index, double T, const int32_t* instance, bool set_contained)
Set the temperature of a cell.
:param int32_t index: Index in the cells array
:param double T: Temperature in Kelvin
:param instance: Which instance of the cell. To set the temperature for all
instances, pass a null pointer.
:param bool set_contained: If the cell is not filled by a material, whether
to set the temperatures of all filled cells
:type instance: const int32_t*
:return: Return status (negative if an error occurred)
:rtype: int
.. c:function:: int openmc_cell_set_density(index index, double density, const int32_t* instance, bool set_contained)
Set the density of a cell.
:param int32_t index: Index in the cells array
:param double density: Density of the cell in [g/cm3]
:param instance: Which instance of the cell. To set the density multiplier for all
instances, pass a null pointer.
:param bool set_contained: If the cell is not filled by a material, whether
to set the density multiplier of all filled cells
:type instance: const int32_t*
:return: Return status (negative if an error occurred)
:rtype: int
.. c:function:: int openmc_energy_filter_get_bins(int32_t index, double** energies, int32_t* n) Return the bounding energies for an energy filter :param int32_t index: Index in the filters array :param double** energies: Bounding energies of the bins for the energy filter :param int32_t* n: Number of energies specified :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_energy_filter_set_bins(int32_t index, int32_t n, const double* energies) Set the bounding energies for an energy filter :param int32_t index: Index in the filters array :param int32_t n: Number of energies specified :param energies: Bounding energies of the bins for the energy filter :type energies: const double* :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_extend_cells(int32_t n, int32_t* index_start, int32_t* index_end) Extend the cells array by n elements :param int32_t n: Number of cells to create :param int32_t* index_start: Index of first new cell :param int32_t* index_end: Index of last new cell :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_extend_filters(int32_t n, int32_t* index_start, int32_t* index_end) Extend the filters array by n elements :param int32_t n: Number of filters to create :param int32_t* index_start: Index of first new filter :param int32_t* index_end: Index of last new filter :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_extend_materials(int32_t n, int32_t* index_start, int32_t* index_end) Extend the materials array by n elements :param int32_t n: Number of materials to create :param int32_t* index_start: Index of first new material :param int32_t* index_end: Index of last new material :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_extend_sources(int32_t n, int32_t* index_start, int32_t* index_end) Extend the external sources array by n elements :param int32_t n: Number of sources to create :param int32_t* index_start: Index of first new source :param int32_t* index_end: Index of last new source :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_extend_tallies(int32_t n, int32_t* index_start, int32_t* index_end) Extend the tallies array by n elements :param int32_t n: Number of tallies to create :param int32_t* index_start: Index of first new tally :param int32_t* index_end: Index of last new tally :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_filter_get_id(int32_t index, int32_t* id) Get the ID of a filter :param int32_t index: Index in the filters array :param int32_t* id: ID of the filter :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_filter_set_id(int32_t index, int32_t id) Set the ID of a filter :param int32_t index: Index in the filters array :param int32_t id: ID of the filter :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_finalize() Finalize a simulation :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_find(double* xyz, int rtype, int32_t* id, int32_t* instance)
Determine the ID of the cell/material containing a given point
:param double[3] xyz: Cartesian coordinates
:param int rtype: Which ID to return (1=cell, 2=material)
:param int32_t* id: ID of the cell/material found. If a material is requested
and the point is in a void, the ID is 0. If an error
occurs, the ID is -1.
:param int32_t* instance: If a cell is repeated in the geometry, the instance
of the cell that was found and zero otherwise.
:return: Return status (negative if an error occurs)
:rtype: int
.. c:function:: int openmc_get_cell_index(int32_t id, int32_t* index) Get the index in the cells array for a cell with a given ID :param int32_t id: ID of the cell :param int32_t* index: Index in the cells array :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_get_filter_index(int32_t id, int32_t* index) Get the index in the filters array for a filter with a given ID :param int32_t id: ID of the filter :param int32_t* index: Index in the filters array :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: void openmc_get_filter_next_id(int32_t* id) Get an integer ID that has not been used by any filters. :param int32_t* id: Unused integer ID
.. c:function:: int openmc_get_keff(double k_combined[2]) :param double[2] k_combined: Combined estimate of k-effective :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_get_material_index(int32_t id, int32_t* index) Get the index in the materials array for a material with a given ID :param int32_t id: ID of the material :param int32_t* index: Index in the materials array :return: Return status (negative if an error occurs) :rtype: int
.. 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 bool 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
.. c:function:: int openmc_get_nuclide_index(const char name[], int* index) Get the index in the nuclides array for a nuclide with a given name :param name: Name of the nuclide :type name: const char[] :param int* index: Index in the nuclides array :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_get_tally_index(int32_t id, int32_t* index) Get the index in the tallies array for a tally with a given ID :param int32_t id: ID of the tally :param int32_t* index: Index in the tallies array :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_hard_reset() Reset tallies, timers, and pseudo-random number generator state :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_init(int argc, char** argv, const void* intracomm)
Initialize OpenMC
:param int argc: Number of command-line arguments (including command)
:param char** argv: Command-line arguments
:param intracomm: MPI intracommunicator. If MPI is not being used, a null
pointer should be passed.
:type intracomm: const void*
:return: Return status (negative if an error occurs)
:rtype: int
.. c:function:: int openmc_load_nuclide(const char* name, const double* temps, int n) Load data for a nuclide from the HDF5 data library. :param name: Name of the nuclide. :type name: const char* :param temps: Temperatures in [K] to load data at :type temps: const double* :param int n: Number of temperatures :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_material_add_nuclide(int32_t index, const char name[], double density) Add a nuclide to an existing material. If the nuclide already exists, the density is overwritten. :param int32_t index: Index in the materials array :param name: Name of the nuclide :type name: const char[] :param double density: Density in atom/b-cm :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_material_get_densities(int32_t index, int** nuclides, double** densities, int* n) Get density for each nuclide in a material. :param int32_t index: Index in the materials array :param int** nuclides: Pointer to array of nuclide indices :param double** densities: Pointer to the array of densities :param int* n: Length of the array :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_material_get_density(int32_t index, double* density) Get density of a material. :param int32_t index: Index in the materials array :param double* density: Pointer to a density :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_material_get_id(int32_t index, int32_t* id) Get the ID of a material :param int32_t index: Index in the materials array :param int32_t* id: ID of the material :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_material_set_density(int32_t index, double density, const char* units) Set the density of a material. :param int32_t index: Index in the materials array :param double density: Density of the material :param units: Units for density :type units: const char* :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_material_set_densities(int32_t index, int n, const char** name, const double* density) :param int32_t index: Index in the materials array :param int n: Length of name/density :param name: Array of nuclide names :type name: const char** :param density: Array of densities :type density: const double* :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_material_set_id(int32_t index, int32_t id) Set the ID of a material :param int32_t index: Index in the materials array :param int32_t id: ID of the material :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_material_filter_get_bins(int32_t index, int32_t** bins, int32_t* n) Get the bins for a material filter :param int32_t index: Index in the filters array :param int32_t** bins: Index in the materials array for each bin :param int32_t* n: Number of bins :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_material_filter_set_bins(int32_t index, int32_t n, const int32_t* bins) Set the bins for a material filter :param int32_t index: Index in the filters array :param int32_t n: Number of bins :param bins: Index in the materials array for each bin :type bins: const int32_t* :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_mesh_filter_get_mesh(int32_t index, int32_t* index_mesh) Get the mesh for a mesh filter :param int32_t index: Index in the filters array :param index_mesh: Index in the meshes array :type index_mesh: int32_t* :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_mesh_filter_set_mesh(int32_t index, int32_t index_mesh) Set the mesh for a mesh filter :param int32_t index: Index in the filters array :param int32_t index_mesh: Index in the meshes array :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_mesh_filter_get_translation(int32_t index, double translation[3]) Get the 3-D translation coordinates for a mesh filter :param int32_t index: Index in the filters array :param double[3] translation: 3-D translation coordinates :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_mesh_filter_set_translation(int32_t index, double translation[3]) Set the 3-D translation coordinates for a mesh filter :param int32_t index: Index in the filters array :param double[3] translation: 3-D translation coordinates :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_meshborn_filter_get_mesh(int32_t index, int32_t* index_mesh) Get the mesh for a meshborn filter :param int32_t index: Index in the filters array :param index_mesh: Index in the meshes array :type index_mesh: int32_t* :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_meshborn_filter_set_mesh(int32_t index, int32_t index_mesh) Set the mesh for a meshborn filter :param int32_t index: Index in the filters array :param int32_t index_mesh: Index in the meshes array :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_meshborn_filter_get_translation(int32_t index, double translation[3]) Get the 3-D translation coordinates for a meshborn filter :param int32_t index: Index in the filters array :param double[3] translation: 3-D translation coordinates :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_meshborn_filter_set_translation(int32_t index, double translation[3]) Set the 3-D translation coordinates for a meshborn filter :param int32_t index: Index in the filters array :param double[3] translation: 3-D translation coordinates :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_meshsurface_filter_get_mesh(int32_t index, int32_t* index_mesh) Get the mesh for a mesh surface filter :param int32_t index: Index in the filters array :param index_mesh: Index in the meshes array :type index_mesh: int32_t* :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_meshsurface_filter_set_mesh(int32_t index, int32_t index_mesh) Set the mesh for a mesh surface filter :param int32_t index: Index in the filters array :param int32_t index_mesh: Index in the meshes array :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_meshsurface_filter_get_translation(int32_t index, double translation[3]) Get the 3-D translation coordinates for a mesh surface filter :param int32_t index: Index in the filters array :param double[3] translation: 3-D translation coordinates :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_meshsurface_filter_set_translation(int32_t index, double translation[3]) Set the 3-D translation coordinates for a mesh surface filter :param int32_t index: Index in the filters array :param double[3] translation: 3-D translation coordinates :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_next_batch()
Simulate next batch of particles. Must be called after openmc_simulation_init().
:return: Integer indicating whether simulation has finished (negative) or not
finished (zero).
:rtype: int
.. c:function:: int openmc_nuclide_name(int index, char** name) Get name of a nuclide :param int index: Index in the nuclides array :param char** name: Name of the nuclide :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_plot_geometry() Run plotting mode. :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_get_plot_index(int32_t id, int32_t* index) Get the index in the plots array for a plot with a given ID. :param int32_t id: Plot ID :param int32_t* index: Index in the plots array :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_plot_get_id(int32_t index, int32_t* id) Get the ID of a plot. :param int32_t index: Index in the plots array :param int32_t* id: Plot ID :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_plot_set_id(int32_t index, int32_t id) Set the ID of a plot. :param int32_t index: Index in the plots array :param int32_t id: Plot ID :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: size_t openmc_plots_size() Number of plots currently allocated. :return: Number of plots in the plots array :rtype: size_t
.. c:function:: int openmc_solidraytrace_plot_create(int32_t* index) Create a new solid raytrace plot. :param int32_t* index: Index of the newly created plot :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_get_pixels(int32_t index, int32_t* width, int32_t* height) Get output pixel dimensions for a solid raytrace plot. :param int32_t index: Index in the plots array :param int32_t* width: Image width in pixels :param int32_t* height: Image height in pixels :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_set_pixels(int32_t index, int32_t width, int32_t height) Set output pixel dimensions for a solid raytrace plot. :param int32_t index: Index in the plots array :param int32_t width: Image width in pixels :param int32_t height: Image height in pixels :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_get_color_by(int32_t index, int32_t* color_by) Get the domain type used for coloring (0=materials, 1=cells). :param int32_t index: Index in the plots array :param int32_t* color_by: Coloring mode :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_set_color_by(int32_t index, int32_t color_by) Set the domain type used for coloring (0=materials, 1=cells). :param int32_t index: Index in the plots array :param int32_t color_by: Coloring mode :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_set_default_colors(int32_t index) Set default random colors for the current ``color_by`` mode. :param int32_t index: Index in the plots array :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_set_all_opaque(int32_t index) Mark all domains in the current ``color_by`` mode as opaque. :param int32_t index: Index in the plots array :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_set_opaque(int32_t index, int32_t id, bool visible) Set whether a specific domain ID is opaque (visible) in the rendered image. :param int32_t index: Index in the plots array :param int32_t id: Cell/material ID (based on ``color_by``) :param bool visible: Whether the domain is opaque :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_set_color(int32_t index, int32_t id, uint8_t r, uint8_t g, uint8_t b) Set RGB color for a specific domain ID. :param int32_t index: Index in the plots array :param int32_t id: Cell/material ID (based on ``color_by``) :param uint8_t r: Red channel :param uint8_t g: Green channel :param uint8_t b: Blue channel :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_get_color(int32_t index, int32_t id, uint8_t* r, uint8_t* g, uint8_t* b) Get RGB color for a specific domain ID. :param int32_t index: Index in the plots array :param int32_t id: Cell/material ID (based on ``color_by``) :param uint8_t* r: Red channel :param uint8_t* g: Green channel :param uint8_t* b: Blue channel :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_get_camera_position(int32_t index, double* x, double* y, double* z) Get camera position. :param int32_t index: Index in the plots array :param double* x: X coordinate :param double* y: Y coordinate :param double* z: Z coordinate :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_set_camera_position(int32_t index, double x, double y, double z) Set camera position. :param int32_t index: Index in the plots array :param double x: X coordinate :param double y: Y coordinate :param double z: Z coordinate :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_get_look_at(int32_t index, double* x, double* y, double* z) Get camera target point. :param int32_t index: Index in the plots array :param double* x: X coordinate :param double* y: Y coordinate :param double* z: Z coordinate :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_set_look_at(int32_t index, double x, double y, double z) Set camera target point. :param int32_t index: Index in the plots array :param double x: X coordinate :param double y: Y coordinate :param double z: Z coordinate :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_get_up(int32_t index, double* x, double* y, double* z) Get the camera up vector. :param int32_t index: Index in the plots array :param double* x: X component :param double* y: Y component :param double* z: Z component :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_set_up(int32_t index, double x, double y, double z) Set the camera up vector. :param int32_t index: Index in the plots array :param double x: X component :param double y: Y component :param double z: Z component :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_get_light_position(int32_t index, double* x, double* y, double* z) Get light source position. :param int32_t index: Index in the plots array :param double* x: X coordinate :param double* y: Y coordinate :param double* z: Z coordinate :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_set_light_position(int32_t index, double x, double y, double z) Set light source position. :param int32_t index: Index in the plots array :param double x: X coordinate :param double y: Y coordinate :param double z: Z coordinate :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_get_fov(int32_t index, double* fov) Get horizontal field of view in degrees. :param int32_t index: Index in the plots array :param double* fov: Field of view in degrees :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_set_fov(int32_t index, double fov) Set horizontal field of view in degrees. :param int32_t index: Index in the plots array :param double fov: Field of view in degrees :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_get_diffuse_fraction(int32_t index, double* diffuse_fraction) Get diffuse-light fraction. :param int32_t index: Index in the plots array :param double* diffuse_fraction: Diffuse fraction in [0, 1] :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_set_diffuse_fraction(int32_t index, double diffuse_fraction) Set diffuse-light fraction. :param int32_t index: Index in the plots array :param double diffuse_fraction: Diffuse fraction in [0, 1] :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_update_view(int32_t index) Recompute internal camera/view transforms after camera changes. :param int32_t index: Index in the plots array :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_solidraytrace_plot_create_image(int32_t index, uint8_t* data_out, int32_t width, int32_t height) Render the plot to an RGB image buffer. :param int32_t index: Index in the plots array :param uint8_t* data_out: Output buffer of shape ``height*width*3`` :param int32_t width: Image width in pixels :param int32_t height: Image height in pixels :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_reset() Resets all tally scores :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_remove_tally(int32_t index); Given an index of a tally, remove it from the tallies array :param int index: Index in tallies array :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_run() Run a simulation :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: void openmc_run_random_ray() Run a random ray simulation
.. 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 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
.. c:function:: int openmc_simulation_finalize() Finalize a simulation. :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_simulation_init() Initialize a simulation. Must be called after openmc_init(). :return: Return status (negative if an error occurs) :rtype: int
.. c:function:: int openmc_source_bank(struct Bank** ptr, int64_t* n) Return a pointer to the source bank array. :param ptr: Pointer to the source bank array :type ptr: struct Bank** :param int64_t* n: Length of the source bank array :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_source_set_strength(int32_t index, double strength) Set the strength of an external source :param int32_t index: Index in the external source array :param double strength: Source strength :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_statepoint_write(const char filename[], const bool* write_source)
Write a statepoint file
:param filename: Name of file to create. If a null pointer is passed, a
filename is assigned automatically.
:type filename: const char[]
:param write_source: Whether to include the source bank
:type write_source: const bool*
:return: Return status (negative if an error occurs)
:rtype: int
.. c:function:: int openmc_tally_get_id(int32_t index, int32_t* id) Get the ID of a tally :param int32_t index: Index in the tallies array :param int32_t* id: ID of the tally :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_tally_get_filters(int32_t index, int32_t** indices, int* n) Get filters specified in a tally :param int32_t index: Index in the tallies array :param int32_t** indices: Array of filter indices :param int* n: Number of filters :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_tally_get_n_realizations(int32_t index, int32_t* n) :param int32_t index: Index in the tallies array :param int32_t* n: Number of realizations :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_tally_get_nuclides(int32_t index, int** nuclides, int* n) Get nuclides specified in a tally :param int32_t index: Index in the tallies array :param int** nuclides: Array of nuclide indices :param int* n: Number of nuclides :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_tally_get_scores(int32_t index, int** scores, int* n) Get scores specified for a tally :param int32_t index: Index in the tallies array :param int** scores: Array of scores :param int* n: Number of scores :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_tally_results(int32_t index, double** ptr, int shape_[3]) Get a pointer to tally results array. :param int32_t index: Index in the tallies array :param double** ptr: Pointer to the results array :param int[3] shape_: Shape of the results array :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_tally_set_filters(int32_t index, int n, const int32_t* indices) Set filters for a tally :param int32_t index: Index in the tallies array :param int n: Number of filters :param indices: Array of filter indices :type indices: const int32_t* :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_tally_set_id(int32_t index, int32_t id) Set the ID of a tally :param int32_t index: Index in the tallies array :param int32_t id: ID of the tally :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_tally_set_nuclides(int32_t index, int n, const char** nuclides) Set the nuclides for a tally :param int32_t index: Index in the tallies array :param int n: Number of nuclides :param nuclides: Array of nuclide names :type nuclides: const char** :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_tally_set_scores(int32_t index, int n, const int* scores) Set scores for a tally :param int32_t index: Index in the tallies array :param int n: Number of scores :param scores: Array of scores :type scores: const int* :return: Return status (negative if an error occurred) :rtype: int
.. c:function:: int openmc_temperature_field_set_temperature(int32_t index, double temperature) Set the temperature value of a given cell in the temperature field :param int32_t index: Index in the tempererature mesh :param double temperature: Temperature in Kelvin :return: Return status (negative if an error occurred) :rtype: int