Difference between revisions of "Contrib/waves2Foam"

From OpenFOAMWiki
m (Periodic Solitary)
(Modifications to the Source Code (History))
(277 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{VersionInfo}}{{Version1.5}}{{Version1.5-dev}}{{Version1.6-ext}}{{Version1.7.1}}{{Version1.7.x}}
+
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.
  
Please report on other successful application of the toolbox
+
<b>Release of the waves2Foam Manual</b>
== waves2Foam ==
+
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).
+
  
=== Referencing ===
+
As of the 17th of August 2017, the waves2Foam Manual is released. Consequently, the content of this Wiki-page is reduced.
Whenever used please do make prober 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 = {2011},
+
Volume = {In print},
+
Pages = {},
+
}
+
  
== Distributed Library ==
+
It is still possible to find download/installation instructions and information on the code contributions.
=== Overview of Content ===
+
[[File:SourceCodeStructure.png|thumbnail|400x189px|Schematics of the code structure in the library]]
+
The library <tt>libwaves2Foam</tt> contains the following functionality:
+
* A namespace called <tt>waveTheories</tt>, where the abstract base class, <tt>waveTheory</tt>, 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 pressure gradient. 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 <tt>setWaveProperties</tt>. From this a definition file to each of the wave theories is implemented. These are addressed from the utility <tt>setWaveParameters</tt>, which sets the needed wave parameters for each wave theory based on a minimum of input parameters. Set below.
+
* A relaxation framework around the class <tt>relaxationZone</tt>, where combinations of relaxation techniques and the shape of relaxation zones can be chosen.
+
* <tt>convexPolyhedral</tt> 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 <math>\eta=a\sin (\omega t - \mathbf{k}\cdot\mathbf{x})</math>, where <math>\eta</math> is the water surface elevation, <math>a</math> is the wave amplitude, <math>\omega</math> is the cyclic frequency, <math>t</math> is time, <math>\mathbf{k}</math> is the horizontal wave number vector, and <math>\mathbf{x}</math> is a spatial coordinate. It should be noted that the intersection routine is <i>not</i> implemented in <tt>convexPolyhedral</tt>, 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 <tt>autoPtr<waveTheories::waveTheory></tt>, hence there is a decoupling of the relaxation zone techniques/boundary conditions and the actual wave theory used in the simulation.
+
* Furthermore boundary conditions and a class for setting initial conditions are part of the library.
+
  
=== Available Wave Theories ===
+
<noinclude>
The library is distributed with the following wave theories
+
[[Category:FeaturedArticle]]
==== Current-type ====
+
== waves2Foam - Information ==
===== Potential current type (uniform velocity distribution from bottom to <tt>seaLevel</tt>) =====
+
+++ Example - setWaveParameters and Running +++
+
waveType potentialCurrent;
+
Tsoft    <scalar>;
+
U        <vector>;
+
==== Regular waves ====
+
===== Stokes first order wave theory (Airy wave) =====
+
+++ Example - setWaveParameters +++
+
waveType  stokesFirst;
+
period    <scalar>;
+
depth      <scalar>;
+
direction  <vector>;
+
Tsoft      <scalar>; // Not required
+
+
+++ Example - Running +++
+
waveType  stokesFirst;
+
height    <scalar>;
+
omega      <scalar>;
+
phi        <scalar>;
+
depth      <scalar>;
+
waveNumber <vector>;
+
Tsoft      <scalar>; // Not required
+
===== First order Stokes standing wave theory =====
+
+++ Example - setWaveParameters +++
+
waveType  stokesFirstStanding;
+
period    <scalar>;
+
depth      <scalar>;
+
direction  <vector>;
+
Tsoft      <scalar>; // Not required
+
+
+++ Example - Running +++
+
waveType  stokesFirstStanding;
+
height    <scalar>;  // The height of each wave component
+
omega      <scalar>;
+
phi        <scalar>;
+
depth      <scalar>;
+
waveNumber <vector>;
+
Tsoft      <scalar>; // Not required
+
===== Stokes second order wave theory =====
+
+++ Example - setWaveParameters +++
+
waveType  stokesSecond;
+
period    <scalar>;
+
depth      <scalar>;
+
direction  <vector>;
+
Tsoft      <scalar>; // Not required
+
+
+++ Example - Running +++
+
waveType  stokesSecond;
+
height    <scalar>;
+
omega      <scalar>;
+
phi        <scalar>;
+
depth      <scalar>;
+
waveNumber <vector>;
+
Tsoft      <scalar>; // Not required
+
===== Stokes fifth order wave theory =====
+
+++ Example - setWaveParameters +++
+
waveType    stokesFifth;
+
height      <scalar>;
+
period      <scalar>;
+
depth      <scalar>;
+
stokesDrift <scalar>;
+
direction  <vector>;
+
Tsoft      <scalar>; // Not required
+
+
+++ Example - Running +++
+
waveType    stokesFifth;
+
height      <scalar>;
+
omega      <scalar>;
+
phi        <scalar>;
+
depth      <scalar>;
+
waveNumber  <vector>;
+
Tsoft      <scalar>; // Not required
+
===== First order cnoidal theory =====
+
+++ Example - setWaveParameters +++
+
waveType    cnoidalFirst;
+
height      <scalar>;
+
depth      <scalar>;
+
period      <scalar>;
+
+
+++ Example - Running +++
+
waveType    cnoidalFirst;
+
height      <scalar>;
+
omega      <scalar>;
+
depth      <scalar>;
+
direction  <vector>;
+
m          <scalar>;
+
length      <scalar>;
+
celerity    <scalar>;
+
Tsoft      <scalar>; // Not required
+
  
<b>NB:</b> Note, that if the wave is extremely shallow, <math>m\rightarrow\infty</math>, so in order not to evaluate <math>K(m=1)=\infty</math>, the write precision in the <tt>controlDict</tt> should be sufficiently high in order to write e.g. 0.9999999999 in stead of 1.0.
+
==== Link to the manual ====
 +
The waves2Foam Manual is freely available through ResearchGate. Click here for download [https://www.researchgate.net/publication/319160515_waves2Foam_Manual].
  
===== Stream function wave theory =====
+
==== Report Bugs via the Mantis on Sourceforge ====
+++ Example - setWaveParameters +++
+
Please report bugs (not compilation errors, unless they are bugs) here:
// Currently not working
+
+
+++ Example - Running +++
+
waveType  streamFunction;
+
omega      <scalar>;
+
depth      <scalar>;
+
phi        <scalar>;
+
waveNumber <vector>;
+
uBar      <scalar>;
+
N          <scalar>;
+
A          <scalarField>;
+
B          <scalarField>;
+
Tsoft      <scalar>; // Not required
+
Tstart    <scalar>; // Not required (Default 0.0);
+
Tend      <scalar>; // Not required (Default GREAT);
+
==== Solitary waves ====
+
===== Solitary First =====
+
+++ Example - setWaveParameters and Running +++
+
waveType  solitaryFirst;
+
height    <scalar>;
+
depth    <scalar>;
+
direction <vector>;
+
x0        <vector>;
+
==== Irregular waves ====
+
===== First order bi-chromatic wave train (wave group) =====
+
+++ Example - setWaveParameters +++
+
waveType    bichromaticFirst;
+
period1    <scalar>;
+
period2    <scalar>;
+
depth      <scalar>;
+
direction1  <vector>;
+
direction2  <vector>;
+
Tsoft      <scalar>; // Not required
+
+
+++ Example - Running +++
+
waveType    bichromaticFirst;
+
height1    <scalar>;
+
height2    <scalar>;
+
omega1      <scalar>;
+
omega2      <scalar>;
+
phi1        <scalar>;
+
phi2        <scalar>;
+
depth      <scalar>;
+
waveNumber1 <vector>;
+
waveNumber2 <vector>;
+
Tsoft      <scalar>; // Not required
+
==== Other ====
+
===== <tt>combinedWaves</tt>, which allows for a combination of any of the above =====
+
+++ Example - setWaveParameters and Running +++
+
waveType            combinedWaves;
+
combinedWaveNames  <workList>; // A list of names of the other sub-dictionaries without the Coeffs-part
+
  
=== Relaxation Techniques ===
+
https://sourceforge.net/apps/mantisbt/openfoam-extend
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 <tt>relaxationZone</tt>. The latter is the one implemented into the solvers to add the relaxation functionalities. The relaxation methods are:
+
==== Explicit Relaxation ====
+
The explicit relaxation techniques is performed before the momentum equation is solved in the following manner:
+
  
<math>\mathbf{u} = (1-w)\mathbf{u}_{target}+w\mathbf{u}_{computed}</math>
+
There is a subsection for waves2Foam. This will make it easier to keep track of issues, which needs attention.
  
<math>\alpha = (1-w)\alpha_{target}+w\alpha_{computed}</math>
+
==== Discussions on cfd-online.com ====
 +
There are two main threads on cfd-online.com, which are related to waves2Foam.
  
where <math>w\in[0,\,1]</math> 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.
+
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.
<b>Interface:</b>
+
For enquiries, discussion, etc., please use
void relaxationZone::correct()
+
[http://www.cfd-online.com/Forums/openfoam-solving/100091-waves2foam-related-topics.html].
==== 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, <math>\sigma</math>, in the relaxation zone, thus it ought to be straight forward to implement a given method.
+
 
+
<b>Interface:</b>
+
tmp<volScalarField> relaxationZone::numericalBeach()
+
 
+
== Applications ==
+
=== waveFoam ===
+
<tt>waveFoam</tt> is based on the original implementation of <tt>interFoam</tt>. Modifications are made to make it possible to use the relaxation zone framework with the solver.
+
== Utilities ==
+
=== Pre-processing ===
+
==== setWaveParameters ====
+
This utility runs through every sub-dictionary (SD) in the dictionary <tt>waveProperties</tt>. A pointer to a derived class of <tt>setWaveProperties</tt> is generated for each SD; the pointer is based on the entry <tt>waveType</tt>. If the necessary input is available, any additional wave parameter, which is needed in the simulation is written to SD.
+
==== 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.
+
==== setWaveField ====
+
This utility sets the initial condition in the computational domain. The entry <tt>initializationName</tt> in <tt>waveProperties</tt> defines which sub-dictionary is used for initialising the wave field.
+
 
+
<b>NB!</b> 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 <tt>Tsoft</tt> should be given a value of 0.0; <tt>Tsoft</tt> is typically set to the wave period as default and is not required by most of the wave theories.
+
== waveProperties File ==
+
The file: <tt>waveProperties</tt> is to be placed in <tt>constant</tt> and must contain the following:
+
seaLevel 0.0; // Defines the still water level
+
 
+
relaxationNames ( <word0> <word1> ); // The list of names of the relaxation zones used in the simulation
+
 
+
initializationName <wordN>; // Used by setWaveField and is the sub-dictionary,
+
                            // which defines what wave theory to use for initialization
+
 
+
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 <tt>relaxationNames</tt> and the <tt>initializationName</tt>. The name of the sub-dictionaries are e.g.
+
<word0>+Coeffs
+
Please note that if an boundary called <tt>inlet</tt> uses one or several of the boundary conditions, then it is allowed for instance to have a relaxation zone called <tt>inlet</tt> 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
+
inletCoeffs
+
{
+
    // 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;
+
+
    // Cyclic wave frequency
+
    omega      3.141593;
+
+
    // Phase shift in the wave
+
    phi        0.000000;
+
+
    // 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
+
    relaxationZone
+
    {
+
        relaxationScheme Spatial;
+
        relaxationShape  Rectangular;
+
        beachType        Empty;
+
   
+
        startX          (0 0.0 -1);
+
        endX            (5 0.0  1);
+
        orientation      (1.0 0.0 0.0);
+
    }
+
};
+
 
+
== Tutorials ==
+
=== Relaxation Zone Layout ===
+
* Name: <tt>tutorials/relaxationZoneLayout</tt>
+
* Utility: <tt>relaxationZoneLayout</tt>
+
* 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.
+
=== Wave Flume ===
+
* Name: <tt>tutorials/waveFoam/waveFlume</tt>
+
* Solver: <tt>waveFoam</tt>
+
* Description: This tutorial will show the user how to use the <tt>constant/waveProperties</tt> dictionary to set-up the wave properties, relaxation zones and initialization specifications.
+
 
+
=== 3D Wave Flume with a Seawall ===
+
[[File:threeDimWaveField.png|thumbnail|300x122px|An example of the surface elevation with waves from 3 directions onto a vertical structure.]]
+
* Name: <tt>tutorials/waveFoam/3Dwaves</tt>
+
* Solver: <tt>waveFoam</tt>
+
* 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 <math>x</math>-axis.
+
 
+
<b>NB:</b> Some reflection does occur on the wall perpendicular to the wave outlet.
+
 
+
=== Periodic Solitary ===
+
* Name: <tt>tutorials/waveFoam/periodicSolitary</tt>
+
* Solver: <tt>waveFoam</tt>
+
* 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.
+
 
+
<b>NB:</b> 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.
+
 
+
== Compatibility ==
+
The toolbox has been tested successfully with the following releases of OpenFoam:
+
* 1.5.x
+
* 1.5-dev
+
* 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
+
 
+
Because of considerable changes in the source code of OpenFoam between version 1.5 and 1.6, there exist a <tt>solvers15</tt> and a <tt>solvers</tt> directory. Please also note that throughout the code, pre-processor choice are made based on the argument <tt>OFVERSION</tt>, which is given as
+
OFVERSION=`echo $WM_PROJECT_VERSION | sed -e 's/\./\n/g' -e 's/-/\n/' | grep "[0-9]" | tr -d '\n'`
+
which strips anything but the numbers from <tt>$WM_PROJECT_VERSION</tt>.
+
 
+
Furthermore note, that the <tt>dev/ext</tt> branches has an additional library called <tt>liblduSolvers.so</tt>, hence in the <tt>Allwmake</tt> script, linking to this particular library is stripped from <i>all</i> solvers, if <tt>$WM_PROJECT_VERSION</tt> contain neither of the strings <tt>dev</tt> and <tt>ext</tt>. Moving to these versions it is henceforth recommended to make a clean checkout.
+
 
+
== Development / On-going and Future ==
+
* In connection with each of the wave theories in <tt>src/waveTheories/</tt>, there should be a corresponding file in <tt>src/setWaveProperties/</tt>, which computes all of the necessary properties based on a minimum number of inputs, e.g. have height, <math>H</math>, water depth, <math>h</math>, and wave period, <math>T</math>.
+
:This work is still ongoing, hence for those waves missing a property-file, the pre-processing tool <tt>setWaveParameters</tt> will fail.
+
* Tests with other outlet boundary types <ref>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</ref><ref>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.</ref>
+
* 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 <math>\partial p/\partial n = 0.0</math>.
+
  
 
== Download and Installation ==
 
== Download and Installation ==
=== Dependencies ===
+
==== Dependencies ====
Besides the standard dependencies in OpenFoam, <tt>waves2Foam</tt> also depend on Gnu Scientific Library (GSL). This is needed for two reasons:
+
Besides the standard dependencies in OpenFoam, <tt>waves2Foam</tt> also depend on a number of additional third-party packaged. These are:
* 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 <math>N</math> non-linear sets of equations in <math>N</math> unknowns. For this purpose GSL is currently being used.
+
  
GSL can e.g. be downloaded using the following commands<ref>Obtained from: http://lavandula.imim.es/adun-new/?page_id=186</ref>
+
* GNU Scientific Library (GSL)
Ubuntu: sudo apt-get install libgsl0-dev
+
* Subversion (SVN)
Fedora: sudo yum install gsl-devel
+
* git
Suse:  sudo zypper install gsl-devel
+
* gfortran
  
Please be aware that the location for GSL might differ between OS's, hence the include paths in the <tt>options</tt>-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.
+
Make sure that these dependencies are installed on the system prior to installation of <tt>waves2Foam</tt>. Refer to the manual for further installation instructions.
  
=== SVN on SourceForge ===
+
==== SVN on SourceForge ====
 
The toolbox is available through the OpenFoam-Extend SourceForge SVN. Check out the code in the following manner:
 
The toolbox is available through the OpenFoam-Extend SourceForge SVN. Check out the code in the following manner:
  svn co https://openfoam-extend.svn.sourceforge.net/svnroot/openfoam-extend/trunk/Breeder_1.6/other/waves2Foam
+
  svn co http://svn.code.sf.net/p/openfoam-extend/svn/trunk/Breeder_1.6/other/waves2Foam
  
=== Installation ===
+
==== Installation ====
* Install GSL as described above
+
* Install all third-party dependencies
 
* Obtain the source code via SVN as described above
 
* Obtain the source code via SVN as described above
 
* Execute the <tt>Allwmake</tt> script in the folder waves2Foam
 
* Execute the <tt>Allwmake</tt> script in the folder waves2Foam
 +
** The <tt>Allwmake</tt> script might cast an error in terms of instructions. Merely follow these.
 +
** Other errors could be a lot of things:)
  
== Also Used in These Works ==
+
== Modifications to the Source Code (History) ==
* 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
+
*2019-11-12 18:28:00 : (r2136) Minor code changes to support ISAMBARD - Reported by Scott Brown/Ed. Ransley
* Jacobsen, N. G. (2011). A Full Hydro- and Morphodynamic Description of Breaker Bar Development. <i>Ph.D. Thesis</i>. Technical University of Denmark, Deparment of Mechanical Engineering
+
* 2019-08-01 10:58:14: (r2135) Resolved parallel computing bug overtopping under SamplingNew
* 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.
+
* 2019-07-31 09:43:43: (r2134) Added waveIsoFoam to 1812 and overtopping functionality for waves2FoamSamplingNew
 +
* 2019-07-22 14:10:15: (r2133) Minor interface update to waveTheory.H
 +
* 2019-06-05 15:39:46: (r2132) Updated waves2Foam to v1812 with waveFoam solver
 +
* 2018-11-30 12:09:25: (r2131) Added irregularFast + Make file
 +
* 2018-11-30 12:05:48: (r2130) Added irregularFast
 +
* 2018-10-11 19:59:00: (r2129) Consistency update of FOAM_USER to WAVES. Decay function to streamFunction (optional)
 +
* 2018-09-28 11:17:21: (r2128) IOstream flushing bug in surface elevation sampling resolved
 +
* 2018-09-21 10:15:36: (r2127) Bug resolved in bichromaticSecond in evaluation of eta
 +
* 2018-07-01 10:24:09: (r2125) Libraries compile on OFv1806; solvers to follow
 +
* 2018-06-10 11:25:40: (r2124) Added flag to waveTheories for non-initialising theories
 +
* 2018-05-27 13:02:23: (r2123) Removed ddxPd method from waveTheory, changed name from p to pExcess for clarity, and added additional pExcess implementation. Removed wavePressure boundary condition; never used/finalised
 +
* 2018-05-25 11:36:12: (r2122) Added rAUf to cross version compatibility
 +
* 2018-05-15 09:54:00: (r2121) Minor changes to setWaveParameters and sampleIncidentWaveField
 +
* 2018-03-29 15:51:32: (r2120) sampleIncidentWaveField also writes the velocity field in the specified points
 +
*  2018-03-06 19:55:01: (r2119) Missing file for porousDamBreak
 +
* 2018-03-05 17:49:43: (r2118) New implementation of surfaceElevation to work on newer versions. Solvers for 1712
 +
* 2018-01-24 21:16:02: (r2116) Part compatibility with OF1712. Solvers and surfaceElevation support to follow
 +
* 2017-10-16 09:14:35: (r2115) Minor edit in jjc2014Zones.C
 +
* 2017-09-15 11:48:27: (r2114) Added porousWaveFoam 1606PLUS
 +
* 2017-07-23 19:46:17: (r2113) 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 <tt>cnoidalFirst</tt>
 +
* 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
  
== References ==
 
<references/>
 
  
----
+
</noinclude>
--[[User:NGJ|NGJ]] 19:57, 14 November 2011 (CET)
+
--[[User:NGJ|NGJ]] 20:10, 04 December 2011 (CET)

Revision as of 17:26, 12 November 2019

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 Link to the manual

The waves2Foam Manual is freely available through ResearchGate. Click here for download [1].

1.2 Report Bugs via the Mantis on Sourceforge

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

https://sourceforge.net/apps/mantisbt/openfoam-extend

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

1.3 Discussions on cfd-online.com

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

For announcements please consider [2]. 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 [3].

2 Download and Installation

2.1 Dependencies

Besides the standard dependencies in OpenFoam, waves2Foam also depend on a number of additional third-party packaged. These are:

  • GNU Scientific Library (GSL)
  • Subversion (SVN)
  • git
  • gfortran

Make sure that these dependencies are installed on the system prior to installation of waves2Foam. Refer to the manual for further installation instructions.

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

2.3 Installation

  • Install all third-party dependencies
  • 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:)

3 Modifications to the Source Code (History)

  • 2019-11-12 18:28:00 : (r2136) Minor code changes to support ISAMBARD - Reported by Scott Brown/Ed. Ransley
  • 2019-08-01 10:58:14: (r2135) Resolved parallel computing bug overtopping under SamplingNew
  • 2019-07-31 09:43:43: (r2134) Added waveIsoFoam to 1812 and overtopping functionality for waves2FoamSamplingNew
  • 2019-07-22 14:10:15: (r2133) Minor interface update to waveTheory.H
  • 2019-06-05 15:39:46: (r2132) Updated waves2Foam to v1812 with waveFoam solver
  • 2018-11-30 12:09:25: (r2131) Added irregularFast + Make file
  • 2018-11-30 12:05:48: (r2130) Added irregularFast
  • 2018-10-11 19:59:00: (r2129) Consistency update of FOAM_USER to WAVES. Decay function to streamFunction (optional)
  • 2018-09-28 11:17:21: (r2128) IOstream flushing bug in surface elevation sampling resolved
  • 2018-09-21 10:15:36: (r2127) Bug resolved in bichromaticSecond in evaluation of eta
  • 2018-07-01 10:24:09: (r2125) Libraries compile on OFv1806; solvers to follow
  • 2018-06-10 11:25:40: (r2124) Added flag to waveTheories for non-initialising theories
  • 2018-05-27 13:02:23: (r2123) Removed ddxPd method from waveTheory, changed name from p to pExcess for clarity, and added additional pExcess implementation. Removed wavePressure boundary condition; never used/finalised
  • 2018-05-25 11:36:12: (r2122) Added rAUf to cross version compatibility
  • 2018-05-15 09:54:00: (r2121) Minor changes to setWaveParameters and sampleIncidentWaveField
  • 2018-03-29 15:51:32: (r2120) sampleIncidentWaveField also writes the velocity field in the specified points
  • 2018-03-06 19:55:01: (r2119) Missing file for porousDamBreak
  • 2018-03-05 17:49:43: (r2118) New implementation of surfaceElevation to work on newer versions. Solvers for 1712
  • 2018-01-24 21:16:02: (r2116) Part compatibility with OF1712. Solvers and surfaceElevation support to follow
  • 2017-10-16 09:14:35: (r2115) Minor edit in jjc2014Zones.C
  • 2017-09-15 11:48:27: (r2114) Added porousWaveFoam 1606PLUS
  • 2017-07-23 19:46:17: (r2113) 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


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