View source for OLI Model Configuration

[[Category:Models]] [[Category:OLI]]
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]] | [[OLI Overview|OLI]]}}
{{OLI Header Tabs|currentpage=3}}

'''Related Links:''' [[OLI Overview#OLI SysCAD Project Workflow|OLI SysCAD Project Workflow]], [[Example_-_06_OLI_Projects|OLI Example Project]]

'''Legacy Models:''' [[OLI Chemistry Model]].  This legacy model is used for backward compatibility purposes.  We highly recommend users convert any existing project to use this new OLI unit model: [[OLI Model Configuration]].
----
{{OLI version comment}}    
{{TOC}}
== General Description ==

OLI Systems is a leading Electrolyte Simulation Software used to predicate equilibrium conditions and properties (such as pH) for aqueous chemistry. It is developed and maintained by OLI Systems ([https://www.olisystems.com/ olisystems.com]).

This model allows the user to select the OLI database file to be used in SysCAD and some configuration of its use.  The two main functions are to select a OLI Database File (*.dbs) (refer to [[#Referenced File|Referenced File]]) and then for the selected Database file, 'map' OLI species/ions to SysCAD species/ions used in the project.  This allows the other OLI models in SysCAD to convert the SysCAD species flow data to OLI species data (and vice-versa) and use the OLI functionality to calculate aqueous equilibrium data.

The model does not do any calculations and has no process links to any other models in SysCAD flowsheets.  Its sole purpose is for management and configuration of a selected OLI Database, other unit models performing OLI calculations will reference this model.  Therefore, this model is essential if the user wishes to use the OLI functionality in SysCAD.

'''NB''': The user '''MUST''' have a licensed version of "OLI Engine Runtime" on their computer.  Please see [[OLI Overview]] for more information.

===Referenced File===

The user may need to have an OLI Database file (*.dbs) before initialising the SysCAD OLI Model Configuration.  Please see [[OLI_Overview#Referenced_File|Referenced File]] for instructions on how to create this file.

=== Diagram ===

[[Image:TPS Model Cfg.png|50 px]]

The diagram shows the default drawing of a OLI Model Configuration unit model.

== Inputs and Outputs ==

There are no connections to this unit.

== Model Theory ==

OLI requires a defined input stream which defines almost all species in ionic form (no phase). At the given conditions (temperature, pressure), OLI returns an output stream which includes aqueous ions in solution and any precipitates (solids) as species.

The OLI Model Configuration defines the mapping of SysCAD species to OLI ions/species to define the required input stream, and the convert the OLI output stream back to SysCAD species.

A diagram is provided below to explain the mapping process.  Red lines represent the mapping criteria.

[[Image:OLIMappingDigram.PNG]]

'''Notes:'''
* Some automatic mapping functions are available to match species based on molecular weights and elements.
* Users can also manually adjust the mappings by selecting matching ions/species from dropdown lists.
* Where more than one ionic breakdown reactions is available for a SysCAD species (defined in IonList.txt), the user can choose which one or combination to use.
* SysCAD species can be selected to bypass the OLI calculations by excluding them from the defined OLI input stream.
* OLI solid species can also be excluded from being formed as part of the OLI output stream.
* [[Ion Definitions]] are provided in IonList.txt.  These are used to calculate SysCAD species breakdowns.

== Workflow ==

{{TPS ModelCfg Workflow|TPS=OLI|speciestypes=ions and species|databasefile= dll or for older dll formats the .dbs |SatIndex=Yes|Suppression=No|IonsPresent=Yes}}

== Data Sections ==

The tabs and variable names are described in detail in the following tables.

# '''[[#OLI Model Configuration tab page|OLIModelCfg]]''' tab - This first tab requires the user select the OLI database file and has various related options and parameters.
# '''[[#OLI Config tab page|OLIConfig]]''' tab - This tab requires the user to map the OLI ions/species to the equivalent species/ions in SysCAD, so that OLI stream compositions can be converted to a SysCAD stream and vice-versa.
# '''[[#ScdSpMap tab page|ScdSpMap]]''' tab - This tab reports the SysCAD to OLI species mapping as a result of choices made on the '''[[#OLI Config tab page|OLIConfig]]''' tab page, so the SysCAD stream composition can be converted to a OLIstream.
# '''[[#ScdIonMap tab page|ScdIonMap]]''' tab - This tab reports the SysCAD to OLI ion mapping as a result of choices made on the '''[[#OLI Config tab page|OLIConfig]]''' tab page, so the SysCAD stream composition can be converted to a OLIstream.
# '''[[#IonicBreakdown tab page|IonicBreakdown]]''' tab - This tab lists the Ion Breakdown reactions for SysCAD species and allows the user to select which ones to use.
# '''[[#UsedBy tab page|UsedBy]]''' tab - This tab displays the OLI model units referencing to this OLI Model configuration unit.
# '''[[#Engines tab page|Engines]]''' tab - This tab contains information about the OLI Engines.
# '''[[Common Data Sections#Common Data on Info Tab Page|Info]]''' tab - contains general settings for the unit and allows the user to include documentation about the unit and create Hyperlinks to external documents.

=== OLI Model Configuration tab page ===
{{TPSModelCfg Tab Page|TPS=OLI|example DB=OLI001.dbs|CheckDuplicates=false}}
|}

=== OLI Config tab page ===

{{TPSConfig Tab Page|TPS=OLI|speciestypes=species/ions|MapByMW=false|IncludeSuppress=Yes|IncludeSatIdx=No|IncludeCFE=No|IncludeIons=Yes}}
|}

=== ScdSpMap tab page ===

{{TPSScdSpMap Tab Page|TPS=OLI|IncludeMapType=Yes|IncludeSelect=Yes}}

=== ScdIonMap tab page ===

{{TPSScdIonMap Tab Page|TPS=OLI}}

=== IonicBreakdown tab page ===

{{TPS IonicBreakdown Tab Page}}
NOTE:
The species listed on this page are determined by the phase selection in the "[[#OLI_Config_tab_page|OLIConfig tab page]] - FwdIonMap.PhasesAllowed" option.

=== UsedBy tab page ===

{{TPS ConnectedUnits Tab Page|TPS=OLI}}

=== Engines tab page ===

{{TPS Engines Tab Page|TPS=OLI}}

== Adding this Model to a Project ==

{{TPS Add Model|TPS =OLI|UnitOp=Chem Model Configuration|Group=General}}