Post-processing: Instruction format

The easiest way to learn about the instruction format is by using the instructions wizard which allows you to create instructions in an interactive manner.

In the OrcaFlex spreadsheet, each instruction consists of the following cells.

Sheet name

The name of the worksheet in which cells are to be written. If a worksheet with this name already exists, then the specified label and output cells will be overwritten but other cells will be left unchanged. If no sheet of that name exists then one will be created.

Label cell

The cell in the sheet name worksheet to which the label (if not empty) will be written.

Label

The string to be written to the label cell. This cell can be left empty, in which case the label cell is ignored.

Output cell

The cell in the sheet name worksheet to which results or data should be written. Some commands specify multiple-value output – for example a time history consists of a column of results. In this case the output cell specifies the top left cell of the block of cells to be written.

Command

This should be either one of the pre-defined commands or empty. If this cell is empty, then the output cell is ignored and just the label is output.

Object name

The name of the OrcaFlex object whose results or data are output.

Additional data

This column is used when outputting results for certain types of OrcaFlex object, as follows.

For the environment object you need to specify the global X,Y,Z coordinates of the point for which you want results – the coordinates must be separated by the ';' character. If no point is specified then (0,0,0) will be assumed. If the result requires a disturbance vessel, this is specified after the coordinates, e.g. "0;0;0; DisturbanceVesselName=Vessel1".

For vessel objects, some results require the local x,y,z coordinates of the point for which you want results. The coordinates must be separated by the ';' character. Leave this cell blank to use the vessel origin.

For 6D buoy objects, you must specify the wing name if you are requesting a wing result, or a point in local x,y,z buoy coordinates for some other results – the coordinates must be separated by the ';' character, or left blank to use the buoy origin.

For supports results offered by vessel and 6D buoy objects you need to specify the support index and, if applicable, a supported line name, e.g. "SupportIndex=3" and "SupportIndex=4; SupportedLineName=Line1".

For Morison element results offered by vessel and 6D buoy objects you need to specify the element index and, if applicable, the arc length, e.g. "ElementIndex=2" and "ElementIndex=1; Arclength 25.0".

For winch objects you may need to specify the winch connection number.

For line objects you must give the position on the line for which results are wanted. There are a variety of ways to do this:

• The position can be specified by arc length, e.g. "Arclength 25.0".
• The node number can be specified, e.g. "Node 4".
• One of the line ends can be specified, e.g. "End A", "End B" or more concisely "A" or "B".
• The touchdown position can be used: "Touchdown".
• For stress results you must also give the position of the point within the cross section through the specified arc length. You do this by specifying R,Theta values, e.g. "Inner", "Outer", "Mid", "Theta 270.0".

• Clearance results can be reported either as clearances from this line to all other lines or from this line to a specified other line. You can choose this other line by adding its name after the position, e.g. "Arclength 35; Line2", "Node 4; Riser"; "End B; Hose" etc. If you do not specify another line (e.g. "Arclength 35") then clearances will be reported from this line to all other lines.

The results are given for the nearest appropriate result point.

For turbine objects, some results require the local x,y,z coordinates of the point for which you want results. The coordinates must be separated by the ';' character. Leave this cell blank to use the turbine origin.

For turbine blade results you must specify the blade index, e.g. "BladeIndex=1". For blade results that also depend on the position along the blade you must specify that position. For example:

• The position can be specified by arc length, e.g. "Arclength 25.0".
• One of the ends can be specified, e.g. "End A", "End B" or more concisely "A" or "B".

The results are given for the nearest appropriate result point.

When specifying both blade index and position, these are separated by the ';' character, e.g. "BladeIndex=2; End A" or "BladeIndex=1; Arclength 25.0".

For the range graph commands you can specify a range of arc lengths, e.g. "20 to 50". You can also use ranges such as "<35" or ">60" to specify all arc lengths less than or greater than that given.

For the Rayleigh extremes instruction you can specify the parameters for the extreme value statistics analysis.

For the frequency domain instructions you can specify the storm duration used to calculate the most probable maximum.

For the cycle histogram instruction you can specify the bin size and how the bin quantity is reported (as a count or percentage).

For the duplicate sheet instruction, the source worksheet is specified in this column.

For the clear instruction, the range to be cleared is specified in this column. If the value in this column is left empty then the entire sheet is cleared.

For externally calculated results defined in an external function, you can specify the external result text to be passed to the external function in the form "externalResultText=your text".

Simulation period

The period of simulation for which results are wanted. This can be Whole simulation, Latest wave, Static state, Build up or a stage number (0 for the build-up, 1 for stage 1 etc.).

It can also be a Specified Period of simulation, given in the form "$t_1 \text{ to } t_2$" where $t_1$ and $t_2$ are numeric time values that are in the simulation and $\text{simulation start time} \leq t_1 \leq t_2 \leq \text{simulation end time}$. For example "20 to 30" or "-12.5 to +35.7". The time values $t_1$ and $t_2$ can be specified as ~ which is interpreted as simulation start time and simulation finish time respectively.

For synthesised time history and range graph results in a frequency domain simulation there is no simulation start and end time to limit the specified period.

To include restart parent models, use a specified period of the form "$t_1 \text{ to } t_2 \text{ collated}$".

This cell should be left empty for the data commands, and when outputting static state results using Static result and the range graph commands.

Variable

The name of the output variable.

If the command is a results command (e.g. Time history, Range graph, Linked statistics, Min etc.) this should be set to the same name as is used for the result in OrcaFlex. For example effective tension, curvature, surge, etc.

If the command is Get data then this is the data name of the data item.

If the command is Set data then this is name = value where name is the data name of the data item and value is its new value.

If the command is Select then this is the wave train, draught, RAO direction or QTF direction to be selected.