User Docs

Here you will learn how to use ARMI. It will cover getting and installing ARMI and its prerequisites, making ARMI input files, running various kinds of ARMI runs, analyzing ARMI output files, etc.

---

• 1. Inputs
  • 1.1. YAML Files
  • 1.2. The Settings Input File
    • 1.2.1. The ARMI GUI
      • 1.2.1.1. The assembly clicker
      • 1.2.1.2. The ARMI Environment Tab
    • 1.2.2. Some special settings
      • 1.2.2.1. Detail assemblies
      • 1.2.2.2. Kinetics settings
      • 1.2.2.3. Cycle history
      • 1.2.2.4. Restart cases
      • 1.2.2.5. Shuffling
      • 1.2.2.6. Zones
  • 1.3. The Blueprints Input File
    • 1.3.1. Blueprint sections
    • 1.3.2. Blocks and Components
      • 1.3.2.1. Defining a Component
      • 1.3.2.2. Component Types
      • 1.3.2.3. Component Links
      • 1.3.2.4. Pin lattices
    • 1.3.3. Flags and naming
    • 1.3.4. Assemblies
    • 1.3.5. Systems
      • 1.3.5.1. Plugin Behavior
    • 1.3.6. Grids
      • 1.3.6.1. Lattice Maps
        • 1.3.6.1.1. Full-Core Cartesian Examples
        • 1.3.6.1.2. Full-Core Hexagonal Examples
        • 1.3.6.1.3. Placeholders and Whitespace
        • 1.3.6.1.4. Two-Ring, Third-Core Hex Maps
        • 1.3.6.1.5. Three-Ring, Third-Core Hex Maps
        • 1.3.6.1.6. Four-Ring, Third-Core Hex Maps
        • 1.3.6.1.7. Five-Ring, Third-Core Hex Maps
        • 1.3.6.1.8. Six-Ring, Third-Core Hex Maps
        • 1.3.6.1.9. Seven-Ring, Third-Core Hex Maps
        • 1.3.6.1.10. Eight-Ring, Third-Core Hex Maps
        • 1.3.6.1.11. Nine-Ring, Third-Core Hex Maps
        • 1.3.6.1.12. Ten-Ring, Third-Core Hex Maps
        • 1.3.6.1.13. Eleven-Ring, Third-Core Hex Maps
    • 1.3.7. Custom Isotopics
    • 1.3.8. Advanced topics
      • 1.3.8.1. Overlapping shapes
      • 1.3.8.2. Component area modifications
      • 1.3.8.3. Putting it all together to make a Block
      • 1.3.8.4. Making blocks with unshaped components
    • 1.3.9. Nuclide Flags
  • 1.4. The Materials Input File
    • 1.4.1. File Format
    • 1.4.2. Material Type
    • 1.4.3. Composition
    • 1.4.4. Properties
    • 1.4.5. Tabulated Data
    • 1.4.6. Functions
    • 1.4.7. Symbolic
    • 1.4.8. Table
    • 1.4.9. Piecewise
    • 1.4.10. Two Dimensional Table
    • 1.4.11. Troubleshooting
  • 1.5. Fuel Management Input
    • 1.5.1. Fuel Management Operations
      • 1.5.1.1. swapAssemblies
      • 1.5.1.2. dischargeSwap
      • 1.5.1.3. swapCascade
    • 1.5.2. Choosing Assemblies to Move
    • 1.5.3. Fuel Management Examples
      • 1.5.3.1. Convergent-Divergent
    • 1.5.4. Fuel Management Tips
    • 1.5.5. Running a branch search
• 2. Outputs
  • 2.1. The Standard Output
  • 2.2. The Database File
    • 2.2.1. Loading Reactor State
    • 2.2.2. Extracting Reactor History
    • 2.2.3. Extracting Settings and Blueprints
    • 2.2.4. File format
    • 2.2.5. Database Structure
    • 2.2.6. Loading Reactor State as Read-Only
• 3. Settings Report
• 4. Parameters Report
  • 4.1. Reactor Parameters
  • 4.2. Core Parameters
  • 4.3. Assembly Parameters
  • 4.4. Block Parameters
  • 4.5. Component Parameters
• 5. Accessing Data in ARMI
  • 5.1. Settings and State Variables
  • 5.2. Accessing Some Interesting Info
• 6. Spatial Block Data
  • 6.1. Sub-block spatial grid
    • 6.1.1. Blueprints
    • 6.1.2. Auto grid
  • 6.2. Interacting with spatial data
    • 6.2.1. Component locations
  • 6.3. Pins
    • 6.3.1. Finding Pins in an ARMI Model
    • 6.3.2. Pin locations
    • 6.3.3. Pin parameter data
  • 6.4. Block rotation
    • 6.4.1. Spatial locators
    • 6.4.2. Pin parameters
    • 6.4.3. Corners and edges
    • 6.4.4. Other rotated parameters
  • 6.5. Assembly Shuffling
• 7. Physics Coupling
  • 7.1. Loose Coupling
  • 7.2. Tight Coupling
    • 7.2.1. Eigenvalue
    • 7.2.2. Block-wise Power
    • 7.2.3. The Global Flux Interface
• 8. Radial and Axial Expansion and Contraction
  • 8.1. Thermal Expansion
  • 8.2. Implementation Discussion and Example of Radial and Axial Thermal Expansion
    • 8.2.1. Component-to-Component Axial Linking
      • 8.2.1.1. Limitations
    • 8.2.2. Target Component Logic
    • 8.2.3. Mass Conservation
      • 8.2.3.1. Block-Level Mass Redistribution
    • 8.2.4. Component temperature update
    • 8.2.5. Component parameter updates
      • 8.2.5.1. Pin and detailed number densities
      • 8.2.5.2. BOL heavy metal
    • 8.2.6. Warnings and Runtime Error Messages
      • 8.2.6.1. Mass Redistribution Between Like Materials
      • 8.2.6.2. Post-Redistribution Temperature Search Failure
      • 8.2.6.3. Negative Block or Component Heights
      • 8.2.6.4. Inconsistent Component and Block Heights
• 9. Symmetry Handling
  • 9.1. Introduction
  • 9.2. Symmetry-Aware Operations
  • 9.3. Parameters Adjusted With Symmetry