2019-09-05 07:31:13 -05:00
|
|
|
------------------------------------------------------
|
|
|
|
|
:mod:`openmc.lib` -- Python bindings to the C/C++ API
|
|
|
|
|
------------------------------------------------------
|
2017-07-04 14:33:18 -05:00
|
|
|
|
2019-09-05 07:31:13 -05:00
|
|
|
.. automodule:: openmc.lib
|
2017-07-31 08:18:55 -05:00
|
|
|
|
|
|
|
|
Functions
|
|
|
|
|
---------
|
|
|
|
|
|
2017-07-17 07:58:35 -05:00
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: generated
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: myfunction.rst
|
|
|
|
|
|
2017-12-24 17:43:14 +07:00
|
|
|
calculate_volumes
|
2023-04-08 19:11:04 +02:00
|
|
|
current_batch
|
2022-01-11 08:18:47 -06:00
|
|
|
export_properties
|
2023-06-09 10:47:27 -05:00
|
|
|
export_weight_windows
|
2017-12-24 17:43:14 +07:00
|
|
|
finalize
|
|
|
|
|
find_cell
|
|
|
|
|
find_material
|
2025-01-07 22:50:02 +01:00
|
|
|
dagmc_universe_cell_ids
|
2023-04-08 19:11:04 +02:00
|
|
|
global_bounding_box
|
|
|
|
|
global_tallies
|
2017-12-24 17:43:14 +07:00
|
|
|
hard_reset
|
2023-04-08 19:11:04 +02:00
|
|
|
id_map
|
2022-01-11 08:18:47 -06:00
|
|
|
import_properties
|
2024-04-07 17:50:44 +01:00
|
|
|
import_weight_windows
|
2017-12-24 17:43:14 +07:00
|
|
|
init
|
2023-04-08 19:11:04 +02:00
|
|
|
is_statepoint_batch
|
2017-12-24 17:43:14 +07:00
|
|
|
iter_batches
|
|
|
|
|
keff
|
|
|
|
|
load_nuclide
|
2023-04-08 19:11:04 +02:00
|
|
|
master
|
2017-12-24 17:43:14 +07:00
|
|
|
next_batch
|
|
|
|
|
num_realizations
|
|
|
|
|
plot_geometry
|
2023-04-08 19:11:04 +02:00
|
|
|
property_map
|
2017-12-24 17:43:14 +07:00
|
|
|
reset
|
2023-04-08 19:11:04 +02:00
|
|
|
reset_timers
|
2017-12-24 17:43:14 +07:00
|
|
|
run
|
|
|
|
|
run_in_memory
|
2026-02-06 10:42:32 -06:00
|
|
|
run_random_ray
|
2022-07-15 13:23:07 -05:00
|
|
|
sample_external_source
|
2017-12-24 17:43:14 +07:00
|
|
|
simulation_finalize
|
2024-04-07 17:50:44 +01:00
|
|
|
simulation_init
|
2017-12-24 17:43:14 +07:00
|
|
|
source_bank
|
2024-04-24 17:09:56 -05:00
|
|
|
statepoint_load
|
2017-12-24 17:43:14 +07:00
|
|
|
statepoint_write
|
2017-07-31 08:18:55 -05:00
|
|
|
|
|
|
|
|
Classes
|
|
|
|
|
-------
|
2017-07-17 07:58:35 -05:00
|
|
|
|
2017-07-04 14:33:18 -05:00
|
|
|
.. autosummary::
|
|
|
|
|
:toctree: generated
|
|
|
|
|
:nosignatures:
|
|
|
|
|
:template: myclass.rst
|
|
|
|
|
|
2024-04-07 17:50:44 +01:00
|
|
|
AzimuthalFilter
|
2017-12-24 17:43:14 +07:00
|
|
|
Cell
|
2024-04-07 17:50:44 +01:00
|
|
|
CellFilter
|
|
|
|
|
CellInstanceFilter
|
|
|
|
|
CellbornFilter
|
|
|
|
|
CellfromFilter
|
|
|
|
|
CollisionFilter
|
2024-01-04 19:12:09 +00:00
|
|
|
CylindricalMesh
|
2024-04-07 17:50:44 +01:00
|
|
|
DelayedGroupFilter
|
|
|
|
|
DistribcellFilter
|
2017-12-24 17:43:14 +07:00
|
|
|
EnergyFilter
|
2024-04-07 17:50:44 +01:00
|
|
|
EnergyFunctionFilter
|
|
|
|
|
EnergyoutFilter
|
|
|
|
|
Filter
|
|
|
|
|
LegendreFilter
|
2017-12-24 17:43:14 +07:00
|
|
|
Material
|
2024-04-07 17:50:44 +01:00
|
|
|
MaterialFilter
|
|
|
|
|
MaterialFromFilter
|
|
|
|
|
Mesh
|
2018-04-01 07:50:14 -05:00
|
|
|
MeshFilter
|
2024-04-04 16:32:21 -05:00
|
|
|
MeshBornFilter
|
2018-04-01 07:50:14 -05:00
|
|
|
MeshSurfaceFilter
|
2024-04-07 17:50:44 +01:00
|
|
|
MuFilter
|
2017-12-24 17:43:14 +07:00
|
|
|
Nuclide
|
2025-02-21 11:47:38 -06:00
|
|
|
ParentNuclideFilter
|
2024-04-07 17:50:44 +01:00
|
|
|
ParticleFilter
|
2026-02-21 10:17:12 -06:00
|
|
|
ParticleProductionFilter
|
2024-04-07 17:50:44 +01:00
|
|
|
PolarFilter
|
2026-02-21 10:17:12 -06:00
|
|
|
ReactionFilter
|
2024-01-04 19:12:09 +00:00
|
|
|
RectilinearMesh
|
2019-06-14 11:07:11 -05:00
|
|
|
RegularMesh
|
2024-04-07 17:50:44 +01:00
|
|
|
SpatialLegendreFilter
|
|
|
|
|
SphericalHarmonicsFilter
|
2024-01-04 19:12:09 +00:00
|
|
|
SphericalMesh
|
2026-02-12 23:54:27 -06:00
|
|
|
SolidRayTracePlot
|
2024-04-07 17:50:44 +01:00
|
|
|
SurfaceFilter
|
2017-12-24 17:43:14 +07:00
|
|
|
Tally
|
2025-07-01 12:43:45 -05:00
|
|
|
TemporarySession
|
2024-04-07 17:50:44 +01:00
|
|
|
UniverseFilter
|
|
|
|
|
UnstructuredMesh
|
2025-05-05 16:33:12 -04:00
|
|
|
WeightFilter
|
2024-04-07 17:50:44 +01:00
|
|
|
WeightWindows
|
|
|
|
|
ZernikeFilter
|
|
|
|
|
ZernikeRadialFilter
|
|
|
|
|
|
|
|
|
|
Data
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
.. data:: cells
|
|
|
|
|
|
|
|
|
|
Mapping of cell ID to :class:`openmc.lib.Cell` instances.
|
|
|
|
|
|
|
|
|
|
:type: dict
|
|
|
|
|
|
|
|
|
|
.. data:: filters
|
|
|
|
|
|
|
|
|
|
Mapping of filter ID to :class:`openmc.lib.Filter` instances.
|
|
|
|
|
|
|
|
|
|
:type: dict
|
|
|
|
|
|
|
|
|
|
.. data:: materials
|
|
|
|
|
|
|
|
|
|
Mapping of material ID to :class:`openmc.lib.Material` instances.
|
|
|
|
|
|
|
|
|
|
:type: dict
|
|
|
|
|
|
|
|
|
|
.. data:: meshes
|
|
|
|
|
|
|
|
|
|
Mapping of mesh ID to :class:`openmc.lib.Mesh` instances.
|
|
|
|
|
|
|
|
|
|
:type: dict
|
|
|
|
|
|
2026-02-12 23:54:27 -06:00
|
|
|
.. data:: plots
|
|
|
|
|
|
|
|
|
|
Mapping of plot ID to :class:`openmc.lib.SolidRayTracePlot` instances.
|
|
|
|
|
|
|
|
|
|
:type: dict
|
|
|
|
|
|
2024-04-07 17:50:44 +01:00
|
|
|
.. data:: nuclides
|
|
|
|
|
|
|
|
|
|
Mapping of nuclide name to :class:`openmc.lib.Nuclide` instances.
|
|
|
|
|
|
|
|
|
|
:type: dict
|
|
|
|
|
|
|
|
|
|
.. data:: tallies
|
|
|
|
|
|
|
|
|
|
Mapping of tally ID to :class:`openmc.lib.Tally` instances.
|
|
|
|
|
|
|
|
|
|
:type: dict
|
|
|
|
|
|
|
|
|
|
.. data:: weight_windows
|
|
|
|
|
|
|
|
|
|
Mapping of weight window ID to :class:`openmc.lib.WeightWindows` instances.
|
|
|
|
|
|
|
|
|
|
:type: dict
|
