|
MATLAB reference: ofxLineObject |
|
|
MATLAB reference: ofxLineObject |
The class ofxLineObject is the MATLAB interface representation of an OrcaFlex line. This class subclasses ofxObject so offers the same Properties and functions, with the addition of line specific functions described here.
A new ofxLineObject is created from an ofxModel object like this:
model = ofxModel
line = model.CreateObject(ofx.otLine, 'line2') % Create a new line object called 'line2'
Or, where the OrcaFlex line already exists, like this:
line = model('line2')
lineTypeAt(arclength)
This returns the line type corresponding to the line position defined by arclength.
EulerBucklingLimitExceeded
Indicates whether the line has exceeded its Euler buckling limit during the simulation.
NearestNodeArclength(targetArclength)
Returns the reference arc length of the nearest node to targetArclength.
NodeArclengths
Returns an array containing the reference arc length of each node in the line.
NodeSeabedFrictionTargetPositions
Returns an array containing the seabed friction target position of each node in the line. The model must have performed a calculation before this property can be accessed.
NodePreBendGeometry
Returns a structure array containing the node positions and orientations of the line, assuming that it adopts its unstressed position as determined by the pre-bend data. The array contains one entry per node, and has the following fields: Arclength, Pos, Orientation, Attitude. For more details on the content of these fields, refer to the C API structure TNodePreBendGeometry.
SetLayAzimuthFromEndPositions
Sets the line lay azimuth data to be the direction from the bottom end towards the top end, based on their current positions.
RangeGraphXaxis(varName[, arclengthRange][, [period])
Returns an array of the RangeGraph X values only, see the RangeGraph function below. The arclengthRange parameter can be omitted if values for the entire line are required. The period is only used when line payout is non-zero.
RangeGraph(varName[, period][, objectExtra][, arclengthRange][, stormDurationHours])
The varName parameter is the name of the result variable required.
The optional period parameter is a Period structure, if this is omitted the default is used (see MATLAB interface: Results).
objectExtra is an ObjectExtra structure that is only required for specific varNames, see C_RangeGraph4.
arclengthRange is an ArclengthRange structure that is used to specfiy a sub-section of the line, if this is omitted the default is the entire line.
stormDurationHours is only used with frequency domain dynamics, and specifies the storm duration in hours used for the calculation of the MPM.
For static state, time domain dynamics or frequency domain dynamics for specified period, this method returns a structure with the following fields: X, Min, Max, Mean, StdDev, Upper, Lower. These are accessed like this:
rangegraph = line.RangeGraph('Effective Tension')
rangegraph_MaxValues = rangegraph.Max
For frequency domain dynamics of a specified period, the output is based on synthesised time histories.
For frequency domain dynamics, if the period specifies the whole simulation, this method returns an object with the following fields: X, StaticValue, StdDev, Upper, Lower. If stormDurationHours is specified, then the returned object has an additional MPM field, calculated in the same manner as by the FrequencyDomainMPM method.
RangeGraphCollated(varName[, period][, objectExtra][, arclengthRange][, restartModels])
Returns a range graph for the specified period, collated for the specified restart models.
The varName parameter is the name of the result variable required.
If period is omitted then all sample times are returned. For a specified period, a value of ofx.OrcinaDefaultReal for from or to means the first sample of the first model or the last sample of the last model, respectively.
objectExtra is an ObjectExtra structure that is only required for specific varNames, see C_RangeGraph4.
arclengthRange is an ArclengthRange structure that is used to specfiy a sub-section of the line, if this is omitted the default is the entire line.
The restartModels argument is an array of integer indices specifying which models are to be included. You can use restartFileNames to obtain the file names of the models in the restart chain, and also the length of the restart chain. If restartModels is omitted, then all models in the restart chain are included.
The return value is the same as for RangeGraph.
SaveShear7datFile(filename)
SaveShear7mdsFile(filename[, firstMode, lastMode][, includeCoupledObjects])
SaveShear7outFile(filename)
SaveShear7pltFile(filename)
SaveShear7anmFile(filename)
SaveShear7dmgFile(filename)
SaveShear7fatFile(filename)
SaveShear7strFile(filename)
SaveShear7curvFile(filename)
SaveShear7zetahystFile(filename)
SaveShear7sthFile(filename)
SaveShear7dthFile(filename)
SaveShear7cthFile(filename)
SaveShear7out1File(filename)
SaveShear7out2File(filename)
SaveShear7allOutputFiles(basename)
SaveVIVAInputFiles(dirname)
SaveVIVAOutputFiles(basename)
SaveVIVAModesFiles(dirname[, firstMode, lastMode][, includeCoupledObjects])
These methods call C_SaveExternalProgramFile to save SHEAR7 and VIVA input and output files. All of these methods require that the statics calculation has been performed.
With SaveShear7mdsFile and SaveVIVAModesFiles you must also specify the first and last transverse (or inline) modes to be exported. A value of -1 for the first mode is interpreted as the lowest numbered transverse (or inline) mode. A value of -1 for the last mode is interpreted as the highest numbered transverse (or inline) mode. The default value for these parameters is -1.
By transverse we mean that the modal analysis classifies the mode as either Transverse or Mostly Transverse. By inline we mean that the modal analysis classifies the mode as either Inline or Mostly Inline. Whether transverse or inline modes are exported is determined by the setting of the response data item on the SHEAR7 data form. For SaveVIVAModesFiles, transverse modes are always exported because VIVA does not have the ability to perform inline VIV analysis.
Additionally, the includeCoupledObjects parameter determines whether or not coupled objects are included in the modal analysis. The default value is false.
These parameters are interpreted in exactly the same way as analogous parameters to the SHEAR7MdsFile batch script command.
vessel.SaveLineClashingReport(filename[, period])
Saves the line clashing report spreadsheet for the specified period to filename. If no period is specified the whole simulation period is used. The file can be an Excel spreadsheet (.xlsx or .xls), a tab delimited file (.txt) or a comma separated file (.csv). The decision is taken based on the file extension that you specify. This method is implemented by calling C_SaveSpreadsheet.