Last updated on Feb 20, 2026.

netsse.simul.ship_resp#

Numerical simulation of ship responses.

Last updated on 20-02-2026 by R.E.G. Mounet

Attributes#

fifo_queue

Classes#

MultiThread

This constructor should always be called with keyword arguments. Arguments are:

Functions#

`process_queue`()	A function to process the FIFO queue.
`simul_ship_resp`(S2D, freq_wave, betas_wave[, U, ...])	Generates several time histories of the waves encountered by a ship and,
`sum_components`(aw, V_seed, W_seed, epsilon_seed, ...)	Performs the summation of the sine components to simulate in the time domain

Module Contents#

class netsse.simul.ship_resp.MultiThread(name)[source]#

Bases: threading.Thread

This constructor should always be called with keyword arguments. Arguments are:

group should be None; reserved for future extension when a ThreadGroup class is implemented.

target is the callable object to be invoked by the run() method. Defaults to None, meaning nothing is called.

name is the thread name. By default, a unique name is constructed of the form “Thread-N” where N is a small decimal number.

args is a list or tuple of arguments for the target invocation. Defaults to ().

kwargs is a dictionary of keyword arguments for the target invocation. Defaults to {}.

If a subclass overrides the constructor, it must make sure to invoke the base class constructor (Thread.__init__()) before doing anything else to the thread.

run()[source]#

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

name[source]#

A string used for identification purposes only.

It has no semantics. Multiple threads may be given the same name. The initial name is set by the constructor.

netsse.simul.ship_resp.process_queue()[source]#

A function to process the FIFO queue.

This basic function runs the function netsse.simul.ship_resp.sum_components() with the queued arguments, until the queue is empty, after which it signals that the task is completed.

See also

sum_components: Performs the summation of the sine components to simulate in the time domain the encountered wave elevation or the wave-induced responses on a ship.

Example

>>> # Wave simulations
>>> time, wavet =
...     simul_ship_resp(S2D,freq_wave,betas_wave,U,'Waves',0,NoTs=10,fs=10,T=30*60,
...                     Nomega=500,AddNoise=True,snr=20)
>>> # Motion simulations
>>> time, wavet, heavet, rollt, pitcht =
...     simul_ship_resp(S2D,freq_wave,betas_wave,U,'Motions',0,freq_TRF,betas_TRF,
...                     TRF_amps,TRF_phases,NoTs,fs,T,Nomega,AddNoise=True,snr=20)

netsse.simul.ship_resp.sum_components(aw, V_seed, W_seed, epsilon_seed, om_enc, time, seed, result, TRF_amps=0, TRF_phases=0, RespStr='Waves', AddNoise=False, snr=20)[source]#

Performs the summation of the sine components to simulate in the time domain the encountered wave elevation or the wave-induced responses on a ship.

Parameters:

aw (array_like of shape (Nfreq,Nbeta,1)) – Amplitude of the wave components.
V_seed (array_like of shape (Nfreq,Nbeta,1)) – Standard normal distributed variables with mean 0 and std. 1.
W_seed (array_like of shape (Nfreq,Nbeta,1)) – Standard normal distributed variables with mean 0 and std. 1.
epsilon_seed (array_like of shape (Nfreq,Nbeta,1)) – Random phases [rad] of the wave components. Those are uniformly distributed variables between 0 and \(2\pi\).
om_enc (array_like of shape (Nfreq,1,1)) – Vector of encounter wave frequencies [rad/s].
time (array_like of shape (1,1,Nt)) – Vector of time [s].
seed (int) – Index of the seed number.
result (array_like of shape (Nseed,Nt)) –
Anterior value of the vector of wave/response sequence.

Note

Consult the documentation of the netsse.simul.ship_resp.simul_ship_resp() function for information on the other parameters.

Returns:

result – Updated value of the vector of wave/response sequence.

Return type:

array_like of shape (Nseed,Nt)