nekRS
20.1
  • Quickstart
    • Build Instructions
    • Setting the Environment
    • Run the Code
    • Documentation
    • Discussion Group
    • Contributing
    • Reporting Bugs
    • License
    • Citing
    • Acknowledgment
  • User 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)
        • RANS models
      • Low-Mach Compressible Model
      • Custom Source Terms
        • Momentum Equation
        • 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
  • Tutorials
    • Fully Developed Laminar Flow
      • Before You Begin
      • Mesh Generation
      • Control parameters
      • User-Defined Host Functions File (.udf)
        • Loading parameters
        • Boundary and initial conditions
      • Running the case
      • Post-processing the results
    • Periodic Hill
      • Before You Begin
      • Mesh generation
      • User Defined Functions file (.udf)
        • Modify mesh
        • Initial & boundary conditions
      • Control parameters
      • Compilation and running
      • Post-processing the results
    • Conjugate Heat Transfer
    • Overlapping Overset Grids
    • RANS Channel
      • Before You Begin
      • Mesh and Boundary Conditions
      • Control Parameters (.par file)
      • User Routines (.usr file)
      • SIZE file
      • Compilation
      • Results
    • Multi-Component RANS
  • Developer guide
    • Doxygen
    • Contributing
    • nekRS Documentation
      • How to build locally
        • Dependencies
        • Building
      • How to contribute
  • Theory
    • Incompressible Flow
      • Non-Dimensional Navier-Stokes
    • Stokes Flow
    • Energy Equation
      • Non-Dimensional Energy / Passive Scalar Equation
    • Low-Mach Compressible Flow
      • Low-Mach Equations with Ideal Gas Assumption
    • RANS Models
  • Other Resources
  • Glossary
  • References
nekRS
  • Developer guide
  • View page source

Developer guide

  • Doxygen
  • Contributing
  • nekRS Documentation
    • How to build locally
    • How to contribute
Previous Next

© Copyright 2019-2025, UCHICAGO ARGONNE, LLC.

Built with Sphinx using a theme provided by Read the Docs.