Class: wsim.waveSettings ======================== Inheiritance Graph -------------------------------------------------- .. raw:: html
.. graphviz:: digraph graph_for_waveSettings { "handle" -> "wsim.waveSettings"; } Parent Class Properties and Methods -------------------------------------------------- .. raw:: html
handle ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Inheirited Properties """""""""""""""""""""""""""""""""""""""""""""""""" None Inheirited Methods """""""""""""""""""""""""""""""""""""""""""""""""" * addlistener : *ADDLISTENER Add listener for event.* * addlistener : *ADDLISTENER Add listener for event.* * addlistener : *ADDLISTENER Add listener for event.* * addlistener : *ADDLISTENER Add listener for event.* * addlistener : *ADDLISTENER Add listener for event.* * delete : *DELETE Delete a handle object.* * eq : *== (EQ) Test handle equality.* * findobj : *FINDOBJ Find objects matching specified conditions.* * findprop : *FINDPROP Find property of MATLAB handle object.* * ge : *>= (GE) Greater than or equal relation for handles.* * gt : *> (GT) Greater than relation for handles.* * isvalid : *ISVALID Test handle validity.* * le : *<= (LE) Less than or equal relation for handles.* * listener : *LISTENER Add listener for event without binding the listener to the source object.* * listener : *LISTENER Add listener for event without binding the listener to the source object.* * listener : *LISTENER Add listener for event without binding the listener to the source object.* * listener : *LISTENER Add listener for event without binding the listener to the source object.* * listener : *LISTENER Add listener for event without binding the listener to the source object.* * lt : *< (LT) Less than relation for handles.* * ne : *~= (NE) Not equal relation for handles.* * notify : *NOTIFY Notify listeners of event.* * notify : *NOTIFY Notify listeners of event.* Properties ---------- .. raw:: html
* A * H * Pw * S * T * bemFreq * currentDepth * currentDirection * currentOption * currentSpeed * deepWaterWave * dw * etaData * etaDataFile * etaImportMaxTime * etaImportMinTime * freqDisc * freqRange * gamma * ignoreFrequencyBands * k * numFreq * phase * phaseSeed * spectrumDataFile * spectrumType * statisticsDataLoad * type * typeNum * viz * w * waterDepth * waveAmpTime * waveAmpTime1 * waveAmpTime2 * waveAmpTime3 * waveDir * waveSpread * wavegauge1loc * wavegauge2loc * wavegauge3loc A ^ [m] Wave amplitude for regular waves or 2*(wave spectrum vector) for irregular waves H ^ % [m] Wave height or significant wave height for irregular Wave height (regular waves) or significant wave height (irregular waves). For regular waves this the peak-to-trough amplitude. (Default = 'NOT DEFINED') Pw ^^ Wave Power Per Unit Wave Crest [W/m] S ^ Wave Spectrum [m^2-s/rad] for 'Traditional' T ^ [s] Wave period, peak wave period or BEM period. Wave period (regular waves), peak period (irregular waves), or period of BEM data used for hydrodynamic coefficients ('noWave') (Default = 'NOT DEFINED') bemFreq ^^^^^^^ Number of wave frequencies from BEM currentDepth ^^^^^^^^^^^^ [m] Define the depth over which the sub-surface current is modeled. For options (1) and (2) the currentDepth must be defined. The current is not calculated for any depths greater than the specified currentDepth. (Default = 0). currentDirection ^^^^^^^^^^^^^^^^ [deg] Surface current direction. (Default = 0). currentOption ^^^^^^^^^^^^^ [-] Define the sub-surface current model to be used in WEC-Sim. (Default = 0) 0 : Depth-independent model 1 : 1/7 power law variation with depth 2 : linear variation with depth 3 : no current currentSpeed ^^^^^^^^^^^^ [m/s] Surface current speed that is uniform along the water column. (Default = 0). deepWaterWave ^^^^^^^^^^^^^ Deep water or not, depending on input from WAMIT, NEMOH and AQWA dw ^^ [rad] Frequency spacing for irregular waves. etaData ^^^^^^^ (n X 2) matrix that contains the times-series wave data. Must be a matrix with two columns, the first time, the second, wave elevation. (Default = []) etaDataFile ^^^^^^^^^^^ Data file that contains the times-series wave data file. The file should contain a single variable named etaData which is a matrix with two columns, the first time, the second, wave elevation. (Default = '') etaImportMaxTime ^^^^^^^^^^^^^^^^ the maximum time in the simulation data imported from the data file when using the 'etaImport' wave type. etaImportMinTime ^^^^^^^^^^^^^^^^ the minimum time in the simulation data imported from the data file when using the 'etaImport' wave type. freqDisc ^^^^^^^^ Method of frequency discretization for irregular waves. Options for this variable are 'EqualEnergy' or 'Traditional'. (Default = 'EqualEnergy'). freqRange ^^^^^^^^^ Min and max frequency for irregular waves. 2x1 vector, rad/s, (default = frequency range in BEM data) gamma ^^^^^ Only used for 'JS' spectrum type to define gamma (Default = 3.3) ignoreFrequencyBands ^^^^^^^^^^^^^^^^^^^^ k ^ Wave Number numFreq ^^^^^^^ of interpolated wave frequencies (default = []) Number of frequencies used, varies depending on method: Traditional = 1000, EqualEnergy = 500 or 'Imported' phase ^^^^^ [rad] Wave phase (only used for irregular waves) phaseSeed ^^^^^^^^^ Only used for irregular waves (Default = 0) if equal to 1,2,3,...,etc, the waves phase is seeded. spectrumDataFile ^^^^^^^^^^^^^^^^ Data file that contains the spectrum data file (Default = 'NOT DEFINED') spectrumType ^^^^^^^^^^^^ String containing the wave spectrum type Can be one of : 'PM', 'BS', and 'JS' (Default = 'NOT DEFINED') statisticsDataLoad ^^^^^^^^^^^^^^^^^^ File name from which to load wave statistics data (Default = []) type ^^^^ String defining the type of waves to be generated. Can be one of: 'noWave', 'noWaveCIC', 'regular', 'regularCIC', 'irregular', 'spectrumImport', and 'etaImport' (Default = 'NOT DEFINED'). typeNum ^^^^^^^ Number to represent different type of waves viz ^^^ Structure defining visualization options Should be a structure containing the fields 'numPointsX' and 'numPointsY'. numPointsX is the number of visualization points in x direction, and numPointsY the number of visualization points in y direction w ^ [rad/s] Wave frequency (regular waves) or wave frequency vector (irregular waves) waterDepth ^^^^^^^^^^ [m] Water depth (from BEM) waveAmpTime ^^^^^^^^^^^ [m] Wave elevation time history waveAmpTime1 ^^^^^^^^^^^^ [m] Wave elevation time history at a wave gauge 1 location specified by user waveAmpTime2 ^^^^^^^^^^^^ [m] Wave elevation time history at a wave gauge 2 location specified by user waveAmpTime3 ^^^^^^^^^^^^ [m] Wave elevation time history at a wave gauge 3 location specified by user waveDir ^^^^^^^ [deg] Incident wave direction (Default = 0) waveDir may be a vector to define more than one wave direction waveSpread ^^^^^^^^^^ Wave Spread probability associated with the wave direction waveSpread should be a vector of the same length as waveDir wavegauge1loc ^^^^^^^^^^^^^ [m] Wave gauge 1 [x,y] location (Default = [0,0]). wavegauge2loc ^^^^^^^^^^^^^ [m] Wave gauge 2 [x,y] location (Default = [0,0]). wavegauge3loc ^^^^^^^^^^^^^ [m] Wave gauge 3 [x,y] location (Default = [0,0]). Methods ------- .. raw:: html
* waveSettings * checkInputs * listInfo * plotEta * plotSpectrum * waveElevationGrid * waveNumber * waveSetup * write_paraview_vtp waveSettings ^^^^^^^^^^^^ .. raw:: html
Summary """""""""""""""""""" wsim.waveSettings constructor Syntax """""""""""""""""""" .. code-block:: none ws = wsim.waveSettings (type) Inputs """""""""""""""""""" type """" .. code-block:: none string containing the type of wave simulation to be generated, the possible values are 'noWave' : no waves 'noWaveCIC' : No waves but with the Convolution Integral Calculation to calculate radiation effects 'regular' : Regular waves 'regularCIC' : Regular waves with Convolution Integral Calculation to calculate radiation effects 'irregular' : Irregular Waves 'spectrumImport' : Irregular Waves with predefined phase 'etaImport' : Irregular Waves with predefined elevation 'sinForce' : Simple sinusoidal force specification with all other hydrodynamic forces disabled except buoyancy. This is intended for testing other parts of the system the hydrodynamic simulation is component of. Additional arguments may be supplied as parameter-value pairs: noWave """""" .. code-block:: none no waves noWaveCIC """"""""" .. code-block:: none No waves but with the Convolution Integral Calculation to calculate radiation effects regular """"""" .. code-block:: none Regular waves regularCIC """""""""" .. code-block:: none Regular waves with Convolution Integral Calculation to calculate radiation effects irregular """"""""" .. code-block:: none Irregular Waves spectrumImport """""""""""""" .. code-block:: none Irregular Waves with predefined phase etaImport """"""""" .. code-block:: none Irregular Waves with predefined elevation sinForce """""""" .. code-block:: none Simple sinusoidal force specification with all other hydrodynamic forces disabled except buoyancy. This is intended for testing other parts of the system the hydrodynamic simulation is component of. Outputs """""""""""""""""""" ws "" .. code-block:: none wsim.waveSettings object checkInputs ^^^^^^^^^^^ .. raw:: html
Summary """""""""""""""""""" Check user inputs 'noWave' period undefined for hydro data listInfo ^^^^^^^^ .. raw:: html
Summary """""""""""""""""""" List wave info plotEta ^^^^^^^ .. raw:: html
Summary """""""""""""""""""" Plot wave elevation time-history plotSpectrum ^^^^^^^^^^^^ .. raw:: html
Summary """""""""""""""""""" Plot wave spetrum waveElevationGrid ^^^^^^^^^^^^^^^^^ .. raw:: html
Summary """""""""""""""""""" calculates wave elevation on a grid at a given time Syntax """""""""""""""""""" .. code-block:: none Z = waveElevationGrid (ws, t, X, Y) Inputs """""""""""""""""""" ws "" .. code-block:: none wsim.waveSettings object Outputs """""""""""""""""""" See Also """""""""""""""""""" .. code-block:: none waveNumber ^^^^^^^^^^ .. raw:: html
Summary """""""""""""""""""" Calculate wave number waveSetup ^^^^^^^^^ .. raw:: html
Summary """""""""""""""""""" Calculate and set wave properties based on wave type write_paraview_vtp ^^^^^^^^^^^^^^^^^^ .. raw:: html
Summary """""""""""""""""""" Write vtp files for visualization using Paraview ground plane