mirror of
https://github.com/openmc-dev/openmc.git
synced 2026-07-28 14:15:42 -04:00
added missing functions and classes to openmc.lib docs (#2847)
Co-authored-by: Paul Romano <paul.k.romano@gmail.com>
This commit is contained in:
parent
704cfbf1af
commit
db3b6f3e9e
3 changed files with 84 additions and 10 deletions
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -188,9 +188,9 @@ class CrossFilter:
|
|||
|
||||
Parameters
|
||||
----------
|
||||
left_filter : Filter or CrossFilter
|
||||
left_filter : openmc.Filter or CrossFilter
|
||||
The left filter in the outer product
|
||||
right_filter : Filter or CrossFilter
|
||||
right_filter : openmc.Filter or CrossFilter
|
||||
The right filter in the outer product
|
||||
binary_op : str
|
||||
The tally arithmetic binary operator (e.g., '+', '-', etc.) used to
|
||||
|
|
@ -200,9 +200,9 @@ class CrossFilter:
|
|||
----------
|
||||
type : str
|
||||
The type of the crossfilter (e.g., 'energy / energy')
|
||||
left_filter : Filter or CrossFilter
|
||||
left_filter : openmc.Filter or CrossFilter
|
||||
The left filter in the outer product
|
||||
right_filter : Filter or CrossFilter
|
||||
right_filter : openmc.Filter or CrossFilter
|
||||
The right filter in the outer product
|
||||
binary_op : str
|
||||
The tally arithmetic binary operator (e.g., '+', '-', etc.) used to
|
||||
|
|
@ -517,7 +517,7 @@ class AggregateFilter:
|
|||
|
||||
Parameters
|
||||
----------
|
||||
aggregate_filter : Filter or CrossFilter
|
||||
aggregate_filter : openmc.Filter or CrossFilter
|
||||
The filter included in the aggregation
|
||||
bins : Iterable of tuple
|
||||
The filter bins included in the aggregation
|
||||
|
|
@ -529,7 +529,7 @@ class AggregateFilter:
|
|||
----------
|
||||
type : str
|
||||
The type of the aggregatefilter (e.g., 'sum(energy)', 'sum(cell)')
|
||||
aggregate_filter : filter
|
||||
aggregate_filter : openmc.Filter
|
||||
The filter included in the aggregation
|
||||
aggregate_op : str
|
||||
The tally aggregation operator (e.g., 'sum', 'avg', etc.) used
|
||||
|
|
|
|||
|
|
@ -15,7 +15,10 @@ from .error import _error_handler
|
|||
from .material import Material
|
||||
from .plot import _Position
|
||||
|
||||
__all__ = ['RegularMesh', 'RectilinearMesh', 'CylindricalMesh', 'SphericalMesh', 'UnstructuredMesh', 'meshes']
|
||||
__all__ = [
|
||||
'Mesh', 'RegularMesh', 'RectilinearMesh', 'CylindricalMesh',
|
||||
'SphericalMesh', 'UnstructuredMesh', 'meshes'
|
||||
]
|
||||
|
||||
|
||||
class _MaterialVolume(Structure):
|
||||
|
|
@ -553,6 +556,7 @@ class CylindricalMesh(Mesh):
|
|||
_dll.openmc_cylindrical_mesh_set_grid(self._index, r_grid, nr, phi_grid,
|
||||
nphi, z_grid, nz)
|
||||
|
||||
|
||||
class SphericalMesh(Mesh):
|
||||
"""SphericalMesh stored internally.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue