OpenSn User Guide (Draft)

• 1. Overview
• 2. Installation
• 3. OpenSn Basics
  • 3.1. The Core Model
  • 3.2. The Typical Workflow
  • 3.3. What Usually Goes Where
  • 3.4. The Three Most Important Practical Rules
  • 3.5. Good Default Habits
  • 3.6. What To Read Next
• 4. Geometry and Mesh
  • 4.1. Overview
  • 4.2. Mesh
  • 4.3. Mesh Generators
  • 4.4. Coordinate Systems
  • 4.5. Partitioning
  • 4.6. Replicated Meshes
  • 4.7. Block IDs
  • 4.8. Boundary Naming and Boundary IDs
  • 4.9. Logical Volumes
  • 4.10. Practical Mesh Workflows
  • 4.11. Inspecting and Exporting Meshes
  • 4.12. Practical Guidance
• 5. Materials and Cross-Section Data
  • 5.1. Overview
  • 5.2. Materials, Block IDs, and xs_map
  • 5.3. Creating a Simple One-Group Cross Section
  • 5.4. Inspecting a MultiGroupXS Object
  • 5.5. Loading OpenSn Cross-Section Files
  • 5.6. Loading OpenMC MGXS Files
  • 5.7. Loading CEPXS-BFP Files
  • 5.8. Custom Cross Sections
  • 5.9. Combining Cross Sections
  • 5.10. Scaling Cross Sections
  • 5.11. Choosing Between OpenSn and OpenMC Inputs
  • 5.12. Practical Example
  • 5.13. Cautions and Best Practices
• 6. Angular Quadratures
  • 6.1. Overview
  • 6.2. How to Choose a Quadrature
  • 6.3. Product Quadratures
  • 6.4. Selecting Enough Angular Resolution
  • 6.5. Angle Aggregation Compatibility
  • 6.6. Examples
  • 6.7. Inspecting a Quadrature
  • 6.8. Recommendations
• 7. Groupsets
  • 7.1. Overview
  • 7.2. What a Groupset Does
  • 7.3. Required Core Fields
  • 7.4. Writing a Minimal Groupset
  • 7.5. Common Optional Groupset Controls
  • 7.6. Single Groupset vs Multiple Groupsets
  • 7.7. Groupsets and AGS
  • 7.8. Example Patterns
  • 7.9. Practical Guidance
• 8. Iterative Methods
  • 8.1. Overview
  • 8.2. Where the Iteration Controls Live
  • 8.3. Inner Groupset Methods
  • 8.4. Convergence Controls
  • 8.5. Across-Groupset Iteration
  • 8.6. DSA Options
  • 8.7. Solver-Specific Outer Iteration
  • 8.8. Choosing a Method
  • 8.9. Examples
  • 8.10. Recommendations
• 9. CMFD Acceleration
  • 9.1. Basic Usage
  • 9.2. Common User Options
  • 9.3. Developer And Debug Options
  • 9.4. Multi-Groupset Behavior
  • 9.5. Diagnostics
  • 9.6. Correction Safeties And Warnings
  • 9.7. Supported Scope
  • 9.8. Limitations
• 10. Boundary Conditions and Sources
  • 10.1. Overview
  • 10.2. Boundary Conditions
  • 10.3. Point Sources
  • 10.4. Volumetric Sources
  • 10.5. Attaching Sources at Problem Construction
  • 10.6. Replacing Sources After Construction
  • 10.7. Transient Source and Boundary Behavior
  • 10.8. Boundary Names and Mesh Labels
  • 10.9. Normalization and Units
  • 10.10. Best Practices
• 11. Discrete-Ordinates Problems
  • 11.1. Overview
  • 11.2. Constructor Summary
  • 11.3. Constructor Inputs
  • 11.4. Shared LBS Interface
  • 11.5. Problem Options
  • 11.6. sweep_type
  • 11.7. Problem Modes
  • 11.8. Uncollided and First-Collision Transport
  • 11.9. Field-Function Interface
  • 11.10. Angular-Flux Access
  • 11.11. Balance and Leakage
  • 11.12. Writing and Reading Transport State
  • 11.13. Updating the Problem In Place
  • 11.14. DiscreteOrdinatesCurvilinearProblem
  • 11.15. Typical Construction Patterns
  • 11.16. Practical Guidance
• 12. CSDA Charged-Particle Transport
  • 12.1. Basic Workflow
  • 12.2. CEPXS CSDA Data
  • 12.3. Problem Requirements
  • 12.4. Derived Field Functions
  • 12.5. Balance Table Entries
  • 12.6. Within-Group DSA
  • 12.7. Convergence and Verification
• 13. preCICE Multiphysics Coupling
  • 13.1. Building
  • 13.2. Overview
  • 13.3. Step 1: Solve the transport problem
  • 13.4. Step 2: Create the energy-deposition field
  • 13.5. Step 3: Convert the field to watts
  • 13.6. Step 4: Describe the geometry
  • 13.7. Step 5: Remove finite-element undershoots (optional)
  • 13.8. Step 6: Write the preCICE configuration
  • 13.9. Step 7: Set up the receiving solver
  • 13.10. Step 8: Run and verify
  • 13.11. Complete examples
  • 13.12. Mapping behavior
  • 13.13. Troubleshooting
  • 13.14. API reference
• 14. Solvers
• 15. Overview
• 16. Validation and lifecycle
• 17. Base Classes
• 18. LBS Problem
• 19. Discrete Ordinates Problem
  • 19.1. Time-Dependent and Steady-State Modes
  • 19.2. Angular-Flux-Specific Features
  • 19.3. DiscreteOrdinatesCurvilinearProblem
• 20. Steady-State Source Solver
  • 20.1. Constructor
  • 20.2. GPU support
  • 20.3. How It Operates
  • 20.4. Adjoint Steady-State Solves
• 21. Transient Solver
  • 21.1. Supported problems
  • 21.2. Constructor
  • 21.3. Using Execute
  • 21.4. Using an Explicit Python Timestep Loop
  • 21.5. Balance Reporting
• 22. Power Iteration k-Eigen Solver
  • 22.1. Constructor
  • 22.2. GPU support
  • 22.3. How It Operates
  • 22.4. Flux normalization
• 23. Nonlinear k-Eigen Solver
  • 23.1. Constructor
  • 23.2. GPU support
  • 23.3. Groupsets and DSA
  • 23.4. Statuses and errors
• 24. Initialization Order and Common Patterns
• 25. Field Functions and Solver Output
• 26. Example Problems
  • 26.1. Common Input Structure
  • 26.2. Overview
  • 26.3. Common Building Blocks
  • 26.4. Example 1: Source-Driven Steady-State Problem
  • 26.5. Example 2: Multi-Material Fixed-Source Problem
  • 26.6. Example 3: Boundary-Driven Problem
  • 26.7. Example 4: Time-Dependent Source Problem
  • 26.8. Example 5: Explicit Python Time Loop
  • 26.9. Example 6: Power-Iteration k-Eigenvalue Problem
  • 26.10. Example 7: Nonlinear k-Eigenvalue Problem
  • 26.11. Example 8: Curvilinear Problem
  • 26.12. Example 9: Updating a Problem In Place
  • 26.13. Example 10: Field-Function Output
  • 26.14. Example 11: Balance and Leakage Checks
  • 26.15. Example 12: Reusing Flux Data
  • 26.16. Example 13: Writing and Reading Restart Dumps
  • 26.17. Example 14: Starting a Transient from a Steady-State Restart
  • 26.18. Choosing a Template
• 27. Post Processors
  • 27.1. Overview
  • 27.2. Updating Existing Field Functions
  • 27.3. Scalar Flux Field Functions
  • 27.4. Derived Field Functions
  • 27.5. Angular Flux Field Functions
  • 27.6. Exporting Field Functions
  • 27.7. Field-Function Interpolation
  • 27.8. Volume Postprocessor
  • 27.9. Cross-Section Sensitivity Postprocessor
  • 27.10. Other Useful Post-Processing Paths
  • 27.11. Transient Workflows
  • 27.12. Practical Guidance
• 28. Visualization
  • 28.1. Overview
  • 28.2. Visualizing the Mesh
  • 28.3. Visualizing Scalar Flux
  • 28.4. Visualizing Power
  • 28.5. Exporting Several Fields Together
  • 28.6. Transient Visualization
  • 28.7. Practical Advice
• 29. Running Problems
  • 29.1. Basic command-line usage
  • 29.2. Running under MPI
  • 29.3. Running with GPUs
  • 29.4. Typical execution pattern
  • 29.5. Inputs, logs, and outputs
  • 29.6. Restart and repeated solves
  • 29.7. Practical advice
• 30. Iterative Best Practices
  • 30.1. Overview
  • 30.2. Core Rules
  • 30.3. Upscatter Across Groupsets Must Be Converged
  • 30.4. Single Groupset First, Then Split Deliberately
  • 30.5. Choose the Inner Method Pragmatically
  • 30.6. Use DSA When the Physics Suggests It
  • 30.7. Watch Maximum Iteration Counts
  • 30.8. Be Careful with Nested Solver Expectations
  • 30.9. Transient Best Practices
  • 30.10. Eigenvalue Best Practices
  • 30.11. What to Check First When Convergence Looks Bad
  • 30.12. Recommended Starting Habits
• 31. Troubleshooting
  • 31.1. Start with the simplest question
  • 31.2. If the code fails immediately
  • 31.3. If the solution does not converge
  • 31.4. If the physics looks wrong
  • 31.5. If field functions are confusing
  • 31.6. If parallel behavior looks odd
  • 31.7. If imported cross sections behave unexpectedly
  • 31.8. General debugging workflow
  • 31.9. When to look elsewhere in the manual
• 32. FAQ
  • 32.1. Why is my problem split into a problem object and a solver object?
  • 32.2. Should I start with multiple groupsets?
  • 32.3. Why is my field function not updating?
  • 32.4. How do I get normalized power or XS-weighted outputs?
  • 32.5. When should I use Execute() and when should I use Advance()?
  • 32.6. What quadrature order should I use?
  • 32.7. Is single-angle aggregation always necessary when using unstructured meshes?
  • 32.8. What is the safest default sweep type?
  • 32.9. Do I need to export field functions during every run?