CFDwavemaker User Manual

Purpose

CFDwavemaker is a C++ library developed with the purpose of providing wave kinematics input to CFD codes. Kinematics may either be generated at the boundary (similar to a traditional wave maker) or used to initialize the entire domain before startup of the simulation (or both), as illustrated in the figure below. What distinguishes CFDwavemaker from other similar codes is its capablility of generating irregular short crested waves with several hundreds of frequency components using second order potential wave theory in a numerically efficient way.

Reference

The code is open source and free to use by anyone. If you find the code useful and decide to used it in projects or publications, make sure to reference to

@inproceedings{landeCFDwavemaker,
   title={CFDWAVEMAKER: An open-source library for efficient generation of higher order wave kinematics},
   author={Lande, Oystein and Helmers, Jens Bloch},
   booktitle={International Conference on Offshore Mechanics and Arctic Engineering},
   volume={57656},
   pages={V03AT02A029},
   year={2022},
   organization={American Society of Mechanical Engineers}
}

Table of Contents:

• 1. Download
  • 1.1. Linux/UNIX
• 2. Build from source
  • 2.1. Build in Linux/Unix
    • 2.1.1. Dependencies
    • 2.1.2. Building the VTK library for linking with CFDwavemaker
    • 2.1.3. Other commands
  • 2.2. Build in Windows
• 3. Linking to your software
  • 3.1. General
  • 3.2. Linking with C/C++
  • 3.3. Linking up with Python
  • 3.4. Linking up with ComFLOW
  • 3.5. Linking up with Basilisk (or C)
    • 3.5.1. Static linking
    • 3.5.2. Dynamic linking
  • 3.6. Linking up with OpenFOAM
• 4. Input file format
  • 4.1. Version
  • 4.2. Wave types
  • 4.3. General input data
  • 4.4. Wave reference point
  • 4.5. Ramps
  • 4.6. Irregular wave specification
    • 4.6.1. Second order wave theory
  • 4.7. Stokes regular wave specification
  • 4.8. Wavemaker theory wave specification
    • 4.8.1. Piston wavemaker theory
  • 4.9. Spectral wave data (SWD) specification
  • 4.10. VTK kinematics reader
  • 4.11. Grid interpolation schemes
    • 4.11.1. Lagrangian-Stretched grid interpolation (LSgrid)
  • 4.12. Output
    • 4.12.1. VTK
    • 4.12.2. Time-series
    • 4.12.3. Spectral data
  • 4.13. Tips & tricks
• 5. Example of usage
  • 5.1. Irregular wave examples
    • 5.1.1. Long-crested irregular focus wave group
    • 5.1.2. Short-crested irregular focused wave
    • 5.1.3. Short-crested irregular random wave
  • 5.2. Regular wave examples
    • 5.2.1. Stokes 5th order regular wave
  • 5.3. Spectral-Wave-Data (swd) example
    • 5.3.1. Example 1: SWD wave1
• 6. Definitions
  • 6.1. Coordinate system
  • 6.2. Phase Definition
• 7. Wave theories
  • 7.1. Irregular wave theory
    • 7.1.1. Linear potential wave theory
    • 7.1.2. Second order potential wave theory
  • 7.2. Regular wave theory
    • 7.2.1. Stokes 5th order wave
  • 7.3. Wave maker theory
    • 7.3.1. Piston wavemaker theory
• 8. Todo-list
  • 8.1. Task completed
  • 8.2. Ideas rejected (or posponed)
• 9. License
• 10. References