wavefunctionsmodule::initfunc4 Interface Reference

Initializes parameters of a sea wave function. More...

Private Member Functions
subroutine	initfunc4fromfile (FNAME, G, D, RFUNC, IERR, RSEED)
	Initializes wave function parameters from the given file. More...
subroutine	initspectrumdnv (Hs, Tp, Gamma, Omega0, dOmega, g, D, RFUNC, IERR, RSEED, NWdir, SprExp)
	Initializes a wave function based on statistical parameters. More...
subroutine	initspectrumof (IOP, H3, T1, Gamma, Omega0, dOmega, g, D, RFUNC, IERR, RSEED)
	Initializes a wave function based on statistical parameters. More...

Detailed Description

Initializes parameters of a sea wave function.

Member Function/Subroutine Documentation

initfunc4fromfile()

subroutine wavefunctionsmodule::initfunc4::initfunc4fromfile ( character(len=*), intent(in)  FNAME, real(dp), intent(in)  G, real(dp), intent(in)  D, real(dp), dimension(:,:), intent(out)  RFUNC, integer, intent(out)  IERR, integer, intent(in), optional  RSEED  )

private

Initializes wave function parameters from the given file.

Parameters

[in]	FNAME	Name of file to read wave parameters from.
[in]	G	Gravity constant
[in]	D	Sea depth for finite depth waves
[out]	RFUNC	Real function parameters
[out]	IERR	Error flag
[in]	RSEED	Seed for random value generator

The file may consist of either two, three or four columns of data. The number of columns may be specified on the first line as #ncol <ncol>. If the first line does not contain the keyword #ncol, a two-column file is assumed. The phase shift is then generated randomly. The wave number is calculated internally unless specified in the fourth column.

col #1 : Amplitude   [m]
col #2 : Frequency   [Hz]
col #3 : Phase shift [0,1]
col #4 : Wave number [1/m]

Author

Knut Morten Okstad

Date

16 Jan 2007

initspectrumdnv()

subroutine wavefunctionsmodule::initfunc4::initspectrumdnv ( real(dp), intent(in)  Hs, real(dp), intent(in)  Tp, real(dp), intent(in)  Gamma, real(dp), intent(in)  Omega0, real(dp), intent(in)  dOmega, real(dp), intent(in)  g, real(dp), intent(in)  D, real(dp), dimension(:,:), intent(out)  RFUNC, integer, intent(out)  IERR, integer, intent(in), optional  RSEED, integer, intent(in), optional  NWdir, integer, intent(in), optional  SprExp  )

private

Initializes a wave function based on statistical parameters.

Parameters

[in]	Hs	Significant wave height (mean of the one third highest waves)
[in]	Tp	The wave period corresponding to the peak frequency
[in]	Gamma	Spectral peakedness (see below).
[in]	Omega0	Lowest frequency in wave spectrum (if ≤ 0 use constant frequency intervals)
[in]	dOmega	Frequency increment between successive wave components
[in]	g	Gravity constant
[in]	D	Sea depth for finite depth waves
[out]	RFUNC	Real function parameters
[out]	IERR	Error flag
[in]	RSEED	Seed for random value generator
[in]	NWdir	Number of wave directions
[in]	SprExp	Wave spreading exponent (for Ndir > 1)

This subroutine generates the wave function parameters from a wave spectrum. If Gamma ≤ 1, a Pierson-Moskowitz spectrum is used, otherwise a JONSWAP spectrum depending on Gamma is used.

References:

1. DNV Recommended practice 205, October 2010.
2. S. K. Chakrabarti, "Hydrodynamics of Offshore Structures", pp. 113-116.

Author

Paul Anton Letnes

Date

3 Jan 2013

Author

Knut Morten Okstad

Date

20 Jul 2015

initspectrumof()

subroutine wavefunctionsmodule::initfunc4::initspectrumof ( integer, intent(in)  IOP, real(dp), intent(in)  H3, real(dp), intent(in)  T1, real(dp), intent(in)  Gamma, real(dp), intent(in)  Omega0, real(dp), intent(in)  dOmega, real(dp), intent(in)  g, real(dp), intent(in)  D, real(dp), dimension(:,:), intent(out)  RFUNC, integer, intent(out)  IERR, integer, intent(in), optional  RSEED  )

private

Initializes a wave function based on statistical parameters.

Parameters

[in]	IOP	Wave spectrum model: Pierson-Moskowitz with constant frequency intervals Pierson-Moskowitz with random frequency intervals JONSWAP spectrum with constant frequency intervals JONSWAP spectrum with random frequency intervals
[in]	H3	Significant wave height (mean of the one third highest waves)
[in]	T1	Mean wave period
[in]	Gamma	Spectral peakedness
[in]	Omega0	Lowest frequency in wave spectrum
[in]	dOmega	Frequency increment between successive wave components
[in]	g	Gravity constant
[in]	D	Sea depth for finite depth waves
[out]	RFUNC	Real function parameters
[out]	IERR	Error flag
[in]	RSEED	Seed for random value generator

This subroutine generates the wave function parameters from a wave spectrum depending on the input argument IOP (see above).

References:

1. O. Faltinsen, Sea Loads on Ships and Offshore Structures, pp. 23-26.

Author

Knut Morten Okstad

Date

29 Jan 2007

---

The documentation for this interface was generated from the following file:

• fedem-foundation/src/FFaFunctionLib/waveFunctionsModule.f90