Palabos documentation

Save trees! The Palabos documentation is frequently updated. Viewing it online avoids paper-wasting printouts and always gets you the most recent version.

Contents:

• Introduction
  • What is Palabos?
  • Functionality covered by Palabos
  • Authors
  • Getting help
• Getting started with Palabos
  • Supported Compilers
  • Installing and compiling the code under Linux and other Unix-like systems
  • Compilation under alternative operating systems
  • Open-source libraries which are bundled with Palabos
  • Recommended open-source software
  • The examples directory
• The Palabos-Python interface
  • Compiling the Python interface
  • Example: Compiling the Python interface under Ubuntu Linux
• Programming with Palabos
  • Quick overview: programming guidelines
  • Non-intrusive program development with Palabos
• Fundamental data types
  • The BlockXD data structures
  • Lattice descriptors
  • The dynamics classes
  • Data processors
• Implemented fluid models
  • Non-thermal Navier-Stokes equations
  • Thermal flows with Boussinesq approximation
  • Multi-component and multi-phase fluids
  • Large eddy simulations
  • Non-Newtonian fluids
• Setting up a problem
  • Attributing dynamics objects
  • Initial values of density and velocity
• Defining boundary conditions
  • Overview
  • Grid-aligned boundaries
  • Periodic boundaries
  • Bounce-back
  • Domain creation from an STL file
• Running a simulation
  • Time cycles of an Palabos program
  • At which point do you evaluate data?
  • Other important things to do
• Input/Output
  • Output streams: writing to the terminal and into files
  • Input streams: reading large data sets from files
  • Accessing command-line parameters
  • Reading user input from an XML file
  • Producing images in 2D and 3D simulations
  • VTK output for post-processing
  • Checkpointing: saving and loading the state of a simulation
• Data evaluation
  • Overview
  • Pipelining data evaluation operators
• Grid refinement
  • Overview
  • Multi-layer grid refinement
• Parallelism
  • Parallel programming approach
  • Controlling the efficiency
• Data processors for non-local operations and couplings between blocks
  • Using helper functions to avoid explicitly writing data processors
  • Convenience wrappers for local operations
  • Writing data processors (or actually, data-processing functionals)
• Utilities
  • Timer
  • Value tracer
• Appendix: list of example programs
  • Directory examples/showCases
  • Directory examples/codesByTopic
• Appendix: partial function/class reference
  • Mutable (in-place) operations for simulation setup and other purposes
  • Non-mutable operations for data analysis and other purposes
• Appendix: Copyright and license agreements
  • Copyright of the Palabos user guide
  • Copyright and open-source license for Palabos
  • GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007