Python reference: OrcaFlexVesselObject

The class OrcaFlexVesselObject is the Python interface representation of an OrcaFlex vessel. This class subclasses OrcaFlexObject so offers the same attributes and methods, with the addition of vessel specific methods described here.

Construction

A new OrcaFlexVesselObject is created from a Model object like this:

model = Model()

vessel = model.CreateObject(ObjectType.Vessel, "vessel2") # Create a new vessel object called "vessel2"

Or, where the OrcaFlex vessel already exists, like this:

vessel = model["vessel2"]

Attributes and methods

SaveDisplacementRAOsSpreadsheet, SaveSpectralResponseSpreadsheet

vessel.SaveDisplacementRAOsSpreadsheet(filename)

vessel.SaveSpectralResponseSpreadsheet(filename)

Saves displacement RAO or spectral response reports to filename. 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.

SaveDisplacementRAOsSpreadsheetMem, SaveSpectralResponseSpreadsheetMem

vessel.SaveDisplacementRAOsSpreadsheetMem(spreadsheetFileType=SpreadsheetFileType.Xlsx)

vessel.SaveSpectralResponseSpreadsheetMem(spreadsheetFileType=SpreadsheetFileType.Xlsx)

Saves displacement RAO or spectral response reports, returning them as a bytearray object. The spreadsheetFileType parameter can be either SpreadsheetFileType.Csv, SpreadsheetFileType.Tab or SpreadsheetFileType.Xlsx to specify the spreadsheet format. This method is implemented by calling C_SaveSpreadsheetMem.

SaveSupportGeometryTable

vessel.SaveSupportGeometryTable(filename)

Saves the support geometry report to filename. 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.

SaveSupportGeometryTableMem

vessel.SaveSupportGeometryTableMem(spreadsheetFileType=SpreadsheetFileType.Xlsx)

Saves the support geometry report, returning it as a bytearray object. The spreadsheetFileType parameter can be either SpreadsheetFileType.Csv, SpreadsheetFileType.Tab or SpreadsheetFileType.Xlsx to specify the spreadsheet format. This method is implemented by calling C_SaveSpreadsheetMem.

SaveAirGapReport

vessel.SaveAirGapReport(filename, period=None)

Saves the air gap report spreadsheet for the specified period to filename. If period is set to None or omitted then 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.

SaveAirGapReportMem

vessel.SaveAirGapReportMem(spreadsheetFileType=SpreadsheetFileType.Xlsx, period=None)

Saves the air gap report spreadsheet for the specified period, returning it as a bytearray object. If period is set to None or omitted then the whole simulation period is used. The spreadsheetFileType parameter can be either SpreadsheetFileType.Csv, SpreadsheetFileType.Tab or SpreadsheetFileType.Xlsx to specify the spreadsheet format. This method is implemented by calling C_SaveSpreadsheetMem.

AirGapPointsSpecifications

vessel.AirGapPointsSpecifications

Returns an iterable of time history specifications corresponding to the user-defined air gap reporting point data for the vessel. These specifications can be passed to GetMultipleTimeHistories