View source for TestPhicau

[http://ihfoam.ihcantabria.com/ IHFOAM] is a set of solvers and boundary conditions to generate and absorb water waves actively at the boundaries and to simulate their interaction with porous coastal structures.

The main scope of these modelling tools is coastal, marine, hydraulic and offshore engineering.

<!-- <noinclude> -->
<!-- [[Category:FeaturedArticle]] -->

== IHFOAM Overview ==
The IHFOAM package includes:
* Individual boundary conditions for wave generation and active wave absorption for alpha1 and U fields. (libIHwaveGeneration.so)
** '''IH_Waves_InletAlpha'''
** '''IH_Waves_InletVelocity'''
* Boundary conditions for pure wave absorption applicable to U field. Based on 2D or 3D theories, both are applicable to 3D cases. (libIHwaveAbsorption.so)
** '''IH_3D_3DAbsorption_InletVelocity'''
** '''IH_3D_2DAbsorption_InletVelocity'''
* Solvers to be used with your favourite version of OpenFOAM or FOAM-extend. See compatibility below.
** '''ihFoam'''
** '''ihDyMFoam'''
* Brief reference manual
* Tutorials and validation cases

=== About IHFOAM solvers === 
ihFoam and ihDyMFoam solve two-phase incompressible flows within porous media by means of the VARANS (Volume-Averaged Reynolds-Averaged Navier-Stokes) equations. More information will be added, in the mean time check the [[#References_and_Citing | references]].

Both solvers are derived from interFoam and interDyMFoam. Furthermore, outside the porous media, the VARANS equations are identical to the classic RANS. Therefore, <u>ihFoam and ihDyMFoam can be used instead of interFoam and interDyMFoam even when the case presents no porous zones.</u>

=== Supported Versions === 
{{VersionInfo}}{{Version1.6-ext}}{{Version1.7.1}}{{Version2.1.1}}{{Version2.2.2}}{{Version2.3.0}}{{Version3.0-ext}}{{Version3.1-ext}}

Known issues:

* {{Version1.7.1}} everything works when you compile this version from source, as there is a problem with the precompiled installable pack. Reference [http://www.cfd-online.com/Forums/openfoam-solving/100091-waves2foam-related-topics.html#post339687].
** Otherwise:
*** The solvers (even the regular version of interFoam) need to include "-linterfaceProperties" to compile.
*** IHFOAM solvers compile and work. Despite the BCs being included, apparently they are not linked, as they are not recognized.
*** If the boundary conditions are included dynamically in controlDict and used with the IHFOAM solvers, turbulence modelling does not work.

* {{Version2.3.0}} the boundary conditions compile and work. 
** No IHFOAM solver is included, as we are experiencing severe problems with pressure calculations (not linked in any way to IHFOAM implementation) in this version. We are preparing an extensive bug report for the OpenFOAM developers. In the mean time we suggest you stay with prior OpenFOAM versions. 
** Should you want to use wave generation and absorption, see below how to link the boundary conditions dynamically in controlDict.

=== Ongoing Development === 
* The current version is 2.0, as released in 15th July 2014. 
* Bug fixes will be issued on a regular basis, while the development of version 3.0 is currently ongoing. 
* The new version will include major changes in the structure of the boundary conditions, which will not affect the use.

Future releases will include:
* Volume-averaged turbulence models, as seen in [http://dx.doi.org/10.1016/j.coastaleng.2013.08.010 the third paper].
* Current generation (already pre-implemented but not referenced, as it needs further work and validation).
* Wave theories implemented as classes, gathered by an autoPtr.

Future releases may include:
* Custom IHdynamicRefineFvMesh to enable dynamic mesh refinement on snappyHexMesh-generated meshes, as seen in [http://dx.doi.org/10.1016/j.coastaleng.2013.09.002 the fourth paper].
* Custom boundary condition to generate waves using moving boundaries, as presented in [http://registration.sdewes.org/ofw09/dfile.php?dm=Px66e485b2cbb21c4047057636a5a9b187cdb36989x2 OFW9].

=== References and Citing === 
IHFOAM is a product developed in the frame of a Master and PhD Thesis at the [http://www.ihcantabria.com/en/ Environmental Hydraulics Institute "IH Cantabria"] of the [http://www.unican.es University of Cantabria]. The implementation and validation details are published in the following references:

[http://dx.doi.org/10.1016/j.coastaleng.2012.07.002 First paper]
<pre>
Realistic wave generation and active wave absorption for Navier-Stokes models: Application to OpenFOAM.
Higuera, P., Lara, J.L. and Losada, I.J. (2013)
Coastal Engineering, Vol. 71, pp. 102-118.
</pre>

[http://dx.doi.org/10.1016/j.coastaleng.2012.06.002 Second paper]
<pre>
Simulating coastal engineering processes with OpenFOAM.
Higuera, P., Lara, J.L. and Losada, I.J. (2013)
Coastal Engineering, Vol. 71, pp. 119-134.
</pre>

[http://dx.doi.org/10.1016/j.coastaleng.2013.08.010 Third paper]
<pre>
Three-dimensional interaction of waves and porous coastal structures using OpenFOAM. Part I: Formulation and validation.
Higuera, P., Lara, J.L. and Losada, I.J. (2014)
Coastal Engineering, Vol. 83, pp. 243-258
</pre>

[http://dx.doi.org/10.1016/j.coastaleng.2013.09.002 Fourth paper]
<pre>
Three-dimensional interaction of waves and porous coastal structures using OpenFOAM. Part II: Application.
Higuera, P., Lara, J.L. and Losada, I.J. (2014)
Coastal Engineering, Vol. 83, pp. 243-258
</pre>

=== Get Connected ===
To submit your feedback, suggestions, bugs... you have many options:
* The IHFOAM mail, found [http://ihfoam.ihcantabria.com/contact/ here].
* The [https://www.linkedin.com/groups?home=&gid=4548979 IHFOAM LinkedIn group].
* At cfd-online forum, username Phicau.

IHFOAM at cfd-online
* IHFOAM Release Thread ---- CREATE and LINK
* IHFOAM Support Thread ---- CREATE and LINK

You can be informed and get all the latest news by joining our mailing list ---- LINK

== Source Download and Compilation ==
IHFOAM download site can be found [http://ihfoam.ihcantabria.com/source-download/ here].

=== Source Code Download ===
You can find IHFOAM in [https://github.com/phicau/IHFOAM GitHub]

To download the source code run the following command:

<pre>
git clone git://github.com/phicau/IHFOAM.git
</pre>

Code updates can be downloaded in the future as follows:

<pre>
git checkout
git pull
</pre>

=== Source Code Structure ===
IHFOAM source code is divided in two main folders:
* '''genAbs''' --> Generation and absorption boundary conditions
** '''waveAbsorption''' --> (BCs)
** '''waveGeneration''' --> (BCs)
** '''common''' --> Scripts shared by both BCs
* '''solvers''' --> Guess what's inside...
** '''ihFoamXXXXX''' --> One for each compatible version, including ihFoam and ihDyMFoam

=== Compilation ===
Compilation has been automatized and needs to be performed only once. Since IHFOAM does not need any dependencies, the source code can be downloaded and compiled anywhere on your computer.

* '''First''' compile the boundary conditions:
<pre>
cd genAbs
./allMake
</pre>

The script will figure out which version of OpenFOAM or FOAM-extend you are running and set a convenient preprocessor statement to adjust the code automatically to each flavour/version.

* '''Second''' compile the solvers: ihFoam and ihDyMFoam
<pre>
cd solvers/ihFoamXXXXX
./allMake
</pre>

Where XXXXX denotes your flavour (OpenFOAM - OF, FOAM-extend - FE) and your version. The currently supported versions have already been [[#Supported_Versions | shown]].

=== Dynamic Linking of the Boundary Conditions === 
In order to include the wave generation and active wave absorption boundary conditions without needing to re-compile a solver, write the following code in controlDict:

<pre>
libs
(
    "libIHwaveGeneration.so"
    "libIHwaveAbsorption.so"
);
</pre>

== IHFOAM Usage ==
'''IMPORTANT NOTES:'''
* IHFOAM is programmed in such a way that gravity has to act in the negative Z direction.
* Currently the X and Y coordinates of each boundary face are substituted by those of the centroid of the paddle to which the face belongs (similarly to what happens in the laboratory). Therefore, to obtain accurate directionality you need several paddles (''nPaddles'' >> 1). Next releases will change the implementation so you can choose.
* Angles such as ''waveDir'' and ''absDir'' are measured in degrees with respect to the positive X axis (0º), growing towards the positive Y axis (90º).

=== Wave Generation BCs ===
To generate waves you have to set the following boundary conditions.

For alpha1:
<pre>
    inlet
    {
        type            IH_Waves_InletAlpha;
        waveDictName    IHWavesDict;
        value           uniform 0;
    }
</pre>

For U:
<pre>
    inlet
    {
        type            IH_Waves_InletVelocity;
        waveDictName    IHWavesDict;
        value           uniform (0 0 0);
    }
</pre>

==== Wave Generation Dictionary ====
[[File:IHFOAM_generationOptions.png|thumbnail|400x280px|Wave generation dictionary options]]

* The wave conditions are read from a dictionary file located in the '''constant''' folder. 
* By default it is named '''IHWavesDict''', however, you can name it differently setting '''waveDictName'''. 
* This way you can even specify different wave conditions for different patches on your case.

All the options are gathered in the figure on the right. The rectangles indicate the different parameters and the rounded boxes denote the options available. A complete showcase for the different wave theories can be found in the '''reference/IHWavesDict''' folder.

Implemented wave theories:

{| class="wikitable" style="color:black"
|-
! waveType / waveTheory !! Reference !! Comments
|-
| regular / StokesI || Dean and Dalrymple (1991) ||
|-
| regular / StokesII || Dean and Dalrymple (1991) ||
|-
| regular / StokesV || Skjelbreia and Hendrickson (1960) ||
|-
| regular / cnoidal || Svendsen (2006) ||
|-
| regular / streamfunction || Fenton (1988) || No solver programmed. Use Fenton's [http://johndfenton.com/Steady-waves/Fourier.html Fourier solver] (old version tested only, distributed with the materials)
|-
| solitary / Boussinesq || Lee et al. (1982) ||
|-
| wavemaker / (tx/tv/txeta/tveta) || Own development || waveTheory depending on what you provide: '''t''' (time series), '''x''' (paddle displacement), '''eta''' (free surface elevation). Note that this BC replicates the wavemaker (constant) profile, but it does not move.
|-
| irregular / () || Dean and Dalrymple (1991) || Linear summation of StokesI components. Second order by Longuet-Higgins and Stewart (1960) completed with Baldock et al. (1996)
|}

Active wave absorption can be connected on the wave generation boundary so that waves incident to it flow out while still generating the target waves. If no other boundary is absorbing it sould be connected, to avoid a mean water level increase due to the stokes drift.
* Controlled by ''genAbs'' bool variable: true/false
* Correction velocity applied in the ''absDir'' direction. When not set or set greater than 360, it defaults the perpendicular direction to the boundary. See the first [[#References_and_Citing | reference]] for a complete explanation on when it is convenient to set ''absDir''.
* You can select ''nPaddles'' greater than 1 to obtain a better directional absorption.

=== Wave Absorption BCs ===
Why pure active wave absorption conditions when wave generation already includes it? Pure active wave absorption, disregarding wave generation, allows a more sofisticated treatment and better performance.

To absorb waves you have to set the following boundary condition for U. This time nothing is read from a dictionary, so everything is set at the boundary condition level. The default values are shown, so the parameters that need no different value can be left out.

2D-theory version, applicable to 2D/3D:
<pre>
    outlet
    {
        type            IH_3D_2DAbsorption_InletVelocity;;
        nPaddles        1;
        nEdgeMin        0;
        nEdgeMax        0;
        absorptionDir   400;
        value           uniform (0 0 0);
    }
</pre>

* ''absorptionDir'' can be used to obtain Quasi-3D behaviour (see the first [[#References_and_Citing | reference]]). Its default value is greater than 360, so absorption is applied to the perpendicular direction to the patch.

3D-theory version, applicable to 3D:
<pre>
    outlet
    {
        type            IH_3D_3DAbsorption_InletVelocity;;
        nPaddles        1;
        nEdgeMin        0;
        nEdgeMax        0;
        value           uniform (0 0 0);
    }
</pre>

The differences between both are explained in the first [[#References_and_Citing | reference]]. If you are unsure whether to use the 2D or 3D version, use the 2D, as its range of applicability is wider.

Similarly to wave generation, setting ''nPaddles'' > 1 will allow directional absorption, as each paddles (vertical slices of the patch) absorbs the waves independently. For stability reasons try to keep your paddles approximately 5 cells wide at least.

* The patch is splitted in ''nPaddles'' vertical transects according to its orientation
** If it is more perpendicular to the X axis, it uses the Y coordinates to divide the patch in ''nPaddles'' between YMin and YMax. nEdgeMin starts to count from YMin. nEdgeMax starts to count from YMax.
** If it is more perpendicular to the Y axis, it uses the X coordinates to divide the patch in ''nPaddles'' between XMin and XMax. nEdgeMin starts to count from XMin. nEdgeMax starts to count from XMax.
* ''nEdgeMin'' and ''nEdgeMax'' solve some issues that appear on the corners, selecting a number of paddles that are only capable of taking water out according to the 2D theory.

== IHFOAM Documentation and Tutorials ==
aaa