TPeriod

The TPeriod data structure specifies the period of an OrcaFlex simulation. The TPeriod data structure corresponds to the period data on the OrcaFlex results page.

typedef struct {

int PeriodNum;

int Unused;

double FromTime;

double ToTime;

} TPeriod;

Members

PeriodNum

Can be one of:

A number between 0 and the number of stages in the simulation. This specifies a numbered stage in the OrcaFlex simulation. For example 0 specifies the build-up, 1 specifies the first stage etc.
pnSpecifiedPeriod: A period specified by the FromTime and ToTime members.
pnLatestWave: The latest wave period.
pnWholeSimulation: The entire simulation.
pnStaticState: Use this value when you want static state results.
pnInstantaneousValue: Use this value when you want a single value at the current simulation time.

Unused

Ignored

FromTime

Only used when PeriodNum is pnSpecifiedPeriod. This is the start time of the period.

For collated results a value of OrcinaDefaultReal() can be used to mean the first sample of the first model in the restart chain.

ToTime

Only used when PeriodNum is pnSpecifiedPeriod. This is the finish time of the period.