Benchmark cases
===============

Cases description
-----------------

Benchmark resource files are available in ``Benchmark`` directory (located at root of HOS-NWT project).

This contains different test-cases with reference solutions (``Ref_data`` sub-directory) in following directories:

-  ``Sloshing``: 2D linear sloshing (icase=1)
-  ``Regular``: 2D regular wave (icase=2)
-  ``Irreg_2D``: 2D irregular wavefield (icase=3)
-  ``Regular_3D``: 3D regular wave with an angle of propagation of 30° (icase=2)
-  ``Irreg_3D``: 3D irregular wavefield (icase=31)

Run and results
---------------

Linux
~~~~~

The execution of all benchmarks and automatic vizualisation of results (using Tecplot) is made with following instructions, using shell files:

-  2D cases

   .. sourcecode:: bash

      sh benchmark.sh

-  3D cases

   .. sourcecode:: bash

      sh benchmark_3D.sh

Windows
~~~~~~~

The program has to be executed in command-line in each directory mentioned previously and results compared to reference data. This may be done using Tecplot's layouts (``.lay`` file) located in each test-case.