Skip to content

Latest commit

 

History

History
270 lines (217 loc) · 5.43 KB

base.rst

File metadata and controls

270 lines (217 loc) · 5.43 KB

openmc -- Basic Functionality

Handling nuclear data

openmc.XSdata openmc.MGXSLibrary

Simulation Settings

openmc.SourceBase openmc.IndependentSource openmc.FileSource openmc.CompiledSource openmc.MeshSource openmc.SourceParticle openmc.VolumeCalculation openmc.Settings

openmc.read_source_file openmc.write_source_file openmc.wwinp_to_wws

Material Specification

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.XTorus openmc.YTorus openmc.ZTorus openmc.Halfspace openmc.Intersection openmc.Union openmc.Complement openmc.BoundingBox openmc.Cell openmc.Universe openmc.DAGMCUniverse 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.MaterialFromFilter openmc.CellFilter openmc.CellFromFilter openmc.CellBornFilter openmc.CellInstanceFilter openmc.CollisionFilter openmc.SurfaceFilter openmc.MeshFilter openmc.MeshBornFilter 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.TimeFilter openmc.ZernikeFilter openmc.ZernikeRadialFilter openmc.ParticleFilter openmc.RegularMesh openmc.RectilinearMesh openmc.CylindricalMesh openmc.SphericalMesh openmc.UnstructuredMesh openmc.Trigger openmc.TallyDerivative openmc.Tally openmc.Tallies

Geometry Plotting

openmc.Plot openmc.ProjectionPlot openmc.Plots

Running OpenMC

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

Post-processing

openmc.Particle openmc.ParticleTrack openmc.StatePoint openmc.Summary openmc.Track openmc.Tracks

openmc.voxel_to_vtk

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

Variance Reduction

openmc.WeightWindows openmc.WeightWindowGenerator openmc.hdf5_to_wws

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.