adding back files to be reviewed

2026-07-25 12:35:29 -04:00 · 2019-10-28 11:55:45 -05:00 · 2019-10-28 11:55:45 -05:00 · bc09d1ef55
commit bc09d1ef55
parent ae28233110
1244 changed files with 301904 additions and 0 deletions
--- a/docs/source/pythonapi/base.rst
+++ b/docs/source/pythonapi/base.rst
@ -0,0 +1,222 @@
+------------------------------------
+:mod:`openmc` -- Basic Functionality
+------------------------------------
+
+Handling nuclear data
+---------------------
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myclass.rst
+
+   openmc.XSdata
+   openmc.MGXSLibrary
+
+Simulation Settings
+-------------------
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myclass.rst
+
+   openmc.Source
+   openmc.VolumeCalculation
+   openmc.Settings
+
+Material Specification
+----------------------
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myclass.rst
+
+   openmc.Nuclide
+   openmc.Element
+   openmc.Macroscopic
+   openmc.Material
+   openmc.Materials
+
+Cross sections for nuclides, elements, and materials can be plotted using the
+following function:
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myfunction.rst
+
+   openmc.plot_xs
+
+Building geometry
+-----------------
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myclass.rst
+
+   openmc.Plane
+   openmc.XPlane
+   openmc.YPlane
+   openmc.ZPlane
+   openmc.XCylinder
+   openmc.YCylinder
+   openmc.ZCylinder
+   openmc.Sphere
+   openmc.Cone
+   openmc.XCone
+   openmc.YCone
+   openmc.ZCone
+   openmc.Quadric
+   openmc.Halfspace
+   openmc.Intersection
+   openmc.Union
+   openmc.Complement
+   openmc.Cell
+   openmc.Universe
+   openmc.RectLattice
+   openmc.HexLattice
+   openmc.Geometry
+
+Many of the above classes are derived from several abstract classes:
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myclass.rst
+
+   openmc.Surface
+   openmc.Region
+   openmc.Lattice
+
+.. _pythonapi_tallies:
+
+Constructing Tallies
+--------------------
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myclass.rst
+
+   openmc.Filter
+   openmc.UniverseFilter
+   openmc.MaterialFilter
+   openmc.CellFilter
+   openmc.CellFromFilter
+   openmc.CellbornFilter
+   openmc.SurfaceFilter
+   openmc.MeshFilter
+   openmc.MeshSurfaceFilter
+   openmc.EnergyFilter
+   openmc.EnergyoutFilter
+   openmc.MuFilter
+   openmc.PolarFilter
+   openmc.AzimuthalFilter
+   openmc.DistribcellFilter
+   openmc.DelayedGroupFilter
+   openmc.EnergyFunctionFilter
+   openmc.LegendreFilter
+   openmc.SpatialLegendreFilter
+   openmc.SphericalHarmonicsFilter
+   openmc.ZernikeFilter
+   openmc.ZernikeRadialFilter
+   openmc.ParticleFilter
+   openmc.RegularMesh
+   openmc.RectilinearMesh
+   openmc.Trigger
+   openmc.TallyDerivative
+   openmc.Tally
+   openmc.Tallies
+
+Geometry Plotting
+-----------------
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myclass.rst
+
+   openmc.Plot
+   openmc.Plots
+
+Running OpenMC
+--------------
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myfunction.rst
+
+   openmc.run
+   openmc.calculate_volumes
+   openmc.plot_geometry
+   openmc.plot_inline
+   openmc.search_for_keff
+
+Post-processing
+---------------
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myclass.rst
+
+   openmc.Particle
+   openmc.StatePoint
+   openmc.Summary
+
+The following classes and functions are used for functional expansion reconstruction.
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myclass.rst
+
+   openmc.ZernikeRadial
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myfunction.rst
+
+   openmc.legendre_from_expcoef
+
+
+Various classes may be created when performing tally slicing and/or arithmetic:
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myclass.rst
+
+   openmc.arithmetic.CrossScore
+   openmc.arithmetic.CrossNuclide
+   openmc.arithmetic.CrossFilter
+   openmc.arithmetic.AggregateScore
+   openmc.arithmetic.AggregateNuclide
+   openmc.arithmetic.AggregateFilter
+
+Coarse Mesh Finite Difference Acceleration
+------------------------------------------
+
+CMFD is implemented in OpenMC and allows users to accelerate fission source
+convergence during inactive neutron batches. To use CMFD, the
+:class:`openmc.cmfd.CMFDRun` class executes OpenMC through the C API, solving
+the CMFD system between fission generations and modifying the source weights.
+Note that the :mod:`openmc.cmfd` module is not imported by default with the
+:mod:`openmc` namespace and needs to be imported explicitly.
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+   :template: myclass.rst
+
+   openmc.cmfd.CMFDMesh
+   openmc.cmfd.CMFDRun
+
+At the minimum, a CMFD mesh needs to be specified in order to run CMFD. Once the
+mesh and other optional properties are set, a simulation can be run with CMFD
+turned on using :meth:`openmc.cmfd.CMFDRun.run`.