wavefunctionsmodule Module Reference

Data Types
interface	initfunc4

Functions/Subroutines
subroutine	initfunc4fromfile (FNAME, G, D, RFUNC, IERR, RSEED)
subroutine	initspectrumof (IOP, H3, T1, Gamma, Omega0, dOmega, g, D, RFUNC, IERR, RSEED)
subroutine	initspectrumdnv (Hs, Tp, Gamma, Omega0, dOmega, g, D, RFUNC, IERR, RSEED, NWdir, SprExp)
real(dp) function, public	wavenumber (omega, g, d)
logical function, public	checkdepth (d, k)
subroutine, public	deepwave (RFUNC, g, x, z, t, atSurface, noWheelerStretching, h, u, w, du, dw, p)
subroutine, public	deepwaves (RFUNC, g, x, y, z, t, atSurface, noWheelerStretching, h, u, v, w, du, dv, dw, p)
subroutine, public	finitedepthwave (RFUNC, g, d, x, z, t, atSurface, noWheelerStretching, h, u, w, du, dw, p)
subroutine, public	finitedepthwaves (RFUNC, g, d, x, y, z, t, atSurface, noWheelerStretching, h, u, v, w, du, dv, dw, p)
subroutine, public	stokes2wave (RFUNC, g, d, x, z, t, atSurface, noWheelerStretching, h, u, w, du, dw)
subroutine, public	initfunc7 (H, T, eps, g, D, RFUNC, ierr)
subroutine, public	stokes5wave (RFUNC, d, x, z, t, atSurface, h, u, w, du, dw)
subroutine, public	initfunc8 (H, T, eps, g, D, RFUNC, iOrder)
subroutine, public	streamwave (RFUNC, d, x, z, t, atSurface, h, u, w, du, dw)
subroutine, public	initfunc9 (IOP, NR, NC, H3, T1, Gamma, Omega0, dOmega, g, D, ramp, embSLW, IFUNC, RFUNC, IERR, RSEED)
subroutine, public	embeddedwave (IFUNC, RFUNC, g, d, x, z, t, atSurf, noWS, h, u, w, du, dw)
subroutine, public	userdefinedwave (ikf, IFUNC, RFUNC, g, d, Xt, atSurf, h, u, du, ierr)

Variables
integer, parameter, public	dp = kind(1.0D0)
real(dp), parameter	pi = 3.141592653589793238_dp
real(dp), parameter, public	twopi = pi+pi

Function/Subroutine Documentation

checkdepth()

logical function, public wavefunctionsmodule::checkdepth	(	real(dp), intent(in)	d,
		real(dp), intent(in)	k
	)

deepwave()

subroutine, public wavefunctionsmodule::deepwave	(	real(dp), dimension(:,:), intent(in)	RFUNC,
		real(dp), intent(in)	g,
		real(dp), intent(in)	x,
		real(dp), intent(in)	z,
		real(dp), intent(in)	t,
		logical, intent(in)	atSurface,
		logical, intent(in)	noWheelerStretching,
		real(dp), intent(out)	h,
		real(dp), intent(out)	u,
		real(dp), intent(out)	w,
		real(dp), intent(out)	du,
		real(dp), intent(out)	dw,
		real(dp), intent(out), optional	p
	)

deepwaves()

subroutine, public wavefunctionsmodule::deepwaves	(	real(dp), dimension(:,:,:), intent(in)	RFUNC,
		real(dp), intent(in)	g,
		real(dp), intent(in)	x,
		real(dp), intent(in)	y,
		real(dp), intent(in)	z,
		real(dp), intent(in)	t,
		logical, intent(in)	atSurface,
		logical, intent(in)	noWheelerStretching,
		real(dp), intent(out)	h,
		real(dp), intent(out)	u,
		real(dp), intent(out)	v,
		real(dp), intent(out)	w,
		real(dp), intent(out)	du,
		real(dp), intent(out)	dv,
		real(dp), intent(out)	dw,
		real(dp), intent(out), optional	p
	)

embeddedwave()

subroutine, public wavefunctionsmodule::embeddedwave	(	integer, dimension(:), intent(in)	IFUNC,
		real(dp), dimension(:), intent(in)	RFUNC,
		real(dp), intent(in)	g,
		real(dp), intent(in)	d,
		real(dp), intent(in)	x,
		real(dp), intent(in)	z,
		real(dp), intent(in)	t,
		logical, intent(in)	atSurf,
		logical, intent(in)	noWS,
		real(dp), intent(out)	h,
		real(dp), intent(out)	u,
		real(dp), intent(out)	w,
		real(dp), intent(out)	du,
		real(dp), intent(out)	dw
	)

finitedepthwave()

subroutine, public wavefunctionsmodule::finitedepthwave	(	real(dp), dimension(:,:), intent(in)	RFUNC,
		real(dp), intent(in)	g,
		real(dp), intent(in)	d,
		real(dp), intent(in)	x,
		real(dp), intent(in)	z,
		real(dp), intent(in)	t,
		logical, intent(in)	atSurface,
		logical, intent(in)	noWheelerStretching,
		real(dp), intent(out)	h,
		real(dp), intent(out)	u,
		real(dp), intent(out)	w,
		real(dp), intent(out)	du,
		real(dp), intent(out)	dw,
		real(dp), intent(out), optional	p
	)

finitedepthwaves()

subroutine, public wavefunctionsmodule::finitedepthwaves	(	real(dp), dimension(:,:,:), intent(in)	RFUNC,
		real(dp), intent(in)	g,
		real(dp), intent(in)	d,
		real(dp), intent(in)	x,
		real(dp), intent(in)	y,
		real(dp), intent(in)	z,
		real(dp), intent(in)	t,
		logical, intent(in)	atSurface,
		logical, intent(in)	noWheelerStretching,
		real(dp), intent(out)	h,
		real(dp), intent(out)	u,
		real(dp), intent(out)	v,
		real(dp), intent(out)	w,
		real(dp), intent(out)	du,
		real(dp), intent(out)	dv,
		real(dp), intent(out)	dw,
		real(dp), intent(out), optional	p
	)

initfunc4fromfile()

subroutine wavefunctionsmodule::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

initfunc7()

subroutine, public wavefunctionsmodule::initfunc7	(	real(dp), intent(in)	H,
		real(dp), intent(in)	T,
		real(dp), intent(in)	eps,
		real(dp), intent(in)	g,
		real(dp), intent(in)	D,
		real(dp), dimension(*), intent(out)	RFUNC,
		integer, intent(out)	ierr
	)

initfunc8()

subroutine, public wavefunctionsmodule::initfunc8	(	real(dp), intent(in)	H,
		real(dp), intent(in)	T,
		real(dp), intent(in)	eps,
		real(dp), intent(in)	g,
		real(dp), intent(in)	D,
		real(dp), dimension(*), intent(out)	RFUNC,
		integer, intent(out)	iOrder
	)

initfunc9()

subroutine, public wavefunctionsmodule::initfunc9	(	integer, intent(in)	IOP,
		integer, intent(in)	NR,
		integer, intent(in)	NC,
		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(2), intent(in)	ramp,
		real(dp), dimension(:,:), intent(in)	embSLW,
		integer, dimension(:), intent(out)	IFUNC,
		real(dp), dimension(:), intent(out)	RFUNC,
		integer, intent(out)	IERR,
		integer, intent(in), optional	RSEED
	)

initspectrumdnv()

subroutine wavefunctionsmodule::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
	)

initspectrumof()

subroutine wavefunctionsmodule::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
	)

stokes2wave()

subroutine, public wavefunctionsmodule::stokes2wave	(	real(dp), dimension(:,:), intent(in)	RFUNC,
		real(dp), intent(in)	g,
		real(dp), intent(in)	d,
		real(dp), intent(in)	x,
		real(dp), intent(in)	z,
		real(dp), intent(in)	t,
		logical, intent(in)	atSurface,
		logical, intent(in)	noWheelerStretching,
		real(dp), intent(out)	h,
		real(dp), intent(out)	u,
		real(dp), intent(out)	w,
		real(dp), intent(out)	du,
		real(dp), intent(out)	dw
	)

stokes5wave()

subroutine, public wavefunctionsmodule::stokes5wave	(	real(dp), dimension(:), intent(in)	RFUNC,
		real(dp), intent(in)	d,
		real(dp), intent(in)	x,
		real(dp), intent(in)	z,
		real(dp), intent(in)	t,
		logical, intent(in)	atSurface,
		real(dp), intent(out)	h,
		real(dp), intent(out)	u,
		real(dp), intent(out)	w,
		real(dp), intent(out)	du,
		real(dp), intent(out)	dw
	)

streamwave()

subroutine, public wavefunctionsmodule::streamwave	(	real(dp), dimension(:), intent(in)	RFUNC,
		real(dp), intent(in)	d,
		real(dp), intent(in)	x,
		real(dp), intent(in)	z,
		real(dp), intent(in)	t,
		logical, intent(in)	atSurface,
		real(dp), intent(out)	h,
		real(dp), intent(out)	u,
		real(dp), intent(out)	w,
		real(dp), intent(out)	du,
		real(dp), intent(out)	dw
	)

userdefinedwave()

subroutine, public wavefunctionsmodule::userdefinedwave	(	integer, intent(in)	ikf,
		integer, dimension(3), intent(in)	IFUNC,
		real(dp), dimension(:), intent(in)	RFUNC,
		real(dp), intent(in)	g,
		real(dp), intent(in)	d,
		real(dp), dimension(4), intent(in)	Xt,
		logical, intent(in)	atSurf,
		real(dp), intent(out)	h,
		real(dp), dimension(3), intent(out)	u,
		real(dp), dimension(3), intent(out)	du,
		integer, intent(out)	ierr
	)

wavenumber()

real(dp) function, public wavefunctionsmodule::wavenumber	(	real(dp), intent(in)	omega,
		real(dp), intent(in)	g,
		real(dp), intent(in)	d
	)

Variable Documentation

dp

integer, parameter, public wavefunctionsmodule::dp = kind(1.0D0)

pi

real(dp), parameter wavefunctionsmodule::pi = 3.141592653589793238_dp

private

twopi

real(dp), parameter, public wavefunctionsmodule::twopi = pi+pi