Contribution to HOS NWT - LHEEA/HOS-NWT GitHub Wiki

For developers/contributors to the HOS-NWT project, a GIT repository has been set-up. In order to avoid any issues concerning the main subroutines, different benchmarks are provided with some reference solutions to compare with.

GIT contributions

The GitHub repository is used in other projects in LHEEA using Gerrit Code Review. As a consequence, each commit message must include

  • Change-Id line
  • Signed-off-by line

Change-Id line

Change-Ids are created at commit time on the client side. A standard commit-msg hook is provided by Gerrit, and can be installed in the local Git repository to automatically generate and insert a Change-Id line during git commit, when none is defined yet.

To install the hook, you can download it from gerrit review and copy the corresponding file to .git/hooks/

Then ensure that the execute bit is set on the hook script:

chmod u+x .git/hooks/commit-msg

Signed-off-by line

The sign-off is a simple line at the end of the explanation of the commit of the form

Signed-off-by: Random J Developer [email protected]

General recommendations

It is asked for anyone contributing to HOS-NWT

  • Fortran source files
  • Makefile: especially compilation options

to run the benchmarks and ensure that results are correct.

Benchmarking

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/Unix environment

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

  • 2D configuration
    • sh benchmark.sh
  • 3D configuration
    • sh benchmark_3D.sh

Windows environment

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.

TO BE COMPLETED

Analytics