Eddylicious

Eddylicious is a python library for generating inflow boundary fields for scale-resolving simulations of turbulent flow.

The goal of eddylicious is to serve as a central place-holder for existing inflow generation methods and make them easily accessible to the CFD community.

Here, all the documentation for the library is collected. This includes a user guide and tutorials, a guide for developers, and source code documentation.

Table of Contents

• User guide
  • Legal information
  • Introduction
  • Installing the package
    • Dependencies
    • Installing from git
  • Common notation
  • Inflow generation methods
    • Using the generators
    • Lund’s rescaling
      • Theory
      • Usage and practical information
    • Interpolation
      • Theory
      • Usage and practical information
  • Supported input formats
    • The foamFile format
    • The HDF5 format
  • Supported output formats
    • The HDF5 file format
    • OpenFOAM native format
  • Utilities
    • inflowStats
    • precursorStats
    • convertFoamFileToHDF5
  • Workflow guidelines
    • Using eddylicious with OpenFOAM
      • Specifying the geometry of the inlet
      • Reading the inflow fields from OpenFOAM
• Tutorials
  • Channel flow in OpenFOAM using Lund’s rescaling
    • Introduction
    • Overview of the set-up
    • The precursor simulation
    • The main simulation
• Developer guide
  • Contributing
  • Code and documentation style
• Source code reference
  • Readers
  • Writers
  • Generators
• List of references