Skip to main content
Ctrl+K

BOUT++ 5.2.0 documentation

Getting started

  • Introduction
  • Quickstart Guide
  • Getting started
  • Advanced installation options
  • Running BOUT++
  • New Features in BOUT++ v5.0

BOUT++ models

  • BOUT++ physics models
  • Makefiles and compiling BOUT++
  • Variable initialisation
  • Boundary conditions
  • Testing
  • GPU support
  • ADIOS2 support

Model inputs

  • BOUT++ options
  • Generating input grids

Model outputs

  • Post-processing
  • The python boutpp module

BOUT++ interfaces

  • Time integration
  • Parallel Transforms
  • Laplacian inversion
  • Differential operators
  • Algebraic operators
  • Staggered grids
  • Eigenvalue solver
  • Nonlocal heat flux models
  • Invertable operators
  • PETSc solvers

Field-aligned coordinate systems

  • Field-aligned coordinates
  • BOUT++ preconditioning
  • Geometry and Differential Operator

Topology Handling

  • BOUT++ Topology
  • Supported Topologies

Developer Documentation

  • Contributing to BOUT++
  • Git crash course
  • Code layout
  • Arrays, scalar and vector field types
  • PETSc interface
  • Mesh
  • File I/O
  • Debugging Models
  • Natural Language Support
  • Performance profiling
  • API reference
    • BOUT++ functions (alphabetical)
    • Python routines
    • boutdata package
    • boutpp package
    • boututils package
    • zoidberg package
  • Repository
  • Suggest edit
  • Open issue
  • .rst

API reference

API reference#

BOUT++ routines

  • BOUT++ functions (alphabetical)

Python routines

  • Python routines
  • boutdata package
  • boutpp package
  • boututils package
  • zoidberg package

previous

Performance profiling

next

BOUT++ functions (alphabetical)

By B. Dudson and The BOUT++ team

© Copyright 2017-2023, B. Dudson and The BOUT++ team.