Python external functions: InstantaneousCalculationData

Some model objects using external functions provide additional state data (such as position, velocity etc.) through the InstantaneousCalculationData attribute of ExternalFunctionInfo. This attribute will contain a Python object, created by OrcaFlex. The type and attributes will depend on the type of model object using the external function. The attributes should not be modified.

6D buoy instantaneous data attributes

The Orientation attribute is a matrix which is represented in Python as a tuple containing 3 tuple vectors, the first tuple element being the vector for the first row of the matrix. ProportionWet and FluidDensity are Python float types and all the other attributes are vectors represented as Python tuples with three elements. See the documentation for the C external function type TBuoyInstantaneousCalculationData for information on the meaning of these attributes.

Vessel instantaneous data attributes

Attributes Position, Velocity, AngularVelocity are vectors that are represented as Python tuples with three elements. The Orientation attribute is a matrix which is represented in Python as a tuple containing 3 tuple vectors, the first tuple element being the vector for the first row of the matrix. The LF prefix on an attribute indicates that it pertains to only the low frequency part of the motion; the WF prefix indicates that it pertains to only the wave frequency part. See the documentation for the C external function type TVesselInstantaneousCalculationData for information on the meaning of these attributes.

Wing instantaneous data attributes

Attributes Position, Velocity, AngularVelocity are vectors that are represented as Python tuples with three elements. The Orientation attribute is a matrix which is represented in Python as a tuple containing 3 tuple vectors, the first tuple element being the vector for the first row of the matrix. See the documentation for the C external function type TWingInstantaneousCalculationData for information on the meaning of these attributes.

Line (node) instantaneous data attributes

Attributes AlphaIn, AlphaOut, NodeArcLength, MidSegArcLengthIn, MidSegArcLengthOut and SegmentStrain are Python float values. Attributes CurvatureIn and CurvatureOut are two element vectors represented as Python tuples. Attributes Position, Velocity and AngularVelocity are vectors represented as Python tuples with three elements. Attributes NodeOrientation, OrientationIn and OrientationOut are matrices represented in Python as a tuple containing 3 tuple vectors, the first tuple element being the vector for the first row of the matrix. See the documentation for the TNodeInstantaneousCalculationData for information on the meaning of these attributes.

Constraint instantaneous data attributes

The Position, Velocity and AngularVelocity attributes are vectors that are represented as Python tuples with three elements. The Orientation attributes are matrices represented in Python as a tuple containing 3 tuple vectors, the first tuple element being the vector for the first row of the matrix. See the documentation for the C external function type TConstraintInstantaneousCalculationData for information on the meaning of these attributes.

Turbine instantaneous data attributes

The GeneratorAngVel, MainShaftAngVel, BladePitchAngle, RotorAngle and HorizontalHubWindSpeed attributes are Python float values. Attributes HubRelativeWindVelocity, TurbinePosition, TurbineVelocity, TurbineAngularVelocity, TurbineAcceleration and TurbineAngularAcceleration are vectors that are represented as Python tuples with three elements. The TurbineOrientation attribute is a matrix which is represented in Python as a tuple containing 3 tuple vectors. See the documentation for the C external function type TTurbineInstantaneousCalculationData for information on the meaning of these attributes.

See also

ExternalFunctionInfo, TBuoyInstantaneousCalculationData, TConstraintInstantaneousCalculationData, TNodeInstantaneousCalculationData, TTurbineInstantaneousCalculationData, TVesselInstantaneousCalculationData, TWingInstantaneousCalculationData.