8. Tools¶

In this section we describe some auxiliary tools related to spectral_wave_data.

8.1. swd2vtk¶

A program swd2vtk is available for advanced three-dimensional visualization of SWD wave fields. For a user specified domain a set of VTK-files is produced. The user selects a set of scalar and vector fields to be generated. VTK-files can be animated or further post-processed using the open-source program ParaView or other tools. More details are described in the swd2vtk user’s guide

Binary distributions of swd2vtk, for Windows and Linux, can be downloaded from the release tab of the GitHub repository spectral_wave_data. The binaries are distributed under the MIT-license. Hence, you can basically apply swd2vtk as you like for free.

8.2. Airy Waves¶

A general set of Airy waves can be written directly to a SWD file (shape 6) using the tools.airy module included in spectral_wave_data.

In this example we apply two wave components.

from spectral_wave_data.tools import airy

airy.write_swd('my_airy.swd',
               amps=[2.0, 3.0], dirs=[180.0, 70.0], phases=[50.0, 0.0], Twaves=[10.5, 13.0],
               depth=32.0, grav=9.81, is_deg_dirs=True, is_deg_phases=True)

The documentation of this function describes relevant optional parameters and further examples.

8.3. Fenton-Stream Waves¶

The raschii Python package for making non-linear regular waves supports output of SWD files. An example of producing a Fenton-Stream wave is given by this code snippet.

import raschii

WaveModel, AirModel = raschii.get_wave_model('Fenton')
wave = WaveModel(height=5.0, depth=15.0, length=200.0, N=30)
wave.write_swd('my_fenton.swd', dt=0.05, nperiods=50)

This method applies the shp=2 shape class. The module swd_tools.py in the raschii distribution demonstrates how to create SWD files directly from Python.

Raschii also has a graphical online demo.

Note

This feature in raschii will soon be released on PyPI. However, it is included in the “write_swd” branch of that repository.

8.4. Stokes Waves¶

The raschii Python package may also output Stokes waves in the SWD format.

import raschii

WaveModel, AirModel = raschii.get_wave_model('Stokes')
wave = WaveModel(height=5.0, depth=15.0, length=200.0, N=5)
wave.write_swd('my_stokes.swd', dt=0.05, nperiods=50)

This method applies the shp=2 shape class.

Note

This feature in raschii will soon be released on PyPI. However, it is included in the “write_swd” branch of that repository.

8.5. WAMOD¶

DNVGL is releasing the program WAMOD for simulation of irregular seas based on HOS(M), the Higher-Order-Spectral-Method. The typical input is a wave spectrum and the output is a SWD file providing linear or nonlinear wave fields. Long and short crested seas can be simulated in finite or infinite water depth.

The new release of WASIM can apply the SWD API for incident wave kinematics and Froude-Krylov forces. There are no restrictions regarding which wave generator produced the SWD file. WASIM is a Rankine panel program for simulating wave induced responses of marine structures.

WAMOD and WASIM have commercial licenses and support.

8.6. Other programs¶

Other software utilizing SWD will be added to this page when they are released. Please contact the maintainers when new software appear.