6.1.1.1. SWD constructor and methods

The documentation for each method in this table is autogenerated from the Python source code.

SpectralWaveData.__init__(file_swd, x0, y0, …)	Constructor
SpectralWaveData.__getitem__(key)	self[key] is an alias for calling the method get()
SpectralWaveData.update_time(time)	Set the current time for all kinematic calculations.
SpectralWaveData.acc_euler(x, y, z)	Calculates the Euler acceleration (grad(phi_t)) at (x,y,z).
SpectralWaveData.acc_particle(x, y, z)	Calculates the particle acceleration at (x,y,z).
SpectralWaveData.bathymetry(x, y)	Calculates the vertical distance from z=0 to the sea floor at (x, y).
SpectralWaveData.bathymetry_nvec(x, y)	Return the unit normal vector of the sea floor at (x,y).
SpectralWaveData.close()	Manual destructor closing the object and the SWD-file.
SpectralWaveData.convergence(x, y, z, csv)	For a specific location create a CSV-file on how velocity, elevation and pressure converge as a function of number of spectral components.
SpectralWaveData.elev(x, y)	Calculates the wave elevation at (x,y).
SpectralWaveData.elev_t(x, y)	Calculates the time derivative of the wave elevation at earth fixed location.
SpectralWaveData.get(key)	Extract metadata from the SWD object
SpectralWaveData.grad_elev(x, y)	Calculates the gradients of the wave elevation.
SpectralWaveData.grad_elev_2nd(x, y)	Calculates the 2nd order gradients of the wave elevations.
SpectralWaveData.grad_phi(x, y, z)	Calculates the particle velocity.
SpectralWaveData.grad_phi_2nd(x, y, z)	Calculates the 2nd order derivatives of the wave potential.
SpectralWaveData.phi(x, y, z)	Calculates the velocity potential at the actual location.
SpectralWaveData.phi_t(x, y, z)	Calculates the time derivative of the wave potential at the actual location (Euler derivative).
SpectralWaveData.pressure(x, y, z)	Calculates the complete nonlinear Bernoulli-pressure (Const=0).
SpectralWaveData.stream(x, y, z)	Calculates the stream function at the actual location.
SpectralWaveData.strip(tmin, tmax, file_swd)	Create a new SWD file containing only the time steps within the time window [tmin, tmax].