Sailfish Reference Manual

Release:2013.1 Date:March 14, 2013

Sailfish is a free computational fluid dynamics solver based on the Lattice Boltzmann method and optimized for modern multi-core systems, especially GPUs (Graphics Processing Units).

Want to see Sailfish in action? Check out our videos on YouTube, or better yet, get the code and see for yourself by running the provided examples.

Contents

• Motivation and Design Principles
• Supported features and models
  • Boundary conditions
• Installation
  • Downloading Sailfish
  • Gentoo installation instructions
  • Ubuntu installation instructions
  • Mac OS X installation instructions (Mac Ports)
• Tutorial
  • Running simulations
    • The program outline
    • How it works behind the scenes
    • Using the command-line arguments
    • Troubleshooting
  • Setting up simulations
    • Understanding node addressing
    • Boundary conditions
    • Initial conditions
    • Body forces
    • Estimating memory usage
    • Mapping physical quantities to simulation parameters
  • Simulation results processing
    • Data output
    • Data visualization
  • Distributed simulations on a cluster
    • Using direct SSH connections
    • Using a PBS cluster
    • Using a LSF cluster
    • Using InfiniBand
• Performance Tuning
  • General tuning strategies
    • Adjusting the block size
    • Limiting register usage
    • Using fast math functions
  • NVIDIA Fermi cards
    • Block size
  • Performance comparison for different devices
    • Single precision
    • Double precision
  • Performance impact of the block size (single precision)
    • GeForce GTX 285
    • Tesla C1060
    • Tesla C2050
  • Performance impact of the block size (double precision)
    • GeForce GTX 285
    • Tesla C1060
    • Tesla C2050
• Sailfish internals
  • Architecture overview
    • Simulation definition
    • Simulation execution
  • From the command line to a running simulation
  • Distributed execution
  • Inside a simulation
  • Template overview and conventions
  • Specifying configuration options
• Examples and test cases
  • 2D examples
    • Lid-driven cavity
    • Poiseuille flow
    • Flow around a cylinder
  • 3D examples
    • Poiseuille flow
    • Flow around a sphere
• Sailfish API
  • Simulation models
    • lb_base
    • lb_single
    • lb_binary
  • Geometry
    • geo
    • subdomain
    • node_type
  • Symbolic computation
    • sym
  • Internals
    • backend_cuda
    • subdomain_runner
    • codegen
    • config
    • connector
    • controller
    • geo_encoder
    • master
    • util
  • Visualization
    • vis
    • vis_2d
• About
  • Development team
  • How to help?
  • License
  • Acknowledgements
• Release notes
  • 2013.1 (in progress)
  • 2012.2
  • 2012.1
• Media files
  • Posters
  • Presentations

Indices and tables

• Index
• Module Index
• Search Page

Demo video