OrcaFlex Manual - Orcina

w
4 AUTOMATION
4.1 INTRODUCTION
OrcaFlex provides several important facilities for automating and post-processing work:
85
Automation, Introduction
� OrcaFlex is supplied with a special Excel spreadsheet which enables you to automate the extraction of
simulation results into your own spreadsheet. You can then use the normal Excel calculation facilities to do your
own customised post-processing and graphing.
� The Batch Processing facility enables you to run a set of simulations in unattended mode, for example as an
overnight job. The simulations can either be of pre-prepared data files, or else can be specified by a batch script
file that specifies the simulation as variations on a base data file. The OrcaFlex Spreadsheet mentioned above
also has facilities for automating the production of batch script files and text data files.
� OrcaFlex includes a well-documented programming interface called OrcFxAPI (short for OrcaFlex Application
Program Interface). See the OrcFxAPI help file for details. OrcFxAPI is a Windows dynamic link library (DLL)
that is installed when you install OrcaFlex, and which provides facilities for setting data, calculating static
positions and extracting results from those calculations or from pre-run simulation files. For example you can
write programs to automate post-processing or that use OrcaFlex as a 'statics calculation engine'. One important
example application of this is for real-time monitoring of pipes, moorings etc. For further information or to
discuss possible applications of OrcFxAPI, please contact Orcina.
4.2 BATCH PROCESSING
4.2.1 Introduction
Simulations, script files, post processing spreadsheets and fatigue analyses can all be run in unattended mode, by
using the Calculation | Batch Processing menu item. This command opens a form that allows you to set up a list of
jobs that are to be run. The list can include any number and mixture of the following types of job:
1. Static analysis of pre-prepared OrcaFlex data files (.dat or .yml). OrcaFlex opens the data file, performs the static
analysis and then saves the results in a simulation file with the same name as the data file, but with a .sim
extension.
2. Dynamic analysis of pre-prepared OrcaFlex data files (.dat or .yml). OrcaFlex opens the data file, performs the
static analysis, runs the dynamic simulation and then saves the results in a simulation file with the same name
as the data file, but with a .sim extension.
3. Partially-run OrcaFlex simulation files (.sim). OrcaFlex opens the simulation file, finishes the dynamic
simulation and then saves the completed simulation, overwriting the original file.
4. A batch script file (.txt). This is a text file which contains OrcaFlex script commands. OrcaFlex opens the script
file and obeys the commands in turn. The most common use of script files is to perform a series of systematic
variations on a base data file.
5. A fatigue analysis file (.ftg or .yml). OrcaFlex performs the fatigue analysis and saves the results to a binary .ftg
file. In addition the results tables are saved to an .xls spreadsheet.
6. An OrcaFlex Spreadsheet (.xls or .xlsx). OrcaFlex will process all Instructions sheets in the Excel workbook. Note
that if the spreadsheet's "Contains Dependencies" options is checked (or the spreadsheet is pre OrcaFlex v9.4)
then the workbook will be processes as a single job using a single thread. If it isn’t checked, then each
instructions sheet will be broken down into multiple load cases which are individually added to the batch and
may be processed simultaneously.
Note: If you wish to use Excel for any reason while OrcaFlex is processing spreadsheets within a batch it
is important that you open Excel first, then open the file you wish to work on. The reason for this is
that when you double click an Excel file, Windows will try to use the copy of Excel OrcaFlex has
claimed, resulting in unpredictable failures.
When adding data files (.dat or .yml) you need to specify whether static or dynamic analysis is to be performed.
This choice is made from the Add Files file dialogue window, or from the popup menu.
OrcaFlex can auto-save partial completed dynamic simulations to file at regular intervals during the batch job. This
is useful if your computer is prone to failure (for example because of overnight power failures) since the part-run
simulation file can be loaded and continued, rather than having to re-run the whole simulation from scratch.