OrcaFlex Manual - Orcina

User Interface, OrcaFlex Model Files
3DBuoys:
- Name: 3D Buoy1
InitialPosition: [0, 0, 10]
DragArea: [100, 100, 30]
Pen: [4, Solid, Yellow]
Without grouping the file would be significantly longer:
3DBuoys:
- Name: 3D Buoy1
InitialX: 0
InitialY: 0
InitialZ: 10
DragAreaX: 100
DragAreaY: 100
DragAreaZ: 30
PenWidth: 4
PenStyle: Solid
PenColour: Yellow
34
w
The majority of grouped data are X,Y,Z components and we adopt the convention that these components appear in
that order when grouped.
YAML files may contain comments which are introduced by a hash (#) character followed by a SPACE. All
subsequent text on the same line is comment and is ignored when OrcaFlex reads a text data file. Comments are not
preserved by OrcaFlex and any user comments in a manually edited YAML file opened with OrcaFlex will be lost if
the file is saved. Comments are formatted in green in the following example:
General:
# Statics
StaticsMethod: Whole System statics
BuoysIncludedInStatics: Individually Specified
# Dynamics
StageDuration:
- 8
- 16
TargetLogSampleInterval: 0.1
# Integration
SimulationIntegrationMethod: Implicit
ImplicitConstantTimeStep: 0.1
A text data file can be rather large, particularly if it contains vessel hydrodynamic data. Code folding editors can help
somewhat, but even so such files can be awkward to work with. The IncludeFile identifier allows you to move
data into a separate file which is then included in the main file:
# File: C:\Desktop\main.yml
VesselTypes:
- Name: FPSO
IncludeFile: FPSO.yml
Vessels:
- Name: Vessel1
VesselType: FPSO
The included file contains just the data for the vessel type:
# File: C:\Desktop\FPSO.yml
Length: 240
RAOResponseUnits: degrees
RAOWaveUnit: amplitude
WavesReferredToBy: period (s)
# ... remainder of large file omitted ...
As well as making the main file shorter and more readable, using this approach can offer significant QA benefits.
In this example we have used a relative path and so the program will look for FPSO.yml in the same directory as the
main text data file.