User Guide

• Getting Started
  • Accessing Rayleigh
  • Setting up a Rayleigh Development Environment
  • Installing Rayleigh
  • Installation on HPC systems
  • Verifying Your Installation
  • Available Benchmarks
• Underlying Physics
  • Notation and Conventions
  • The System of Equations Solved in Rayleigh
  • The Streamfunction Formulation
  • The Pseudospectral Approach
  • Parallelization and Performance
• Setting Up a Model
  • Preparation
  • Grid Setup
  • Numerical Controls
  • Physics Controls
  • Initial Conditions
  • Custom Reference States
  • Boundary Conditions & Internal Heating
  • Output Controls
  • Transport coefficents
  • Examples from Recent Publications
• Running Rayleigh
  • Load-Balancing
  • Checkpointing
  • Controlling Run Length & Time Stepping
  • The Log File
  • I/O Control
  • Run Termination
• Running at Scale
  • Getting Ready for Large Runs
  • Modules and Queues
  • Example Configurations
  • Sample Jobscripts
  • Ensemble Mode
• Analyzing Output
  • The Lookup Table (LUT)
  • Plotting Examples
  • 3-D Visualization with VAPOR
  • Common Diagnostics
• Contributing to Rayleigh
  • Getting started with git and GitHub
  • Asking and answering questions about Rayleigh
  • Bug reports
  • Making Rayleigh better
  • Acknowledgment of contributions
  • License
• Troubleshooting
  • Compiling Errors
  • Segmentation Fault Crashes
  • Timestep Crashes
  • Numerical Ringing
• References
• Utilities
  • Spectral Input
• Under Development
  • Arbitrary Scalar Fields
  • Newtonian Cooling
  • Coupled Boundary Conditions
  • Pseudo-Incompressibility