Program documentation

Note

This documentation is fully based on the new XML input format. Important information about porting legacy input files comflow.in to the new XML-based input format comflow.cfi is given in Chapter 27.

Hint

The documentation is categorized by program functionality. In order to get more information about a specific XML key or attribute in the input file, use the search function of the documentation pages. For example, to learn more about the XML attribute numerical/linear_solver/@solver_choice, search for solver_choice.

Table of contents

• 1. Introduction
  • 1.1. The ComFLOW projects
  • 1.2. Contents of this manual
• 2. Mathematics and numerics
  • 2.1. Mathematical model for 1-phase flow
  • 2.2. Mathematical model for 2-phase flow
  • 2.3. Numerical Model
• 3. Installation and first-time use
  • 3.1. Installation on Linux
  • 3.2. Installation on Windows
  • 3.3. Installing the pre- & post-processor
  • 3.4. Performing a test run
  • 3.5. The different parts of ComFLOW
• 4. Command line options
  • 4.1. The executables
  • 4.2. Python wrapper and ComFLOW batch files
  • 4.3. Paths and file names
  • 4.4. ComFLOW command Prompt (Windows only)
• 5. Domain and geometry definition
  • 5.1. Domain definition
  • 5.2. Geometry definition
  • 5.3. Building the geometry (outdated)
  • 5.4. Visualizing the geometry
  • 5.5. Examples
• 6. Moving reference frame
  • 6.1. Virtual body force
  • 6.2. Regular motions
  • 6.3. Irregular motions
  • 6.4. Interactively moving objects
  • 6.5. Getting started
• 7. Setup of the computational grid
  • 7.1. Defining the Cartesian reference grid
  • 7.2. Building a locally refined grid
  • 7.3. Guidelines
  • 7.4. Examples
  • 7.5. Analyzing or debugging the local refinement setup
• 8. The momentum equations
  • 8.1. Convection
  • 8.2. Diffusion
  • 8.3. Turbulence modeling
  • 8.4. External forces
• 9. Fluid displacement
  • 9.1. SLIC-VOF
  • 9.2. PLIC-VOF/-MOF
  • 9.3. Correction method
• 10. Wave modeling
  • 10.1. Built-in wave models
  • 10.2. Background current
  • 10.3. Initial conditions and ramping functions
  • 10.4. Guidelines for simulation setup
• 11. Boundary conditions
  • 11.1. Domain boundary conditions
  • 11.2. Domain extensions
  • 11.3. Definition of a numerical beach
  • 11.4. Partial-slip condition
• 12. Moving objects
  • 12.1. Getting started
  • 12.2. Conventions and notations
  • 12.3. Prescribed motions
  • 12.4. Interactive body motion
  • 12.5. Output files
  • 12.6. The INI input format
• 13. Modeling mooring lines (XMF)
  • 13.1. The XMF library
  • 13.2. Examples
• 14. Two-phase flow
  • 14.1. General
  • 14.2. Fluid properties
  • 14.3. Surface tension
• 15. Initial conditions
  • 15.1. Initial liquid distribution
  • 15.2. Initial velocity field
• 16. Time integration
  • 16.1. Numerical schemes
  • 16.2. Manual and automatic time step control
  • 16.3. Example
• 17. Linear solver
  • 17.1. Stopping criterion
  • 17.2. The ILU preconditioner
  • 17.3. The SOR search algorithm
  • 17.4. Recommended settings
  • 17.5. Diagnostics
• 18. Parallelization options
  • 18.1. OpenMP parallelization
  • 18.2. MPI parallelization
• 19. Simulation output
  • 19.1. Print output
  • 19.2. Snapshot file series
  • 19.3. Monitoring output
  • 19.4. Relative water height lines
  • 19.5. Boxes
  • 19.6. Particle paths
  • 19.7. HDF5 field data (special boxes)
  • 19.8. Various output
• 20. Paraview visualization
  • 20.1. Paraview plugins
• 21. Python scripts and modules
  • 21.1. Prerequisites
  • 21.2. ComFLOW Python classes
• 22. Restarting a simulation
  • 22.1. Example
• 23. Guidelines for simulation setup
  • 23.1. Grid resolution and grid stretching
  • 23.2. Time integration and numerical stability
• 24. ComFLOW as static library
  • 24.1. Getting started
  • 24.2. Available subroutines
  • 24.3. An example
• 25. Plugins for initial and boundary conditions
  • 25.1. Getting started
  • 25.2. Prebuilt plug-ins
  • 25.3. Creating a custom plug-in
• 26. ComFLOW XML format specification
  • 26.1. Getting started
  • 26.2. Time intervals
  • 26.3. Documentation of all XML statements
• 27. Porting legacy input to XML
• 28. File formats
  • 28.1. Restart files and legacy snapshot files
  • 28.2. HDF5 field data
  • 28.3. Monitor surfaces
  • 28.4. VTK snapshot files (*.vtu)
  • 28.5. HDF5 matrix files (*.csr)

Indices and tables

• Index
• Module Index
• Search Page