TObjectExtra2

The TObjectExtra2 data structure is used to specify where on an object results are required.

For the environment you need to specify which point in the sea results are for and whether these results are for the undisturbed sea state, or the sea state owing to the presence of a particular disturbance vessel.
For a line you specify either end A, end B, touchdown, the node number or the arclength. For stress component results you specify the position within the pipe cross section by setting RadialPos and Theta. Also if you want clearance results to be reported as clearances from a specified line then you can specify that line.
For a 6D buoy, if you want results for a particular wing attached to the 6D buoy, you must specify that wing.
For a winch, if you want position results, you must specify the winch connection point at which results are reported.

typedef struct {

int Size;

TVector EnvironmentPos;

int LinePoint;

int NodeNum;

double ArcLength;

int RadialPos;

double Theta;

LPCTSTR WingName;

LPCTSTR ClearanceLineName;

int WinchConnectionPoint;

TVector RigidBodyPos;

LPCTSTR ExternalResultText;

LPCTSTR DisturbanceVesselName;

int SupportIndex;

LPCTSTR SupportedLineName;

int BladeIndex;

int ElementIndex;

double SeaSurfaceScalingFactor;

} TObjectExtra2;

Members

Size

Specifies the size, in bytes, of this data structure. Set this member to sizeof(TObjectExtra2) before calling a function with a TObjectExtra2 parameter.

EnvironmentPos

You only need to set this member if you are requesting results for the environment. This is a position in global coordinates. Results such as Surface Elevation, X Velocity etc. are given at this point.

LinePoint

You only need to set this member if you are requesting results for a line, a turbine or a Morison element of a vessel or 6D buoy.

Can be one of:

ptEndA: results at end A of the line or turbine. Note that this value cannot be used for a Morison element.
ptEndB: results at end B of the line or turbine. Note that this value cannot be used for a Morison element.
ptTouchdown: results at the line's touchdown point. Note that this value cannot be used for a turbine or Morison element.
ptNodeNum: results at the point specified by NodeNum. Note that this value cannot be used for a turbine or Morison element.
ptArcLength: results at the point specified by ArcLength.

NodeNum

You only need to set this member if you are requesting results for a line and LinePoint is ptNodeNum. Otherwise it is ignored.

Set this to be the number of the node for which you want results. Nodal results will be given for this node and segment results will be given for the following segment, or for the preceding segment if it is the last node.

ArcLength

You only need to set this member if you are requesting results for a line, turbine or Morison element and LinePoint is ptArcLength. Otherwise it is ignored.

Set this to be the arclength for which you want results. Nodal results will be given for the nearest node to this arclength and segment results will be given for the segment that contains this arclength. (If the arclength is exactly at the boundary between segments n and n+1 then segment results will be given for segment n+1.)

RadialPos

You only need to set this member if you are requesting results for a line and the results variable requires specification of the position of the point within the cross section through the specified arclength. Otherwise it is ignored.

Set this to rpInner, rpOuter or rpMid. For more details see the diagram in the Pipe Stress Calculation section of the OrcaFlex calculation.

Theta

Set this to the angle, in degrees, from the line's local x-axis measured towards the line's local y-axis. For more details see the diagram in the Pipe Stress Calculation section of the OrcaFlex calculation.

WingName

You only need to set this member if you are requesting results for a wing attached to a 6D buoy. Otherwise you must set it to NULL.

Set this to the name of the wing for which you want results.

Note:

The results variables which require WingName are those which begin "Wing" (e.g. Wing Lift, Wing Drag, Wing X etc.)

ClearanceLineName

You only need to set this member if you are requesting line clearance results for a line or turbine. Otherwise you must set it to NULL.

If this is set to NULL then reported clearances are from all other lines in the model. If this is set to the name of a line in the model then reported clearances are clearances from the named line.

WinchConnectionPoint

You only need to set this member if you are requesting position results for a winch.

Set this to the number of the winch connection point for which you want position results. This is an integer in the range 1 to number of winch connections inclusive.

RigidBodyPos

You only need to set this member if you are requesting position, velocity or acceleration results for 6D buoys or vessels. This is a position in the local coordinate system of the object. Position, velocity and acceleration results are given at this point.

ExternalResultText

This member is only set if you are passing user specified parameters when requesting an external result from an external function, otherwise this member should be set to NULL.

DisturbanceVesselName

This member must be set if you are requesting elevation, velocity or acceleration results for the environment. If it is set to NULL then the results reported will be for the undisturbed sea state; otherwise, the results will be for the disturbed sea state owing to the presence of a particular disturbance vessel.

SupportIndex

This member must be set if you are requesting supports results. Set this member to the 1-based index of the support for which results are requested.

SupportedLineName

This member must be set if you are requesting supports results. Set this member to NULL to request results over all supported lines, or to the name of a supported line. If the result variable is not dependent on the supported line, this member should be set to NULL.

BladeIndex

This member must be set if you are requesting results for individual turbine blades. Set this member to the 1-based index of the blade for which results are requested.

ElementIndex

This member must be set if you are requesting results for individual Morison elements of a vessel or 6D buoy. Set this member to the 1-based index of the element for which results are requested.

SeaSurfaceScalingFactor

This member must be set if you are requesting air gap results for a vessel.

Unicode and ANSI

The Unicode structure name is TObjectExtra2W and the ANSI structure name is TObjectExtra2A.