Python API

Math

Spherical harmonics

math.Ylm

Compute the tesseral spherical harmonics.

Point

math.Vector3

General 3-element vector structure.

Function wrappers

Note

This API is temporary. It will no longer required once ParameterBlock is removed.

`math.Function`	Function base class.
`math.ScalarMaterialFunction`	Scalar material function.
`math.ScalarSpatialFunction`	Scalar spatial function.
`math.ScalarSpatialMaterialFunction`	Scalar spatial material function.
`math.VectorSpatialFunction`	Vector spatial function.

Angular quadrature

Base class

aquad.AngularQuadrature

Angular quadrature.

Product quadratures

`aquad.ProductQuadrature`	Product quadrature.
`aquad.CurvilinearQuadrature`	Curvilinear quadrature.

`aquad.GLProductQuadrature1DSlab`	Gauss-Legendre quadrature for 1D, slab geometry.
`aquad.GLCProductQuadrature2DXY`	Gauss-Legendre-Chebyshev quadrature for 2D, XY geometry.
`aquad.GLCProductQuadrature3DXYZ`	Gauss-Legendre-Chebyshev quadrature for 3D, XYZ geometry.

aquad.GLCProductQuadrature2DRZ

Gauss-Legendre-Chebyshev quadrature for 2D, RZ geometry.

Simplified LDFES quadrature

aquad.SLDFESQuadrature

Piecewise-linear finite element quadrature using quadrilaterals.

Field functions

Base class

fieldfunc.FieldFunction

Field function.

Grid-based

fieldfunc.FieldFunctionGridBased

Field function grid based.

Interpolation

`fieldfunc.FieldFunctionInterpolationPoint`	Line based interpolation function.
`fieldfunc.FieldFunctionInterpolationLine`	Line based interpolation function.
`fieldfunc.FieldFunctionInterpolationVolume`	A line based interpolation function.

Mesh

mesh.MeshContinuum

Mesh continuum.

Surface mesh

mesh.SurfaceMesh

Surface mesh.

Mesh generator

mesh.MeshGenerator

Generic mesh generator.

`mesh.ExtruderMeshGenerator`	Extruded mesh generator.
`mesh.OrthogonalMeshGenerator`	Orthogonal mesh generator.
`mesh.FromFileMeshGenerator`	From file mesh generator.
`mesh.SplitFileMeshGenerator`	Split file mesh generator.
`mesh.DistributedMeshGenerator`	Distributed mesh generator.

Graph partitioner

mesh.GraphPartitioner

Generic graph partitioner.

`mesh.KBAGraphPartitioner`	Koch, Baker and Alcouffe based partitioning.
`mesh.LinearGraphPartitioner`	Basic linear partitioning.
`mesh.PETScGraphPartitioner`	PETSc based partitioning.

Logical volume

Base class

logvol.LogicalVolume

Generic logical volume.

Logical volume types

`logvol.BooleanLogicalVolume`	Boolean logical volume.
`logvol.RCCLogicalVolume`	Right circular cylinder logical volume.
`logvol.RPPLogicalVolume`	Rectangular parallel piped logical volume.
`logvol.SphereLogicalVolume`	Spherical logical volume.
`logvol.SurfaceMeshLogicalVolume`	Surface mesh logical volume.

Response evaluator

response.ResponseEvaluator

Response evaluator by folding sources against adjoint solutions.

Source

`source.PointSource`	Point sources, defined by its location and a group-wise strength vector.
`source.VolumetricSource`	Multi-group isotropic volumetric sources.

Cross section

xs.MultiGroupXS

Multi-group cross section.

Solver

Base class

solver.Solver

Base class for all solvers.

Linear Boltzmann solver

solver.LBSProblem

Base class for all Linear Boltzmann solvers.

`solver.DiscreteOrdinatesProblem`	Base class for discrete ordinates solvers.
`solver.DiscreteOrdinatesCurvilinearProblem`	A neutral particle transport solver in point-symmetric and axial-symmetric curvilinear coordinates.

Steady state solver

solver.SteadyStateSolver

Non-linear k-eigen

solver.NonLinearKEigenSolver

Power iteration solver

`solver.PowerIterationKEigenSolver`
`solver.PowerIterationKEigenSCDSASolver`
`solver.PowerIterationKEigenSMMSolver`

Point kinetic trnasient solver

solver.PRKSolver

General transient solver for point kinetics.

Diffusion solver

diffusion.DiffusionSolverBase

Base class for diffusion solvers.

`diffusion.CFEMDiffusionSolver`	CFEM diffusion solver.
`diffusion.DFEMDiffusionSolver`	DFEM diffusion solver.

Post-processors

Base class

post.PostProcessor

Base class for all post-processors.

Post-processor

`post.SolverInfoPostProcessor`	Post-processor for basic info of a Solver.
`post.AggregateNodalValuePostProcessor`	Aggregator for nodal values.
`post.CellVolumeIntegralPostProcessor`	Compute the volumetric integral of a field-function.

Printer

`post.Print`	Print a list of post-processors.
`post.SetPrinterOptions`	Set printer options.

Settings

Logs

`context.SetVerbosityLevel`	Set verbosity level (0 to 3).
`context.UseColor`	Enable/disable color output.
`context.EnablePETScErrorHandler`	Allow PETSc error handler.

Caliper configuration

`context.SetCaliperConfig`	Set configuration to the Caliper manager.
`context.EnableCaliper`	Start the Caliper manager and mark the program begin.

Argument vector

`context.InitializeWithArgv`	Overwrite OpenSn settings using `sys.argv`.
`context.Finalize`	Finalize OpenSn context.