Post-processing: Data commands |
The Get data command outputs the value of a data item. The model object to which the data item refers is given in the object name column of the instruction sheet, and the data item in the variable column.
The data item is specified by its data name. If the data item appears in a table in OrcaFlex, then its row number must be given. The row number follows the data name and is given as an index enclosed by either square or round brackets (do not mix them on the same row). The index is always 1-based, i.e. [1] represents the first row of the table. For example if you wanted to output the number of segments in the 3rd section of a line then the variable would be NumberOfSegments[3]. For more details see batch script assignment.
Object tags can be obtained by with Tags[Name] where Name is the name of the tag.
The Set data command is used to modify data values. Because the command has no output, the sheet name, label cell, label and output cell columns are not used. The model object to which the data item refers is given in the object name column of the instruction sheet, and the variable column must be of the form name = value where name is the data name and value is its new value.
Note: | There are only limited scenarios where it is desirable to modify data whilst post-processing. Most OrcaFlex data are used as inputs to the calculation, and so cannot be modified during post-processing. However, some data are used solely for post-processing and these are the data that would be modified during post-processing. Examples of such data include stress loading factors and code checks data. |
Some objects require special select commands to output certain data items. For example if you want to output wave train data for the Environment and there is more than one wave train present, then you need to first Select the particular wave train you require. Likewise, certain vessel type data require you to Select a draught and possibly an RAO type and direction. Example instructions to do this are given below:
Command | Object name | Additional data |
Simulation period |
Variable |
---|---|---|---|---|
Select WaveTrain | Environment | Wave2 | ||
Get Data | Environment | WaveTrainType | ||
Select WaveTrain | Environment | Wave3 | ||
Get Data | Environment | WaveTrainType | ||
Select Draught | VType1 | Draught3 | ||
Get Data | VType1 | CurrentCoeffSurgeArea | ||
Select RAOs | VType1 | Displacement | ||
Select Direction | VType1 | 30 | ||
Get Data | VType1 | RAOSwayAmplitude[3] | ||
Select Direction | VType1 | 60 | ||
Get Data | VType1 | RAOSwayAmplitude[2] | ||
Select RAOs | VType1 | QTF | ||
Select Direction | VType1 | 45 | ||
Get Data | VType1 | RAOSurgeAmplitude[6] |
Notes: | The Select commands must be issued before the Get data commands. |
The Select commands are only needed for certain data items. For example, the sea density data item does not depend on wave train so it would not need a Select WaveTrain command. |