TFrequencyDomainProcessComponent2

The TFrequencyDomainProcessComponent2 structure contains the properties of a frequency domain process component. This information is returned from C_GetFrequencyDomainProcessComponents2.

typedef struct {

int ProcessType;

int ProcessIndex;

double Frequency;

double FrequencyLowerBound;

double FrequencyUpperBound;

double PhaseLagWrtSimulationTime;

} TFrequencyDomainProcessComponent;

Members

ProcessType

One of iptWave, iptWind, iptWaveDrift or iptLFIdentifier. Identifies the type of independent process in which this component is contained.

The iptLFIdentifier type is non-physical and is only added after a solve at low-frequency, combined linearisation solution frequencies when the number of physical wave frequency and low-frequency components are the same. It is used internally by the API.

ProcessIndex

Identifies the independent process in which this component is contained. All components with the same index are from the same independent process. The lowest index value is always zero.

Frequency

The frequency of the component.

FrequencyLowerBound, FrequencyUpperBound

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

PhaseLagWrtSimulationTime

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

For ProcessType iptWave, it is the phase lag to the time the wave component's crest passes the global origin.
For ProcessType iptWind, it is the phase lag to the time of the wind component's peak velocity.
For ProcessType iptWaveDrift, it is a random phase lag assigned using the wave drift load component seed. Unlike the other process types it does not define the phase lag relative to some physical feature of the environmental system. However, it allows the phase of the wave drift components to be defined relative to each other.

This member is only used for the synthesis of time histories.