Public Member Functions | |
| double | pm (double omega, double omega_p) |
| void | Recalculate () |
| Recalculate all derived quantities from inputs. More... | |
| void | RecalculateCmr () |
| Recalculate for constant wavelength-amplitude ratio. More... | |
| void | RecalculatePms () |
| Recalculate for Pierson-Moskowitz spectrum sampling model. More... | |
| WaveParametersPrivate () | |
| Constructor. More... | |
Public Attributes | |
| double | amplitude |
| The mean wave amplitude [m]. More... | |
| std::vector< double > | amplitudes |
| The component wave amplitudes (derived). More... | |
| double | angle |
| Set the angle between component waves and the mean direction. More... | |
| std::vector< double > | angularFrequencies |
| The component wave angular frequencies (derived). More... | |
| double | angularFrequency |
| The mean wave angular frequency (derived). More... | |
| ignition::math::Vector2d | direction |
| The mean wave direction. More... | |
| std::vector< ignition::math::Vector2d > | directions |
| The component wave dirctions (derived). More... | |
| double | gain |
| The multiplier applied to PM spectra. More... | |
| std::string | model |
| Name of wavefield model to use - must be "PMS" or "CWR". More... | |
| size_t | number |
| The number of component waves. More... | |
| double | period |
| The mean wave period [s]. More... | |
| double | phase |
| The mean wave phase (not currently enabled). More... | |
| std::vector< double > | phases |
| The component wave phases (derived). More... | |
| double | scale |
| Set the scale of the largest and smallest waves. More... | |
| double | steepness |
| Control the wave steepness. 0 is sine waves, 1 is Gerstner waves. More... | |
| std::vector< double > | steepnesses |
| The component wave steepness factors (derived). More... | |
| double | tau |
| The time constant for exponential increasing waves on startup. More... | |
| double | wavelength |
| The mean wavelength (derived). More... | |
| double | wavenumber |
| The mean wavenumber (derived). More... | |
| std::vector< double > | wavenumbers |
| The component wavenumbers (derived). More... | |
Definition at line 55 of file Wavefield.cc.
|
inline |
Constructor.
Definition at line 58 of file Wavefield.cc.
|
inline |
Definition at line 192 of file Wavefield.cc.
|
inline |
Recalculate all derived quantities from inputs.
Definition at line 263 of file Wavefield.cc.
|
inline |
Recalculate for constant wavelength-amplitude ratio.
Definition at line 137 of file Wavefield.cc.
|
inline |
Recalculate for Pierson-Moskowitz spectrum sampling model.
Definition at line 201 of file Wavefield.cc.
| double asv::WaveParametersPrivate::amplitude |
The mean wave amplitude [m].
Definition at line 92 of file Wavefield.cc.
| std::vector<double> asv::WaveParametersPrivate::amplitudes |
The component wave amplitudes (derived).
Definition at line 122 of file Wavefield.cc.
| double asv::WaveParametersPrivate::angle |
Set the angle between component waves and the mean direction.
Definition at line 86 of file Wavefield.cc.
| std::vector<double> asv::WaveParametersPrivate::angularFrequencies |
The component wave angular frequencies (derived).
Definition at line 119 of file Wavefield.cc.
| double asv::WaveParametersPrivate::angularFrequency |
The mean wave angular frequency (derived).
Definition at line 110 of file Wavefield.cc.
| ignition::math::Vector2d asv::WaveParametersPrivate::direction |
The mean wave direction.
Definition at line 101 of file Wavefield.cc.
| std::vector<ignition::math::Vector2d> asv::WaveParametersPrivate::directions |
The component wave dirctions (derived).
Definition at line 134 of file Wavefield.cc.
| double asv::WaveParametersPrivate::gain |
The multiplier applied to PM spectra.
Definition at line 107 of file Wavefield.cc.
| std::string asv::WaveParametersPrivate::model |
Name of wavefield model to use - must be "PMS" or "CWR".
Definition at line 77 of file Wavefield.cc.
| size_t asv::WaveParametersPrivate::number |
The number of component waves.
Definition at line 80 of file Wavefield.cc.
| double asv::WaveParametersPrivate::period |
The mean wave period [s].
Definition at line 95 of file Wavefield.cc.
| double asv::WaveParametersPrivate::phase |
The mean wave phase (not currently enabled).
Definition at line 98 of file Wavefield.cc.
| std::vector<double> asv::WaveParametersPrivate::phases |
The component wave phases (derived).
Definition at line 125 of file Wavefield.cc.
| double asv::WaveParametersPrivate::scale |
Set the scale of the largest and smallest waves.
Definition at line 83 of file Wavefield.cc.
| double asv::WaveParametersPrivate::steepness |
Control the wave steepness. 0 is sine waves, 1 is Gerstner waves.
Definition at line 89 of file Wavefield.cc.
| std::vector<double> asv::WaveParametersPrivate::steepnesses |
The component wave steepness factors (derived).
Definition at line 128 of file Wavefield.cc.
| double asv::WaveParametersPrivate::tau |
The time constant for exponential increasing waves on startup.
Definition at line 104 of file Wavefield.cc.
| double asv::WaveParametersPrivate::wavelength |
The mean wavelength (derived).
Definition at line 113 of file Wavefield.cc.
| double asv::WaveParametersPrivate::wavenumber |
The mean wavenumber (derived).
Definition at line 116 of file Wavefield.cc.
| std::vector<double> asv::WaveParametersPrivate::wavenumbers |
The component wavenumbers (derived).
Definition at line 131 of file Wavefield.cc.