Difference between revisions of "Contrib/waves2Foam"

From OpenFOAMWiki
Line 9: Line 9:
== waves2Foam ==
== waves2Foam - Information ==
The package is to be used in the modelling of free surface water waves. The package contains the following:
* One library <tt>libwaves2Foam</tt>. See description below.
* Solver(s) to be used with 1.5 and 1.6+ (see below in section "Compatibility"). The foundation in the solvers is interFoam, where the relaxationZone part of <tt>libwaves2Foam</tt> has been added to the solver.
* Preprocessing tools used to:
** <tt>setWaveParameters</tt>: Sets the wave parameters for a given wave theory based on a set of input variables. E.g. for Airy wave theory, the period, water depth, and magnitude of the gravitational acceleration produces the wave number. The utility goes through all sub-dictionaries in <tt>waveProperties</tt> file, see below.
** <tt>setWaveField</tt>: This utility sets initial conditions in the files <tt>U</tt> and <tt>gamma</tt> (v. 1.5)/<tt>alpha1</tt> (v. 1.6 and more recent) based on a runTime selectable wave theory.
** <tt>relaxationZoneLayout</tt>: Produces an overview of the spatial layout of the relaxation zone.
* Tutorials
* Since <tt>setWaveParameters</tt> is not working for all wave theories, a set of Matlab&reg; functions are provided for the missing wave theories (Currently: stream function waves and cnoidal first waves).
=== Supported Versions of OF ===
<b>NB:</b> The code is <b>only</b> compatible with OpenFoam version 1.5 up to and including svn-revision number 1950.
<b>NB:</b> The code is also compilable this the version 2.0 of OpenFoam, however, the solvers are not distributed along with the SVN-repository. Nevertheless, minor changes are needed in order to modify interFoam to get it to work; see below.
<b>NB:</b> The code might be compatible with the version OF-1.6-ext, OF-1.7 and OF-1.7.1 and OF2.0, but this is no longer tested as of svn revision 2072.
<b>NB:</b> Note that the sampling library does not work in OpenFoam-4.0.0.
Please report on successful applications of the toolbox.
==== Miscellaneous on Cross-Version Compatibility ====
The toolbox has been tested successfully with the following releases of OpenFoam:
* 1.5.x (up to revision 1950)
* 1.5-dev (up to revision 1950)
* 1.6.x (Notice, that the release solves for total pressure, and the pressure boundary condition is given in excess pressure. It ought not change anything, however, it has not been tested)
* 1.6-ext
* 1.7.1
* 2.0.x
* 2.1.x
* 2.2.0
Throughout the code, pre-processor statements are used based on the argument <tt>OFVERSION</tt>, which is given as
if [ `uname` == "Darwin" ]
    version=`echo $WM_PROJECT_VERSION"-0" | sed -s 's/\.x/-0/' -e 's/\./\'$'\n/g' -e 's/-/\'$'\n/g' | grep "[0-9]" | head -3 | tr -d '\n'`
    version=`echo $WM_PROJECT_VERSION"-0" | sed -e 's/\.x/-0/' -e 's/\./\n/g' -e 's/-/\n/g' | grep "[0-9]" | head -3 | tr -d '\n'`
# Version number for the OpenFoam-v1606+ version numbering (no dots, etc)
flag=`echo $WM_PROJECT_VERSION | grep "^v[0-9]*+"`
if [ -n "$flag" ]
    if [ `uname` = "Darwin" ]
        version=`echo $WM_PROJECT_VERSION | sed -e 's/[v+-]/\'$'\n/g' | tr -d '\n'`
        version=`echo $WM_PROJECT_VERSION | sed -e 's/[v+-]/\n/g' | tr -d '\n'`
which strips anything but the first three digits from <tt>$WM_PROJECT_VERSION</tt> (and in case it only contains 2, it is zero-padded). This also take into account that the scripting arguments are different on Linux and Darwin. Also note, that the <tt>OFVERSION</tt> is used to distinguish between options-files for the compilation, since the needed number of include-statements differs, as a result of a restructuring of the code as of OpenFoam version 2.2.
Furthermore, a pre-processor flag called <tt>EXTBRANCH</tt> is introduced in the more recent versions. This is introduced to take differences in class names between the two branches into account.
=== Referencing ===
Whenever used please do make proper referencing to the following journal paper:
@article { jacobsenFuhrmanFredsoe2011,
Author = {Jacobsen, N G and Fuhrman, D R and Freds\o{}e, J},
title = {{ A Wave Generation Toolbox for the Open-Source CFD Library: OpenFoam\textregistered{} } },
Journal = {{ Int. J. Numerl. Meth. Fluids} },
Year = {2012},
Volume = {70},
Number = {9},
Pages = {1073-1088},
DOI = {{10.1002/fld.2726} },
The paper has now been published.
=== Ideas / Improvements / Suggestions / Contributions ===
If you have any ideas on how to improve this toolbox, or if you have developed pieces of code/functionalities, which you think would fit nicely into the framework, then please do not hesitate contacting me, e.g. via the cfd-online forum, where my user name is <i>ngj</i>.
==== Report Bugs via the Mantis on Sourceforge ====
==== Report Bugs via the Mantis on Sourceforge ====
Line 99: Line 20:
=== Discussions on cfd-online.com ===
=== Discussions on cfd-online.com ===
There are two main threads on cfd-online.com, which are related to waves2Foam.
There are two main threads on cfd-online.com, which are related to waves2Foam.
For announcements please consider
For announcements please consider
[http://www.cfd-online.com/Forums/openfoam-news-announcements-other/94251-release-wave-generation-absorption-toolbox.html]. Note that questions will generally not be answered here. It is a source of communication on development/release topics.
[http://www.cfd-online.com/Forums/openfoam-news-announcements-other/94251-release-wave-generation-absorption-toolbox.html]. Note that questions will generally not be answered here. It is a source of communication on development/release topics.
For enquiries, discussion, etc., please use
For enquiries, discussion, etc., please use
=== Also Used in These Works ===
* Bredmose, H. and Jacobsen, N. G. (2010). Breaking Wave Impacts on Offshore Wind Turbine Foundations: Focused Wave Groups and CFD. <i>Proceedings of the 29th ASME International Conference on Ocean, Offshore and Arctic Engineering</i>, Shanghai, China, <b>3</b>, 397-404
* Bredmose, H. and Jacobsen, N. G. (2011). Vertical wave impacts on offshore wind turbine inspection platforms. <i>Proceedings of the 30th ASME International Conference on Ocean, Offshore and Arctic Engineering</i>, Rotterdam, The Netherlands (on CD)
* Gadelho, J.H.M., Lavrov, A. and Guedes Soares, C. (2014). Modelling the effect of obstacles on 2D wave propagation with OpenFOAM. Developments in Maritime Transportation and Exploitation of Sea Ressources, 1057-1065.
* Jacobsen, N. G. (2011). A Full Hydro- and Morphodynamic Description of Breaker Bar Development. <i>Ph.D. Thesis</i>. DCAMM Special Report no. S136, Technical University of Denmark, Deparment of Mechanical Engineering. Available at [http://orbit.dtu.dk/getResource?recordId=313371&objectId=2&versionId=1]
* Jacobsen, N. G. and Fredsoe, J. (In print). Cross-Shore Re-Distribution of Nourished Sand Near a Breaker Bar. <i>J. of Waterway, Port, Coastal and Ocean Engineering - ASCE</i>, --, --
* Jacobsen, N. G. and Fredsøe, J (2011). A Full Hydrodynamic Modelling of 2D Breaker Bar Development. <i>Proceedings to Coastal Sediments</i>, Miami, Florida, U.S.A.
* Jensen, B., Jacobsen, N.G., Christensen, E.D. (2014). Investigation on the porous media equations and resistance coefficients for coastal structure. <i>Coastal Engineering</i>, <b>84</b>, 56-72.
* Li, L, Tan, M. and Blake, J. (2012). OpenFoam Simulation of Regular Wave and Wave Load on Cylinder. <i>15th Numerical Towing Tank Symposium</i>, 7th-9th of October 2012, Cortona, Italy
* Paulsen, B. T., Bredmose, H. and Bingham, H. B. (2012). Accurate computation of wave loads on a bottom fixed circular cylinder. <i>International Workshop on Water Waves and Floating Bodies</i>, Copenhagen, Denmark (http://www.iwwwfb.org)
* Paulsen, B. T., Bredmose, H. and Bingham, H. B. (2013). Focused Wave Impact on a Vertical Cylinder: Experiment, Numerical Reproduction and a Note on Higher Harmonics. <i>International Workshop on Water Waves and Floating Bodies</i>, Marsaille, France (http://www.iwwwfb.org)
* Piro, D. J. and Maki, K. J. (2013). Whipping Response of a Box Barge in Oblique Seas. <i>International Workshop on Water Waves and Floating Bodies</i>, Marsaille, France (http://www.iwwwfb.org)
* Ransley, E., Hann, M., Greaves, D., Raby, A. and Simmonds, D. (2013).Numerical and physical modelling of extreme waves at Wave Hub. In: Conley, D.C., Masselink, G., Russell, P.E. and O'Hare, T.J. (eds), <i>Proceedings 12th International Coastal Symposium</i> (Plymouth, England), <i>Journal of Coastal Research</i>, Special Issue No. 65, 1645-1650
* Stahlmann, A. and Schlurmann, T. (2012). Investigations of Scour Development at Tripod Foundations for Offshore Wind Turbines: Modeling and Application. <i>Proceedings of the International Conference on Coastal Engineering</i>, Santander, Spain (http://journals.tdl.org/icce)
* Vyzikas, T., Ransley, E., Hann, M., Magagna, D., Greaves, D., Simmonds, D., Magar, V. and Conley, D. (2013). Integrated Numerical Modelling System for Extreme Wave Events at the Wave Hub Site. <i>Inst. of Civil Engineers Conference: Coasts, Marine Structures and Breakwaters</i>, Edinburgh, September 2013.
* Winden, B., Turnock, S. R. and Hudson, D. (2012). Validating Force Calculations using OpenFoam on a Fixed Wigley Hull in Waves. <i>15th Numerical Towing Tank Symposium</i>, 7th-9th of October 2012, Cortona, Italy
== Distributed Library ==
== Distributed Library ==

Revision as of 18:38, 17 August 2017

The library waves2Foam is a toolbox used to generate and absorb free surface water waves. Currently the method applies the relaxation zone technique (active sponge layers) and a large range of wave theories are supported and the relaxation zones can take arbitrary shapes.

Release of the waves2Foam Manual

As of the 17th of August 2017, the waves2Foam Manual is released. Consequently, the content of this Wiki-page is reduced.

It is still possible to find download/installation instructions and information on the code contributions.


1 waves2Foam - Information

1.1 Report Bugs via the Mantis on Sourceforge

Please report bugs (not compilation errors, unless they are bugs) here:


There is a subsection for waves2Foam. This will make it easier to keep track of issues, which needs attention.

1.2 Discussions on cfd-online.com

There are two main threads on cfd-online.com, which are related to waves2Foam.

For announcements please consider [1]. Note that questions will generally not be answered here. It is a source of communication on development/release topics. For enquiries, discussion, etc., please use [2].

2 Distributed Library

2.1 Overview of Content

Schematics of the code structure in the library

The library libwaves2Foam contains the following functionality:

  • A namespace called waveTheories, where the abstract base class, waveTheory, defines the interface for the implementation of free surface water waves. At present the interface requires the definition of the velocity, the surface elevation, and the surface normal pressure gradient (the last only used on the boundaries). It is optional to implement the actual pressure. The set of wave theories presently available is given below.
It is extremely simple to extend the number of implemented wave theories, as long as the needed algebraic expressions are available.
  • An abstract base class called setWaveProperties. From this a definition file to each of the wave theories is implemented. These are addressed from the utility setWaveParameters, which sets the needed wave parameters for each wave theory based on a minimum of input parameters. See below.
  • A relaxation framework around the class relaxationZone, where combinations of relaxation techniques and the shape of relaxation zones can be chosen. See details below.
  • convexPolyhedral This set of files carries out intersection routines between faces/convex polyhedrals and the water surface given in terms of e.g. an algebraic equation such as \eta=a\sin (\omega t - \mathbf{k}\cdot\mathbf{x}), where \eta is the water surface elevation, a is the wave amplitude, \omega is the cyclic frequency, t is time, \mathbf{k} is the horizontal wave number vector, and \mathbf{x} is a spatial coordinate. It should be noted that the intersection routine is not implemented in convexPolyhedral, but rather the relaxation zones and boundary conditions is derived from this class, and the virtual methods for the distance function is implemented. These again are based a pointer, namely autoPtr<waveTheories::waveTheory>, hence there is a decoupling of the relaxation zone techniques/boundary conditions and the actual wave theory used in the simulation.
  • Furthermore, available trough this library is:
    • Boundary conditions for the velocity, the void fraction ratio and the pressure gradient (the last is not fully implemented in all wave theories)
    • A class for setting initial conditions
    • A class which is used for either runTime or post-processing of the surface elevation

2.2 Available Wave Theories

A set of different wave theories are implemented in waves2Foam. Besides stating the required wave type in the waveProperties.input file, each wave theory have different additional required information, such as wave height, wave period, water depth, etc. The detailed information are gather here:

Wave Theories and Specifications.

The following wave theories are implemented to date:

  • Current type
    • Potential current
  • Regular waves
    • Stokes first order theory
    • Stokes first order theory (standing)
    • Stokes second order theory
    • Modulated stokes second order theory
    • Stokes fifth order theory
    • First order cnoidal theory
    • Stream function wave theory
  • Solitary waves
    • Solitary first
  • Irregular waves
    • First order bichromatic wave (wave group)
    • Second order bichromatic wave
    • First order irregular super-position
  • Other
    • Mixed boundary

2.3 Relaxation Techniques

Relaxation techniques generally cover the method of removing reflected or internally generated wave components adjacent to vertical boundaries. One method is currently fully functioning and the framework have been made ready for another type. Both of these are a part of the overall relaxation framework, which is implemented into relaxationZone. The latter is the one implemented into the solvers to add the relaxation functionalities.

The relaxation zones are updated each and every time step in case a topological change has found place. It is updated based on mesh.changing(). The relaxation weight is recomputed each time step to accommodate for small changes in the cell position originating from mesh motion. Big mesh motions are not recommended inside the relaxation zones.

The relaxation methods are:

2.3.1 Explicit Relaxation

The explicit relaxation techniques is performed before the momentum equation is solved in the following manner:

\mathbf{u} = (1-w)\mathbf{u}_{target}+w\mathbf{u}_{computed}

\alpha = (1-w)\alpha_{target}+w\alpha_{computed}

where w\in[0,\,1] is a weigthing function. One particular method is implemented, however, everything is done with runTime-selection, so it should be rather easy to make another method and test it.


void relaxationZone::correct()

2.3.2 Numerical Beach

The numerical beach considers the addition of an artificial viscosity into the momentum equation.

A framework has been made ready with runTime selection, however, presently only a dummy-beach is implemented, which does not alter the artificial viscosity from the default value of 0.0. The numerical beach has direct access to the local distance function, \sigma, in the relaxation zone, thus it ought to be straight forward to implement a given method.


tmp<volScalarField> relaxationZone::numericalBeach()

2.3.3 Relaxation Weights

Several relaxation weights are implemented into the current framework, where all of them can also be subject to a correction, which make the weight dependent on the local Courant number (see below). Exponential Weight (Default)

The exponential weight is given as [1]

w = 1 - \frac{\exp(\sigma^{p})-1}{\exp(1) - 1}

where the exponent p\in\mathcal{R}_+. Default value is 3.5. Free Polynomial Weight

The free polynomial weight is given as [2]

\quad{}w = 1 - \sigma^{p}

where p\in\mathcal{N}. There is no default value. Third Order Polynomial Weight

The third order polynomial weight is given as [2]

w = -2 \tilde{\sigma}^3 + 3 \tilde{\sigma}^2

where \tilde{\sigma} = 1 - \sigma. This shape is particularly derived to be used for relaxation zones, which are both generating and absorption waves. Additional Temporal correction

The temporal correction is that of Sopheak Seng et al.[3], and is based on the local Courant number, Co, where the corrected weight, \tilde{w} is given as

\tilde{w}=1 - (1 - w^*)^{Co/Co_{max}}

where w^* = 1 - w.

2.3.4 Relaxation Shapes

Relaxation shapes defines the shape and relaxation direction of the relaxation zone. The available shapes and their input format are Rectangular
    relaxationShape Rectangular;

    relaxType   INLET;
    startX      (90 90 0);
    endX        (100 100 0);
    orientation (0 1 0);

Generates a rectangular relaxation zone, which primary axis in the plane is along orientation. If the target solution is wanted in startX, then relaxType should read INLET. If the target solution is wanted in endX, then relaxType should read OUTLET. It holds for the inner product (\mathbf{x}_{end}-\mathbf{x}_{start})\boldsymbol{\cdot}\mathbf{e}_{orientation}>0. Cylindrical
    relaxationShape Cylindrical;
    centre   (70 70 0);
    rInner   15;
    rOuter   25;

Generates a cylindrical relaxation zone, where the target solution is enforced along the outer radii. SemiCylindrical
    relaxationShape SemiCylindrical;
    centre             (30 30 0);
    rInner             5;
    rOuter             25;
    zeroAngleDirection (1 0 0);
    angleStart         45;
    angleEnd           220;

Generates a semi-cylindrical relaxation zone, where the target solution is enforced along the outer radii. In addition the user needs to specify the direction of primary axis in the unit circle, zeroAngleDirection. The two angles, angleStart and angleEnd, must be in the interval [-180^\circ,\,+180^\circ].

3 Applications

3.1 waveFoam

waveFoam is based on the original implementation of interFoam. Modifications are made to make it possible to use the relaxation zone framework with the solver.

3.2 waveFoam - How to Modify interFoam

NB! The guide is somewhat outdated, but the general idea is the same. The differences are in how to modify the options-file. Please consult existing solvers for inspiration. NB!

For more recent versions of OpenFoam, the toolbox is not straightforward applicable, as the user (for the time being), needs to create waveFoam him-/herself from interFoam. Here are the necessary steps:

  • Copy the files, which belong to interFoam into a new folder. E.g. disregard all files related to the derived multiphase solvers. Rename interFoam.C to waveFoam.C
  • Add the following line in waveFoam.C
#include "relaxationZone.H"
  • Inside main in waveFoam.C add the following two lines just below #include "initContinuityErrs.H" and above createFields.H
#include "readGravitationalAcceleration.H"
#include "readWaveProperties.H"
  • After the line in waveFoam.C stating #include "alphaEqnSubCycle.H" add
  • Furthermore in createFields.H, one should delete the line stating
#include "readGravitationalAcceleration.H"
  • And add the following at the very bottom
relaxationZone relaxing(mesh, U, alpha1);
  • The output should be placed in FOAM_USER_APPBIN, so modify Make/files so it reads

  • In order to make it compilable one should add the following in Make/options under EXE_INC:
-DOFVERSION=<Replace brackets with the first three digits in the OF-version number> \

If the version number only contain 2 digits, then add a third digit being 0.

  • and similar below the EXE_LIBS part:
  • Do remember to add the necessary "\" in Make/options for it to read the additional lines.

3.3 waveDyMFoam - How to couple waves2Foam with dynamic mesh motion

NB! The guide is somewhat outdated, but the general idea is the same. The differences are in how to modify the options-file. Please consult existing solvers for inspiration. NB!

Step-by-step guide about how to couple the CFD ToolBox waves2Foam with dynamic mesh motion

1. Copy the folder of solver interDyMFoam in the wave2Foam solver folder for version which you use, for example, for version 1.7.1:

cp -r $WM_PROJECT_DIR/applications/solvers/multiphase/interFoam/interDyMFoam $WM_PROJECT_USER_DIR/applications/solvers/waves2Foam/applications/solvers/solvers17/waveFoam/

2. Now modify the name of copied folder to waveDyMFoam (or whatever name you want... but it looks fine):

cd $WM_PROJECT_USER_DIR/applications/solvers/waves2Foam/applications/solvers/solvers17/waveFoam
mv interDyMFoam/ waveDyMFoam

3. Clean the compiled solver and modify the name of C file:

cd waveDyMFoam
mv interDyMFoam.C waveDyMFoam.C

4. Now we must follow the guidelines in section 3.2 (but with some difference, as for example, we don’t need modify createFields.H since it’s read from one level-up):

  • Add the following line in waveDyMFoam.C
#include "relaxationZone.H"
  • Inside main in waveDyMFoam.C add the following two lines just below #include "initContinuityErrs.H" and above createFields.H
#include "readGravitationalAcceleration.H"
#include "readWaveProperties.H"
  • After the line in waveDyMFoam.C stating #include "alphaEqnSubCycle.H" add

5. Now we need set properly the Make files. First, open and modify ‘Make/files’:



6. And in ‘Make/options’ do:

  • After -I$(LIB_SRC)/dynamicFvMesh/lnInclude \ add:
  • And add the following lines at the very bottom
  • REMEMBER to add the two new needed \ at the end of lines:

7. At main directory, compile the new solver typing:


8. It’s done ;)

This tutorial section is an adaptation to wiki from:


4 Utilities

4.1 Pre-processing

4.1.1 faceSetToSTL

A simple program, which can be used to create simple STL-surfaces. The user defines a closed cell with an arbitrary number of faces or defines one face and an extrude direction. Based on this an STL-file is written.

The program relies on the face triangulation inside OpenFoam.

In the input dictionary, and arbitrary number of STL-definitions can be specified.

4.1.2 waveGaugesNProbes

This utilities allows for simple creation of a set of wave gauges. Several types are distributions are available, and the output is

  • A set file, which contains all of the wave gauges
  • A code snippet, which can be copy-pasted into the controlDict, such that runTime sampling is activated. This code snippet comes with some default settings, which the user should consider
  • A surfaceElevationDict, such that sampling of the free surface can be done as a post-processing step
  • A VTK-file, such that it is easy to visualise the location of the wave-gauges in e.g. ParaView.

The the input dictionary, several sets of wave gauges can be defined. This is interesting, if e.g. five specific gauges are used for reflection analysis, and the other e.g. 100 gauges are for dense measuring. This split makes the post-processing of the reflection analysis faster and less error-prone.

This utility is prepared for the creation of probe location files as well, however, this is work to be carried out.

4.1.3 setWaveParameters

This utility runs through every sub-dictionary (SD) in the dictionary waveProperties.input. A pointer to a derived class of setWaveProperties is generated for each SD; the pointer is based on the entry waveType. If the necessary input is available, the additional wave parameters are computed.

The derived data and the other needed input are written to the file waveProperties, which is subsequently used in the simulations.

As of revision 1982 the utility has become independent on the mesh, so unnecessary time for loading the computational mesh is avoided. This loading could potentially take a long time and on really big meshes prevent the execution on a serial machine.

4.1.4 relaxationZoneLayout

A tool for visualising the relaxation fields in the computational domain. It also depicts the orientation of the relaxation zone. A tutorial is availabel.

4.1.5 setWaveField

This utility sets the initial condition in the computational domain. The entry initializationName in waveProperties defines which sub-dictionary is used for initialising the wave field.

NB! Note that the ramp-up factor is multiplied onto the expressions also during initialization of the computational domain. Hence, in order not to get a horizontal water surface and stagnant water, the parameter Tsoft should be given a value of 0.0; Tsoft is typically set to the wave period as default and is not required by most of the wave theories.

4.2 Post / Run-Time Data Extraction

4.2.1 surfaceElevation

This utility is a specialisation of the OpenFoam/src/sampling/sampledSet/sampledSets in such a way that the sampled (scalar) quantity is integrated along a line defined in the file surfaceElevationDict. The utility is intended to by used as a post-processing utility, where the void ratio field is integrated along a vertical line, which yields the location of the free surface.

Since it is a specialisation of the native sample-utility, it runs both in serial and parallel modes. The two calls are as

surfaceElevation [-latestTime] [-time ranges]
mpirun -np NPROCS surfaceElevation -parallel [-latestTime] [-time ranges] Input File

An example of the input file is placed in applications/utilities/postProcessing/surfaceElevation. The rules are the same as for sampleDict, however, it only makes sense to sample the void ratio field, e.g. gamma or alpha1.

The utility only considers scalar fields. Output File

The output file is placed in surfaceElevation/startTime/surfaceElevation.dat, and it contains all the sampled data for all sampled time steps. The formatting is as follows:

Time lineName0 lineName1 lineName2 // Merely some string references
-1   x0        x1        x2        // The x-coordinates of the first point on the sampling line. -1 has no meaning.
-2   y0        y1        y2        // The y-coordinates of the first point on the sampling line. -2 has no meaning. 
-3   z0        z1        z2        // The y-coordinates of the first point on the sampling line. -3 has no meaning.
0.0  eta0      eta1      eta2      // The elevation for Time = 0.0 s
0.1  eta0      eta1      eta2      // The elevation for Time = 0.1 s
0.2  eta0      eta1      eta2      // The elevation for Time = 0.2 s
0.3  eta0      eta1      eta2      // The elevation for Time = 0.3 s
0.4  eta0      eta1      eta2      // The elevation for Time = 0.4 s
0.5  eta0      eta1      eta2      // The elevation for Time = 0.5 s Why -1e15 ?

The value -1e15 is written to the output file under the following circumstances:

  • The number of points along the integration line is less than 2.
  • Both the top and the bottom integration points are either 0 or 1 within a tolerance of 0.0001. -1e15 is preferred as this suggests the integration line to be fully inside or outside of the water column. Used as FunctionObject

The utility can also be used as a functionObject. The tutorial waveFlume includes an example on how to use it.

In this mode a couple of additional time controls has been implemented into surfaceElevation. These are

samplingStartTime <scalar>; // Default value: 0.0

This stalls the sampling of the interface location until the specified starting time is exceeded.

surfaceSampleDeltaT <scalar>; // Default value: -1.0

This value only has an effect, if it is strictly larger than 0.0. It modifies the output time for the sampling, so it is not control by neither a constant number of time steps nor the global output time. This allows for a sub-time step output of the surface elevation and thus saves disk space. This delta time does not feed back into the global setting of the time step, thus the output is only at intervals of approximately surfaceSampleDeltaT, where the accuracy obviously increases with decreasing deltaT / surfaceSampleDeltaT. So forth this ratio exceeds 1, one or more outputs is simply omitted.

For optimal uses of the surfaceSampleDeltaT, it is also recommended to specify the following

outputControl timeStep;
outputInterval 1; Compatibility

This utility has been tested for compatibility with OF-1.6, OF-1.7, OF-2.0 and OF-2.1.

The utility does not compile with OF-1.5.

4.3 postProcessWaves2Foam

The post-processing utility postProcessWaves2Foam can be used to analyse various kinds of probes data. The utility can read data extracted from a simulation both as runTime and as a post-processing step from the following data times:

  • The surfaceElevation (using the native waves2Foam utility)
  • The forces (using the native OpenFoam utility forces)
  • The velocities in points (using the native OpenFoam utility probes)
  • The overtopping flux (using the native waves2Foam utility)

Furthermore, the utility can perform the following types of analysis on the data sets:

  • Evalutation of powerSpectra (FFT and least squares methods)
  • Decomposition into reflected and incident wave components (FFT and least squares methods)

Other miscellaneous methods are described below.

4.3.1 Basic Layout of Input File

All the control is defined in the file constant/postProcessingProperties. As a global choice, the following entry is needed:

deleteParentOutputDirectory false;

This option deletes the output directory (postProcessedWaves2Foam) used for all the post-processing.

It can contain any number of sub-dictionaries of the following example (description of each method is described below):

    // Folder name for the output in postProcessesWaves2Foam
    callName interp;

    // A wordList of actions to be performed in the user defined order
    actionList ( removeSubDirs interpolateSurfaceElevation powerSpectraFFT write2Ascii );

    // The indices of the data sets used in the analyses "powerSpectraFFT" and "reflectionAnalysis2DFFT"
    allDataSets yes;

    // Specs for the interpolation of the raw data sets.
    // Equidistant data sets are needed for some of the post-processing methods
    deltaT 0.25;
    tMin   1033.0;
    tMax   3600;
    // Spectral windowing details - used by FFT-methods
    freqBins 1024;
    windowShiftFraction 0.5;

One potentially important feature is that a given operation do not need to begin with reading of the raw data. One could e.g. add the following sub-dictionary to work on the same interpolated data set:

    // Note that the operation know works on the same read data
    callName interp;
    // A wordList of actions to be performed in the user defined order
    actionList ( reflectionAnalysis2DFFT removeData);

    // The indices of the data sets used in the analyses "powerSpectraFFT" and "reflectionAnalysis2DFFT"
    indices 3(4 5 6);
    // Spectral windowing details - used by FFT-methods
    freqBins 1024;
    windowShiftFraction 0.5;

    // Physical properties needed for the reflection analysis
    // The depth is for computation of linear wave number and coordName is the
    // direction of the reflection analysis. Currently, an arbitrary direction is not supported,
    // however, it does not seem so important in the case of 2D reflection analysis.
    depth 50;
    coordName x;

    // Removal of outputted data in the <callName> directory
    removeOF false;    // Default value = true;
    removeAscii false; // Default value = false;

The benefit of having two dictionaries is that the reflection analysis works on very specific sets of data, so a specific list of indices must be stated for the analysis to make sense. The computation of the power spectra on the other hand, can easily be performed on all of the data sets in one go.

4.3.2 Reading and Writing of Raw Data

Four method is available, and they are all capable of reading from a set of time folders, so in case of a restart of the simulation, the probes data can be concatenated:

inputDir <inputDirName>; // Depending of input data, this option has a default value
timeDirs ("0" "10.34");  // This is not required. Default is all time directories rawSurfaceElevation

This method reads the surface elevation. The option inputDir has a default value of surfaceElevation. rawVelocityProbes

This method reads the velocities probes in runTime. The option inputDir has a default value of probes<tt>. rawAlphaProbes

This method reads the alpha1 probes in runTime. The option <tt>inputDir has a default value of probes<tt>. rawOvertopping

This methods reads the overtopping flux. The option <tt>inputDir has a default value of overtopping.

Furthermore, the method has an additional option called overtoppingScaling, which has a default value of 1.0. This is used to scale the overtopping flux from m3/s to m3/s/m, which is needed in e.g. 2-dimensional simulations, where the width of the domain differs from 1.0 m. rawForcesAndMoments

This method reads the forces and moment extracted using the forces-functionObject. The option inputDir has no default value, and only the values for one patch is read per inputDir.

4.3.3 Reading and Writing of Interpolated Data

The writing of interpolated data is based on the input method in the raw-data methods, hence those inputs for those described above is also required, when interpolating the data.

Furthermore, the following input is required by the user

deltaT <scalar>; // The equidistant time step for the interpolation
tMin   <scalar>; // Not required. Default = the smallest logged time instance
tMax   <scalar>; // Not required. Default = the largest logged time instance

The reading of forces and moments outputs two data files, where the forces are outputted with index 0 and moments are outputted with index 1.

The available methods are the following:

  • interpolateSurfaceElevation
  • interpolateVelocityProbes
  • interpolatedAlphaProbes
  • interpolateOvertopping
  • interpolateForcesAndMoments

4.3.4 Naming of Main Data

The data read (and written) using the raw and interpolated methods is outputted using the naming scheme


Here, index runs from 0 to N-1, with N being the number of data sets.

4.3.5 Other IO Data Manipulation write2Ascii

If write2Ascii is put in the action list, then data outputted from any of the raw* or interpolate* are outputted in ASCII format with none of the header OF-header files.

The OF-formatted filename is followed by the string .txt, when outputted.

No options.

4.3.6 Choice of Indices

Several of the methods below acts on data sets, which do not necessarily include all of the data sets. Therefore, it should be possible only to target a sub-set of the indices, so the choice on indices are as follows:

allDataSets no; // Default value = false / no
indices 6( 1 3 4 5 6 7);

If allDataSets is set to yes, then the input indices is ignored.

4.3.7 Ensemble Averaing

The method ensembleAverage performs an ensemble average of the data set. The following options are needed

period <scalar>; // The return period

The output is an ensemble average with a time step of deltaT, however, this is not a needed option, because it comes from the interpolation routine, also if an interpolation method is not in the action list.

This method is only valid, if period / deltaT is an integer.

Data is outputted in postProcessedWaves2Foam/<callName>/ensembleAverage

4.3.8 Spectral Methods Output

Data is outputted in postProcessedWaves2Foam/<callName>/<spectralMethod>

4.3.9 Cleaning Methods removeData

If removeData is put in the action list, then files of the type Foam::fileName::FILE are removed in the directory postProcessedWaves2Foam/<callName>/.


removeOF false;    // Default value = true. Removes data files with OF format. 
                                            E.g. as written by rawSurfaceElevation or interpolateSurfaceElevation;
removeAscii false; // Default value = false. Removes data files of ASCII format as written by write2Ascii. removeSubDirs

If removeSubDirs is put in the action list, then all the directories in postProcessedWaves2Foam/<callName>/ are removed.

No options.

5 waveProperties File

The file: waveProperties is to be placed in constant and must contain the following:

seaLevel 0.0; // Defines the still water level
wind (0.0 0.0 0.0); // Defines the velocity in the air part. Not needed. Default value:= vector::zero.
relaxationNames ( <word0> <word1> ); // The list of names of the relaxation zones used in the simulation
initializationName <wordN>; // Used by setWaveField and it is the sub-dictionary, 
                            // which defines which wave theory to be used for initialization
pName <word>;

Furthermore, sub-dictionaries are needed for every boundary, which uses any of the boundary conditions:

waveAlphaFvPatchScalarField    (type: waveAlpha)
wavePressureFvPatchScalarField (type: wavePressure)
waveVelocityFvPatchVectorField (type: waveVelocity)

and for all of the relaxationNames and the initializationName. The name of the sub-dictionaries are e.g.


Please note that if an boundary called inlet uses one or several of the boundary conditions, then it is allowed for instance to have a relaxation zone called inlet in order not to duplicate the input.

An example of a combined boundary and relaxation zone input is given here, where Stokes first order wave theory (Airy wave) is the input

   // Wave type to be used at boundary "inlet" and in relaxation zone "inlet"
   waveType    stokesFirst;  
   // Ramp time of 2 s
   // Foam::sin(2 * mathematicalConstant::pi / (4.0 * Tsoft_) * Foam::min(Tsoft_, runTime.time().value() ))
   // and explicitly "1" for Tsoft = 0
   Tsoft       2;

   // Water depth at the boundary and in the relaxation zone
   depth       0.400000;

   // Period - needed by setWaveParameters -> yields omega
   period      2.0;

   // Cyclic wave frequency
   omega       3.141593;

   // Phase shift in the wave
   phi         0.000000;

   // Wave propagation direction - needed by setWaveParameters -> yields k with period and depth
   direction   (1 0 0);

   // Wave number vector, k. 
   waveNumber  (1.70048 0.0 0.0);

   // Wave height
   height      0.1;
   // Specifications on the relaxation zone shape and relaxation scheme
       relaxationScheme Spatial;
       relaxationShape  Rectangular;
       beachType        Empty;
       startX           (0 0.0 -1);
       endX             (5 0.0  1);
       orientation      (1.0 0.0 0.0);

       // Additional optional arguments
       relaxationWeight Exponential; //Default and otherwise: FreePolynomial, ThirdOrderPolynomial
       courantCorrection off; // Default and otherwise: on

6 Tutorials

6.1 Overview

This table shows, which tutorials are set up to use the different functionalities functionalities:

Name of tutorial relaxationZoneLayout relaxationZones setWaveParameters setWaveField faceSetToSTL waveGaugesNProbes waveFoam surfaceElevation postProcessingWaves Validation
relaxationZoneLayout Yes Yes No No No No No No No No
waveFlume No Yes Yes Yes No Yes Yes Yes (runTime) Yes No
standingWave No Yes No Yes No No Yes No No No
3Dwaves No Yes Yes Yes No No Yes No No No
periodicSolitary No No No Yes No No Yes No No No
squarePile No Yes No Yes No No Yes No No No
bejiBattjes No Yes Yes Yes Yes No Yes Yes (runTime) No Yes

6.2 Use of relaxationZoneLayout

6.2.1 Relaxation Zone Layout

  • Name: tutorials/relaxationZoneLayout
  • Utility: relaxationZoneLayout
  • Description: This tutorial will show how to use the utility to obtain a visual on the relaxation zones. This could be helpful to detect potential problems in the setup.

6.3 Use of waveFoam

6.3.1 Wave Flume

  • Name: tutorials/waveFoam/waveFlume
  • Solver: waveFoam
  • Description: This tutorial will show the user how to use the constant/waveProperties dictionary to set-up the wave properties, relaxation zones and initialization specifications.

6.3.2 Standing Wave

  • Name: tutorials/waveFoam/standingWave
  • Solver: waveFoam
  • Description: This tutorial shows how to handle wave generation and a fully reflecting sea wall utilising the relaxation zone technique.

6.3.3 3D Wave Flume with a Seawall

An example of the surface elevation with waves from 3 directions onto a vertical structure.
  • Name: tutorials/waveFoam/3Dwaves
  • Solver: waveFoam
  • Description: This tutorial shows the use of relaxation zones in 3 dimensions. There are 3 inlet relaxation zones and one outlet relaxation zone. In the middle of the wave tank there is a vertical internal wall on which the waves are reflected. The waves, which are generated in the 3 inlet relaxation zones, have different directions relative to the x-axis.

NB: Some reflection does occur on the wall perpendicular to the wave outlet.

6.3.4 Periodic Solitary

  • Name: tutorials/waveFoam/periodicSolitary
  • Solver: waveFoam
  • Description: This tutorial uses the method for initialising a wave profile, which is different from a flat water surface with a sea-level, which differs from 0 m. The computational domain is cyclic in the direction of wave propagation and the initial field is a solitary wave.

NB: In the simulation a portion of the wave propagates in the opposite direction of the actual wave propagation. It is considered to be due to the fact that the solitary wave theory does not fulfil the non-linear wave problem accurately enough, which is why a part of the wave energy is reflected on the wave itself. It has been tested to initialise with and without the analytical expression for the excess pressure, however, it does not make a difference. Experimental evidence of this behaviour is reported in [4].

6.3.5 Square Pile in Cylindrical Domain

The surface elevation around a square pile in a constant and unidirectional current. The gray area is the relaxation zone.
  • Name: tutorials/waveFoam/squarePile
  • Solver: waveFoam
  • Description: This tutorial shows how to use the cylindrical relaxation zone. A unidirectional current is the target function all the way around, hence one relaxation zone acts as both generation and absorption. The relaxation zone removes the internally generated surface disturbances. It could be interesting to have it tested for ships waves. Alternatively, a better shape for that purpose, e.g. an elliptical relaxation zone shape could be implemented.

NB: Generating waves in the computational domain in this tutorial will give bad results. This is a direct consequence of the huge variation in cells per wave length depending on the location in the domain and not the relaxation method! Particular attention should be given to circular domains with waves.

6.3.6 Wave Transformation over Submerged Bar

  • Name: tutorials/waveFoam/bejiBattjes
  • Solver: waveFoam
  • Description: This tutorial provides the experimental setup from [5] and a Matlab script, which can be used to compare the experimental data and the simulations.

7 Development / On-going and Future

  • In connection with each of the wave theories in src/waveTheories/, there should be a corresponding file in src/setWaveProperties/, which computes all of the necessary properties based on a minimum number of inputs, e.g. have height, H, water depth, h, and wave period, T.
This work is still ongoing, hence for those waves missing a property-file, the pre-processing tool setWaveParameters will fail.
  • Tests with other outlet boundary types [6][7]
  • The pressure gradient points in the direction of the boundary face, irrespectively of the fact that it should be corrected for the angle between wave propagation and the direction of the boundary face.
  • The pressure gradient is not implemented in all of the wave theories - returns instead \partial p/\partial n = 0.0.

8 Download and Installation

8.1 Dependencies

Besides the standard dependencies in OpenFoam, waves2Foam also depend on Gnu Scientific Library (GSL). This is needed for two reasons:

  • In the cnoidal wave theory one has to evaluate Jacobian elliptic functions and complete elliptic integrals. These are not natively available in OpenFoam.
  • A pre-processing tool, which is currently being developed, computes the needed wave parameters giving the minimal number of input parameters. This quickly results in a set of N non-linear sets of equations in N unknowns. For this purpose GSL is currently being used.

GSL can e.g. be downloaded using the following commands[8]

Ubuntu: sudo apt-get install libgsl0-dev gfortran
Fedora: sudo yum install gsl-devel
Suse:   sudo zypper install gsl-devel

Please be aware that the location for GSL might differ between OS's, hence the include paths in the options-files could be wrong. If you have successfully installed GSL and the compilation complains over missing header files or libraries, this is the first place to look.

Additional dependencies:

  • gfortran
  • git

8.2 SVN on SourceForge

The toolbox is available through the OpenFoam-Extend SourceForge SVN. Check out the code in the following manner:

svn co http://svn.code.sf.net/p/openfoam-extend/svn/trunk/Breeder_1.6/other/waves2Foam

8.3 Installation

  • Install GSL as described above
  • Obtain the source code via SVN as described above
  • Execute the Allwmake script in the folder waves2Foam
    • The Allwmake script might cast an error in terms of instructions. Merely follow these.
    • Other errors could be a lot of things:)

9 Modifications to the Source Code (History)

  • 2017-07-23 19:46:17: (2113) Continue adding pressures to wave theories: Now chappelear and corrects for still water level
  • 2017-07-15 22:07:26: (r2112) Added solitary wave theory (Chappelear) and fixed bug in solitaryFirst
  • 2017-07-14 18:01:19: (r2111) Adding pressure distribution to stokesSecond
  • 2017-05-17 17:12:03: (r2107) Added a small interface correction to waveTheory.H
  • 2017-05-07 21:53:13: (r2106) Added utility to compute the (analytical) wave field in a multiple of points: sampleIncidentWaveField
  • 2017-04-09 20:23:26: (r2105) Added breeder version of catenary mooring line (v1606). Also coded pressure to StokesFirst
  • 2017-01-15 18:50:23: (r2104) Support for foam-extend-4.0
  • 2016-11-08 18:41:24: (r2103) waves2Foam available for v1606+
  • 2016-10-13 16:00:22: (r2102) Preparing for better treatment of KC; no functional change
  • 2016-09-27 07:31:45: (r2101) porousWaveFoam for OpenFoam-v3.0+ (only explicit advection of alpha.water)
  • 2016-08-12 15:48:56: (r2100) Added compatibility with OpenFoam-v3.0+ and solvers for foam-extend-3.2
  • 2016-07-08 10:40:35: (r2096) Minor change to pEqn.H for foam-extend-3.1 to support on-going developments. No functional change.
  • 2016-07-01 22:41:30: (r2095) Added support for OpenFoam-4.0.0. porousWaveFoam not created and sampling library broken in OpenFoam-4.0.0
  • 2016-05-19 22:05:52: (r2094) Support for stream function wave theory
  • 2016-05-19 10:27:57: (r2093) Debug overtopping: results of rhoU2A were bugged, not the overtopping rate itself.
  • 2016-04-29 11:11:26: (r2092) Minor cosmetic changes. Only functional change: Extruded faceSetToSTL always have outward pointing normal.
  • 2016-04-04 14:52:42: (r2091) Changed source location for OceanWave3D. New version resolves bugs with respect to wave generation with the use of a paddle signal. Otherwise no functional effects are expected.
  • 2016-04-04 09:48:18: (r2090) Resolved need for dual compilation, if WAVES_LIBBIN does not exist at the beginning of the compilation. WAVES_LIBBIN and WAVES_APPBIN are made manually.
  • 2016-03-08 11:05:46: (r2089) Minor downstream dependencies. No functional change
  • 2016-02-03 10:58:03: (r2088) Minor bug corrected in compilation procedure; effect on foam-extend branch
  • 2016-02-02 10:50:34: (r2087) Corrected minor bug in oceanWave3D-coupling.
  • 2016-01-08 17:42:13: (r2086) Update tutorial porousDamBreak + porousWaveFoam for OF2.3.0
  • 2015-12-18 18:29:10: (r2085) Added time control checks to oceanWave3D.C
  • 2015-11-23 07:27:38: (r2084) Added solver for OpenFoam-3.0.0
  • 2015-11-20 18:50:30: (r2083) Preparation of compatibility with OpenFoam-3.0.0 - do not use this revision
  • 2015-10-15 22:09:38: (r2082) Debugging of ThirdParty/Allwmake compile script
  • 2015-10-15 21:17:44: (r2081) Additional of OceanWave3D coupling + related tutorial + documentation in 'doc'
  • 2015-10-01 20:00:40: (r2080) src+utilities compiles with foam-extend-3.2. Solvers to follow
  • 2015-09-16 09:27:48: (r2079) Minor issues with options and file for solvers
  • 2015-09-09 16:07:37: (r2078) Added the possibility of using the sea level as vertical reference. Tutorials and setWaveParameters modified accordingly.
  • 2015-08-24 17:10:42: (r2077) Added '- phi' to the argument in stokesFifth.C
  • 2015-07-27 09:44:25: (r2073) Minor changes related to external wave forcing (e.g. nicer closing in solver + works with setWaveField)
  • 2015-07-12 13:48:09: (r2072) waves2Foam compiles on OF2.4 + waveFoam solver
  • 2015-06-06 18:22:46: (r2068) Added zero-crossing functionality + porosity model can be used for non-wave related things
  • 2015-04-14 21:24:03: (r2066) Streamlined the code (removed duplication) for the setWaveProperties and related classes. Change in input format in waveProperties.input.
  • 2015-03-25 09:05:40: (r2064) surfaceElevation now gives correct results on moving meshes in runTime (tested on foam-extend-3.1). Increase computational time.
  • 2015-03-16 14:38:06: (r2063) Small change to porosityCoefficients. NO functional change. Also, corrected bug in surfaceElevation.C, which affected foam-extend branch.
  • 2015-03-12 15:14:46: (r2062) Small change in the interface for the porosity module. No functional change.
  • 2015-02-05 13:28:26: (r2060) Added porousWaveFoam for foam-extend-3.1
  • 2014-10-30 11:01:34: (r2057) Resolving naming match between waves2Foam and 2+ OF-versions [DO NOT USE REVISION 2056]
  • 2014-10-30 10:18:49: (r2056) Made the porosity runTime-selectable. Currently only one method available. Commit includes derived modifications.
  • 2014-10-24 22:03:27: (r2055) Directional check on wave directions in wave theories. 3Dwaves tutorial corrected accordingly
  • 2014-09-09 14:41:16: (r2051) Small interface change in the external wave classes (constructs now with fvMesh as well)
  • 2014-09-04 14:43:15: (r2050) Modified options files so the compilation works with local installations of GSL
  • 2014-09-04 11:36:01: (r2049) Changes to the output location of some applications and libraries. Now uses WAVES_APPBIN/WAVES_LIBBIN
  • 2014-06-21 18:04:47: (r2045) Compiling on foam-extend-3.1, waveFoam 3.1 and waveFoam/porousWaveFoam added directly from OF2.2.1 to OF2.2.2
  • 2014-05-31 22:02:48: (r2044) waveFoam support to foam-extend 3.0 + minor bug-fixes + new relaxation zone shape
  • 2014-05-17 11:28:34: (r2043) Minor maintanence, i.e. waveProperties.input in waveFlume tutorial.
  • 2014-04-12 17:35:52: (r2042) Corrected OF2.3.0 issue with the test case bejiBattjes
  • 2014-04-06 12:33:09: (r2041) Release to facilitate planned future open-source contribution(s) [No functional change in execution].
  • 2014-03-27 21:17:38: (r2040) Additional corrections to the tutorials to run in 2.3.0. Also corrected periodicSolitary, so the tutorial runs for recent cyclic definition.
  • 2014-03-26 19:22:46: (r2039) Corrected tutorials, such that they can actually execute (adding the 0.org-directory)
  • 2014-03-20 11:11:40: (r2038) Added a single post-processing functionality (writeIndexLocation)
  • 2014-03-11 20:57:55: (r2037) Updated structure of tutorials to easier accommondate future changes. Now runs for OF2.3 with alpha.water.
  • 2014-03-01 19:05:46: (r2036) Adjusted to be used with OF2.3. Furthermore, the porousDamBreak case now offers comparison with experiments. The tutorials are not yet adjusted to work with the changes from OF2.2 -> OF2.3.
  • 2014-01-26 16:13:27: (r2026) Compatibility of waves2Foam libraries and utilities with foam-extend-3.0. Still no solver (waveFoam)
  • 2013-12-28 11:43:19: (r2025) Porosity module with solvers (OF1.6, 2.1.0, 2.1.1, 2.2.0, 2.2.1) and a single tutorial.
  • 2013-11-25 19:35:06: (r2024) Modified the fatal error message in the compilation, such that it is easy to understand how to resolve the issue with a wrong WAVES_DIR environmental variable.
  • 2013-10-24 09:11:15: (r2022) Added a new relaxationScheme and a new relaxationShape
  • 2013-10-07 20:36:24: (r2021) Modified src/waves2Foam*/Make/options.* to include XVERSION flag
  • 2013-09-15 09:37:28: (r2020) Added phase focusing as an option for irregular waves.
  • 2013-09-05 13:31:41: (r2019) Trivial bug-fix, not affecting results (Thanks: Bjarne Jensen)
  • 2013-09-03 10:38:12: (r2018) Increased flexibility for setting wave spectra for JONSWAP.
  • 2013-08-12 14:40:19: (r2017) Minor bug-fix in src/waves2Foam/waveTheories/irregular/irregular/irregular.C
  • 2013-08-07 23:34:24: (r2016) Faster evaluation of irregular waves
  • 2013-08-06 21:59:56: (r2015) A bit of code maintenance/simplification
  • 2013-07-28 12:15:35: (r2014) Fourth revision on code style change according to: www.openfoam.org/contrib/code-style.php. [No functionality change]
  • 2013-07-27 22:03:15: (r2013) Third revision on code style change according to: www.openfoam.org/contrib/code-style.php. [No functionality change]
  • 2013-07-27 19:31:35: (r2012) Second revision on code style change according to: www.openfoam.org/contrib/code-style.php. [No functionality change]
  • 2013-07-22 22:53:39: (r2011) First revision on code style change according to: www.openfoam.org/contrib/code-style.php. [No functionality change]
  • 2013-07-15 13:09:08: (r2010) Corrected missing files in src/waves2FoamProcessing/Make/files
  • 2013-07-13 11:32:48: (r2009) waves2Foam now compiles under OF2.2.1
  • 2013-07-09 15:12:25: (r2008) Added an additional point distribution (user-defined) for wave gauges
  • 2013-07-07 19:28:45: (r2007) Release of pre- and post-processing utilities, overtopping sampling and modified tutorials.
  • 2013-07-07 18:37:43: (r2004-r2006) Temporary revision: Restructuring the src-directory
  • 2013-07-07 17:41:18: (r2003) Bug in bichromatic second.
  • 2013-06-11 20:46:14: (r2000) Resolve incompatibility between version 2.2.0 and 2.2.x for waveFoam header files
  • 2013-06-09 09:13:39: (r1997) Added a small script for the creation of new wave theories in waves2Foam/doc/templateWaveTheory
  • 2013-06-08 21:11:23: (r1996) Updated compilation system
  • 2013-06-07 21:38:02: (r1991-r1995) Temporary commit during updating to new SVN
  • 2012-12-03 12:52:40: (r1984) Added second order bichromatic waves. Set numerical beach type to "Empty" as defalt.
  • 2012-11-29 15:10:18: (r1983) Added wave theory. Automatic enhanced write precision for cnoidal waves parameters. Slight change to waveTheory interface.
  • 2012-11-23 15:52:01: (r1982) Changed setWaveParameters so (i) parameters are read from waveProperties.input and written to waveProperties and (ii) it does not depend on the mesh. The latter speeds up the execution (a lot!).
  • 2012-11-18 21:48:17: (r1981) Added a check for validity of second order stokes in the properties file
  • 2012-10-31 15:29:27: (r1980) Bug in compiling setWaveParameters for OFVERSION >= 17. Added pre-processor statement
  • 2012-10-31 14:38:18: (r1979) (i) Bug in bichromaticFirstProperties.C. (ii) Cosmethics in the *Properties files, when writing waveProperties-file
  • 2012-10-18 17:00:21: (r1977) (i) Added solvers for 2.1. (ii) Changed the approach used by setWaveParameters to write waveProperties file. (iii) Updated headers with publication data on the journal article. (iv) Added the file sourceCodeStructure_r1923.svg in the doc directory.
  • 2012-10-17 12:04:01: (r1976) Removed all pre-processing if's related to version 15. Altered the OFVERSION pre-processor to work on e.g. 211 and 160 rather than 21 and 16.
  • 2012-10-01 11:49:20: (r1975) Modified the tutorials, so they are also running under OF2.1
  • 2012-09-10 21:29:21: (r1973) Corrected infinite loop in the computation of the wave number, when kh > 60 (extreme deep water).
  • 2012-08-16 09:44:50: (r1972) Added an option for a local sealevel in potentialCurrent
  • 2012-07-13 20:51:52: (r1969) Added the following: (i) runTime selection of relaxation zone weights, (ii) a local correction to relaxation weight based on the local Courant number, (iii) update of relaxationZoneLayout to show the weight and (iv) added interface for numerical beach in UEqn.H but still not functional.
  • 2012-06-08 12:09:21: (r1967) Added some post-processing utilities to be used in matlab and modified the misc/matlab file structure. Minor bug-fix in generateStreamFile.m so the output file is consistent with the format in waves2Foam.
  • 2012-05-16 10:44:43: (r1966) Corrected bug in matlab script for stream function theory (previous results correct, if the program could finalise!)
  • 2012-05-15 12:01:18: (r1965) Additional output time control for the surfaceElevation utility. Especially needed under functionObject functionality
  • 2012-05-10 14:37:47: (r1961) Added a optional starting time for the surface elevation sampling
  • 2012-05-09 14:18:23: (r1960) Added phase-lag (phi_) in streamFunction.C
  • 2012-05-03 13:22:43: (r1953) Added functionObject functionality for sampledSurfaceElevation. Included in the tutorial waveFlume.
  • 2012-05-02 10:11:01: (r1952) Modification to Allwmake and src/Allwmake so "sed" also works under Mac OSX.
  • 2012-04-30 21:28:20: (r1951) Added a post-processing utility, which can be used to extract the surface elevation. As of now, version 1.5 is no longer supported.
  • 2012-04-11 10:13:10: (r1947) Bug in Allwmake script
  • 2012-03-26 21:45:20: (r1945) Changed the way setWaveProperties output irregular wave properties. Adjusted irregular waveTheory accordingly.
  • 2012-03-17 15:56:02: (r1944) Solved bug in convexPolyhedral. Furthermore added an addition relaxation shape (semiCircular)
  • 2012-03-13 16:13:42: (r1943) Minor changes
  • 2012-02-19 14:45:14: (r1940) Added the possibility of a wind vector, which is constant in space and time.
  • 2012-01-29 19:15:41: (r1938) Changed the Make/files and Make/options to have the output files in FOAM_USER_LIBBIN and FOAM_USER_APPBIN.
  • 2012-01-28 15:55:34: (r1937) Added a Pierson-Moskowitz spectrum
  • 2012-01-27 13:28:00: (r1936) Added framework for irregular wave spectra - properties and wave theory
  • 2012-01-24 13:20:58: (r1935) Small changes to src/Make/files and the overall Allwmake script in order to avoid the recompilation of waves2Foam on non-dev/ext versions of OF
  • 2012-01-19 16:50:48: (r1934) Modified the code, so PI can be used both in pre- and post-2.0 versions of OpenFoam. It is replaced by PI_(4.0*atan(1.0)) a few neccesary places as a protected member variable.
  • 2011-12-04 20:07:35: (r1932) Added a tutorial showing how to generate a standing wave from a fully reflecting sea wall
  • 2011-11-22 10:02:44: (r1929) Added a tutorial utilising the cylindrical relaxation zone
  • 2011-11-19 01:01:19: (r1928) Added "waveFoam" for 1.7, modified Allwmake script and added necessary files to tutorials due to above change.
  • 2011-11-16 19:22:22: (r1937) setWaveParameters now also works for cnoidalFirst
  • 2011-11-14 20:04:08: (r1926) Added matlab tools for cnoidal and stream function waves
  • 2011-11-14 17:52:52: (r1925) Added a 3D wave tank tutorial
  • 2011-11-10 11:30:30: (r1923) Initial release of waves2Foam - all files

10 References

  1. Jacobsen, N. G., Fuhrman, D. R. and Fredsoe, J. (In print). A Wave Generation Toolbox for the Open-Source CFD Library: OpenFoam® Int. J. of Numerl. Meth. Fluids. DOI: 10.1002/fld.2726
  2. 2.0 2.1 Engsig-Karup, A. P. (2006). Unstructured Nodel DG-FEM Solution of High-order Boussinesq-type Equations. Ph.D. Thesis, Technical University of Denmark.
  3. Seng, S., Jensen, J.J. and Pedersen, P.T. (2012). Numerical prediction of slamming loads. Institution of Mechanical Engineers. Proceedings. Part M: Journal of Engineering for the Maritime Environment, 226(2), 120-134
  4. Grilli, ST, Subramanye, R, Svendsen, IA and Veeramony, J (1994). Shoaling of Solitary Waves on Plane Beaches, Journal of Waterway, Port, Coastal and Ocean Engineering, 120(6), 609-628
  5. Beji, S. and Battjes, J.A. (1993). Experimental Investigation of Wave-Propagation over a Bar. Coastal Engineering, Volume 19(1-2), 151-162
  6. Clement, A (1996). Coupling of two absorbing boundary conditions for 2D time-domain simulations of free surface gravity waves. Journal of Computational Physics, pp. 139-151
  7. Ducloc, G, Clement, AH, Chatry, G (2001). Absorption of outgoing waves in a numerical wave tank using a self-adaptive boundary condition. International Journal of Offshore and Polar Engineering, pp. 168-175.
  8. Obtained from: http://lavandula.imim.es/adun-new/?page_id=186

--NGJ 20:10, 04 December 2011 (CET)