Skip to content

Latest commit

 

History

History
222 lines (177 loc) · 4.52 KB

base.rst

File metadata and controls

222 lines (177 loc) · 4.52 KB

openmc -- Basic Functionality

Handling nuclear data

openmc.XSdata openmc.MGXSLibrary

Simulation Settings

openmc.Source openmc.VolumeCalculation openmc.Settings

Material Specification

openmc.Nuclide openmc.Element openmc.Macroscopic openmc.Material openmc.Materials

Cross sections for nuclides, elements, and materials can be plotted using the following function:

openmc.plot_xs

Building geometry

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:

openmc.Surface openmc.Region openmc.Lattice

Constructing Tallies

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

openmc.Plot openmc.Plots

Running OpenMC

openmc.run openmc.calculate_volumes openmc.plot_geometry openmc.plot_inline openmc.search_for_keff

Post-processing

openmc.Particle openmc.StatePoint openmc.Summary

The following classes and functions are used for functional expansion reconstruction.

openmc.ZernikeRadial

openmc.legendre_from_expcoef

Various classes may be created when performing tally slicing and/or arithmetic:

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 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 openmc.cmfd module is not imported by default with the openmc namespace and needs to be imported explicitly.

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 openmc.cmfd.CMFDRun.run.