DYNAMIC MULTIPHASE FLOW SIMULATOR

OLGA 2016
Version 2016.2

Convert an OLGA scheduler case

with internal sub-model
Copyright Notice
Copyright © 2017 Schlumberger. All rights reserved.
This work contains the confidential and proprietary trade secrets of Schlumberger and may not
be copied or stored in an information retrieval system, transferred, used, distributed, translated
or retransmitted in any form or by any means, electronic or mechanical, in whole or in part,
without the express written permission of the copyright owner.

Trademarks & Service Marks

Schlumberger, the Schlumberger logotype, and other words or symbols used to identify the
products and services described herein are either trademarks, trade names or service marks of
Schlumberger and its licensors, or are the property of their respective owners. These marks
may not be copied, imitated or used, in whole or in part, without the express prior written
permission of Schlumberger. In addition, covers, page headers, custom graphics, icons, and
other design elements may be service marks, trademarks, and/or trade dress of Schlumberger,
and may not be copied, imitated, or used, in whole or in part, without the express prior written
permission of Schlumberger. Other company, product, and service names are the properties of
their respective owners.

An asterisk (*) is used throughout this document to designate marks of Schlumberger.

Security Notice
The software described herein is configured to operate with at least the minimum specifications
set out by Schlumberger. You are advised that such minimum specifications are merely
recommendations and not intended to be limiting to configurations that may be used to operate
the software. Similarly, you are advised that the software should be operated in a secure
environment whether such software is operated across a network, on a single system and/or
on a plurality of systems. It is up to you to configure and maintain your networks and/or
system(s) in a secure manner. If you have further questions as to recommendations regarding
recommended specifications or security, please feel free to contact your local Schlumberger
representative.
Convert an OLGA scheduler case to work with OLGA 2016 Page i

TABLE OF CONTENTS

1. INTRODUCTION 1

2. CONVERT A CASE USING AN OLGA 2015.X GUI 2

3. CONVERSION EXAMPLE USING THE OLGA 2015.3 GUI 3

4. CHANGE THE KEYWORD-BASED INPUT FILES (.KEY AND .GENKEY FILES) 5

Convert an OLGA scheduler case to work with OLGA 2016 Page 1

1. INTRODUCTION
In earlier versions of OLGA* where the scheduler functionality is available, you could set up a
server case with a scheduler controlling an internal model and its connections to other external
sub-models.

From OLGA 2016.1, OLGA does not accept internal models (that is, network component
SUBMODEL LOCATION = INTERNAL). Therefore, you must change older cases with internal
models to work from OLGA 2016.1.

This document describes the steps you need to convert OLGA case files with scheduler and an
internal model.

You might find it useful when you convert the case to have, for example, OLGA 2015.3 or
another earlier version that accepts SUBMODEL LOCATION = INTERNAL. The LOCATION
key is not available in the OLGA 2016 GUI, and can give unnecessary errors during the
conversion.
Convert an OLGA scheduler case to work with OLGA 2016 Page 2

2. CONVERT A CASE USING AN OLGA 2015.X GUI

1. Make a copy of the case input file with the SCHEDULER and SUBMODEL LOCATION
= INTERNAL settings. The original scheduler/internal model file is referred to as ‘the
scheduler case’ from now on.
You can rename the new case file with the internal model name, if that is unique for
the system (for example, SERVEROPTIONS MODELNAME = <xxxx>, which is part of
the server name visible from the OPC client).
2. In the scheduler case:
a. In the Model Browser, remove all network components (under Flow
Component, Process Equipment, Controller, and so on) except those with
TYPE = SUBMODEL (under Submodelling).
b. For the former internal sub-model:
i. Set the internal sub-model to local: Submodelling, SUBMODEL, change
LOCATION from INTERNAL to LOCAL.

ii. Refer to the new external sub-model file name: Submodelling,

SUBMODEL CASEFILE = <xxxx>.
NOTE: If the system is run from the OLGA GUI, you can use both .key
and .opi files. When running in command line mode, you can use only
.key/.genkey files.

iii. Optional: Rename Submodelling, SUBMODEL LABEL to reflect the new

sub-model name.
NOTE: Avoid using ‘SUBMODEL-#’, where # is a number for LABEL, as
a GUI-generated TAG name automatically uses this naming convention
when working through the GUI (only visible in key files). Using
‘SUBMODEL-#’ in LABEL can lead to confusing mismatches on TAG
and LABEL for sub-models.
c. Remove all connection definitions, except those related to the sub-models.
d. Remove all global and library keywords not related to the scheduler.
e. Remove any trend, profile or output data keywords not related to time, time
step or speed.
3. In the case input file for the former internal model (the copy of the former scheduler
case input file with an internal model).
a. Remove the Case Definition: SCHEDULER keyword.
b. Change the values of the following keys in the SERVEROPTIONS keyword to
reflect the new submodel name:
i. SERVERNAME
ii. MODULENAME
iii. MODELNAME
c. Remove the keywords Submodelling: SUBMODEL.
d. Remove the keywords CONNECTIONS related to sub-model connections.
Convert an OLGA scheduler case to work with OLGA 2016 Page 3

3. CONVERSION EXAMPLE USING THE OLGA 2015.3 GUI

This example uses the Submodel sample case from OLGA 2015.3.
In the OLGA 2015.3 GUI, in the File menu, click New, then Categories and then
Submodelling.
1. Create and save the MasterModel (scheduler and internal model) case as
MasterModel.opi.
2. Create a case with the name Flowline.opi from the Submodel_1.opi. Save it in the
same folder as MasterModel.opi.
3. In the MasterModel case:
a. Duplicate the MasterModel case and save it as Separator.opi.
b. In the MasterModel case, in the Model Browser, go to the Submodelling
folder, SUBMODEL: mastermodel.
i. Change the LOCATION from INTERNAL to LOCAL.
ii. Change the CASEFILE from ./mastermodel.genkey to
./Separator.genkey.
iii. Change the LABEL from ‘mastermodel’ to ‘separator’.
c. In the Submodelling folder, SUBMODEL: submodel_1.
i. Change the CASEFILE from ./submodel_1.genkey to ./Flowline.genkey.
ii. Change the LABEL from ‘submodel_1’ to ‘flowline’.
d. In the Library folder, delete all keywords (MATERIAL, TABLE, WALL).
e. In the Controller folder, delete all keywords (MANUALCONTROLLER,
PIDCONTROLLER).
f. In the Flow Component folder, delete all keywords (FLOWPATH, NODE).
g. In the Process Equipment folder, delete the SEPARATOR keyword.
h. Check the sub-model connections by Tools > Submodel connections.
i. In the Model Browser, in the Case Definition folder, delete the FILES
keyword.
j. In the Output folder, delete the TRENDDATA keyword, containing the
VALVOP variable.
k. Optional: Delete the Comment boxes.
l. Save the case.
4. In the Separator case:
a. In the Model Browser, in the Case Definition folder:
i. Delete the SCHEDULER keyword.
ii. In the SERVEROPTIONS keyword, change values of the
SERVERNAME, MODULENAME and MODELNAME keys to
‘separator’.
b. In the Submodelling folder, delete both SUBMODEL keywords.
c. In the Comment boxes on the ‘Home’ view canvas, replace the ‘submodel_1’
strings with ‘flowline’. These comment boxes indicate the external couplings to
the Flowline sub-model.
d. Save the case.
5. In the Flowline case:
a. In the Model Browser, in the Case Definition folder, SERVEROPTIONS
keyword: Change values of the SERVERNAME, MODULENAME and
MODELNAME keys to ‘flowline’.
b. In the Comment box, replace the ‘mastermodel’ string with ‘separator‘. The
comment box indicates the external coupling to the Separator sub-model.
c. Save the case.
Convert an OLGA scheduler case to work with OLGA 2016 Page 4

6. Go to the MasterModel case and start it in batch mode.

Three command windows appear, executing the scheduler and the two sub-model
cases.
Convert an OLGA scheduler case to work with OLGA 2016 Page 5

4. CHANGE THE KEYWORD-BASED INPUT FILES (.KEY AND .GENKEY

FILES)

1. Make a copy of the case input file with the SCHEDULER definition. The original
scheduler/internal model file is referred to as ‘the scheduler case’ from now on.
You can rename the new case file with the internal model name, if that is unique for
the system (for example, SERVEROPTIONS MODELNAME = <xxxx>, which is part of
the server name visible from the OPC client).

2. In the scheduler case input file:

a. Remove all network components except those with TYPE = SUBMODEL.
b. For the internal sub-model:
i. Set the internal sub-model to external (NETWORKCOMPONENT,
remove LOCATION = INTERNAL).
ii. Refer to the new external sub-model file name:
NETWORKCOMPONENT CASEFILE = <xxxx>.
NOTE: If the system is run from the OLGA GUI, you can use both .key
and .opi files. When running in command line mode, you can use only
.key/.genkey files.
iii. It can be useful to rename NETWORKCOMPONENT LABEL to reflect
the new sub-model name.
NOTE: Avoid using ‘SUBMODEL-#’, where # is a number for LABEL, as
a GUI-generated TAG name automatically uses this naming convention
when working through the OLGA GUI (only visible in .key and .genkey
input files). Using ‘SUBMODEL-#’ in LABEL can lead to confusing
mismatches on TAG and LABEL for sub-models.

c. Remove all connection definitions, except those related to the sub-models.

d. Remove all global and library keywords not related to the scheduler.
e. Remove any trend, profile or output data keywords not related to time, time
step or speed.
3. In the case input file for the former internal model (the copy of the former scheduler
case input file with an internal model):
a. Remove the SCHEDULER keyword.
b. Change the values of the following keys in the SERVEROPTIONS keyword to
reflect the new submodel name.
i. SERVERNAME
ii. MODULENAME
iii. MODELNAME
c. Remove the keywords NETWORKCOMPONENT with TYPE = SUBMODEL.
d. Remove the keywords CONNECTIONS related to sub-model connections.