Contrib/waves2Foam

From OpenFOAMWiki
< Contrib
Revision as of 10:39, 19 October 2011 by NGJ (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

1 waves2Foam

This web page will shortly contain information of how to use and download "waves2Foam".

The package is to be used in the modelling of free surface water waves. The package contains the following:

  • Two libraries called convexPolyhedral and waves2Foam. See description below.
  • Solver(s) to be used with 1.5 and 1.6+.
  • Preprocessing tools to initialise the wave field in a domain and visualise the setup of the relaxation zone
  • Tutorials on the use of waves2Foam
  • Until later notice, a set of Matlab® functions are provided, which compute the needed wave parameters for the different wave theories

2 Distributed Libraries

  • convexPolyhedral
This library 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.
  • waves2Foam
This library contains implementations of wave theories, wave boundary conditions for p, \mathbf{u} and \alpha, being velocity, pressure and void-ratio respectively. Furthermore the library also contain the implementation of the relaxation zone technique, which is the method used for avoiding reflections from e.g. outlet boundaries. Finally it also contains an object to be used for initialising the velocity and void-ratio fields with e.g. an Airy wave.

3 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.

4 Download

At present the package is located on a non-public SVN. It will shortly be moved to a public SVN on SourceForge.