Skip to content

Commit 15bbd9b

Browse files
committed
Document the new C-API functions.
1 parent 8e41a2a commit 15bbd9b

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/source/capi/index.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,17 @@ Functions
8484
:return: Return status (negative if an error occurred)
8585
:rtype: int
8686
87+
.. c:function:: int openmc_cell_get_density_mult(int32_t index, const int32_t* instance, double* rho)
88+
89+
Get the unitless density multiplier of a cell
90+
91+
:param int32_t index: Index in the cells array
92+
:param int32_t* instance: Which instance of the cell. If a null pointer is passed, the density
93+
multiplier of the first instance is returned.
94+
:param double* rho: temperature of the cell
95+
:return: Return status (negative if an error occurred)
96+
:rtype: int
97+
8798
.. c:function:: int openmc_cell_set_fill(int32_t index, int type, int32_t n, const int32_t* indices)
8899
89100
Set the fill for a cell
@@ -119,6 +130,20 @@ Functions
119130
:return: Return status (negative if an error occurred)
120131
:rtype: int
121132
133+
.. c:function:: int openmc_cell_set_density_mult(index index, double rho, const int32_t* instance, bool set_contained)
134+
135+
Set the unitless density multiplier of a cell.
136+
137+
:param int32_t index: Index in the cells array
138+
:param double rho: Unitless density multiplier
139+
:param instance: Which instance of the cell. To set the density multiplier for all
140+
instances, pass a null pointer.
141+
:param set_contained: If the cell is not filled by a material, whether to set the density multiplier
142+
of all filled cells
143+
:type instance: const int32_t*
144+
:return: Return status (negative if an error occurred)
145+
:rtype: int
146+
122147
.. c:function:: int openmc_energy_filter_get_bins(int32_t index, double** energies, int32_t* n)
123148
124149
Return the bounding energies for an energy filter

0 commit comments

Comments
 (0)