TWaveComponent2

The TWaveComponent2 structure is used to store information about a single wave component. This information is returned from C_GetWaveComponents2.

typedef struct {

int WaveTrainIndex;

double Frequency;

double FrequencyLowerBound;

double FrequencyUpperBound;

double Amplitude;

double PhaseLagWrtWaveTrainTime;

double PhaseLagWrtSimulationTime;

double WaveNumber;

double Direction;

} TWaveComponent2;

Members

WaveTrainIndex

The index of the wave train to which this component belongs. The index is zero-based so that the first wave train has index 0.

Frequency

The frequency of the wave component.

FrequencyLowerBound, FrequencyUpperBound

For a wave component in a random wave train (e.g. a wave train defined by a frequency spectrum) the component represents a frequency interval. The FrequencyLowerBound and FrequencyUpperBound fields define this interval. For wave trains that are not defined by a frequency spectrum (e.g. regular waves, user-specified components) then these fields are set to OrcinaUndefinedReal().

Amplitude

The amplitude of the wave component.

PhaseLagWrtWaveTrainTime

The phase lag of the wave component. This value is measured for the wave crest at the wave origin, in degrees, and is with respect to the wave train time origin.

PhaseLagWrtSimulationTime

The phase lag of the wave component. This value is measured for the wave crest at the wave origin, in degrees, and is with respect to the simulation time origin.

WaveNumber

The wave number of the wave component. This is defined as 2π / L where L is the wave length for this component.

Direction

The direction of the wave component. This value is measured in degrees and is equal to the wave train direction data item in OrcaFlex.