crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-25 20:45:35 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

added missing functions and classes to openmc.lib docs (#2847)

Browse source 
Co-authored-by: Paul Romano <paul.k.romano@gmail.com>
This commit is contained in:
Jonathan Shimwell 2024-04-07 17:50:44 +01:00 • committed by GitHub
parent 704cfbf1af
commit db3b6f3e9e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 84 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

76
docs/source/pythonapi/capi.rst
View file

@ -16,7 +16,6 @@ Functions
current_batch
export_properties
export_weight_windows
import_weight_windows
finalize
find_cell
find_material
@ -25,6 +24,7 @@ Functions
hard_reset
id_map
import_properties
import_weight_windows
init
is_statepoint_batch
iter_batches
@ -40,8 +40,8 @@ Functions
run
run_in_memory
sample_external_source
simulation_init
simulation_finalize
simulation_init
source_bank
statepoint_write
@ -53,16 +53,86 @@ Classes
:nosignatures:
:template: myclass.rst
AzimuthalFilter
Cell
CellFilter
CellInstanceFilter
CellbornFilter
CellfromFilter
CollisionFilter
CylindricalMesh
DelayedGroupFilter
DistribcellFilter
EnergyFilter
MaterialFilter
EnergyFunctionFilter
EnergyoutFilter
Filter
LegendreFilter
Material
MaterialFilter
MaterialFromFilter
Mesh
MeshFilter
MeshBornFilter
MeshSurfaceFilter
MuFilter
Nuclide
ParticleFilter
PolarFilter
RectilinearMesh
RegularMesh
SpatialLegendreFilter
SphericalHarmonicsFilter
SphericalMesh
SurfaceFilter
Tally
UniverseFilter
UnstructuredMesh
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
.. 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