Evaluates the specified user-defined wave function. More...

Public Member Functions
integer function	ffauf_wave (baseId, funcId, d, g, params, args, h, u, du)

Detailed Description

Evaluates the specified user-defined wave function.

Parameters

[in]	baseId	Base Id of the function to evaluate
[in]	funcId	Index of function to evaluate
[in]	d	Wather depth
[in]	g	Gravity constant
[in]	params	Function parameters (constant)
[in]	args	Function argument values (position and time)
[out]	h	Wave elevation
[out]	u	Water particle velocity
[out]	du	Water particle acceleration

Constructor & Destructor Documentation

integer function ffauserfuncinterface::ffauf_wave::ffauf_wave	(	integer, intent(in)	baseId,
		integer, intent(in)	funcId,
		real(dp), intent(in)	d,
		real(dp), intent(in)	g,
		real(dp), dimension(*), intent(in)	params,
		real(dp), dimension(*), intent(in)	args,
		real(dp), intent(out)	h,
		real(dp), dimension(3), intent(out)	u,
		real(dp), dimension(3), intent(out)	du
	)

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