Home

CN-Stream

CN-Stream is a library for the computation of nonlinear regular ocean waves. The library is developped in order to be easily integrated with wave generation models in CFD solvers. It is based on the stream function theory and provides significant improvements regarding the applicability of the method for waves close to breaking (in deep or shallow water) compared to the classical implementation of Rienecker and Fenton. It has been developed at Ecole Centrale de Nantes for several years and is used in different research projects.

This wiki details the procedure to download and use CN-Stream as well as the documentation of the current installation.

Overview

CN-Stream can be compiled as an executable file for the study of specific wave problems with inputs and dedicated outputs to be detailed in the following sections. It can also be used as a static library, which can easily be linked to other numerical models in the objective of, for instance, solve the problem of wave-structure interactions.

Reference

Any publication or report using CN-Stream have to refer to the corresponding publications

• Ducrozet G., Bouscasse B., Gouin, M., Ferrant P. and Bonnefoy F.: CN-Stream: Open-source library for nonlinear regular waves using stream function theory. submitted to Comp. Phys. Comm., 2019; doi:xxx

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Main points one has to remind about this license:

• CN-Stream is a free software. This means:
  • the freedom to use it for any purpose,
  • the freedom to change it to suit your needs,
  • the freedom to share it with your friends and neighbors, and
  • the freedom to share the changes you make.
• GPL license uses concept of copyleft
  • CN-Stream stay a free software, no matter who changes or distributes the program
  • if you release a modified version to the public in some way, the GPL requires you to make the modified source code available to the program's users, under the GPL.
  • if you want to include CN-Stream in your program and distribute it, your program must also be free software (with GPL or compatible license).
• CN-Stream may be released under another license for specific commercial softwares. Contact us for details

Download

Download of latest release version is available here.

Developers are welcome to contribute, cloning is available from the main GitHub page for CN-Stream: here.