User guide

This section explains the basic structure and functionality of nekRS from a user perspective (I.E. what will be applicable to most people using nekRS). If you wish to view information relevant to developing nekRS and contributing changes please look at the Developer guide.

• Introduction
  • Solving in Dimensional vs Non-Dimensional Form
    • Adapting to nekRS
    • Constant Properties
    • Variable Properties
  • Compute Backend Abstraction (OCCA)
  • Data Structures
    • Platform
    • Mesh
    • Flow Solution Fields and Simulation Settings
    • Passive Scalar Solution Fields and Simulation Settings
• Installing
  • Requirements
  • Acquiring the code
  • Set NEKRS_HOME
  • Cmake compilation
    • CMake flags
  • Building the Nek5000 Tool Scripts
• Meshing
  • Using Nek5000 Meshing Tools
    • genbox
    • reatore2
  • Using gmsh2nek
  • Using exo2nek
  • Conjugate Heat Transfer
  • TET-TO-HEX
  • Sidesets and applying boundary conditions
  • Mesh-related data structures
  • Mesh modification in NekRS
  • Miscellaneous Tips
• Boundary conditions
  • Available Types
    • User Defined Value/Gradient
    • Internal / Periodic
  • Turbulent Inflow
    • Velocity Recycling
• Initial conditions
  • Restart
• Models and Source Terms
  • Turbulence models
    • Large Eddy Simulation (LES)
      • High pass filter relaxation
    • RANS models
  • Low-Mach Compressible Model
  • Custom Source Terms
    • Momentum Equation
      • Implicit Linearized Momentum Source
    • Scalar Equations
• Physical properties
  • Constant
  • Variable
• Postprocessing
  • Checkpointing & Visualization
  • Compute Derived Quantity
  • Adding Custom Checkpoint Fields
  • Adding Custom Output File
  • Run time averaging
• Case files
  • Parameter File (.par)
  • Mesh File (.re2)
  • User-Defined Host File (.udf)
    • OKL block
    • UDF_Setup0
    • UDF_Setup
    • UDF_ExecuteStep
  • Trigger Files (.upd)
• Running
  • Native Running
  • MPI launch scripts
  • Queueing system
• Debugging Tips
  • Just-in-time Compilation