PLGetTorque

<< Click to Display Table of Contents >>

Navigation:  PipeLay > Excel Add-In > Function Reference > Force Functions >

PLGetTorque

Previous page Next page

PURPOSE

Retrieve a Torque value from the database.

NOTE: You can also use PLGetValue with parameter number 5 to retrieve the same data.

SYNTAX

PLGetTorque( DatabaseName, TimeIndex, ElementIndex, LocalNodeNo )

PARAMETERS

DatabaseName (Character String)

The full path and filename to the relevant database. The file extension is optional.

TimeIndex (Integer)

The relevant time index, from 1 to the number of solutions in the database.

ElementIndex (Integer)

The index of the required element from 1 to number of elements.

LocalNodeNo (Integer)

The Local node number from 1 to 3.

OUTPUT

A numerical value containing the Torque value for the specified parameters or one of the following error codes:

-999999998

Invalid Database.

-999999995

Invalid Time Index.

-999999990

No Data Available.

-999999986

Element Index is out of range.

-999999983

Local Node Number is out of range.

-999999980

General Read Error.

UNITS

Imperial

Metric

lbf·ft

N·m

SEE ALSO

Error Codes

PLGetNumSolutionTimes

PLGetElementCount

PLGetValue

PLGetAxialForce

PLGetContactSurfaceReaction

PLGetEffectiveTension

PLGetLocalAxialStrain

PLGetLocalAxialStrainFromForceOnly

PLGetLocalShearYForce

PLGetLocalShearYForce

PLGetLocalYBendingMoment

PLGetLocalYCurvature

PLGetLocalZBendingMoment

PLGetLocalZCurvature

PLGetPipeInPipeReaction

PLGetReactions

PLGetZeroGapGuideReaction

Back to Table of Contents