https://help.syscad.net/api.php?action=feedcontributions&user=Kevin.Heppner&feedformat=atomSysCAD Documentation - User contributions [en]2024-03-29T09:47:11ZUser contributionsMediaWiki 1.39.4https://help.syscad.net/index.php?title=Build_139_Revision_History&diff=79049Build 139 Revision History2024-03-19T14:10:01Z<p>Kevin.Heppner: /* Build 35102 */</p>
<hr />
<div>[[Category:SysCAD Versions and Builds]]<br />
{{Navigation|[[User Guide]]|[[SysCAD Version History]]}}<br />
<br />
'''Related Links:''' [[What's New]], [[Product Blog]], [[Upgrading Builds]], [[Upgrading Projects]], [[Software Licenses Expiry Dates]]<br />
----<br />
__NOTOC__<br />
This page contains details of all revisions since the initial release of [[Build 139 Release Notes|SysCAD 9.3 Build 139]].<br />
<br />
'''NOTE:''' New builds can be downloaded from [https://www.syscad.net/login/ the SysCAD website]. It is recommended that a full install, rather than an update, is performed from time to time to ensure that the latest supporting files, utilities and examples are included.<br />
<br />
==SysCAD 9.3 Build 139 Revision History==<br />
<!---===============WORKING AREA [Clear when Publishing]===============<br />
<br />
<br />
=========================END WORKING AREA==========================---><br />
===Build 35102===<br />
:''Released 19 March 2024<br />
* Fixes for bugs introduced in previous Builds:<br />
** Build 34985: Important usability fix for building flowsheets where dropdown list of available unit models is not updated. This affected three areas of functionality (a) ConnectTo tag in Feeder used for connecting cross page connectors, (b) MakeupSrc tag in Makeup Block for selecting Makeup Source, (c) DiscardSnk tag in Discard Block for selecting Discard Sink.<br />
** Build 34985: Fix for graphics symbol preview for [[Insert_Graphics_Commands#Insert_Unit|Insert Unit]] when the selected scale is not 100% (the preview was incorrectly scaled and drawn over the contents of the dialog box).<br />
* Fix for saving, loading and use of global user display setting for Symbolic Paths in [[Project Window]].<br />
* Project load now fails with error message when selecting a model DLL with required species and the species are not selected for use in the project in the [[Species Configuration|configuration file]].<br />
* Fix for a crash when loading a project after removing (or renaming) a species from the configuration that is referenced in a [[Makeup Block (MU)]] or [[Discard Block (DB)]].<br />
* For [[Set Tag Controller]] for specific case of using (a) MatchCnvFromTag, (b) Tag conversion family is "Temperature", (c) Calculation is "Ratio and Offset"; the Offset tag conversion is now "Temperature Change" (dT).<br />
* Fix for enthalpy change values used for phase change when adding H2O(s) (ice) using same H2O component as hardwired H2O(l) and H2O(g).<br />
* Minor [[Access Window]] display improvements. Remove incorrect trace marks left behind when changing selection of text. Added missing faint horizontal row guidelines between tags and data values for grid displays.<br />
* [[TCE]] Improvements:<br />
** If TCE equilibrium solve fails, retain previous property results rather than clear the results. This helps with smoother control actions (e.g. PID) for occasional failed equilibrium calculations.<br />
** For forward mapping, unmapped species (shown in QUnmapped, QRxnUnmapped) were not set to the correct temperature for this bypass, resulting in an energy balance error occurring when this bypass is mixed with the results. Other Bypass options functioned correctly.<br />
**:'''NOTE:''' Energy balance results may be different for cases of unmapped reaction species.<br />
** For Scaling results page, fix for tags not working in Excel reports, Trends, etc. with hide zeros.<br />
<br />
===Build 34985===<br />
:''Released 6 March 2024<br />
* '''WARNING:''' This build contains a bug with Makeup and Cross-Page Connector dropdown lists not updating. This will affect building/editing models (running existing models is safe). Recommendations:<br />
** Use a Different Build: If you intend to make model changes and wish to use the droplist to select connected tags, we recommend updating to a newer build.<br />
** Reopen Project Workaround: After the new unit operations have been added (Feeder/Sink, Makeup Source, Discard Block), to force the dropdown list update, save, close, and re-open the project.<br />
** Manual Entry Workaround: After the new unit operations have been added (Feeder/Sink, Makeup Source, Discard Block), manually type or paste in the name of the connector or makeup source tag. Manual entry will function correctly.<br />
* Fixes for bugs introduced in previous Builds:<br />
** Build 34893: Fix for changing tag size or rotation in graphics from [[Edit_Graphics_Commands#Tag_Position.2C_Show_or_Hide|Update Tag Annotation]] dialog.<br />
* Improved graphics symbol preview for [[Insert_Graphics_Commands#Insert_Unit|Insert Unit]] and [[Insert_Graphics_Commands#Insert_Symbol|Insert Symbol]].<br />
* [[TCE]] Improvements:<br />
** For OLI, PHREEQC and AQSol add new optional Scaling tab page to display SatIndex result values for solids (Scaling tendencies). For OLI, display extra tab page (if needed) of solids that have been excluded in OLI database file.<br />
** Implemented new [[OLI Solvent Extraction]] unit model.<br />
** Implemented support for [[OLI_Overview#OLI_Liquid-2|OLI Liquid-2]] phase (Liq2) for immiscible liquids (typically organics) used in various OLI reactors and unit models including [[OLI Solvent Extraction]].<br />
** Fix for [[AQSol]] for some DLLs where a calculation fails when a floating point exception occurs.<br />
** Fix for crash when using [[OLI]] with some solid species excluded in the database (DBS) file.<br />
<br />
===Build 34893===<br />
:''Released 16 February 2024<br />
* Now support [[AQSol]] Version 3 DLLs with significantly accelerated solve times (especially for AQSol libraries with larger number of species).<br />
* New functionality for graphics for [[Insert_Graphics_Commands#Insert_Text|Insert Text]] and [[Edit_Graphics_Commands#Change_Text|Change Text]] to allow user so select which dxf font is used. These are based in the dxf .shp files located in the [[SysCAD_Files#Base_Files_Folder|Basefiles\Font]] folder. Allows use of various fonts, including fonts with various symbols.<br />
* Updated [[Audit]] tags and tables to include a display of Normalised Relative Error (NormRelError) in addition to the existing error tags. This provides clearer transparency for the Audit mass balance checks using [[Tolerance Testing]] calculations.<br />
* For [[Excel Reports]] Feedback worksheet, reorganised the 2 heading lines over 3 lines with the feedback report date on it's own line.<br />
* Model improvements for dynamic projects:<br />
** Added totaliser display tags in [[Feeder]], [[Makeup Source]] and [[Discard Block (DB)|Discard Block]].<br />
** For [[Simple Heater]] removed option for DemandConnection (only valid for ProBal).<br />
** Fixed bug in [[Tank_-_Dynamic_Mode#Layered_Flow|Layered Tank]] that had a Mass Balance error if the dynamic project required multiple iterations to solve a time step.<br />
** Fixed a crash on solve error when unit models did not have all the required pipes connected.<br />
* Fix for bug in [[Reaction Block (RB)]] individual reaction using a [[Reaction_Block_-_Extents#User_Defined_Properties_(User_Calc)_(RB_and_CRB)|User Calc]] extent control method. The error was that the User Calc, calculated during RB convergence, may be performed using the incorrect temperature and/or composition.<br />
*:'''NOTE:''' This will affect reaction results where User Calc is used for extent control.<br />
**Added example on how to use User Calc reaction as reaction extent: [[Reaction_Block_Summary#Example_-_Using_UserCalc_Reaction_Extent|Using UserCalc Reaction Extent]]<br />
* Fix for incorrect [[Conversions]]: MJ/L for H(V) and some (normally hidden) US units such as cal/lb for H(Ms); Ha/s and Ha/h for ThermDiff and some other cal based US units. May affect results if these units were used in controllers or reporting.<br />
* Fix errors in parsing OrderBy for multiple tags for [[Setting_and_Reporting_Tags_from_text_files#Reporting_Tags_to_text_files|TagSelect Text file reporting]]. Expanded [[Excel_Tag_Select_Reports#Tag_Select_Report_Function_Syntax|TagSelect OrderBy]] terms used in Excel and Text reports to support alternate formats for Asc and Desc (Des, Descend and Ascend).<br />
* Fix error where SysCAD incorrectly exits when pressing the F9 key from the [[Access Window]].<br />
* Fix for crash in [[Copy and Paste Graphics Commands|Graphics Copy and Paste]] when pasting a Tie or Tank with two outlets using a [[Split Flows (Split)|SplitFlow]] operation with a Target Stream.<br />
* Various miscellaneous usability improvements: Some improvements in model condition warnings. Improved Access window displays for various models. Some dialog box display improvements. New popup warning dialog when closing Insert Unit or Insert Symbol with 2 or more objects added.<br />
* [[PGM]] Improvements:<br />
** Fixes for some miscellaneous edge case errors. (Too many display tags in a class; Checking for duplicate classes in ClassGrid; Loading some old project PGM state information.)<br />
** Fix for compile and runtime errors for PGM code referencing nested class within an array of classes. Code such as "x = Tanks[3].SomeClass.SomeFunc()" failed with a crash or wrong result, as did code such as "Tanks[3].SomeClass.abc = x"<br />
** New PGM load error messages if incomplete expressions (i.e. ending in an operator). Examples: "if (a or )" or "x = a + b + "<br />
** Allow PGM/MP files saved in "UTF-8 with BOM" format to load and work.<br />
* [[TCE]] Improvements:<br />
** Added tag to display expiry date of [[ChemApp]] cst files.<br />
** Fix for [[PHREEQC]] edge case where feed enthalpies did not always match those of the feed SysCAD streams due to mapping algorithm issues.<br />
** Fix for TCE Feeder where outlet composition may be cleared.<br />
** Fix in TCE Unit models (stream displays) when referenced TCE model cfg is changed, even if a model is selected that is not yet loaded.<br />
** Updated TCE Utilities for generating initial databases.<br />
<br />
===Build 34613===<br />
:''Released 11 January 2024<br />
* Fixes for bugs introduced in previous Builds:<br />
** Build 33457: Fix for solver startup crash where PGM is setting [[Makeup Block (MU)]] Model during startup.<br />
* [[Flash Train]] tag and error reporting improvements when flashtrain is at maximum limit of allowed pressure. This helps with resolving The maximum allowed flash pressure for each steam source (FlashTank, Evaporator, etc.) is shown in new tag FeedSatP. A new condition warning is given for the flashtrain and any unit models at the flash pressure limit.<br />
<br />
===Build 34461===<br />
:''Released 14 December 2023<br />
* Fixes for bugs introduced in previous Builds:<br />
** Build 33632: Fix for various user interface bugs in [[Controls Window]] (e.g. Context menu with incorrect options for selected tag).<br />
* Pipe recycle [[Tear]] improvements:<br />
** Fix bugs in save and recover of overrides of [[Tear#Settings_Tab|tolerance settings]] of individual variables in a Tear Block.<br />
** Improved save and recover of Tear state.<br />
** Fixed bug for use of Tol.Strategy overrides when selecting tolerance value to be used.<br />
** Added Access window display warnings (and red text for values) when overriding a tolerance value that would be ignored based on the Tol.Strategy.<br />
* For [[PID]] in ProBal, added display tag CvgError which is the Normalised Relative Error used for solver convergence criteria. New CvgError tag matches the reported Error in [[Solver Status]] and [[Solver Setting - Convergence|Convergence]] criteria. This new tag is also added to [[Controls]] page.<br />
* Fix for edge case where tag is not selected in [[Model Data Transfer]] dialog when using context menu option "Data Transfer" from Access window tag.<br />
* [[Size Distribution (PSD)]] improvements:<br />
** Expanded [[Plant_Model_-_Qualities#SzDist_(PSD)_Quality_Configuration|PlantModel Qualities]] to include display table of the full sieve series intervals.<br />
** Updated the [[Size_Distribution_(PSD)#Size_Data_Sections_(Sz_Tab)|Sz]] and DSz tab pages to display a description (in mm) of the size interval on RHS of each row in the table.<br />
** Updated displays of size data in unit models such as [[Screen2]], [[Solids Recovery Unit]], etc. to include a a description (in mm) of the size interval on RHS of each row in the table.<br />
* Fix for [[TCE]] save and recover of breakdown reaction extents and phase mapping. Database save errors occurred with multiple saves of a project.<br />
* Fixed bug in reporting of [[TCE]] phase deportment.<br />
*Example projects:<br />
** New [[Example_-_05_PHREEQC_Projects#Raffinate_Water_Treatment_Example_With_Adsorption|Raffinate Water Treatment Example With Adsorption]] project used with paper presented at MetPlant 2023. Project uses [[PHREEQC]] to model a multistage water treatment circuit for waste water streams. It includes multicomponent adsorption to ferrihydrite and alumina.<br />
<br />
===Build 34246===<br />
:''Released 15 November 2023<br />
* Fixes for bugs introduced in previous Builds:<br />
** Build 34068: Update for SysCAD [[Access_Window#Data_Entry_in_SysCAD|Data Entry Style]] of numeric fields when clicking on whitespace on LHS of existing number and entering a new value. <br />
* Fix for display bug for [[Audit]] for PowerIn and PowerOut under the "Streams Audit Summary" heading which did not display in correct column.<br />
* Fix for edge case [[Reaction Block (RB)]] convergence error message when target for reaction extent solver is zero.<br />
* Updated messaging for [[Upgrading_Projects#Upgrade_Compatibility_Check|Upgrade Compatibility Checks]].<br />
* [[TCE]] Improvements:<br />
** Include new dynamic mode [[OLI Pond Model]].<br />
** Fixed error for [[ChemApp]] use for phase electron balance issues.<br />
** Improved [[ChemApp]] log file outputs used for trouble shooting.<br />
** Improved displays for timing and statistics for TCE Engines.<br />
** Fix for issue with copy and paste for operating mode settings.<br />
** Fix for issue with copy and paste of TCE Model Configurations.<br />
** For [[PHREEQC]] use of Surface Adsorption calculations, don't fail the overall calculation when the Adsorption part fails.<br />
<br />
===Build 34068===<br />
:''Released 19 October 2023<br />
*Fixes for bugs introduced in previous Builds: <br />
** Build 33873: Fix for use of "like" in [[TagSelect]] statements primarily used in Excel TagSelect reports and PGM TagSelect class. A statement such as "[Tag] like 'P_.*'" fails in Build 33873. The original functionality is restored to what it was before 33645.<br />
* For string input field in Access window, when clicking on RHS of text (more than 2 spaces after last characters) then the entire field is selected and overwritten with newly typed text. This makes SysCAD [[Access_Window#Data_Entry_in_SysCAD|Data Entry Style]] of string fields the same as numeric fields. Excel Data Entry Style is unchanged.<br />
* New option in [[Evaporator]] with external HX outlet connection, or with embedded heat exchanger, to specify the amount of solids to include with HX recycle. Can select this outlet to have liquids only.<br />
* Fixes and improvements in [[Shell and Tube Heat Exchanger 2]] condensing mode to support selection of component other then H2O in VLE block.<br />
* The Comment field entered in [[Reaction Editor]] for each reaction is now shown as a result tag in [[Reaction Block - Individual Reactions]].<br />
* [[TCE]] Improvements:<br />
** Fix for intermittent crash seen in TCE SideCalc.<br />
** For TCE SideCalc QProd no longer valid if ''Model'' is SideCalc. To include reverse mapping after TCE equilibrium calculation to SysCAD stream and optional QProd display select Reactor for ''Model''.<br />
** Fix for TCE Feeder that stopped working after an Empty action.<br />
* [[Reaction Editor]] version 1.5.34041:<br />
** Fix for bug introduced in version 1.5.33315 where selection for HoR conditions droplist was stuck at Custom.<br />
** For newly created reactions - extent now changes live in table and entry correctly has * marker.<br />
<br />
===Build 33873===<br />
:''Released 28 September 2023<br />
*Fixes for bugs introduced in previous Builds: <br />
** Build 32582: Fix for PlantModel.Area1.Activate (and Deactivate) tag not working due to incorrect indexing where PlantModel.AreaN.Activate tags being applied to Area(N-1) instead of Area(N). This only applies to use of these tags in PGM, etc. Tags are displayed correctly in [[Plant Model - Flowsheets]] Access window.<br />
** Build 33457: Fix in [[Access Window]] for paste of single value from Clipboard to each field of multiple selected fields.<br />
** Build 32925: Fix for a SysCAD startup error for users of older versions of Windows 10.<br />
** Build 33127: Fix for edge case crash with error message "Some PostConnects not called at EO_Execute" occurring at Solve when drawing flowsheets.<br />
* Update to not include [[Qualities Models]] on [[Plant Model - Qualities]] tab page (and in Feeder select Qualities) if Quality model is NOT selected in the cfg file. This also removes invalid error messages related to incomplete configuration of Qualities settings.<br />
*:'''NOTE:''' For some projects where a Quality (e.g. "Size Distribution") is required, but was not selected in the cfg file, all data and settings related to use of the Quality may be removed at project load. To solve this, first edit the cfg file and ensure the required Quality [[Model Selection|models are selected]] (e.g. "Size Distribution" for SzDist1.dll).<br />
* Fix for occasional incorrect selection of initial VLE BPE.Method when inserting units with [[VLE]] (e.g. [[Flash Tank 2]]). The initial setting was sometimes (seemingly randomly) "None" (or "VantHoff") instead of the default "StreamModel".<br />
*:'''NOTE:''' Projects may have unintended BPE.Method selected for Single Component VLE blocks in FlashTanks and other units where VLE is used to flash. We recommend that users check settings for VLE.BPE.Method in projects. One way to check this is to right click on the tag and select "Open Find Results" menu option (or press F8) to get a [[Find_Units_using_Query#Find_Results_List|list of values]] for this tag in all unit models of the same type.<br />
* Fix for User [[Species Calculations]] using Volume as one of the terms.<br />
*:'''NOTE:''' Any project using a User Species Calculation that includes stream or phase Volume as one of the calculation terms may have had incorrect results. This may affect project results if Species Calculation using volumes is used in model control.<br />
* Fix for memory leak (reduction to available memory in SysCAD application) that occurs when closing a project using [[TCE]].<br />
* Fix in Tank and Tie for incorrect Order for SplitFlows where Operation is [[SplitFlow - General Operation|General]] and Priority "Last" is used together with "Auto".<br />
* [[General Separator]] now correctly handles the edge case where feed solid conditions exactly match target conditions.<br />
* Fix for Find filters "StartsWith" and "Contains" used in [[Quick Find]] and [[Explorer Window]] when searching where tags containing wildcard characters such as ? and *. Find using Contains or StartsWith now correctly searches based on exactly what user has entered.<br />
* Fix for [[Precipitation3]] using SSA method where Seed Solids option did not work correctly when solving from empty.<br />
* Fix for recycle [[Tear]] Streams incorrectly creating [[Qualities Models]] (e.g. PSD) in outlet of pipe with Tear when the Quality should not be used in the project based on user selection and configuration of the quality definition.<br />
* Fix in dynamic for edge case bug where error 'Over specified' warning are generated in a [[Makeup Source]] and there is no makeup flow. Error can occur when first configuring the makeup block and pressing solve.<br />
* Fix for false error message in [[Simple Evaporator]] when applying small Duty that simply heats the stream slightly (does not reach saturation temperature).<br />
* Improved [[Reaction Block (RB)]] test for Starved reaction if reaction is Forward Only or Reverse Only which was previously giving a false reaction not converged error message.<br />
* Updated [[COM Automation]] API behaviour when trying to get/set tags and an empty tag string is provided. Reports error code instead of failing.<br />
* Updates to [[PHREEQC Pond Model|TCE Pond]] for energy balance reporting for heat of mixing.<br />
* For [[VLE]], added new LiquidMassFlow (LQm) result tag. Fix for Reset not clearing all results. Multicomponent VLE now correctly calculates result fields VapFlashed.Qm and LiqFlashed.Frac.<br />
* For TCE [[PHREEQC]] product results, added tag for oxidation reduction potential (ORP).<br />
* Include Upgrade Compatibility Checks at project save.<br />
* [[Reaction Editor]] version 1.5.33781:<br />
** Fix to handle ionic species names ending with one or more + characters (e.g. +++).<br />
* SysCAD [[VS Code]] PGM Extension:<br />
** Released a minor update with expanded list of PGM syntax keywords.<br />
<br />
===Build 33632===<br />
:''Released 29 August 2023<br />
*Fixes for bugs introduced in previous Builds: <br />
** Build 32925: Fix for SysCAD startup crash when user folder name for [[VS Code]] selection as PGM Editor was no longer valid, or related VS Code folder for extensions is not found or changed.<br />
** Build 31866: Fix in Access window display where + and - buttons did not expand or collapse groups of tags.<br />
*Added result tags Rho25, LRho25 and SolidConc25 for [[Material_Flow_Section#Properties|Stream Properties]] display.<br />
*New [[Species_Table_-_Specific_Heat_(Cp)#Cp_Equation_Format|Cp (Enthalpy) equation formats]] for Gibbs functions including parameters for Magnetic effects of species. GibbsMag_Cp(...) and GibbsExMag_Cp(...).<br />
*For [[Disk Centrifuge]], added new result tags for Feed Qm, Sf and SolidConc25. Added option for QFeed stream display. <br />
*Fix for [[Disk Centrifuge]] behaviour when feed solids concentration was below 700g/L, hardwired limit is removed. Edge case behaviour improved.<br />
*:'''NOTE:''' This may affect results of projects operating at these "edge" case settings.<br />
*Fix for dynamic tank with [[Tank_-_Dynamic_Mode#Level_Control|Level Control]] and Makeups or Discards where the selected Stream tag was not recovered at project load. Added new StreamTag string tag to allow setting of Level Control outlet stream tag by PGM, etc.<br />
*Fix for edge case crash on solve for [[Set Tag Controller]] when making multiple changes to list of tags to be set that includes removing and then adding back the same tag.<br />
*Updated "Tear not converged" Condition messages shown as solver is paused when $Solver.Convergence.Message.Frequency (found on [[Solver Setting - Convergence]] page) was "StoppedOrPaused".<br />
*If SysCAD is started with any [[Command Line Options]], these are shown in Message window at startup for information.<br />
*Don't remove project from "Most Recently Used" file list if project load fails.<br />
*Example projects:<br />
** New [[Example_-_GFEM_Projects#Green_Steelmaking_Example|Green Steelmaking]] example project used with paper presented at COM 2023. Project uses GFEM with RK parameters to demonstrate use of Hydrogen for green steelmaking.<br />
<br />
===Build 33513===<br />
:''Released 8 August 2023<br />
* Fixes for bugs introduced in previous Builds:<br />
** Build 33457: Fix for bug in TCE ion mapping error that can occur for some edge cases.<br />
*Project Window the [[Project_Window#Conversion_List|Conversions]] tab page improvements:<br />
** Shows selected default in bold.<br />
** Added right click context menu with actions to change Default conversion, Show/Hide conversions, Copy conversion to clipboard in PGM format and option to open Manage Conversions Dialog.<br />
*Added "[[Actions_Command_Summary|Step or Idle]] (F10)" command to Actions menu.<br />
*Fix for RB with ShowSpRequirements and/or ShowReactionLimits selected not clearing related results after a Reset action or during solve when the RB is switched off.<br />
*Improved [[Simple Heater]] "FeedCalc" calculation to correctly calculate required flow for a greater range of feed flow conditions.<br />
<br />
===Build 33457===<br />
:''Released 2 August 2023<br />
* Fixes for bugs introduced in previous Builds:<br />
** Build 33001: Fix for for incorrect RB results for [[Reaction Block - Other|RB with Src/Recycle/Sink]] that occurs after a full [[Actions_Commands#Reset|Reset]]. The unit models with RB with this condition report a mass balance error due to incorrect Src/Recycle/Sink calculation. Result is corrected on subsequent project load and solve.<br />
* For [[Disk Centrifuge]], added new "CentSolids/SolidAnalysis" option for Method. This allows user to specify target CentrateSolidFracReqd and CakeSolidFracReqd.<br />
* New "FeedCalc" option for [[Simple Heater]] to optionally calculate the required flow to achieve a target temperature. This can optionally be connected to use General Demand.<br />
* Updated [[Reaction Editor]] (from Version 1.5.32836 to 1.5.33315). Includes fix for display of sequence number on high resolution (4K) displays, and improved functionality for selecting HOR override species (especially with reverse reaction option).<br />
* Fix for losing "Create new Tab for User Property Calculations" setting in cfg file for [[User Property Calculations]]. Setting was lost when editing Species Database from open project.<br />
* Fix for custom [[Calculation Configuration|User Calculations]] where a "specialist function" with parameters, such as Density(phase,T,P), was not parsed and calculated correctly when the specialist function is part of a larger full calculation.<br />
* Fix to allow use of [[Split Thermal (SplitT)]] for Tie/Tank when Operation is Phase Recovery, Solids Recovery, Water Recovery or Gas Vent. Both outlet pipes are now shown and configurable on the SplitT tab page.<br />
* Fixed bug where Qualities could not be set in the [[Makeup Source]] when it is first inserted.<br />
* Fix for edge case in [[Simple Heat Exchanger]] using Other.FlowCalc where there was a runaway flow demand. Improved error messages for inoperative conditions/settings for flow demand calc.<br />
* Improved [[Heap Leach|Heap / Column]] model top layer evaporation logic and included user feedback when required evaporation is not met. Added display of evaporation flowrates for each layer and overall. Added display of "Heatflow" associated with water removed due to evaporation (as Heap Layer temperatures remain unchanged with evaporation).<br />
* New [[Print#Print_Multiple_PDF|Printing Graphics flowsheets]] functionality:<br />
** Can now select to print in Colour or Black & White.<br />
** Can now optionally include/exclude animations (Dynamic Bars, etc).<br />
** The new print settings are available on [[General Options Graphics]] tab page.<br />
* Fix for a new graphics page not using the specified [[Project_Settings#Graphics_and_Tags|Drawing Frame]] when "Frame Extent" was "None". Note that list of available frame symbols has been extended in SysCAD install.<br />
* Fix for "Tear not converged" Condition messages not being shown when solver is paused when $Solver.Convergence.Message.Frequency (found on [[Solver Setting - Convergence]] page) was "StoppedOrPaused".<br />
* For Access window added new "Copy Displayed" Ctrl+Shift+C copy to clipboard command for [[Access_Window#Right_click_on_Access_Window_variables|right click popup menu]]. The purpose is to copy text as displayed in Access window, in particular unlike "Copy" Ctrl+C for listed tags it copies the displayed text rather than the underlying full tag. Values are always copied in full.<br />
* Added Ctrl+Q shortcut key for Close Project.<br />
* Added new solver "Step or Idle" action command associated with F10 shortcut key. It is a single convenient button for solver stepping regardless of solver state. Three possible solver state actions: <br />
** (a) solver Step if Paused/Idle. Same as Actions|Step command. Use Shift+F10 shortcut to apply multiple steps.<br />
** (b) go to Paused/Idle if Stopped. Same as Actions|Idle command.<br />
** (c) go to Paused/Idle if Solving. Same as Actions|Idle command.<br />
* Rearranged and extended the [[Windows#Application_Window_Background_Pop-up_Options|context popup menu for right click on the background]]. This provides an ideal shortcut to access common commands rather then navigating through menus. Three possible menus are given: (a) when no project loaded; (b) when solver is stopped; (c) when solver is busy or paused.<br />
* Renamed [[Conversions]] menu options "Defaults and Display" to "Manage Conversions", and "Conversions Database" to "User Database".<br />
* Changed the default display conversion units for Cp(Ms), Cp(Ml), S(Ms), S(Ml), HCap, HCapF, DPperQm and DPperVol. Updated some [[Conversion List Table|Conversion Family]] full descriptive names for clarity and consistency. Added a few more conversions to some Conversion Families.<br />
* Implemented additional Upgrade Compatibility Checks to lists all models and options used that are "old" and will be discontinued in the next Build.<br />
* Various improvements to reduce memory use in projects.<br />
* SysCAD updated to use a newer version of "Microsoft Visual C++ Redistributable" package. An updated version of vc_redist.x86.exe is included with SysCAD install.<br />
* [[TCE]] Improvements:<br />
** Updates for determining optimal breakdown reactions for forward ion mapping to TCE Input species and ions.<br />
** Significant updates for ion mapping algorithms that results in improved product SysCAD species list after TCE calculation for a range of conditions. Algorithm changes relate to minimising the use of water in forward/reverse species to ion breakdowns and avoiding combined production of reduced and oxidised products.<br />
*:'''NOTE:''' These changes will likely affect the results of some models using the TCE interface for OLI, AQSol and/or PHREEQC.<br />
** Fix for displayed PHREEQC stream density when solids present (PHREEQC only returns liquid phase density).<br />
** ChemApp minimum version required updated to version 8.2.2 from 7.4.0. Updated ChemApp DLL (ca_sc_e.dll) included with SysCAD.<br />
*Tutorial:<br />
** The [[Tutorial_Overview#Introductory_Steady_State_Tutorial_Documentation|Introductory Tutorial]] has been updated (Rev 35.6) and renamed from "Basic Tutorial" to "Introductory Tutorial".<br />
** The associated Introductory Tutorial projects have been updated.<br />
*Example projects:<br />
** New [[Example_-_03UnitModels_Projects_1#Absorption_Tower_.28MultiK.29_Project|Absorption Tower (MultiK)]] example project to demonstrate use of multicomponent VLE to remove HCl and SO2 from fumes.<br />
** [[Example_-_03UnitModels_Projects_2#Cooling_Tower_Project|Cooling Tower Example]] updated to demonstrate using slightly "dirty" water in Cooling Tower feed.<br />
** Updated [[Example_80_Uranium|Demo Uranium Project]] to use General Controller instead of PID for ammonia addition to stripping.<br />
** Minor updates to various other example projects.<br />
<br />
===Build 33127===<br />
:''Released 22 June 2023<br />
* Fixes for bugs introduced in previous Builds:<br />
** Build 32925: Fix for not being able to change the state of a CheckBox in a Grid (Table) in the Access window.<br />
* For [[Explorer Window]] Graphics section, updated the heading display of Graphics Window and Area counts. Drag and drop of individual Graphics windows is easier by allow drop on existing pages as well as on Area heading.<br />
* Fix for [[Access Window]] Grid (Table) headings not being correctly lined up with the column of data in some tables.<br />
* Fix for inconsistency in VLE Grid/List display of tags for [[Vapour_Liquid_Equilibrium_(VLE)#Data_Section_for_Multi_Component_VLE|Multicomponent VLE]].<br />
* For [[Flange]] and [[DirectLink]], improved Access window display text and added additional tags for clarity of connections. Improved the text generated for the GeneralDescription.<br />
* Updated [[Links Table]] display when TableInfo is Detailed, with display of PortID on both sides of each connection.<br />
* For [[Pipe#Tear|Pipe Tear]] settings, renamed Tear.ReqdType option "NoTear" to "TearIfReqd" to more clearly convey its use.<br />
* For [[EB]] with multiple blocks switched on, display Evaluation sequence in comment on RHS of tag.<br />
* Added new PGM [[Formatting#TextBreak|TextBreak]] keyword to leave a blank line in Access window - alternate to TextLabel "" or TextLabel() or TextLabel("").<br />
* For [[General Controller]], added new button "Init Variables" to reset all tags (numeric types with Init values) to their Init values defined in the PGM code.<br />
* Fix for [[Queue Profile]] control model that was incorrectly setting tags with AdvanceRow, etc. when the model is off and SetTagAlways is unchecked.<br />
* Fix for edge case in [[Flotation Cell]] with air connection where a small energy balance error (slightly incorrect exit temperatures) occurred for some types of stream compositions.<br />
* For [[Models#Mass_Separation_Models|Filter Separation Models]] increased the maximum allowed CakeMoistReqd. For SplitFlows [[Split_Flows_(Split)#OPERATION_-_Water_Recovery|Water Recovery]] option increased the recovery allowed.<br />
* Reduced memory use in [[Multi-Storage]]. Fix for display of Up/Down buttons to cycle through individual Store displayed in the Access window.<br />
* Implemented additional Upgrade Compatibility Checks to lists all models and options used that are "old" and will be discontinued in the next Build.<br />
* [[Trend Window]] improvements:<br />
** Improved logic for selecting x-axis grid widths with zoom in/out for ProBal projects. <br />
** Added new option to display grid x-axis spacing label together with the window width label. The new option can set in [[General Options Trends]] and is on by default.<br />
** Fix for ScrollBack and ScrollBackFast menu/button [[Trend Command Summary|trend commands]] which were back to front.<br />
* [[TCE]] Improvements:<br />
** Upgraded [[PHREEQC]] version in SysCAD from 3.5.0-14000 to 3.7.3-15968.<br />
**:'''NOTE''': This may affect project results using PHREEQC.<br />
** Added missing error message displays for manual TCE [[PHREEQC Direct Calc Model|Direct Calc]].<br />
** Allow use of OLI Engine V11.x DLLs with [[OLI_Chemistry_Model|Legacy OLI]] interface.<br />
** Modifications to adsorption calculation algorithm for [[PHREEQC]].<br />
**:'''NOTE''': This may affect project results for projects that implement adsorption calculations in PHREEQC.<br />
<br />
===Build 33001===<br />
:''Released 18 May 2023<br />
* Fixes for bugs introduced in previous Builds:<br />
** Build 32925: Fix for crash with loading TCE OLI projects.<br />
* [[Reaction Block (RB)]] improvements:<br />
** Updated checks for RB Extent type [[Reaction_Block_-_Extents#Final_Elemental_Fraction_.28RB_.26_CRB.29|Final Elem Frac]] when using by Total instead of by Phase.<br />
** Improved convergence tolerance test for individual reactions in a RB. The result is greater accuracy in achieving reaction extents to more significant digits, and less "Extent not achieved" error condition messages where extent is almost achieved.<br />
** Reduced memory use in RB.<br />
* TCE: New option for [[TCE_Species_Mapping#Reverse_Mapping_Algorithms|Reverse Mapping Algorithm]] which can greatly improve the calculated final composition of aqueous SysCAD species from TCE outlet ion composition. Tag is "RevIonMap.BreakdownFirst" in TCE ModelCfg. For existing projects behaviour is as before, user can change this setting and check the results.<br />
* For [[Hydrocyclone]] using Whiten Fishhook method with a "large" fishhook and low WaterRecovery (Rf), prevent small "negative" flows in small PSD sizes and give an error condition message.<br />
* For [[Single Variable Histogram]] added option to specify number of display digits for bucket percentages. Various other improvements including grid display in Access window of the histogram bucket values.<br />
* New graphics display commands "Update Makeup/Discard/SrcLink Graphics" to reset (repair) the default associated DirectLink graphics. Functionality is similar to existing [[Display_Graphics_Commands#Update_Tear_Graphics|Update Tear Graphics]]. Found in graphics Display menu (and graphics context menu).<br />
<br />
===Build 32925===<br />
:''Released 5 May 2023<br />
* '''NOTE''': Full install recommended as Build 32925 includes new Reaction Editor, updated Basefiles (symbols, template reports, Notepad++ syntax files, etc), new VS Code extension for SysCAD PGM and updated example projects.<br />
* Improved options for PGM (and MP) code editing:<br />
** Microsoft [[Using VS Code|VS Code]] is an alternative text editor to [[Using Notepad++|Notepad++]] for editing PGM files. Kenwalt has developed a VS Code extension for SysCAD PGM files which provides a productive rich environment for editing PGM files with full syntax colour highlighting, etc. If Microsoft VS Code is not installed, download and install the software. Then install the SysCAD PGM extension using syscad-pgm.cmd (located in SysCAD139\Setup\VSCode_PGM_Extension\syscad-pgm.cmd).<br />
** The colours for keyword highlighting (for VS Code and Notepad++) have been updated, with a particular focus on use of a separate colour for all non-logic (i.e. formatting) type keywords. To update Notepad++ PGM Syntax keywords, follow [[Using_Notepad%2B%2B#Repairing_or_updating_User_Defined_Language|updating user defined language]] instructions.<br />
** Expand selections of editors in [[General Options General]] to include separate selection of PGM editor. This now includes functionality to find and use VS Code. Improved functionality under new "Select" button for selecting preferred editor.<br />
* Updates to rework Flowsheet Area management in [[Explorer Window]] and [[Plant Model - Flowsheets]] tab page for cleaner management of flowsheets by Area. Rework logic for "Unassigned" flowsheets. Removed Global Area. Added option to allow/disallow flowsheets to be unassigned to areas (belong to "None" when not assigned). New Explorer Window context menu option (for graphics Area) to add new graphics directly to Areas.<br />
* Added support for a Graphics, Trend or TagList document to have the same name. Names must be unique within the document window type.<br />
* New menu option "Tools|Upgrade Compatibility Checks". This lists all models and options used that are "old" and will be discontinued in the next Build. This will allow user to check a project, and make any changes to resolve any reported issues, before it can be used in a newer Build.<br />
* Improved [[Merge Project]] efficiency and robustness, primarily related to managing Flange tags (auto create new flanges in imported project). For system DirectLinks (Src/Snk/Spill) added option to include in tag checks or ignore and create new tags (as per Flange tags).<br />
* Improved functionality for [[Access Window]] copy and paste of multiple fields including Checkboxes.<br />
* Display conversion family name in [[Conversions#Changing_Conversion_units_for_a_Data_Field|right click]] popup context menu for change conversions - useful for quick lookup of conversion family name for editing PGM files. Last entry is now "Change *CnvName* Default..." instead of "Change Default...".<br />
* Some rework of opening [[General Options]] and [[Project Settings]] dialog boxes to prevent occasional crashes on some PC's or failure to open dialog box.<br />
* Fix for initial placement of toolbars after install.<br />
* For [[Zip Project]] added new option to open containing folder after zip; and new option to include scenario files.<br />
* [[Reaction Block (RB)]] improvements:<br />
** Implemented new "[[Reaction_Block_-_Extents#Final_Elemental_Fraction_.28RB_.26_CRB.29|Final Elem Frac]]" reaction [[Reaction Block - Extents|extent method]]. Allows control of reaction extent to achieve a target elemental molar or mass fraction.<br />
** For "[[Reaction_Block_-_Extents#Final_Fraction_.28RB_.26_CRB.29|Final Frac]]" Extent method, added support for final fraction by IPhase.<br />
** It is now possible to load an empty reaction file (no reactions). Previously this gave errors and prevented project solve. RCT file can have RHX only.<br />
** Condition warnings for reaction extents at user limit when using LimitAmountReacted or LimitFracReacted are not shown if Extent.Type is Target (i.e. only shown for Strict).<br />
** Improved RB.Status feedback descriptions.<br />
** Improved display when reactions in a RB are off and HideOffReactions is selected.<br />
** Improved error message reporting when RCT file fails to load.<br />
* [[Reaction Editor]] improvements:<br />
** Released new [[Reaction Editor]] version 1.5 with multiple functionality improvements and various bug fixes.<br />
** Supports new Final Elem Frac extent method and Final Frac by IPhase.<br />
** Added 'Open Containing Folder' option for quick access to reaction files.<br />
** Added right-click option to Reverse Reaction (swap reactants and products).<br />
** UI improvements, including sharper image on high resolution screens.<br />
** Fractional extents are now input and displayed as percentages.<br />
* Improvements and fixes for selection and use of component for use in VLE in [[Simple Condenser]] and [[Simple Evaporator]].<br />
* For the [[Compressor]] added a new Polytropic calculation method. Improved options for Adiabatic Efficiency.<br />
* Added new [[Conversions]] family LRate "Length Rate (Level Change)" as an alternate to Ldt "Velocity". Useful for display of rainfall rate, etc. in PGM files.<br />
* Stricter checking for case sensitive unique names for Individual Phases (IPhase) in [[Species_Table#Species_Definition|Species Definition]]. Fail project load when an error.<br />
* Added new functionality for Tank/Tie [[SplitFlows]] with new Operation option [[Split_Flows_(Split)#OPERATION_-_Target_Stream|Target Stream]] that allows selection of a single outlet stream where all flow is directed. <br />
* Improved [[Dynamic_Tank_-_Optional_Data_Sections#Level_Lookup_.28LL.29_Tab_Page|Level Lookup]] functionality for Dynamic Tank.<br />
* Added functionality in Dynamic for Batch control (new tag BatchClearOnEmpty) in [[Pipe_-_Dynamic_Mode#FC.28FlowCapacity.29|pipes]] and [[Feeder-Cross_Page_Connector#Batch_Feed|feeders]] to allow batch amount to be reset (cleared) with Empty Action.<br />
* For [[GFEM]] all the tags on Results tab page are now shown on project load.<br />
* Fix for crash in use of [[Species_Table_-_Transport_Properties#Laliberté_Viscosity_Function|Laliberté Viscosity]] correlation when large AqFrac.<br />
* Fix for [[Drum Filter]] vent causing mass balance error warning when vapours in feed goes on/off.<br />
* Fix for incorrect [[Feeder]] outlet flowrate when FlowBasis is Solids or Liquids and Mode is VolumeFlow.<br />
* Fix error in load [[Scenarios]] with [[Set Tag Controller]] getting the conversion units wrong.<br />
* [[EHX]] Ambient5 method updated to limit outlet temperature to ambient conditions.<br />
* Dynamic mode [[Heap Leach]] (or layered column) model now included with standard SysCAD install. Was previously available on request.<br />
* [[Heap Leach]] unit model improvements in displays for Measurements and RBControl. Added Langmuir RBControl for Extent type "Amount Reacted - Molar". Changed measurements used in Langmuir extent control to be feed plus content.<br />
* Improved functionality in [[General Controller]] for Copy to Clipboard buttons for TagList of all PGM Input/Result tags, with additional options in popup menu.<br />
* Added PGM [[Matrix Class]] function MultLeftArray and CopyMultLeftArray for Vector times Matrix (useful alongside existing Matrix times Vector function).<br />
* [[Excel Reports]]:<br />
** Improved management of template files, including a change in logic to only create copies of template report files when first generated or viewed in Excel. <br />
** Expanded options for [[Adding_and_Executing_Excel_Reports#Right_Click_Pop_Up_Options|right click context menu options]] for Reports in Excel Report list dialog.<br />
** Improved warning message in Excel feedback worksheet, when full tags (or primary tags in TagTable) start with a dot (.). <br />
** Where a Cell in Excel for a full tag (or primary tag in TagTable) only contains a dot (.) this is now [[Excel_Get_Tag_Reports#Reporting_Rules|treated as a special case]] equivalent to an empty cell.<br />
* [[Graphics Window]] (flowsheets):<br />
** For [[Print#Print_Multiple_PDF|Print Multiple PDF]] of graphics flowsheets, added new option to open containing folder after print to pdf.<br />
** Fixed crash for graphics paste after [[Copy_and_Paste_Graphics_Commands#Cut|graphics cut]] if some other command occurred between these two actions.<br />
** Implemented functionality in project to select default drawing frame for new flowsheet pages. The Frames drawing symbols are now installed to a separate symbols folder.<br />
** For [[General Options Colours]]: Removed unused option for negative flow. Fixed an error with underlying save and load of settings. (Current user settings may be replaced with defaults when first using this new Build.)<br />
** For [[General Options Drawing]]: Added new user option to select thickness (weight) of drawn lines. For different screen resolution displays (DPI) and depending on graphics window size or zoom, line thicknesses could vary. Line thickness (or weight) is now more consistent based on user selection, including option to always display single pixel line widths for all screen display types.<br />
* [[Trend Window]]:<br />
** Improved display of vertical green line for current timeline cursor display. Results in smoother trendline display without scrolling gaps in trend lines.<br />
** Improved display of text labels in trend line window.<br />
** [[General Options Trends]]: Added new user option to select thickness (weight) of trend lines, including option to always display single pixel line widths for all screen display types. Line thickness (or weight) is now more consistent for different screen resolution displays (DPI) and user sizing of trend window.<br />
* [[TCE]] Improvements:<br />
** General improvements for error reporting.<br />
** TCE Pond functionality improvements.<br />
** Fix for false TCE error reporting when TCE is Off (i.e. Model = "None (Off)")<br />
** For OLI display of IonicStrength changed calculation and display units to mol/kg to be consistent with all TCE's and common use. Old tag was mol fraction. Caution: projects using this tag may get different results.<br />
** Added option to copy OLI Apparent species to clipboard.<br />
<br />
===Build 32530===<br />
:''Released 23 February 2023<br />
* Fix for recycle tears with no flow that were not detected as NoFlow state. This gave errors in convergence reporting and false convergence of temperature in recycle with no flow.<br />
* Improved display of Criteria, [[Solver Setting - Tears|Tear Blocks]] and [[Tear|Tears]] shown in $Solver and for individual Tears. Includes some additional result fields (e.g. tear state), and changes to tags for consistency.<br />
* For dynamic projects, moved reporting options for [[Solver Setting - Spills|Spills]] from PlantModel to $Solver.<br />
* Improved [[Model Data Transfer]] dialog by excluding global parameters and some repeated tags in the list of tags. Removal of repeated tags fixes errors in Data Transfer not working correctly for some use cases.<br />
* Graphics dialog improvements: For [[Insert Graphics Commands|Insert Unit]] allow user to clear and enter the tag without a default tag being automatically created when field is cleared. For [[Construct Graphics Commands|Construct Unit/Link]] hide the Search field.<br />
* Renamed the SysCAD temp folder folder in system user temp from SysCAD139 to _SysCAD_139_.<br />
* For species database temperature range for [[Species_Table_-_Specific_Heat_(Cp)|Cp (Enthalpy)]], if value is below 1K, give warning message and use 1K as the minimum temperature.<br />
* [[Merge Project]] is more efficient. New system flange tags are automatically created instead of trying to manage flange tag naming conflicts.<br />
* Bug fix for [[Zip Project]] for large projects.<br />
* Clearer display of IsothermComponent selection for use in [[Solvent Extraction Unit]].<br />
* Updated calculations and tags for recently introduced [[Sugar Fugal 2]].<br />
* [[Heap Leach]] model improvements:<br />
** Fix for incorrectly including solids flow between layers when LiqDrain method is None. <br />
** Improved calculation of LiqFrac holdup when solids included with LiqDrain.<br />
** Reduced memory use.<br />
** Display improvements: Fix for some layer result displays for empty layers. Add display of Sf for feed to each layer. Add display of last step OpModeUsed. Add result display of Product.Qm.<br />
** New condition warnings: When OreFeed flow and OpMode is not stacking. When OreFeed flow and heap is full.<br />
*Example projects:<br />
**Updated all [[Example - 05 PHREEQC Projects|PHREEQC Examples]].<br />
*New [[General Controller]] PGM Runtime Debug mode. To track down where in the code runtime errors (such as divide by zero) occur, select the "Enable Debug" button which will reload the PGM with stored line numbers that are then used when reporting any runtime errors in the message window. At next project load, any models in RuntimeDebug mode are returned to normal operation.<br />
*New PGM '''[[Class#Macros|Macros]]''' for use with Classes providing significant new functionality for working with collections (lists) of class instances:<br />
** Added ForEachSub macro as alternate to ForEachClass. Syntax ForEachSub(Classes, SubName(...)) Example ForEachSub(TankClass, Exec())<br />
** New ForEachFn macro. Syntax ForEachFn(ResultVariable, OperationMethod, Classes, FunctName(...)) Example ForEachFn(Total, +, {T1,T2,T3}, CalcArea()) is equivalent to Total = T1.CalcArea() + T2.CalcArea() + T3.CalcArea()<br />
** New ForEachVar macro. Syntax ForEachVar(ResultVariable, OperationMethod, Classes, ClassVariable). Example ForEachVar(TotalVol, +, {T1,T2,T3}, Volume) is equivalent to TotalVol = T1.Volume + T2.Volume + T3.Volume<br />
** New ForEachVarSet macro. Syntax ForEachVarSet(Classes, Variable, Expression). Example ForEachVarSet({T1,T2,T3}, Height, 17) is equivalent to T1.Height = 17 T2.Height = 17 T3.Height = 17<br />
** New ForEachFnCalc macro function. Syntax ForEachFnCalc(OperationMethod, Classes, FunctName(...)). Example: Total = ForEachFnCalc(+, {T1,T2,T3}, CalcArea())<br />
** New ForEachVarCalc macro function. Syntax ForEachVarCalc(OperationMethod, Classes, ClassVariable). Example: TotalVol = ForEachVarCalc(+, {T1,T2,T3}, Volume)<br />
** New ForEach macro function. Syntax ForEach(OperationMethod, Classes, FunctName(...)/ClassVariable). This auto detects last parameter type and is then equivalent to ForEachFnCalc or ForEachVarCalc.<br />
** New ClassCount(Classes). This returns the number of class instances in the list. Example: AveArea = ForEach(+, {T1,T2,T3}, CalcArea()) / ClassCount({T1,T2,T3})<br />
** For ''OperationMethods'' parameter the available operators are : +, *, -, or, and, bor, band, bxor<br />
** For ''Classes'' parameter in these macros, this can be a named ClassList, a list of specific class instances and/or a class arrays all enclosed in {}, or a list of class types enclosed in {}.<br />
*New PGM '''[[Class#ClassList|ClassList]]''' command to define a list of class instances, including class arrays, that can then be referenced in subsequent code (for example in multiple calls to ForEach macros). <br />
** Syntax is ClassList ListName {classes}. Example ClassList L1 {T1,T2,T3} or ClassList TanksList {Tanks,T1,T7,MoreTanks[2],MoreTanks[7],T12} (where Tanks and MoreTanks are arrays of classes).<br />
** A ClassList provides the convenience of defining a class list (collection) once. For example: If we have "TankClass T1,T2,T3,T4,T5". We can have different lists such as "ClassList L1 {T1,T2,T3}" and "ClassList L2 {T3,T4,T5}" intentionally including T3 in both lists.<br />
** A ClassList can be declared when defining the class instances, where the list is all the instances. For example TankClass{List(TanksList)} T1,T2,T3,T4,T5<br />
** Some examples: ForEachVarSet(L1, CalcHeatLoss, true) ForEachSub(TanksList, Exec())<br />
*New PGM '''[[Class#ClassGrid|ClassGrid]]''' keyword to display classes in a grid (table):<br />
** New [[Class#ClassGrid|ClassGrid]] keyword for displaying classes in a grid format, where each column is a grid and each row is a variable for the class. <br />
** Syntax is ClassGrid classes. Where classes is a previously defined ClassList or list of classes similar to use in ForEach macros. Examples: ClassGrid {T1,T2,T3} ClassGrid L1 ClassGrid {TankClass} ClassGrid Tanks (where ''Tanks'' is an array of classes)<br />
** Use ClassGridMaxColumns within class definition to set the maximum number of columns. Default is 10. Multiple grids are shown when larger number of class instances.<br />
** Use ClassGridColumnWidth within class definition to set the column width. Default is 14.<br />
** TextLabels within the class grid are shown as row separators, however blank lines and multiple text lines are ignored (only the last textlabel in a group is shown). All TextLabels in a grid can be hidden if using keyword ClassGridHideText in the class definition.<br />
** If comments are used for class instances, these are shown as text for each column in first row of grid. This can be disabled using keyword ClassGridHideComment in the class definition.<br />
** If option ClassGridPageLabel is used in class definition, then the grid is displayed on a new tab page in the Access window.<br />
** Instead of using ClassGrid keyword, it is possible to use a grid when declaring the class instances using the keyword Grid within {} or use the # symbol For example TankClass# T1,T2,T3,T4<br />
*General [[PGM]] Improvements:<br />
** Allow use of @ or @@ when declaring [[Data_Types#User_Defined_Constants_using_the_Const_Keyword|const]] variables to provide visibility. Example: const double MinAreaT@ = 18<br />
** Allow use of previously defined constant in declaring options [[Declaring_Variables#Declaring_variables_with_an_Initial_Value|Init]] or [[Declaring_Variables#Declaring_variables_with_ranges|Range]] for variable. For example: double ValReqd*{Init(PI)} double T_Reqd*<MinAreaT,MaxAreaT>.<br />
** Allow use of previously defined string constant in [[Declaring_Variables|declaring variable]] comment option. Must use Comment() keyword. For example: double QmReqd*{comment(Desc)} where Desc is previously defined as: const Str Desc = "Some common description"<br />
** When specifying comments when [[Declaring Variables]], it is not necessary to include the "comment()" keyword. For example use: real FlowReqd*{"Enter feed flowrate"} instead of: real FlowReqd*{comment("Enter feed flowrate")}<br />
** Use new keyword ClassAsGroup in class definition to display class instances in Access window with "ClassName..." instead of repeating "ClassName.xxx" for each variable of class.<br />
** Allow specification of Comments for Class Instances. The display of the comment in the Access window depends on use of ClassAsGroup and if class is shown in Grid. Example TankClass T1{"Feed Tank"}, T2{"Acid Tank"}. The keyword [[Class#ClassComment|ClassComment]] can also be used, where syntax is ClassComment Class "comment". Example: ClassComment T[1] "Feed tank"<br />
** New functions [[Predefined_Functions#User_Defined_Messages_and_Errors_Functions|StopSolver(..) and PauseSolver(..)]] as alternates to PGM variables StopSimulation and PauseSimulation.<br />
** General improvements in PGM load error reporting. Stricter checking for literal string parameters being enclosed in quotes ("). New warnings for unexpected scope use of keywords within functions, if-blocks or while-blocks. New warnings if using special characters ':', '~' or '&' in variable/function names, they will not be allowed in future Builds.<br />
** Added load time warnings if any old PGM syntax or keywords are used (will be discontinued in future Builds).<br />
* [[TCE]] Improvements:<br />
** Various improvements in Ion mapping algorithm.<br />
** PHREEQC bug fix for saving and loading SatIndex when < 0.<br />
** Don't allow loading of PHREEQC databases containing '''-no_check''' reactions because this allows PHREEQ equilibrium calculations that don't conserve mass. If you get this error, edit PHREEQ database to remove these reactions.<br />
** Fix for OLI projects failing to load (bug introduced in 32335).<br />
** Fix for TCE Feeder where the outlet stream was not properly calculated after changes to the selected model configuration (i.e. changes to SatIndex, mapping tolerances, etc.)<br />
** Added option to copy to clipboard all connected feeds/products.<br />
** Plotter bug fixes and improvements.<br />
<br />
===Build 32335===<br />
:''Released 17 January 2023<br />
* Fixes for bugs introduced in previous Builds:<br />
** Build 32217: The maximum number of PGM tab pages were mistakenly limited to 10. Returned the limit to 250.<br />
* For Dynamic projects, in [[Solver Settings]] ($Solver) added new functionality for reporting [[Solver Setting - Spills|Spills]] and [[Solver Setting - Vents|Vents]]. Includes some options for some detailed analysis of when and where spills occur.<br />
* Added optional display of QFeed and QProd to [[Valve]], [[Pump]], [[Gas Pump]], [[Reducer]], and QPrimary and QSecondary feeds for [[Thermocompressor]].<br />
* For [[Precipitation3]] changed various Ea/R tags from temperature conversion to dimensionless for clarity. K is shown as comment in Access window.<br />
* Improved display of CheckBoxes in [[Access Window]] at different high resolutions.<br />
* Example projects:<br />
** New GFEM + ChemApp example project [[Example - 07 ChemApp Projects#Hybrid GFEM + ChemApp Electric Furnace|Electric Furnace]].<br />
* [[PGM]] Improvements:<br />
** For PGM ForEachClass macro used with PGM [[Class]], now require use of brackets for the subroutine used. For example use "ForEachClass(TankClass, Init())" instead of "ForEachClass(TankClass, Init)".<br />
** For defining constant [[Array Class|Array]], [[StrArray Class|StrArray]] and [[Matrix Class|Matrix]], the const keyword is now required. For example "const array Vals = {1,4,2,98}" instead of "array Vals = {1,4,2,98}".<br />
** Give PGM load time warnings if strings for [[Formatting#Labels|PageLabel and TextLabel]] are not enclosed in quotes (").<br />
* [[TCE]] Improvements:<br />
** Added a Forward Mapping Summary to Results page<br />
** Allow selection of Off for TCE in all TCE unit models. Allow solve when no license for TCE (TCE calculations bypassed).<br />
** New OnStart option for TCE side calculations.<br />
<br />
===Build 32217===<br />
:''Released 19 December 2022<br />
* Fixes for bugs introduced in previous Builds:<br />
** Build 31866: Fix crash or freeze that can occur when list of PIDs in [[Controls Window]] is being updated while building flowsheets by inserting a PID.<br />
* Fix for [[Info_Report#Species_Information_Report|Excel Species Info]] report for project with large number of species.<br />
* Fixed tag visibility error of Isotherm options in [[Solvent Extraction Unit]].<br />
* Fix for edge case [[Flash Train]] not solving correctly where a Tie/Tank SplitFlows using General OpMode has multiple outlets with QmDemand and the last of these doesn't find a demand sink (e.g. condensing Shell&Tube heater). The Tie/Tank outlet in Demand mode without a detected demand destination is now treated as a zero demand flow.<br />
* Added option for [[Shell and Tube Heat Exchanger 2]] for when the model is Off, so that a condition warning is given when model is off but there is flow to the shell side. Especially useful for Condensing mode.<br />
* Added option "OFSolidsPriority" to [[General Separator]] for "SplitMethod" selection "Solid Separation". This is to prioritise OF or UF Solids requirements for the OF "SolidsSeparMethod" choices when the feed solids are too low to meet any requirement. For some flowsheet arrangements (recycles), this can help project convergence reach required OF setpoints and solids flow.<br />
* For [[Vapour_Liquid_Equilibrium_(VLE)#Multiple_Component_VLE|Multicomponent VLE]] user specified K values, implemented a fix to allow user to specify a 0 value for K (resulting in all of that component going to liquid phase).<br />
* Fix for dynamic mode where the Historian restarted twice at solver startup for set time option for [[Solver_Setting_-_Scenario|Scenario management]].<br />
* For dynamic mode Feeder using volume flow [[Feeder-Cross_Page_Connector#Batch_Feed|Batch Feed]], fixed edge case where this failed to work due to previous zero outlet flow.<br />
* Added new option for OPC [[Marshal]] to block Marshal setting mapped SysCAD tags when Marshal OPC tags are invalid or Marshal cannot connect to OPC Server.<br />
* New [[Sugar Fugal 2]] model as an alternate to [[Sugar Fugal]].<br />
* New option in [[Heap Leach]] for bottom up flow of liquid feed in the column, in addition to original top down behaviour. Implemented other display improvements and bug fixes in [[Heap Leach]] model.<br />
* Added optional display of QFeed and QProd to [[Compressor]], [[Valve 2]], [[Pump 2]], [[Piping System Model]] and [[Pressure Exchanger]].<br />
* Improved management of user [[Conversions#Changing_Conversion_units_for_a_Data_Field|selection of conversion units]] in the [[Access Window]]. In particular, for tags on stream pages (Qo, QFeed, etc), the user selections are now applied to all Streams in all unit models. Fixed a bug where after a conversion change the numerical values were not immediately shown for the "same" tag displayed in other tab pages of the model.<br />
* Improved efficiency and responsiveness on close of [[Insert Graphics Commands|Insert Unit]] dialog.<br />
*Example projects:<br />
** New PHREEQC example project [[Example_-_05_PHREEQC_Projects#Raffinate_Water_Treatment_Example|Raffinate Water Treatment]].<br />
*[[PGM]] Improvements:<br />
** Fix for PGM Array and Matrix recovering the data when pressing the Reload button. Previously the Array and Matrix size was set to zero length when reloading a PGM when the project is open.<br />
** Added alternate variable [[Data Types]] bool and boolean for bit; and int for long/integer.<br />
** New [[String Functions]] StrInsert, StrErase, StrReplace and StrReplaceFrom.<br />
** Alternate [[String Functions]] StrFind for StrStr, and StrFindFrom for StrStrFrom.<br />
** For [[Array Class]] and [[StrArray Class]] added new functions InsertAt(Index, Value) and RemoveAt(Index, Count).<br />
** Added support for const readonly PGM [[StrArray Class]] declared with = {"..", "..", etc}.<br />
** New [[Class#Syntax|ClassAsPageLabel]] keyword for use in class definitions. Use this to automatically create page labels for each instance of a class.<br />
** Don't report special case of 0/0 runtime warnings while running PGM code, the result is 0 (as before). SomeValue/0 still gives a runtime warning always. This runtime warning message can be switched on in the [[General Controller]].<br />
** Some improved PGM load time checks and build error messages for declaring variables, functions and classes.<br />
* [[TCE]] Improvements:<br />
** Further improvements to Ion mapping algorithm to handle edge cases in reverse mapping.<br />
** IonList.txt file should not have charged neutral species. They are ignored.<br />
** Improved error reporting for loading IPhaseMap.txt file. New option to edit file from edit configuration dialog.<br />
** To manage warnings about Acids and Bases being present in a product stream, user can select target breakdown reaction in $SDB species properties to control if a species is seen as an Acid, Base or Amphoteric.<br />
** Only display TCE Density value tags (and SolidsConc) if these are calculated by the TCE.<br />
** Corrected tag names and column display headings for solid/liquid/gas phase ActivityCoeff / Activity / Fugacity / SatIdx /etc. for the different TCE prod streams. Values are now correctly saved and recovered at project load. Any reports/controllers using these tags may need updating.<br />
** Fixed inconsistent stream tags QRxnUnmapped and QUnmapped in all TCE models.<br />
** Various improvements in displays and options for SideCalc, including use of optional reverse mapping.<br />
** For ChemApp updated direct reporting of Feed and Prod Enthalpy and Heatflow.<br />
** For PHREEQC allow user to set maximum number of iterations and fix of crash in loading of specific database files.<br />
** For OLI various improvements in display of property results and apparent species.<br />
** User can select Phases allowed for Mapping for Forward and Reverse mapping separately.<br />
<br />
===Build 31866===<br />
:''Released 26 October 2022<br />
* Fixes for bugs introduced in previous Builds:<br />
** Build 31157 - Show the option "IndividualPhase" for tag "EleBasis" on [[Material_Flow_Section#Sp_and_EC_Tab_Pages|EC]] tab page to report concentrations, etc. of elements by IndividualPhase - drop down option was mistakenly hidden.<br />
** Build 31602 - Fix PGM bug where on editing and/or reload of the PGM, the contents of all pgm strings were discarded.<br />
** Build 31388 - Fix error for [[Command Scripts]] or [[COM Automation]] stopping on SaveProject command (i.e. not completing the command and returning control).<br />
** Build 30874 - Fix for graphics symbol using NURB splines (e.g. forklift) that caused dxf files to expand in size with each save (and eventually crash SysCAD).<br />
* License administration changes:<br />
** Renamed license add-on option "SMDK Runtime" to "[[SysCAD_Structure#Integrated_Libraries_.28SMDK_Runtime.29_Add-On|Integrated Libraries]]" add-on.<br />
** Combined previously named OLI add-on, PHREEQC add-on, AQSol add-on and ChemApp add-on to a single combined add-on called "[[SysCAD_Structure#TCE_.28Thermodynamic_Calculation_Engines.29_Add-On|TCE add-on]]". Any existing license using these old add-ons will automatically include "TCE add-on" providing all TCE options.<br />
* Second generation of OLI integration libraries (now as part of TCE) are now included with standard SysCAD installation - see [[OLI Overview]]. Separate download and Beta label has been removed.<br />
*Example projects:<br />
**New example project using Python script for [[Example - 07 ChemApp Projects#Nickel Laterite Smelter Multivariable Optimisation|multi-variable optimisation of ChemApp Nickel Laterite Smelter]].<br />
* The list of all PID controls on [[Controls]] is now ordered alphabetically.<br />
* The list of all PIDs is now automatically updated on existing [[Controls Window]].<br />
* For [[SplitFlows]] in Tank/Tie added new option "Last" for "Priority". Useful to mark a pipe as always last (doesn't change with adding/removing pipes.)<br />
* Significant rework of Dynamic mode [[Solver Setting - SS Monitor|Steady State Monitor (SSM)]] and [[Solver Setting - SS Finder|Steady State Finder (SSF)]] functions. SSM is ideal for analysis of changes in flows and contents in a dynamic model, especially at startup.<br />
* When specifying isotherms in text files, added support for specifying conversion units in column headings.<br />
*[[PGM]] Improvements:<br />
** Improved PGM and MP runtime error condition reporting at solver startup.<br />
** Allow [[Tag_Functions#SetTag_Functions|PGM setting of tags]] that change from results to parameters during a model run. Various improvements and fixes in error reporting for failing to write to tags from PGM or MP.<br />
** Added [[Matrix Class]] class functions ColOffset, ColSum, ColAvg, ColMin, ColMax, ColMinIndex and ColMaxIndex.<br />
* Other fixes:<br />
** Fix for error (or occasional crash) in activating/deactivating pages from [[Plant Model - Flowsheets]] Access window.<br />
** Fix for controller "Not in evaluation sequence" error message after page activate/deactivate.<br />
** Fix for [[Discard Sink]] that reported incorrect temperature (and enthalpy) for total QProd. Error was in accounting for first discard link in list.<br />
** Fix for dynamic push/pull not achieving correct volume flow in a time step for edge case of use of Tie with no flows in "local network".<br />
** Fix for error for [[Historian]] where for a new project it was not located in the correct folder leading to subsequent historian errors on project load.<br />
** Fix in [[Drum Filter]] when using recycle option.<br />
** For [[Adding_and_Executing_Excel_Reports#Excel_Automation:_Export_Reports_and_Import_Data_Dialog_Box|Excel reporting Dialog]] allow Excel filename with a quote (') in filename.<br />
* [[TCE]] Improvements:<br />
** Improved TCE ion mapping logic and project load time for building ion mapping lists from [[Ion Definitions]] file.<br />
** Improved tests for errors loading TCE libraries or licenses. When an error occurs, prevent project save. Save-as is allowed.<br />
** Improved dialog for [[TCE Configuration]]. New option when editing cfg files to allow IonMapping for selected TCE ChemApp databases.<br />
** For TCE tab page for TCE unit models, improved the Access window layout of tags. Selection of linked Chemistry Model is always first. TCE Reactor and TCE SideCalc now have a separate TCE page consistent with other TCE unit models.<br />
** TCE RO model fixes and improvements.<br />
<br />
===Build 31623===<br />
:''Released 27 August 2022<br />
* Fixes for bugs introduced in recent Builds:<br />
** Build 31602 - Fix for crash editing a cfg file when selecting the Calculations tab page.<br />
** Build 31388 - Fix for crash in Tank or Tie with large number of connected pipes.<br />
** Build 31602 - Fix for being unable to load ChemApp model even when license is valid.<br />
* For dynamic projects, introduced a warning message if invalid [[SplitFlows]] option "Demand Mass Flow" is selected in Ties.<br />
<br />
===Build 31602===<br />
:''Released 22 August 2022<br />
* Allow projects using [[TCE]] Demo (Light) versions to load and solve without requirement for TCE license add-on.<br />
* Improved error reporting for loading of rct files in [[Reaction Block (RB)]].<br />
* Updated functionality for Dynamic Steady State Monitor ([[Solver Setting - SS Monitor|SS Monitor]]).<br />
* For Dynamic Control Reset, fixed an issue in initialising values in range for [[PID]] and for [[Tank_-_Dynamic_Mode#Level_Control|Tank Level Control]].<br />
* Improved error reporting for [[Feeder-Cross Page Connector]] when connecting/disconnecting pipes.<br />
* New PGM [[String Functions]] StrStrFrom(String1, String2, FromIndex). Similar to StrStr(String1, String2) but allows user to specify start position for the find.<br />
* Fixed crash in [[PGM]] load/save where PGM contained strings in excess of 1000 characters.<br />
* Fix for Tie/Tank [[SplitFlows]] for edge case of separating out individual species to cause an automatic phase change at mass fraction, as can occur for H2SO4.<br />
* Updated version of [[ChemApp Overview|ChemApp]] libraries included with SysCAD to ChemApp version 8.2.<br />
* Fixed errors for TCE models with VLE and Bypass - allow separate bypass for Feed and VLE Rxn.<br />
* Miscellaneous improvements in [[TCE]] error reporting and DLL load checks.<br />
* Minor improvements writing to temporary files, and moved some of these to the LogOutputs folder. <br />
* Miscellaneous improvements in ProBal solver to reduce memory use and provide some minor solve time efficiencies.<br />
<br />
===Build 31388===<br />
:''Released 2 August 2022<br />
* Fixes for bugs introduced in recent Builds:<br />
** Fixed bug for incorrect [[Demand]] calculation through a Tie, Tank or Pipe with [[Makeup Block (MU)]]. Bug was introduced in Build 31207.<br />
** Fix error preventing use of [[ChemApp Overview|ChemApp]] CFE species. Bug was introduced in Build 31218.<br />
* New option to prevent solver start if reaction (RCT), general controller (PGM) or model procedure (MP) files failed to load or are missing. The user can turn this global option off in the individual unit models or in [[Solver Setting - FS Solver|Solver Settings]] on first tab page.<br />
**'''NOTE''' that as these new options are on by default, existing projects with these errors will not solve unless user fixes the error or turns the option off.<br />
* For [[SysCAD Marshal]] improved error reporting and feedback when loading the slots tag list. Improved support for optional fields. Includes fixes for crashes.<br />
* Allow MultiStep.StepCount used with solver [[Actions Command Summary|MultiStep Action]] to be configured on first tab page of [[Plant Model]]. This setting is now saved and recovered with the project.<br />
* Added display of HeatFlow, Feed and Prod T for [[Discard Block (DB)]]. Improved Discard Block calculation of outlet temperature due to heat of mixing.<br />
* For the [[Sugar Fugal]] model the BasketWash connection is now optional.<br />
* For the [[Filter Press]], fixed edge case error for bad feed conditions that resulted in incorrect (invalid) outlet streams.<br />
* For dynamic [[Multi-Storage]] display of list of connected Feeds and Prods added Find and Access buttons for pipe tags.<br />
* Fix error for [[Save Project]] with extra dots in user specified project name being truncated.<br />
* Fix for bug in Dynamic where [[Pipe_-_Dynamic_Mode#FC.28FlowCapacity.29|pipe capacity and Batch]] settings, for example at tank outlet, are not saved and recovered in a new model that hasn't been run before a save.<br />
* For Stream [[Material_Flow_Section#Properties|Material Flow]] (e.g. QFeed) and [[Common_Content_Section#Content_Properties|Content]] added new slurry based fraction tags SLf, SLvf, Slurry.Svf, Slurry.Lvf and MlSLf.<br />
* For Tank and Tie [[Split Flows (Split)]] and [[Split Thermal (SplitT)]] added tags for total feed MassFlow and Temperature shown at top of Split and SplitT tab pages.<br />
* Various [[Split Thermal (SplitT)]] improvements: <br />
** Fixed bug for setting required mode, or settings getting lost when adding/removing connected streams.<br />
** New option to set order to match the order of the outlet streams in the SplitFlows section.<br />
** New error condition messages for case where target temperature is not achieved in a stream. Additional HeatCorrection result tag to show the HeatFlow variation that would be required to meet the temperature outlet targets.<br />
** Improved display for outlet streams in Result field and display of massflow.<br />
** Various improvements in efficiency of calculations.<br />
** Option is now disabled and hidden when Heat Exchange is switched off.<br />
* Added new Engineering [[Conversions]] family "Specific Power Volume" (PwrV). Various additions to available conversions in a number of conversion families.<br />
* For the [[Access Window]] displays, ensure text lines are Italics (reverted back to original behaviour).<br />
* Improvements in [[Quick_View#Copy_Data_for_Excel_Reports|Quick View copy]] to clipboard for tags without conversions.<br />
* [[Explorer Window]] improvements:<br />
** Fixed bug where DirectLinks were inconsistently excluded from lists.<br />
** Fix for selection count (numbers shown in brackets) based on filter string. Added selection count for UnitTypes.<br />
** Added optional section "[[Explorer_Window#Flange_Flows|Flange Flows]]" which lists all flanges (the connection flange objects between pipes and models).<br />
** Restore vertical scroll position when adding/deleting models in the flowsheets.<br />
** Improved right click context menus.<br />
* [[Graphics Window]] improvements:<br />
** Fix arrow keys for editing graphics that stopped working after project save and some other actions.<br />
** Updated context menu for right click for graphics window.<br />
** Fix freeze when pressing F11 in Access window for "Send to Annotation Table" when the Dialog is not open.<br />
* Expanded PGM [[Class#ForEachClass_Function|ForEachClass]] macro function:<br />
** Allow a ClassTypeList of class definition types as first parameter. List in {} e.g. ForEachClass({TankClass,ThickenerClass}, Exec())<br />
** Allow a ClassList of class instances as first parameter. List in {}. They can be different class definition types as long as they all have a sub with the same name. e.g. ForEachClass({T1,T3,W.T,X}, Exec())<br />
** Allow the Sub to have any number of parameters. String parameters not supported. e.g. ForEachClass(ThickenerClass, SetCalcsOn(true))<br />
** New function ExcludeClass that can be used to mark a class instance for exclusion from ForEachClass function. Ideal to pair with ExcludeWatch to skip class at index 0 in an array. e.g. ExcludeClass T[0]<br />
* New PGM [[String Functions]]:<br />
** string ConstStr(constant) returns the constant (including enum constant) as a string.<br />
** string EnumStr(EnumDropList variable) to return as a string the current enum value of the supplied EnumDropList variable. Useful for display of enum mode, state, etc. e.g. StateDesc = EnumStr(FilterState)<br />
* New PGM [[Mathematical Functions]]:<br />
** bit IsClose(Val1, Val2) and IsCloseTol(Val1, Val2, AbsTol, RelTol) that returns true or false if the values match within tolerance. Default tolerances are 1e-9. Useful for convergence loops, or any comparison within some tolerance.<br />
** double IsCloseError(Val1, Val2) and IsCloseTolError(Val1, Val2, AbsTol, RelTol) return error value of comparison. A value less than 1 is considered "close".<br />
* [[TCE]] Improvements:<br />
** Various Reverse Osmosis (RO) unit model improvements including new option for ion permeability, membrane interface and concentration polarization.<br />
** ChemApp - allow use of newer versions of ChemApp DLL<br />
** For TCE Unit models such as TCE Evaporator & TCE FlashTank, moved the TCE settings to separate tab page in Access window.<br />
<br />
===Build 31218===<br />
:''Released 12 July 2022<br />
* Fixes for bugs introduced in recent Build 31207:<br />
** Fix for [[Explorer Window]] right click on page names not bringing up context menu.<br />
** Fix for [[Makeup Block (MU)]] in dynamic mode not calculating any flows after a Reset action.<br />
* For PGM [[Particle Size Definition Class]] (PSD Class), added new functions ParticleCountFactor(), SmallestSize(Dist), GeomMeanArray(Dist, Array), TopSizeArray(Dist, Array).<br />
<br />
===Build 31207===<br />
:''Released 8 July 2022<br />
* Improved [[Explorer Window]] functionality for selecting current window on open, maintaining vertical scroll position while editing flowsheets and improved behaviour when using Explorer window to select windows.<br />
* Fixed error introduced in 30918 for Toolbar positioning. Added new menu command View|Toolbars as short cut for [[General Options Toolbars]] Dialog.<br />
* For Tank in dynamic mode with [[Tank_-_Dynamic_Mode#Level_Control|Level Control]], implemented new options for specifying flow limits on a volume flow basis.<br />
* Fixed error in calculating combined makeup flows for some arrangements of multiple cascaded [[Makeup Source]]s and [[Makeup Block (MU)|Makeup Blocks]].<br />
* Fix for reporting mass balance error in dynamic after deleting a [[Makeup Block (MU)]].<br />
* Fix display error in [[Graphics]] where drawing was shifted after printing.<br />
<br />
===Build 31157===<br />
:''Released 29 June 2022<br />
* [[Graphics]] improvements:<br />
** IMPORTANT: Fix for error introduced in Build 30874 where saved dxf files progressively grow in size eventually leading to a crash at project load. With fix, the saved dxf file is returned to correct size at next save.<br />
** Fixed error in [[Print#Print_Multiple_PDF|printing]], where all flowsheet pages are now correctly in black & white, in the past some pages "randomly" were in colour.<br />
** Fixed error in graphics symbol preview where some symbols were not shown in preview, these are now correctly displayed for Insert Unit, Change Symbol, etc.<br />
* Implemented new report format for [[Command Scripts]] ReportTags command used for generating csv file reports. The new formats "TagSelectTable" and "TagSelectList" are described in [[Setting and Reporting Tags from text files]]. TagSelectTable is text file equivalent of Excel TagSelect report.<br />
* For single component [[VLE]] species, allow user to set maximum amount of species flashed and the minimum amount retained as liquid. These are set on the [[Plant Model - Species#VLE Liquid Phase Change Limits|Plant Model - Species]] tab page. These limits are applied in VLE in some unit models such as the [[Evaporator]]. When the model is operating at a limit a warning condition is given.<br />
* Fix for [[Conveyor Belt]] outlet massflow error for first time step under certain operating conditions; and fix Preset not emptying conveyor contents for option PresetClear.<br />
* For [[Crusher_2_Model_Theory#Model_Theory_-_Whiten_Crusher_Method|Crusher2 Whiten Method]] implemented some improvements in display of results for clarity.<br />
* For [[Crusher_2_Model_Theory#Model_Theory_-_Test_Data|Crusher2 Test Data Method]] added new option to allow size increase ("agglomeration") as an alternative to the existing size reduction ("breakage") functionality.<br />
* Fix for [[Gibbs FEM]] when using ionic species.<br />
* [[TCE]] Updates:<br />
** Solver efficiency improvement for [[ChemApp Overview|ChemApp]] with use of previous results and when excluding species.<br />
** For aqueous TCE, implemented a new warning at reverse mapping step testing if both aqueous acid species and aqueous base species are present in the SysCAD solution.<br />
** New display of total solids yield, useful for overall display of nett precipitation or dissolution.<br />
** For [[PHREEQC Side Calc Model|TCE Side Calc]] implemented option for user to set frequency of iterations for calculation.<br />
** Clearer reporting, displays and tags for forward and reverse mapping.<br />
** [[PHREEQC Reverse Osmosis Unit|TCE Reverse Osmosis]] Model improvements. New heat balance options. Enhancements may result in slight changes to existing models.<br />
<br />
===Build 30918===<br />
:''Released 18 May 2022<br />
* Fix bug introduced in recent Build 30874 for occasional crash when opening Access window for a model using [[VLE]].<br />
* Improved handling of [[TCE]] error case where after a call to TCE equilibrium solve the reverse mapping of ions to SysCAD species fails.<br />
* Improved energy balance accuracy in [[CCD]] and [[Classifier]] when there is a heat of dilution effect (results in small change in outlet stream temperatures).<br />
* Fix a save and load error for some user parameters for [[Sugar Fugal]].<br />
* Improvements for dynamic [[Controller -- Waveform Controller|Waveform Controller]], including new option for B-Spline interpolation of data points, and descending option for SawTooth signal.<br />
* Implemented functionality in dynamic simulation projects for user selection of time (including date) at project load. New option can be set on [[Solver_Setting_-_Dyn|$Solver Dynamic]] tab page. This can be set to last time in historian (current behaviour) or to time at last project save.<br />
* Extended [[Plant Model - Flowsheets]] to display count of different model groups on each flowsheet. Also displays a count of graphics symbols for the models which can also be useful to show that there are multiple symbols for a model on a page.<br />
* Full install includes new [[Example - 05 PHREEQC Projects#USX Example|Uranium Solvent Extraction demo project]] using [[PHREEQC Add-On]].<br />
<br />
===Build 30874===<br />
:''Released 11 May 2022<br />
* For [[Solvent Extraction Unit]] (Mixer/Settler) the PreMixEntrained option is now used for ''None'' Method as well as ''Isotherm'' Method. Improved display of results with additional tags and clearer Access window text. When using PreMixEntrained and NOT using the Isotherm Method, this will change the result of OARatio reported.<br />
* For dynamic projects, four new WaveformType options for [[Controller -- Waveform Controller|Waveform Controller]] to allow user to specify a sequence of values that are then repeated every time Period. The output value will be calculated from the points (or averages) using a Periodic Spline or Linear interpolation. Ideal to generate smooth data for a repeated period (e.g. annual temperatures). The Averaging Periodic Spline method will conserve "area under the graph" (totaliser of outputs). This model provides a useful alternative to [[Controller -- Profile|Profile Controller]] configured in WrapAround mode.<br />
* Improved display results for Multi-component [[VLE]] to include BubblePt and DewPt. For Multi-component VLE option "Multi/Ideal K's" exclude components that don't have a VapourP equation defined.<br />
* For [[VLE]] added a display for status of any Inerts (Non Condensables and/or NonVolatiles) that are present for VLE calculation.<br />
* For [[TCE]] added new display of Reverse Mapping Summary on the TCEResults tab page. Useful to compare the reported TCE stream Enthalpy against the SysCAD Stream Enthalpy immediately after reverse mapping.<br />
* Improved data entry and displays for [[PHREEQC_Feeder_Model|TCE Feeder]] and [[PHREEQC_Direct_Calc_Model|TCE DirectCalc]]. Fix bug with display of SatIndex for PurePhases in [[ChemApp Overview|ChemApp]].<br />
* For [[PHREEQC_Model_Configuration|TCE ModelCfg]] expanded global options for elemental convergence tolerance, and for PHREEQC allow user to set the Tolerance to be used in call to PHREEQC calculations.<br />
* New Graphics [[Symbol Management Commands]] menu command "List And Highlight Tear and DirectLink Symbols" that on a graphics page can be used to show all [[Tear]] and [[DirectLink]] models automatically created.<br />
* Fix for crash in graphics for loading (importing) a dxf drawing or symbol that contains NURB (Non-Uniform Rational B-spline) curve elements in symbols. These are now supported in SysCAD [[Graphics]].<br />
* For PGM [[StrArray Class]] and [[Array Class]] added function AppendItem(Item) which will increase the length of the array by one by adding the supplied data.<br />
<br />
===Build 30807===<br />
:''Released 27 April 2022<br />
* Fixed error in implementation of ''SumElemIPhase'' function in Build 139 used in custom "User Property Calculations" or "Species Calculations" in [[Calculation Configuration]]. The implementation of SumElemIPhase caused some local memory corruption causing incorrect results for the function and in same cases a crash in SysCAD.<br />
*:'''IMPORTANT NOTE''': Projects using SumElemIPhase in [[User Property Expressions]] or [[Species Calculation Expressions]] may produce different reported results, and if used as control measurements different results for model solve. <br />
* Fix for [[Precipitation3]] using [[Alumina3_Precip_-_Full_PSD|PSD method]] where outlet stream has PSD Create or Modify action. As this may impact model behaviour, a checkbox [[Precipitator3 Data Sections#PSD Tab|''AcknowledgePSDOutletChange'']] will appear in affected units, and will need to be checked before the model can run. Model results will need to be reviewed and the model may need to be retuned.<br />
* Fix for Precipitation3 new [[Precipitator3 Data Sections#Agglomeration Parameters|Agglom.UseMidSize]] option (introduced in Build 139.30599) where mid size was incorrectly applied in old project upgrade.<br />
* Fix for [[Merge Project]] where in some cases the flowsheet (and trend) document windows were not correctly merged.<br />
* Fix for mass balance error in [[Shell_and_Tube_Heat_Exchanger_2#Method:_Condensing|Condensing Shell & Tube Heat Exchanger]] for the very specific case of stand-alone condensing mode, with vent connected and species in shell feed that are not water/steam. Non H2O species were discarded.<br />
* Added options to show outlet streams for [[Shell and Tube Heat Exchanger 2]], [[Simple Heat Exchanger]], [[Simple Heater]] and [[Steam Turbine]].<br />
* Improved condition warning messages for [[Simple Heater]] when Duty is not met due to Critical temperature for water. Fix for save & recover of all results.<br />
* Implemented results display for Multi-component [[VLE]]. Previously (invalid) results for a single component system were displayed even when multi-component VLE is used.<br />
* Display IdealK value on [[SDB - Vapours]] tab page for vapour phase species with Vapour Pressure equations.<br />
* Some improvements in [[Graphics Symbols]] management:<br />
** Fix for error in buttons/menus shown for Activating or Deactivating graphics pages (from [[Explorer_Window#Graphics|Explorer window]] context menu or [[Plant Model - Flowsheets]]) when there are multiple symbols on the flowsheet for a model.<br />
** New Graphics [[Symbol Management Commands]] menu command "List And Highlight Multiple Symbols" that can be used to show all tags (units/pipes/tears/etc) that have multiple graphics symbols on a graphics page.<br />
** Fix for bug where multiple symbols for tears are created (can eventually lead to a crash). Duplicates are removed from flowsheet at project load.<br />
* [[TCE]] improvements:<br />
** '''New [[PHREEQC_Feeder_Model|TCE Feeder]] unit model'''. Allow data entry of TCE species directly. After TCE equilibrium calculation, reverse mapping is completed to form SysCAD stream which becomes the outlet product stream. Useful new model to specify a feed in terms of TCE composition.<br />
** Added option to [[PHREEQC_Direct_Calc_Model|TCE DirectCalc]] to optionally complete reverse mapping and display the resulting SysCAD stream.<br />
** Significant solve time speedup in [[ChemApp Overview|ChemApp]] projects by eliminating unnecessary extra function calls.<br />
** For data entry of TCE input species composition in [[PHREEQC_Direct_Calc_Model#DInput tab page|TCE DirectCalc]] and [[PHREEQC_Feeder_Model#DInput tab page|TCE Feeder]] added functionality to report charge balance (and give condition warning when not balanced). Added option for user to optionally specify balance TCE species which adjusted to try maintain neutral mixture.<br />
** Improved display of Feed and Product massflow summaries in [[PHREEQC_Reactor#PHREEQCResults_tab_page|TCE Results]] tab page.<br />
** Added display comments for unmapped species when entering data for [[PHREEQC_Reactor#Bypass_tab_page|TCE Bypass]] and [[PHREEQC_Feeder_Model|TCE Feeder]].<br />
** Rework and expansion of displayed statistics for TCE Interface Engines, as shown on [[PHREEQC_Model_Configuration#Engines_tab_page|TCE Engines]] tab page for TCE ModelCfg.<br />
** Improved save and recover of some TCE block energy balance tag values.<br />
* [[PGM]] improvements:<br />
** New [[Mathematical Functions]] RoundTo(Value, Decimals) and Cbrt(Value).<br />
** New [[Predefined Constants and Variables|Predefined Constants]] MinLong and MaxLong.<br />
** New [[StrArray Class]] functions: Copy(StrArray), Append(StrArray), Reverse(), Sort(CaseSensative).<br />
** New [[Array Class]] functions: Append(Array), Reverse(), Norm().<br />
** For [[StrArray Class]] and [[Array Class]] implemented SetSize(len) as alternate to SetLen(len) and Size() as alternate to GetLen().<br />
** New [[Matrix Class]] functions: Norm(), SwopRows(row1, row2), SwopCols(col1, col2), SortByRefRow(row, increasing), SortByRefCol(col, increasing).<br />
** For [[Matrix Class]] implemented Rows() as alternate to GetRowCount() and Cols() as alternate to GetColCount().<br />
** New [[Matrix Class]] row functions (Array functions on a row): RowSum(row), RowAvg(row), RowMin(row), RowMax(row), RowMinIndex(row), RowMaxIndex(row), RowNorm(row), RowReverse(row), RowSetAll(row, Value), RowScale(row, Value), RowOffset(row, Value), RowSort(row, Ascending), RowIsSorted(row, Ascending)<br />
** New [[Matrix Class]] column functions: ColSetAll(col, Value), ColScale(col, Value)<br />
<br />
===Build 30670===<br />
:''Released 5 April 2022<br />
* For [[Makeup Source]] added new option '''Link to MakeupSrc''' in list for '''[[Makeup_Source#MakeupSource_Operation_Selection|Operation]]''' to connect with a Direct Link to another Makeup Source. This is particularly useful for cascaded Makeup Sources. For example defining a single water source in a MakeupSrc, then each area has a local MakeupSrc linked back to the single MakeupSrc. The area Makeup Sources provide reporting for area water use and single MakeupSrc provides overall water use.<br />
* For [[TCE]] product stream, display actual and effective saturation index for solids (actual = Q/K; effective = Q/(K*factor)).<br />
* Fix for [[Access Window]] not always displaying the correct context menu for right mouse click on a tag.<br />
<br />
===Build 30613===<br />
:''Released 23 March 2022<br />
* Implemented new [[Alumina3 Precip - Full PSD]] agglomeration method [[Alumina3_Precip_-_Full_PSD#David-Rijkeboer_Kernel|David-Rijkeboer Kernel]].<br />
* For [[TCE]] ModelCfg added a button to add any missing ions (required for mapping) to [[Ion Definitions|ionlist.txt (Ion Definitions)]].<br />
<br />
===Build 30599===<br />
:''Released 21 March 2022<br />
* For [[TCE]] projects, implemented stricter checking for inclusion of ions in [[Ion Definitions|ionlist.txt (Ion Definitions)]] to ensure more robust and correct forward and reverse mapping. Solver will not start if any ions are not mapped. For existing AQSol and PHREEQC projects it may be necessary to edit the ionlist.txt file and add the missing ions.<br />
* Improvements in [[TCE]] SideCalc, including new option to select species for adjustment for charge Balance.<br />
* Implemented new dynamic mode [[PHREEQC Pond Model]], currently in Beta.<br />
* For user defined PGM [[Class]] implemented functions '''ClassName'''() that returns class name ("type") as a string; and '''ClassTag'''() that returns the class instance variable name (tag) as a string. The ClassTag function is particularity useful when class instance name matches model tag in flowsheet, so that an Init function or similar can use this instead of having to enter this separately.<br />
* Implemented new PGM [[Mathematical Functions]] '''Floor''' and '''Ceil''' for use alongside Trunc and Round.<br />
* Implemented new functions for PGM [[Array Class]] '''CircConv'''(Array) and '''CopyCircConv'''(Array) for Circular (Cyclic) Convolution function.<br />
* New [[Precipitator3 Data Sections#Agglomeration Parameters|Agglom.UseMidSize]] option to choose between PSD interval mid size or top size for agglomeration kernel calculations.<br />
* Improved [[TagList Window]] context menu options for inserting rows at end. Improved error reporting of unknown tags.<br />
* [[Access Window]] improvements: <br />
** LHS Margin is narrower and does not change with More/Less button. <br />
** Display help descriptions in flyby tooltips when mouse is over [[Access_Window#Selection_Buttons|Selection Buttons]] at top of page.<br />
** Fix issues with selected fields when changing tabs or using resize button.<br />
<br />
===Build 30498===<br />
:''Released 4 March 2022<br />
* Implemented new WashCalc calculation option in [[Filter Press]] to calculate wash water feed required to meet a selected target wash ratio. With this new feature controllers for wash water addition can be removed or simplified. Wash Water feed can optionally be connected to General Demand to automatically control the wash addition.<br />
* New option for user to select rule for positioning of dialog (or floating window) on Displays when the dialog box or window is opened. This is especially useful when working with multiple Displays (screens). For example user can select to keep the Explorer window on the same display as the SysCAD application, or within the SysCAD Application window. The options for this can be set in [[General_Options_General|General Options on the General]] tab page.<br />
* Fixed error when inserting a new pipe and setting for "Simplify" was inconsistently (randomly) selected. Error was introduced in Build 30270.<br />
* Fix error in Tie/Tank using [[Split Flows (Split)]] for specific case of selecting (a) Operation as [[SplitFlow - General Operation|"General"]], and for an outlet pipe (b) QmMode as "VolumeFlow" and (c) MkMode as "Composition". The calculated output flow is now calculated correctly for the targeted composition.<br />
* Allow PGM [[Class#ForEachClass_Function|ForEachClass]] to be used within functions/sub (but not functions/sub within a class definition).<br />
<br />
===Build 30448===<br />
:''Released 25 February 2022<br />
* Fix for crash and error in handling a [[ChemApp Overview|ChemApp]] cst file containing CFE species.<br />
* New [[Access_Window#Selection_Buttons|Access Window Selection Button]] alongside "Adjust Access Window Height" button to position Access.1 window to RHS of graphics so that their is no overlap with graphics windows. In some cases this may move graphics windows to the left. This is a useful windows layout feature for navigating flowsheets and viewing model values in Access window displayed alongside the graphics.<br />
* Fix for reported values in [[Discard Sink]] under "Results: Total Flow Conditions" on Total tab page, it was showing values for the first discard link only.<br />
* Fix for crash in [[TagList Window]] when right clicking on tag to bring up context menu and the tag is referenced by controllers.<br />
<br />
===Build 30427===<br />
:''Released 22 February 2022<br />
* IMPORTANT fix for Build 30316 and 30376: Fix for tears not being listed in count of convergence criteria shown in [[Solver Setting - Convergence|Solver Convergence]]. This may on occasion prevent the solver from stopping (iterations continue after convergence). <br />
* New option for managing graphics display for Tears. The graphics symbol for the [[Tear]] can be incorrectly located based on previous actions in redrawing and moving links. New graphics [[Display_Graphics_Commands#Display|Display]] menu option "Graphic|Display|Update Tear Graphics" will recreate all Tear graphics on a flowsheet. This is also available under the Display button in a [[Group Operations]] dialog to apply to multiple flowsheets.<br />
* Correctly use the "Link Text Size" defined in [[General Options Drawing]] when creating Makeup or Discard link graphics.<br />
<br />
===Build 30376===<br />
:''Released 15 February 2022<br />
* Updated new Volume based Wash Efficiency options in [[Filter Press]] introduced in Build 30316.<br />
* For [[TCE]] Reactors added FeedT OpMode to perform calculations at SysCAD feed stream temperature.<br />
* Fix failure when editing cfg file for [[TCE Configuration Options]].<br />
* Further reductions in memory use for SysCAD projects.<br />
* Fix error in [[Feeder]] with Mode set to NVolumeFlow with a Fetch. The targeted NQv was not achieved, or only achieved in subsequent iterations.<br />
* Allow [[Precipitation3]] to be a network isolator in Dynamic models.<br />
<br />
===Build 30316===<br />
:''Released 4 February 2022<br />
* Implemented additional Wash Efficiency (WashEffMethod) options in [[Filter Press]] for Volume based calculations. Expand results display to include additional volume based efficiency results.<br />
* Fix for crash in [[Precipitator3 Dynamic Mode]] edge case where no solids.<br />
* Reduced memory use for SysCAD projects.<br />
<br />
===Build 30270===<br />
:''Released 1 February 2022<br />
* Reduced memory use for SysCAD projects (especially for Steady State).<br />
* For [[Plant_Model_-_Environment|PlantModel Environment]] improved '''DryAir''' functionality to include option to always use composition based on CIPM-2007 Standard Air definition.<br />
* For all [[Thermodynamic Calculation Engines]] (TCE) the ModelCfg includes a new section listing all Unit models using this TCE ModelCfg. Ideal to follow usage of the Chemistry Model Configuration in the project flowsheets.<br />
* For all [[Thermodynamic Calculation Engines]] (TCE) improved functionality for the selection in TCE unit models (ChemModel.UnitTag) of Model Configuration used to allow a blank selection. Provides significantly easier management of changing Chemistry Model databases for use in different unit models.<br />
* For [[ChemApp Overview|ChemApp]] TCE, improved upgrading of Build 138 projects for ModelCfg cst databases used. Fixed issues for use of CFE token species in CST files.<br />
* For [[AQSol Overview|AQSol]] TCE, allow entry of larger SaturationIndex values to block formation of selected solids. Improved Cfg editor to automatically mark Demo version when selecting AQSol001.<br />
* For [[Plant_Model_-_Species#SpUse_(Species_Use)|Species Use]] (SpUse section) on Species tab page of PlantModel, added a button to report list of all species referenced in all reaction (RCT) files. List is built at project load.<br />
* Miscellaneous [[Explorer Window]] improvements.<br />
* For [[Tear]] added Tear.ConvergeType tag and improved links to related tags. For [[Solver Setting - Tears]] fixed links to Tear tags.<br />
<br />
===Build 30140===<br />
:''Released 12 January 2022<br />
* SysCAD [[AQSol Add-On]] now included as part of standard installation. Existing users of AQSol in SysCAD no longer need to download and unzip this add-on separately.<br />
* Full install includes 3 new [[Example - 08 AQSol Projects|AQSol example projects]].<br />
* New [[Reaction Editor]] (Version 1.4), with new options and improvements for balancing reactions.<br />
* [[Makeup Source]] has new option '''Operation''' similar to the [[Feeder-Cross_Page_Connector#Feeder_Operation_Selection|Feeder Operation]] option. This significantly improves flexibility of how the MakeupSource composition, T & P can be defined.<br />
* Improvements in [[Find_Units_using_Query|Find Results]] dialog - Sort by column now works correctly, value in first row uses correct conversion units.<br />
* In [[Reactor (Gibbs FEM)]] add displays of individual Heats Of Reactions (HoR), as well as overall change in Hf@0 (which is equal to overall HOR when no EHX or temperature override).<br />
* Additional displays on [[SDB - Elements]] tab page for list of elements used, and on [[SDB - Components]] additional displays when multiple components with the same elemental definition.<br />
* For PGM [[Species Database Class]] added functions for accessing Elements used in the project: FindElem(Str ElemName), ElemCount(), ElemName(long ElemIndex), ElemAW(long ElemIndex). In addition added function [[Predefined_Functions#Species_Functions|ElemI("ElementName")]].<br />
* For PGM implemented new function [[Class#ForEachClass_Function|ForEachClass]] to efficiently loop through all instances of a class type calling a specified Subroutine.<br />
* For [[Precipitation3]] implemented new "EnthalpyCalcs" option that gives finer control for energy balance calculations for Heats of Reaction for the different precipitation reactions. Functionality is dependent on data entry of H25 and Cp equations for participating species.<br />
* Implemented some improvements in [[Importing_Species_into_User_Species_Database#Importing_Species_from_HSC_Database|importing species from HSC]] for illegal characters in species names.<br />
* For [[Plant_Model_-_Environment|PlantModel Environment]] added option to define DryAir composition in addition to Air. DryAir can be specified on mass or mole fraction basis and will always have zero for H2O(g).<br />
* Added new [[Feeder-Cross_Page_Connector#Feeder_Operation_Selection|Feeder Operation]] option "PlantModel DryAir" that uses global DryAir composition specified in [[Plant Model - Environment]].<br />
* Fix for bug when using [[Reaction_Block_-_Extents#Reaction_Extent_:_Calculations_and_Properties|RB Extent]] method "Final SpModel Property : Standard.BPE".<br />
* Improved logic for [[Heat_Exchanger_(HX)|Tank HX]] Mode "Simple" selections. Improved error reporting and edge case tests. When water is present, limit maximum outlet temperature to H2O critical temperature. When used with "Other.CalcFlow" the general demand logic has been improved to demand zero flow when inoperative. <br />
* Numerous [[Thermodynamic Calculation Engines]] (TCE) improvements. Includes: improved routine for loading data; improved handling & reporting of edge cases; reworked TCE mixing (calculating total feed enthalpy); other miscellaneous improvements & fixes.<br />
<br />
===Build 29945===<br />
:''Released 29 November 2021<br />
* Fix for crashes using [[AQSol Add-On]] demonstration version.<br />
* Fix for [[Access Window]] "go to previous" button.<br />
<br />
===Build 29907===<br />
:''Released 23 November 2021<br />
* Improve calculation for pass through [[Demand]] through a Tie/Tank/Pipe/etc. that includes [[Discard Block (DB)]].<br />
* Updated editing of [[TCE Configuration Options]]. Settings for AQSol have changed. Existing AQSol projects will require review of TCE settings in cfg.<br />
* Fix in dynamic mode Feeder where [[Feeder-Cross_Page_Connector#Batch_Feed|Batch]] tags were hidden.<br />
* For graphics [[Insert_Graphics_Commands#Insert_Symbol|Insert Symbol]] and [[Insert_Graphics_Commands#Insert_Unit|Insert Unit]] a new Search box has been added to help find the desired graphics symbol. This is particularly useful with Group set to *All*.<br />
* Improved options for Arrow Style and Scaling when editing graphics using [[Edit_Graphics_Commands#Reroute_Link|Reroute Link]], [[Edit_Graphics_Commands#Redraw_Link|Redraw Link]], etc.<br />
* Display the correct status colour in graphics for [[Feeder]] configured with Operation "Link to MakeupSrc".<br />
* Fix for project close crash if project contained a reaction rct file that failed to load. Improved warning condition message for [[Reaction Block (RB)]] rct file load errors.<br />
* Fix for crash in [[Excel Reports]], reporting some tags that are dropdown lists.<br />
* Fix for crash running SysCAD [[Command Scripts]] that start with the command WaitTillStop.<br />
* Miscellaneous improvements in computational efficiency and memory use in stream mixing and property calculations.<br />
<br />
===Build 29722===<br />
:''Released 27 October 2021<br />
* Fix for error introduced in Build 29706 for for [[Tank_-_Dynamic_Mode|Dynamic Tank]] with Vent connection that produced a mass balance error for vent outlet.<br />
* Improved implementation of Entropy function for [[Plant_Model_-_Species#Water_properties_below_0C|water below 0°C]].<br />
<br />
===Build 29706===<br />
:''Released 22 October 2021<br />
* Allow tighter tolerances in [[RB]] Extent and Convergence calculations. Default tolerances are tighter (for existing projects you will need to edit each RB to change existing values). Using tighter tolerances allows Concentration reaction extents to achieve results closer to the target by a few more significant figures by solving a few extra iterations to meet the tighter tolerance.<br />
* Improved calculations for [[Reaction_Block_-_Individual_Reactions#Display_Additional_Reaction_Information|RB ShowSpRequirements]] option implemented. In some cases, the displayed amounts of species flow required to exactly meet the reaction extent were incorrect (and are fixed in this update). This improves robustness in use of feed forward controllers using these tags to adjusting reagent additions.<br />
* Improved checking and error reporting for selection of water species in [[Reactor (Gibbs FEM)|Gibbs FEM]] when any aqueous species are selected.<br />
* [[Thermodynamic Calculation Engines]] (TCE) improvements - SideCalc pressure selection; Copy&Paste in Direct Calc; TCE Databases used now included in project file list and backup zip files; miscellaneous improvements in Access window result displays.<br />
* Updated cfg editor for [[TCE_Configuration_Options|Thermodynamic Calculation Engines Configuration]] settings. Can now browse for the folder where the TCE databases are located and select the databases you want to make available in the project. No longer need to edit these in the cfg file manually. Database list is auto-upgraded, but in some cases you may need to edit the cfg file and check the selections on the TCEs tab page.<br />
* Implemented new "Isentropic Full" constant Entropy method for [[Compressor]].<br />
* For large projects: (1) fix save error for large number of graphics pages; and (2) fix error for selecting cross page connection "ConnectTo" for a large number of sinks.<br />
* Fix error for reported enthalpy values for species using [[Species_Table_-_Specific_Heat_(Cp)#Shomate_Equation|Shomate_Cp]].<br />
* Implemented new PGM function [[Conditional_Functions#IIfStr|IIfStr]] for returning String data type, similar to inline function [[Conditional_Functions#IIf|IIf]] returning a numerical result.<br />
* Fix error on first solve when converting SteadyState ProBal projects to Dynamic.<br />
* Dynamic mode [[Tank_-_Dynamic_Mode|Tank]] using [[Tank_-_Dynamic_Mode#Layered_Flow|Layered]] Mixing.Model now supports multiple inlets at multiple heights adding material to the layer located at the inlet stream connection height.<br />
===Build 29552===<br />
:''Released 22 September 2021<br />
* Improved user experience when working with multiple projects and cfg files. When editing or selecting a project [[Project_Configuration_(cfg_File)|Configuration (cfg) file]] there is a new "Last Accessed" column showing when a cfg file was last used (i.e. used by a project load, or cfg file edited). Select any column header to sort by the column.<br />
* Improve project load and save to support a large number of [[RB]] reactions (and associated reaction species).<br />
* Significantly improve implementation (speed) of setting bulk tags using [[COM Automation]] API function TagValues.SetValues(...).<br />
* Fix for [[Save_Project#Save_Version|Project Save-As / Save-Version]] where selected unused (un-referenced) files were not copied across to the new project folder.<br />
<br />
===Build 29506===<br />
:''Released 14 September 2021<br />
* All [[Historian]] files are now all located in a sub-folder of the project. On first project save in this Build, the existing historian files are moved to the new "Historian" folder resulting in a more organised project folder.<br />
* [[Reactor (Gibbs FEM)|Gibbs FEM]] "Assign Phases" action button updated to apply to all species rather than selected species only.<br />
* Improvements for '''condensing''' mode '''with non-condensables''' for [[Shell and Tube Heat Exchanger 2]]. For two of the [[Shell_and_Tube_Heat_Exchanger_2#Method:_Condensing|CondensingMethod]] options ("Demand (UA)" and "Demand (UA & TubeT)") when non-condensables are present in Shell feed, the model was evaluated at total pressure (SatT@P) instead of at partial pressure (SatT@PP). This causes a difference (proportional to non-condensables fraction) in shell operating temperature and heat transfer. For backward compatibility an option "IgnoreNoncondensables" is provided. A warning message is given when non-condensables are present and the old method (using total P) is used to alert the user to this condition. In these cases the recommended fix is to switch off "IgnoreNoncondensables" and resolve/retune the model.<br />
* Fix for [[TagSelect]] reports not reporting correct [[DirectLink]] tags in results.<br />
* Improvements in PHREEQC: output calculated gas fugacity, improvements in managing gas pure phase solubility calculations. Note that SysCAD-PHREEQC interface only supports pure phase gas solubility at this time. Thus, for any gas solubility to be calculated correctly, it must be the only gas present in the vapour phase. For insoluble gases, such as N2, the error is small if it is in a vapour mixture. However, the error is large for reactive and/or soluble gases, such as O2 and NH3, when in a vapour mixture.<br />
<br />
===Build 29465===<br />
:''Released 6 September 2021<br />
* For graphics [[Edit_Graphics_Commands#Redraw_Link|Redraw Link]] and [[Edit_Graphics_Commands#Reroute_Link|Reroute Link]] improved logic and user interface when selecting a "non standard" (i.e. "constructed") pipe graphics.<br />
* New option in pipes to block [[Pipe#General_Demand|demand transfer]] when the required demand flow (Qm_Demand.Dst) is small (less than PlantModel.DemandThresholdQm).<br />
<br />
===Build 29437===<br />
:''Released 1 September 2021<br />
* Implemented new user option to zip a project. This is available in main Project menu - [[Zip Project]] or from 'Zip Project' button in [[Project_Window#Files_List|project window]] (on Files tab page).<br />
* For [[Models#Mass_Separation_Models|Separation Models]] (Thickeners, Filters, SolidsRecovery, etc), added optional outlet stream displays for QOF, QUF, QCake, QTailings, etc.<br />
* If underlying data type of a [[Access_Window#Drop_List|drop list]] is a string (e.g. XPG_001.ConnectTo P_001.EHX.Model), then do not show RHS integer values in displayed dropdown list. The purpose is to make it clearer that tag can't be set by integer value from PGM, Excel, etc. In addition, the tooltip window shown when mouse hovers over the drop list field includes 'Underlying tag is a String type' in description.<br />
* In Access window, when using [[Access_Window#Right_click_on_Access_Window_variables|context menu]] option "[[Copy_and_Paste#Copy_Tag_For_PGM|Copy Tag for PGM]]" for any string tag (including dropdown list with underlying string) the clipboard value is now [Str "fulltag"].<br />
<br />
===Build 29390===<br />
:''Released 27 August 2021<br />
* Implemented locks to prevent multiple users (or SysCAD instances) of the ''same'' project (i.e. same local or network folder location) being saved simultaneously and corrupting the project data. Also delay (or prevent) project load if another user is busy saving.<br />
* For [[Models#Thermodynamic Calculation Engines|Thermodynamic Calculation Engine (TCE) Models]], added new options for selecting actions to be followed when encountering unmapped species for forward- and reverse-mapping.<br />
* [[Alumina3_Precip_-_Full_PSD#Agglomeration|Precipitation3 Agglomeration]] - include power term for solids volume fraction in Agglom kernel. Added fine tuning factor.<br />
<br />
===Build 29370===<br />
:''Released 25 August 2021<br />
* '''First full release of Build 139.''' See [[Build 139 Release Notes]] for full list of changes and new features<br />
<br />
===Build 29334 (BETA)===<br />
:''Released 19 August 2021<br />
* Improved support and error handling for very long full path and filenames, especially for errors caused by loss of graphics flowsheet pages.<br />
* Improved Alumina [[Precipitation3|Precipitator3]] Agglomeration options including new [[Alumina3_Precip_-_Full_PSD#Kernel_Builder|Kernel Builder]] options.<br />
* Fix for [[Feeder-Cross_Page_Connector#Composition_Fetch|Composition Fetch]] where the entered tag was from a [[Discard Sink]].<br />
* Correctly handle energy balance (exit temperatures) in [[Reverse Osmosis (RO) Unit]] where heat of dilution occurs.<br />
* [[EHX]] methods in pipes in dynamic mode that specify pipe diameter and length, now correctly use these values (they were ignored).<br />
* Some improvements in [[Copy_and_Paste_Graphics_Commands|Copy & Paste]] of flowsheet graphics and data.<br />
* During project load, added an extra user feedback message on Species Database tab of [[Message_Window#Species_Database_Tab|Message Window]] for when user has selected "[[Species_Properties_Configuration#Selecting_Hardwired_or_User_data_for_Properties|Ignore Data]]" for a species property in the cfg file.<br />
* Miscellaneous Beta version bug and feature fixes.<br />
<br />
===Build 29199 (BETA)===<br />
:''Released 28 July 2021<br />
* Bug fix for [[Edit_Graphics_Commands#Change_Unit|Change Unit]].<br />
* New optional Vent outlet connection for [[Reactor (Gibbs FEM)|Gibbs FEM]].<br />
* Improved organisation of Access window tags and options in TCE Models Configuration for species mapping.<br />
* Limit pH output to 7.0 for [[Standard_Species_Model#Acidity_.28pH.29_Calculations|Acidity (pH)]] calculation for very low OH- or H+ concentrations.<br />
<br />
===Build 29102 (BETA)===<br />
:''Released 15 July 2021''<br />
* Log and debug files now go to project subfolder ''\LogOutputs''. If opening multiple copies of same project, additional folders are created to avoid conflicts.<br />
* Improved handling for very large (>300) number of graphics/trend pages.<br />
* Additional [[Reactor (Gibbs FEM) | Gibbs Free Energy Minimisation (FEM)]] warnings when S25 for species is not specified.<br />
* Improved TCE loading, multithreading, Ion Mapping and error handling.<br />
* [[Ion Definitions|IonList.txt]] file used in TCE projects must now be located in the CfgFiles folder. If file is missing, the file located in BaseFiles folder is copied to CfgFiles folder. For TCE projects IonList.txt is now included in backup zip file with project save and displayed in list of files in Project window.<br />
* New option ''BulkSetTagsValidation'' in [[General Controller]] (default ON) which affects how all tags are set in referenced models at the end of PGM execution. If new option is ON then validation of model tags data occurs '''after''' setting '''all''' the values. If this option is OFF (original behaviour) then after each tag value is set, the data is immediately validated. The new option is more efficient and fixes error for setting interdependent tags (e.g. species composition fractions in a feeder).<br />
* For new low temperature (below 0C) Cp and Density implement options on [[Plant_Model_-_Species#Water_properties_below_0C|PlantModel.Species]], implement logic to initialise correctly based on original project temperature range. <br />
* Updates for new [[Material Body]] model.<br />
* Simplified [[Solver_Set_up_for_Dynamic_Projects|Dynamic Solver Setup Dialog]] and related tags in [[Solver_Setting_-_Method|$Solver Method tab page]] simplified options. Removed StepsPerUpdate option. Added user specified min and max dynamic step sizes.<br />
* When using a species model other than Standard in a [[Makeup Source]], then the [[MU|Makeup Block]] now selects Makeup Source SpModel if the feed to the MakeupBlock is using Standard SpModel.<br />
<br />
===Build 28898 (BETA)===<br />
:''Released 10 June 2021''<br />
* See [[Build 139 Release Notes]] for full list of changes and new features<br />
* Please [mailto:info@syscad.net contact us] for BETA access</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:ProductBlog&diff=79048Template:ProductBlog2024-03-19T14:06:31Z<p>Kevin.Heppner: </p>
<hr />
<div>__NOEDITSECTION__<!---<br />
Arguments:<br />
condensed=1 Show only the Recent News section without heading<br />
Icons:<br />
{{Release}} SysCAD New Release<br />
{{MajorUpdate}} Tick Major Updates - Unit, Functionality, Example Project<br />
{{MinorUpdate}} Cog Minor Updates - Bugfixes, Interface Updates<br />
{{Tip}} Lightbulb Tips & Tricks<br />
{{Article}} Document Product Spotlight Articles, Discussion Pages<br />
{{Video}} Videos YouTube Videos<br />
{{Info}} Info i News, General, Wiki Updates<br />
===============WORKING AREA [Clear when Publishing]===============<br />
<br />
=========================END WORKING AREA=========================<br />
--->{{#if: {{{condensed|}}}||== Latest Updates ==}}<br />
;19 Mar 2024<br />
:{{Release}} [[Build_139_Revision_History#Build 35102|Build 139.35102]] update released.<br />
::{{MinorUpdate}} Important fix for droplists not updating in Feeder, Makeup and Discard<br />
::{{MinorUpdate}} Various bug, crash and stability fixes for UI, save/load and TCE<br />
;06 Mar 2024<br />
:{{Release}} [[Build_139_Revision_History#Build 34985|Build 139.34985]] update released.<br />
::{{Info}} WARNING: This build contains a bug with Feeder, Makeup and Discard droplists.<br />
::{{MajorUpdate}} New OLI Solvent Extraction unit model<br />
::{{MinorUpdate}} Improved graphics symbol preview for Insert Unit and Symbol<br />
::{{MinorUpdate}} Fix for tag size/rotation bug<br />
;29 Feb 2024<br />
:{{Tip}} Remember to account for leap years in "per year" calculations, e.g. by using a [[Discussion: Annual Climate Data for Dynamic Modelling, Part III#The Julian Year|Julian Year]] (365.25 days)<br />
;28 Feb 2024<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=_c4v2gtPUFI First Principles Modelling of Mine Wastewater Treatment]<br />
{{#if: {{{condensed|}}}||<br />
== Older Updates ==<br />
;16 Feb 2024<br />
:{{Release}} [[Build_139_Revision_History#Build 34893|Build 139.34893]] update released.<br />
::{{MajorUpdate}} Support for AQSol v3 DLLs with faster solve time<br />
::{{MajorUpdate}} Selection of fonts for Insert/Change Text<br />
::{{MinorUpdate}} Fix for reaction extent using User Calc<br />
::{{MinorUpdate}} Wide variety of unit model, UI, PGM and TCE improvements<br />
;14 Feb 2024<br />
:{{Article}} Discussion Page: [[Discussion: Machine Learning and Neural Networks for Process Simulation|Machine Learning and Neural Networks for Process Simulation]]<br />
;11 Jan 2024<br />
:{{Release}} [[Build_139_Revision_History#Build 34613|Build 139.34613]] update released.<br />
::{{MinorUpdate}} Flash train reporting improvements at max pressure<br />
::{{MinorUpdate}} Fix for startup crash with PGM setting Makeup Block<br />
;08 Jan 2024<br />
:{{Info}} Happy New Year 2024!<br />
:{{Tip}} Follow us on [https://www.linkedin.com/company/syscad LinkedIn] for the latest news and articles.<br />
;22 Dec 2023<br />
:{{Info}} Happy Holidays! Our office is closed 22 Dec - 8 Jan. For any issues please [mailto:support@syscad.net contact support].<br />
;19 Dec 2023<br />
:{{Article}} Spotlight Article: [https://www.syscad.net/seven-golden-rules-of-process-modelling/ Seven Golden Rules of Process Modelling]<br />
;14 Dec 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 34461|Build 139.34461]] update released.<br />
::{{MajorUpdate}} New Raffinate Water Treatment with Adsorption example project<br />
::{{MinorUpdate}} Added display for Normalised Relative Error (CvgError) <br />
::{{MinorUpdate}} Improved Pipe recycle Tears<br />
;15 Nov 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 34246|Build 139.34246]] update released.<br />
::{{MajorUpdate}} New OLI Pond TCE unit model<br />
::{{MinorUpdate}} Various TCE fixes and improvements<br />
::{{MinorUpdate}} Fix for Reaction Block with zero extent<br />
;19 Oct 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 34068|Build 139.34068]] update released.<br />
::{{MajorUpdate}} Updated Reaction Editor - recommend upgrading<br />
::{{MinorUpdate}} Fixes and improvements for various VLE and HX units<br />
::{{MinorUpdate}} SysCAD Data Entry Style for RHS of string fields<br />
::{{MinorUpdate}} TCE SideCalc and Feeder bug fixes<br />
:{{Info}} Conference attendance: We are exhibiting and presenting at [https://www.syscad.net/syscad-at-metplant-2023/ MetPlant 2023]<br />
;03 Oct 2023<br />
:{{Article}} Discussion Page: [[Discussion: Ternary Saturation Diagrams using PHREEQC|Ternary Saturation Diagrams using PHREEQC]]<br />
;28 Sep 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 33873|Build 139.33873]] update released.<br />
::{{MinorUpdate}} Fix for incorrect VLE BPE.Method on insert unit<br />
::{{MinorUpdate}} Fix for User Species Calculations using volume<br />
::{{MinorUpdate}} Wide range of fixes for various other units and models<br />
;22 Sep 2023<br />
:{{Article}} Discussion Page: [[Discussion: K Values in Multicomponent VLE|K Values in Multicomponent VLE]]<br />
;29 Aug 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 33632|Build 139.33632]] update released.<br />
::{{MajorUpdate}} New Green Steelmaking example project<br />
::{{MinorUpdate}} Additional stream property tags<br />
::{{MinorUpdate}} Fixes for various unit models<br />
;28 Aug 2023<br />
:{{Video}} Video: [https://youtu.be/jaGRn5Eu4sg Theoretical and Practical Limitations of Hydrogen Steelmaking – A Process Simulation Perspective]<br />
;08 Aug 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 33513|Build 139.33513]] update released.<br />
::{{MajorUpdate}} New 'Step or Idle' (F10) command in Actions menu<br />
::{{MinorUpdate}} Improved Conversions tab in Project Window<br />
::{{MinorUpdate}} Fix for edge case bug with TCE ion mapping<br />
;07 Aug 2023<br />
:{{Info}} Conference attendance: We presented at the [https://www.syscad.net/syscad-at-the-14th-annual-academic-conference-of-the-nonferrous-metals-society-of-china/ 14th Annual Academic Conference of the Nonferrous Metals Society of China]<br />
;02 Aug 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 33457|Build 139.33457]] update released.<br />
::{{MajorUpdate}} New 'FeedCalc' option for Simple Heater<br />
::{{MajorUpdate}} New keyboard shortcut commands, including 'Copy Displayed'<br />
::{{MinorUpdate}} Updates for various unit models, TCE ion mapping and example projects<br />
::{{MinorUpdate}} Updated Introductory Tutorial and Reaction Editor<br />
;24 Jul 2023<br />
:{{Info}} Conference attendance: We are exhibiting and presenting at [https://www.syscad.net/syscad-at-com-2023/ COM 2023]<br />
;13 Jul 2023<br />
:{{Article}} Discussion Page: [[Discussion: Estimation of Specific Heat for Mineral Species|Estimation of Specific Heat for Mineral Species]]<br />
;05 Jul 2023<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=D_FwFJ-JZzc Use of the THEREDA Database in ChemApp for Potash Process Modelling]<br />
;22 Jun 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 33127|Build 139.33127]] update released.<br />
::{{MajorUpdate}} Upgraded to PHREEQC version 3.7.3-15968.<br />
::{{MinorUpdate}} Trend window x-axis grid improvements.<br />
::{{MinorUpdate}} Flange, Tear, DirectLink and Links Table tidy-ups.<br />
::{{MinorUpdate}} General Controller option to reset values to initial defaults.<br />
;14 Jun 2023<br />
:{{Info}} Conference attendance: We are presenting at the [https://www.syscad.net/syscad-at-25th-gtt-users-meeting-2023/ 25th GTT Users' Meeting 2023]<br />
;18 May 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 33001|Build 139.33001]] update released.<br />
::{{MinorUpdate}} Reaction Block improvements.<br />
::{{MinorUpdate}} Fix for crash with OLI units in Build 139.32925.<br />
;04 May 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 32925|Build 139.32925]] update released.<br />
::{{MajorUpdate}} New VS Code extension for PGM syntax highlighting<br />
::{{MajorUpdate}} Reaction Editor v1.5 and reaction block improvements<br />
::{{MajorUpdate}} New Target Stream split flows method<br />
::{{MinorUpdate}} Various unit model improvements and bug fixes<br />
::{{MinorUpdate}} Options to change graphics and trend line weight<br />
::{{MinorUpdate}} 'Upgrade Compatibility Checks' option to identify old models<br />
:{{Tip}} To access new features, we recommend a full install for Build 139.32925<br />
;21 Apr 2023<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=GTuftUA5iks Modelling Non-Ideal Binary Solutions using SysCAD GFEM and Optimising Solution Parameters]<br />
;29 Mar 2023<br />
:{{Info}} Conference attendance: We are presenting at [https://www.syscad.net/syscad-at-ex-mente-pyro-week-2023/ Ex Mente Pyro Week 2023]<br />
;23 Feb 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 32530|Build 139.32530]] update released.<br />
::{{MajorUpdate}} New PGM syntax, macros, functions, class options<br />
::{{MajorUpdate}} New debug option for General Controller PGM<br />
::{{MinorUpdate}} Heap Leach model and TCE fixes/improvements<br />
::{{MinorUpdate}} Fix for recycle tears without flow<br />
;02 Feb 2023<br />
:{{Article}} Spotlight Article: [https://www.syscad.net/learning-with-syscad/ Learning with SysCAD]<br />
;17 Jan 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 32335|Build 139.32335]] update released.<br />
::{{MajorUpdate}} New functionality for dynamic model spills and vents<br />
::{{MajorUpdate}} New Hybrid GFEM + ChemApp Electric Furnace example project<br />
::{{MinorUpdate}} Updated keywords and syntax for PGM<br />
::{{MinorUpdate}} TCE forward mapping summary with results<br />
;09 Jan 2023<br />
:{{Info}} Happy New Year! We look forward to working with you in 2023.<br />
:{{Tip}} Follow us on [https://www.linkedin.com/company/syscad LinkedIn] for the latest news and articles.<br />
;21 Dec 2022<br />
:{{Info}} Happy Holidays! Our office is closed 22 Dec - 3 Jan. For any issues please [mailto:support@syscad.net contact support].<br />
;19 Dec 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 32217|Build 139.32217]] update released.<br />
::{{MajorUpdate}} New PHREEQC Raffinate Water Treatment example project<br />
::{{MajorUpdate}} Range of new PGM functions and keywords<br />
::{{MinorUpdate}} Fixes for demand with offline units or zero flow<br />
::{{MinorUpdate}} Various TCE, UI and unit model improvements <br />
;21 Nov 2022<br />
:{{Article}} Spotlight Article: [https://www.syscad.net/from-digital-prototype-to-digital-twin/ From Digital Prototype to Digital Twin]<br />
;08 Nov 2022<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=QQvJLG7ZSVE Advances in Simulation of Agglomeration in Bayer Precipitation (Part I)]<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=7heIAGTiy-8 Advances in Simulation of Agglomeration in Bayer Precipitation (Part II)]<br />
;26 Oct 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 31866|Build 139.31866]] update released.<br />
::{{MajorUpdate}} OLI officially released as part of TCE add-on<br />
::{{MajorUpdate}} New example project using Python for multivariable optimisation<br />
::{{MinorUpdate}} Reworked steady-state monitor and finder for dynamic solver<br />
::{{MinorUpdate}} Significant list of bug fixes and improvements<br />
:{{Tip}} TCE license options are now combined as a single TCE add-on.<br />
;18 Oct 2022<br />
:{{Info}} Honoured to be awarded [//www.linkedin.com/feed/update/urn:li:activity:6988095699053596672 Best Alumina Paper] at ICSOBA 2022!<br />
;07 Oct 2022<br />
:{{Info}} Conference attendance: We are presenting at [https://www.syscad.net/syscad-at-icsoba-2022/ ICSOBA 2022]<br />
;06 Sep 2022<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=phRdsPywXvE Modelling Dynamic Ion Exchange Uranium Processes]<br />
;27 Aug 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 31623|Build 139.31623]] update released.<br />
::{{MinorUpdate}} Fixes for various crashes in recent updates<br />
;22 Aug 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 31602|Build 139.31602]] update released.<br />
::{{MinorUpdate}} Allow loading TCE demo projects without license add-on<br />
::{{MinorUpdate}} Fix for dynamic control reset of PID and tank level control<br />
::{{MinorUpdate}} Various TCE and PGM improvements<br />
;16 Aug 2022<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=x_khIJOq6-0 Digital Transformation using Simulation in a Project Life Cycle]<br />
;03 Aug 2022<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=aZsECW1WoO8 Dynamic Simulation of Batch Copper Converting with ChemApp]<br />
;02 Aug 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 31388|Build 139.31388]] update released.<br />
::{{MajorUpdate}} New option to prevent solver start in case of missing files<br />
::{{MajorUpdate}} New PGM functionality<br />
::{{MinorUpdate}} Various user interface bug fixes and improvements<br />
;29 Jul 2022<br />
:{{Info}} Conference attendance: We are presenting at [https://www.syscad.net/syscad-at-com-2022/ COM 2022]<br />
;13 Jul 2022<br />
:{{Article}} Spotlight Article: [https://www.syscad.net/thermodynamic-calculation-engines-in-syscad/ Thermodynamic Calculation Engines in SysCAD]<br />
;12 Jul 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 31218|Build 139.31218]] update released.<br />
::{{MajorUpdate}} New PGM PSD class functions<br />
::{{MinorUpdate}} Fix for bugs introduced in 31207<br />
;08 Jul 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 31207|Build 139.31207]] update released.<br />
::{{MinorUpdate}} Explorer window, toolbars and graphics improvements<br />
::{{MinorUpdate}} Fix for Makeup Blocks and Sources<br />
;29 Jun 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 31157|Build 139.31157]] update released.<br />
::{{MajorUpdate}} Implemented TagSelect within Command Script ReportTags<br />
::{{MinorUpdate}} Option to control phase change limits for VLE, plus new warnings <br />
::{{MinorUpdate}} Fix for graphics (.dxf) file size increasing<br />
;27 Jun 2022<br />
:{{Info}} Conference attendance: We are presenting at [https://www.syscad.net/syscad-at-gtt-users-meeting-2022/ GTT Users' Meeting 2022]<br />
;25 May 2022<br />
:{{Article}} Discussion Page: [[Discussion: Annual Climate Data for Dynamic Modelling, Part III|Annual Climate Data for Dynamic Modelling, Part III]]<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=PDLnWF5ntkY Modelling Solvent Extraction of Uranium with Molybdenum Control]<br />
;24 May 2022<br />
:{{Article}} Discussion Page: [[Discussion: Annual Climate Data for Dynamic Modelling, Part II|Annual Climate Data for Dynamic Modelling, Part II]]<br />
;18 May 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30918|Build 139.30918]] update released.<br />
::{{MajorUpdate}} New Uranium Solvent Extraction demo project using PHREEQC<br />
::{{MinorUpdate}} Energy balance correction for CCD and Classifier<br />
::{{MinorUpdate}} Various stability improvements<br />
;11 May 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30874|Build 139.30874]] update released.<br />
::{{MajorUpdate}} New Waveform Controller options<br />
::{{MinorUpdate}} Improved display for multi-component VLE<br />
::{{MinorUpdate}} Various TCE improvements<br />
;03 May 2022<br />
:{{Info}} Conference attendance: We are presenting at [https://www.syscad.net/syscad-at-alta-2022/ ALTA 2022]<br />
;27 Apr 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30807|Build 139.30807]] update released.<br />
::{{MajorUpdate}} Fix for Precip3 PSD method with PSD Create/Modify in Product stream.<br />
::{{MajorUpdate}} TCE improvements including new TCE Feeder unit model.<br />
::{{MinorUpdate}} Various new PGM functions and improvements.<br />
;13 Apr 2022<br />
:{{Article}} Discussion Page: [[Discussion: Annual Climate Data for Dynamic Modelling|Annual Climate Data for Dynamic Modelling]]<br />
;05 Apr 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30670|Build 139.30670]] update released.<br />
::{{MajorUpdate}} New Link to Makeup Source option.<br />
::{{MinorUpdate}} Access window and TCE fixes.<br />
;23 Mar 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30613|Build 139.30613]] update released.<br />
::{{MajorUpdate}} New Alumina Precip3 agglomeration kernel David-Rijkeboer.<br />
;21 Mar 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30599|Build 139.30599]] update released.<br />
::{{MajorUpdate}} New PGM functions for Classes and Arrays.<br />
::{{MinorUpdate}} Stricter checking of TCE ion definitions (ionlist.txt).<br />
::{{MinorUpdate}} Various Access Window display improvements.<br />
;04 Mar 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30498|Build 139.30498]] update released.<br />
::{{MajorUpdate}} New Filter Press WashCalc option.<br />
;25 Feb 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30448|Build 139.30448]] update released.<br />
::{{MajorUpdate}} New access window auto-layout option.<br />
::{{MinorUpdate}} Crash fixes for ChemApp and TagList.<br />
;22 Feb 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30427|Build 139.30427]] update released.<br />
::{{MinorUpdate}} Fixed critical solver convergence error in Builds 30316 and 30376.<br />
;15 Feb 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30376|Build 139.30376]] update released.<br />
::{{MinorUpdate}} Further reduced memory usage, various bug fixes and improvements.<br />
:{{Article}} Discussion Page: [[Discussion: Transfer Push and Pull for Batch Processes|Transfer Push and Pull for Batch Processes]]<br />
;04 Feb 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30316|Build 139.30316]] update released.<br />
;02 Feb 2022<br />
:{{Article}} Discussion Page: [[Discussion: Air in Modelling|Air in Modelling]]<br />
;01 Feb 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30270|Build 139.30270]] update released.<br />
::{{MinorUpdate}} Reduced memory usage.<br />
::{{MinorUpdate}} Various TCE model improvements.<br />
;31 Jan 2022<br />
:{{Article}} Discussion Page: [[Discussion: New Reaction Heat Features in Alumina Precipitation Models|New Reaction Heat Features in Alumina Precipitation Models]]<br />
;12 Jan 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30140|Build 139.30140]] update released.<br />
::{{MajorUpdate}} Official release of [[AQSol Add-On]], plus new [[Example - 08 AQSol Projects|AQSol example projects]].<br />
::{{MajorUpdate}} Reaction Editor 1.4 including improved reaction balancing.<br />
::{{MinorUpdate}} Various species database, energy balance, PGM, feeder and makeup improvements.<br />
;21 Dec 2021<br />
:{{Info}} Happy Holidays! Our office is closed 22 Dec - 5 Jan. For any issues please [mailto:support@syscad.net contact support].<br />
;15 Dec 2021<br />
:{{Article}} Spotlight Article: [https://www.syscad.net/potash-process-modelling-for-a-growing-industry/ Potash - Process Modelling for a Growing Industry]<br />
;29 Nov 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29945|Build 139.29945]] update released.<br />
;23 Nov 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29907|Build 139.29907]] update released.<br />
::{{MajorUpdate}} New search function for Insert Symbol/Unit graphics.<br />
::{{MinorUpdate}} Improved TCE Configuration for AQSol.<br />
::{{MinorUpdate}} Various visual, project crash and bug fixes.<br />
;03 Nov 2021<br />
:{{Article}} Discussion Page: [[Discussion: Rare Earths Example Project|Rare Earths Example Project]]<br />
;27 Oct 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29722|Build 139.29722]] update released.<br />
::{{MinorUpdate}} Improved entropy calculation for water below 0°C.<br />
;26 Oct 2021<br />
:{{Article}} Discussion Page: [[Discussion: Alumina Precipitation and Classification with PSD|Alumina Precipitation and Classification with PSD]]<br />
;22 Oct 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29706|Build 139.29706]] update released.<br />
::{{MajorUpdate}} New configuration editor for Thermodynamic Calculation Engine (TCE) databases.<br />
::{{MinorUpdate}} Reaction Block (RB), TCE and FEM improvements.<br />
;22 Sep 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29552|Build 139.29552]] update released.<br />
::{{MajorUpdate}} New example project - [[Precipitation Projects#Example 5: Precipitation and Classification Example Project using Full Particle Size Data (PSD)|Alumina Precipitation and Classification with PSD]]<br />
::{{MajorUpdate}} Added column to sort configuration (cfg) files by access date.<br />
::{{MinorUpdate}} Improved project save/load.<br />
;14 Sep 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29506|Build 139.29506]] update released.<br />
::{{MinorUpdate}} Improvements for Shell and Tube Heat Exchanger 2 condensing mode.<br />
:{{Article}} Spotlight Article: [https://www.syscad.net/bayer-process-modelling-for-the-alumina-industry/ Bayer Process Modelling for the Alumina Industry]<br />
;06 Sep 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29465|Build 139.29465]] update released.<br />
;01 Sep 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29437|Build 139.29437]] update released.<br />
::{{MajorUpdate}} New option to zip project files (Project > Zip Project).<br />
;27 Aug 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29390|Build 139.29390]] update released.<br />
::{{MinorUpdate}} Improved handling for multiple users on same project file.<br />
;26 Aug 2021<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=kxLHuw3P91s Modelling Solvent Extraction Separation of Neodymium from Praseodymium]<br />
;25 Aug 2021<br />
:{{Release}} '''Build 139 official release''' - [[Build_139_Revision_History#Build 29370|Build 139.29370]]<br />
::{{MajorUpdate}} See [[Build 139 Release Notes]] for full list of changes and new features.<br />
::{{Tip}} Now available on the [https://www.syscad.net/login/ Downloads page] for users with active Upgrade & Support.<br />
::{{Info}} If required, please [mailto:support@syscad.net contact us] for upgrade support.<br />
;19 Aug 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29334 (BETA)|Build 139.29334 BETA]] update released.<br />
::{{MajorUpdate}} New [[Alumina3 Precip - Full PSD#Kernel Builder|Agglomeration Kernel Builder]] added to Alumina [[Precipitation3]].<br />
;12 Aug 2021<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=0zde5f7-NeA Particle Size Distribution Visualisation]<br />
;06 Aug 2021<br />
:{{Info}} Conference attendance: We are presenting at [https://www.syscad.net/syscad-at-com-2021/ COM 2021]<br />
;28 Jul 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29199 (BETA)|Build 139.29199 BETA]] update released.<br />
;15 Jul 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29102 (BETA)|Build 139.29102 BETA]] update released.<br />
;23 Jun 2021<br />
:{{Article}} Spotlight Article: [https://www.syscad.net/syscad-in-the-life-cycle-of-plant-development/ SysCAD in the Life Cycle of Plant Development]<br />
;18 Jun 2021<br />
:{{Info}} Follow us on [https://www.linkedin.com/company/syscad LinkedIn] for company news and process modelling highlights.<br />
;17 Jun 2021<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=SA3nlthmg-c SysCAD Reporting Tools]<br />
;10 Jun 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 28898 (BETA)|Build 139.28898 BETA]] released.<br />
::{{MajorUpdate}} See [[Build 139 Release Notes]] for full list of changes and new features.<br />
::{{Info}} Please [mailto:info@syscad.net contact us] for BETA access.<br />
;09 Jun 2021<br />
:{{Info}} Welcome to the '''Product Blog'''! Check back here for the latest SysCAD news and updates.<br />
== Icon Legend ==<br />
:{{Release}} Build Release<br />
::{{MajorUpdate}} Major Update<br />
::{{MinorUpdate}} Minor Update<br />
:{{Tip}} [[Tips and Tricks|Tips & Tricks]]<br />
:{{Article}} [https://www.syscad.net/category/articles/ Spotlight Articles] and [[Discussion Pages]]<br />
:{{Video}} [https://www.youtube.com/SysCADVideos Videos]<br />
:{{Info}} [https://www.syscad.net/category/news/ News] and General Information<br />
}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:ProductBlog&diff=79047Template:ProductBlog2024-03-19T14:05:45Z<p>Kevin.Heppner: </p>
<hr />
<div>__NOEDITSECTION__<!---<br />
Arguments:<br />
condensed=1 Show only the Recent News section without heading<br />
Icons:<br />
{{Release}} SysCAD New Release<br />
{{MajorUpdate}} Tick Major Updates - Unit, Functionality, Example Project<br />
{{MinorUpdate}} Cog Minor Updates - Bugfixes, Interface Updates<br />
{{Tip}} Lightbulb Tips & Tricks<br />
{{Article}} Document Product Spotlight Articles, Discussion Pages<br />
{{Video}} Videos YouTube Videos<br />
{{Info}} Info i News, General, Wiki Updates<br />
===============WORKING AREA [Clear when Publishing]===============<br />
<br />
=========================END WORKING AREA=========================<br />
--->{{#if: {{{condensed|}}}||== Latest Updates ==}}<br />
;19 Mar 2024<br />
:{{Release}} [[Build_139_Revision_History#Build 35502|Build 139.35502]] update released.<br />
::{{MinorUpdate}} Important fix for droplists not updating in Feeder, Makeup and Discard<br />
::{{MinorUpdate}} Various bug, crash and stability fixes for UI, save/load and TCE<br />
;06 Mar 2024<br />
:{{Release}} [[Build_139_Revision_History#Build 34985|Build 139.34985]] update released.<br />
::{{Info}} WARNING: This build contains a bug with Feeder, Makeup and Discard droplists.<br />
::{{MajorUpdate}} New OLI Solvent Extraction unit model<br />
::{{MinorUpdate}} Improved graphics symbol preview for Insert Unit and Symbol<br />
::{{MinorUpdate}} Fix for tag size/rotation bug<br />
;29 Feb 2024<br />
:{{Tip}} Remember to account for leap years in "per year" calculations, e.g. by using a [[Discussion: Annual Climate Data for Dynamic Modelling, Part III#The Julian Year|Julian Year]] (365.25 days)<br />
;28 Feb 2024<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=_c4v2gtPUFI First Principles Modelling of Mine Wastewater Treatment]<br />
{{#if: {{{condensed|}}}||<br />
== Older Updates ==<br />
;16 Feb 2024<br />
:{{Release}} [[Build_139_Revision_History#Build 34893|Build 139.34893]] update released.<br />
::{{MajorUpdate}} Support for AQSol v3 DLLs with faster solve time<br />
::{{MajorUpdate}} Selection of fonts for Insert/Change Text<br />
::{{MinorUpdate}} Fix for reaction extent using User Calc<br />
::{{MinorUpdate}} Wide variety of unit model, UI, PGM and TCE improvements<br />
;14 Feb 2024<br />
:{{Article}} Discussion Page: [[Discussion: Machine Learning and Neural Networks for Process Simulation|Machine Learning and Neural Networks for Process Simulation]]<br />
;11 Jan 2024<br />
:{{Release}} [[Build_139_Revision_History#Build 34613|Build 139.34613]] update released.<br />
::{{MinorUpdate}} Flash train reporting improvements at max pressure<br />
::{{MinorUpdate}} Fix for startup crash with PGM setting Makeup Block<br />
;08 Jan 2024<br />
:{{Info}} Happy New Year 2024!<br />
:{{Tip}} Follow us on [https://www.linkedin.com/company/syscad LinkedIn] for the latest news and articles.<br />
;22 Dec 2023<br />
:{{Info}} Happy Holidays! Our office is closed 22 Dec - 8 Jan. For any issues please [mailto:support@syscad.net contact support].<br />
;19 Dec 2023<br />
:{{Article}} Spotlight Article: [https://www.syscad.net/seven-golden-rules-of-process-modelling/ Seven Golden Rules of Process Modelling]<br />
;14 Dec 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 34461|Build 139.34461]] update released.<br />
::{{MajorUpdate}} New Raffinate Water Treatment with Adsorption example project<br />
::{{MinorUpdate}} Added display for Normalised Relative Error (CvgError) <br />
::{{MinorUpdate}} Improved Pipe recycle Tears<br />
;15 Nov 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 34246|Build 139.34246]] update released.<br />
::{{MajorUpdate}} New OLI Pond TCE unit model<br />
::{{MinorUpdate}} Various TCE fixes and improvements<br />
::{{MinorUpdate}} Fix for Reaction Block with zero extent<br />
;19 Oct 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 34068|Build 139.34068]] update released.<br />
::{{MajorUpdate}} Updated Reaction Editor - recommend upgrading<br />
::{{MinorUpdate}} Fixes and improvements for various VLE and HX units<br />
::{{MinorUpdate}} SysCAD Data Entry Style for RHS of string fields<br />
::{{MinorUpdate}} TCE SideCalc and Feeder bug fixes<br />
:{{Info}} Conference attendance: We are exhibiting and presenting at [https://www.syscad.net/syscad-at-metplant-2023/ MetPlant 2023]<br />
;03 Oct 2023<br />
:{{Article}} Discussion Page: [[Discussion: Ternary Saturation Diagrams using PHREEQC|Ternary Saturation Diagrams using PHREEQC]]<br />
;28 Sep 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 33873|Build 139.33873]] update released.<br />
::{{MinorUpdate}} Fix for incorrect VLE BPE.Method on insert unit<br />
::{{MinorUpdate}} Fix for User Species Calculations using volume<br />
::{{MinorUpdate}} Wide range of fixes for various other units and models<br />
;22 Sep 2023<br />
:{{Article}} Discussion Page: [[Discussion: K Values in Multicomponent VLE|K Values in Multicomponent VLE]]<br />
;29 Aug 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 33632|Build 139.33632]] update released.<br />
::{{MajorUpdate}} New Green Steelmaking example project<br />
::{{MinorUpdate}} Additional stream property tags<br />
::{{MinorUpdate}} Fixes for various unit models<br />
;28 Aug 2023<br />
:{{Video}} Video: [https://youtu.be/jaGRn5Eu4sg Theoretical and Practical Limitations of Hydrogen Steelmaking – A Process Simulation Perspective]<br />
;08 Aug 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 33513|Build 139.33513]] update released.<br />
::{{MajorUpdate}} New 'Step or Idle' (F10) command in Actions menu<br />
::{{MinorUpdate}} Improved Conversions tab in Project Window<br />
::{{MinorUpdate}} Fix for edge case bug with TCE ion mapping<br />
;07 Aug 2023<br />
:{{Info}} Conference attendance: We presented at the [https://www.syscad.net/syscad-at-the-14th-annual-academic-conference-of-the-nonferrous-metals-society-of-china/ 14th Annual Academic Conference of the Nonferrous Metals Society of China]<br />
;02 Aug 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 33457|Build 139.33457]] update released.<br />
::{{MajorUpdate}} New 'FeedCalc' option for Simple Heater<br />
::{{MajorUpdate}} New keyboard shortcut commands, including 'Copy Displayed'<br />
::{{MinorUpdate}} Updates for various unit models, TCE ion mapping and example projects<br />
::{{MinorUpdate}} Updated Introductory Tutorial and Reaction Editor<br />
;24 Jul 2023<br />
:{{Info}} Conference attendance: We are exhibiting and presenting at [https://www.syscad.net/syscad-at-com-2023/ COM 2023]<br />
;13 Jul 2023<br />
:{{Article}} Discussion Page: [[Discussion: Estimation of Specific Heat for Mineral Species|Estimation of Specific Heat for Mineral Species]]<br />
;05 Jul 2023<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=D_FwFJ-JZzc Use of the THEREDA Database in ChemApp for Potash Process Modelling]<br />
;22 Jun 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 33127|Build 139.33127]] update released.<br />
::{{MajorUpdate}} Upgraded to PHREEQC version 3.7.3-15968.<br />
::{{MinorUpdate}} Trend window x-axis grid improvements.<br />
::{{MinorUpdate}} Flange, Tear, DirectLink and Links Table tidy-ups.<br />
::{{MinorUpdate}} General Controller option to reset values to initial defaults.<br />
;14 Jun 2023<br />
:{{Info}} Conference attendance: We are presenting at the [https://www.syscad.net/syscad-at-25th-gtt-users-meeting-2023/ 25th GTT Users' Meeting 2023]<br />
;18 May 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 33001|Build 139.33001]] update released.<br />
::{{MinorUpdate}} Reaction Block improvements.<br />
::{{MinorUpdate}} Fix for crash with OLI units in Build 139.32925.<br />
;04 May 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 32925|Build 139.32925]] update released.<br />
::{{MajorUpdate}} New VS Code extension for PGM syntax highlighting<br />
::{{MajorUpdate}} Reaction Editor v1.5 and reaction block improvements<br />
::{{MajorUpdate}} New Target Stream split flows method<br />
::{{MinorUpdate}} Various unit model improvements and bug fixes<br />
::{{MinorUpdate}} Options to change graphics and trend line weight<br />
::{{MinorUpdate}} 'Upgrade Compatibility Checks' option to identify old models<br />
:{{Tip}} To access new features, we recommend a full install for Build 139.32925<br />
;21 Apr 2023<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=GTuftUA5iks Modelling Non-Ideal Binary Solutions using SysCAD GFEM and Optimising Solution Parameters]<br />
;29 Mar 2023<br />
:{{Info}} Conference attendance: We are presenting at [https://www.syscad.net/syscad-at-ex-mente-pyro-week-2023/ Ex Mente Pyro Week 2023]<br />
;23 Feb 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 32530|Build 139.32530]] update released.<br />
::{{MajorUpdate}} New PGM syntax, macros, functions, class options<br />
::{{MajorUpdate}} New debug option for General Controller PGM<br />
::{{MinorUpdate}} Heap Leach model and TCE fixes/improvements<br />
::{{MinorUpdate}} Fix for recycle tears without flow<br />
;02 Feb 2023<br />
:{{Article}} Spotlight Article: [https://www.syscad.net/learning-with-syscad/ Learning with SysCAD]<br />
;17 Jan 2023<br />
:{{Release}} [[Build_139_Revision_History#Build 32335|Build 139.32335]] update released.<br />
::{{MajorUpdate}} New functionality for dynamic model spills and vents<br />
::{{MajorUpdate}} New Hybrid GFEM + ChemApp Electric Furnace example project<br />
::{{MinorUpdate}} Updated keywords and syntax for PGM<br />
::{{MinorUpdate}} TCE forward mapping summary with results<br />
;09 Jan 2023<br />
:{{Info}} Happy New Year! We look forward to working with you in 2023.<br />
:{{Tip}} Follow us on [https://www.linkedin.com/company/syscad LinkedIn] for the latest news and articles.<br />
;21 Dec 2022<br />
:{{Info}} Happy Holidays! Our office is closed 22 Dec - 3 Jan. For any issues please [mailto:support@syscad.net contact support].<br />
;19 Dec 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 32217|Build 139.32217]] update released.<br />
::{{MajorUpdate}} New PHREEQC Raffinate Water Treatment example project<br />
::{{MajorUpdate}} Range of new PGM functions and keywords<br />
::{{MinorUpdate}} Fixes for demand with offline units or zero flow<br />
::{{MinorUpdate}} Various TCE, UI and unit model improvements <br />
;21 Nov 2022<br />
:{{Article}} Spotlight Article: [https://www.syscad.net/from-digital-prototype-to-digital-twin/ From Digital Prototype to Digital Twin]<br />
;08 Nov 2022<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=QQvJLG7ZSVE Advances in Simulation of Agglomeration in Bayer Precipitation (Part I)]<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=7heIAGTiy-8 Advances in Simulation of Agglomeration in Bayer Precipitation (Part II)]<br />
;26 Oct 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 31866|Build 139.31866]] update released.<br />
::{{MajorUpdate}} OLI officially released as part of TCE add-on<br />
::{{MajorUpdate}} New example project using Python for multivariable optimisation<br />
::{{MinorUpdate}} Reworked steady-state monitor and finder for dynamic solver<br />
::{{MinorUpdate}} Significant list of bug fixes and improvements<br />
:{{Tip}} TCE license options are now combined as a single TCE add-on.<br />
;18 Oct 2022<br />
:{{Info}} Honoured to be awarded [//www.linkedin.com/feed/update/urn:li:activity:6988095699053596672 Best Alumina Paper] at ICSOBA 2022!<br />
;07 Oct 2022<br />
:{{Info}} Conference attendance: We are presenting at [https://www.syscad.net/syscad-at-icsoba-2022/ ICSOBA 2022]<br />
;06 Sep 2022<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=phRdsPywXvE Modelling Dynamic Ion Exchange Uranium Processes]<br />
;27 Aug 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 31623|Build 139.31623]] update released.<br />
::{{MinorUpdate}} Fixes for various crashes in recent updates<br />
;22 Aug 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 31602|Build 139.31602]] update released.<br />
::{{MinorUpdate}} Allow loading TCE demo projects without license add-on<br />
::{{MinorUpdate}} Fix for dynamic control reset of PID and tank level control<br />
::{{MinorUpdate}} Various TCE and PGM improvements<br />
;16 Aug 2022<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=x_khIJOq6-0 Digital Transformation using Simulation in a Project Life Cycle]<br />
;03 Aug 2022<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=aZsECW1WoO8 Dynamic Simulation of Batch Copper Converting with ChemApp]<br />
;02 Aug 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 31388|Build 139.31388]] update released.<br />
::{{MajorUpdate}} New option to prevent solver start in case of missing files<br />
::{{MajorUpdate}} New PGM functionality<br />
::{{MinorUpdate}} Various user interface bug fixes and improvements<br />
;29 Jul 2022<br />
:{{Info}} Conference attendance: We are presenting at [https://www.syscad.net/syscad-at-com-2022/ COM 2022]<br />
;13 Jul 2022<br />
:{{Article}} Spotlight Article: [https://www.syscad.net/thermodynamic-calculation-engines-in-syscad/ Thermodynamic Calculation Engines in SysCAD]<br />
;12 Jul 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 31218|Build 139.31218]] update released.<br />
::{{MajorUpdate}} New PGM PSD class functions<br />
::{{MinorUpdate}} Fix for bugs introduced in 31207<br />
;08 Jul 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 31207|Build 139.31207]] update released.<br />
::{{MinorUpdate}} Explorer window, toolbars and graphics improvements<br />
::{{MinorUpdate}} Fix for Makeup Blocks and Sources<br />
;29 Jun 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 31157|Build 139.31157]] update released.<br />
::{{MajorUpdate}} Implemented TagSelect within Command Script ReportTags<br />
::{{MinorUpdate}} Option to control phase change limits for VLE, plus new warnings <br />
::{{MinorUpdate}} Fix for graphics (.dxf) file size increasing<br />
;27 Jun 2022<br />
:{{Info}} Conference attendance: We are presenting at [https://www.syscad.net/syscad-at-gtt-users-meeting-2022/ GTT Users' Meeting 2022]<br />
;25 May 2022<br />
:{{Article}} Discussion Page: [[Discussion: Annual Climate Data for Dynamic Modelling, Part III|Annual Climate Data for Dynamic Modelling, Part III]]<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=PDLnWF5ntkY Modelling Solvent Extraction of Uranium with Molybdenum Control]<br />
;24 May 2022<br />
:{{Article}} Discussion Page: [[Discussion: Annual Climate Data for Dynamic Modelling, Part II|Annual Climate Data for Dynamic Modelling, Part II]]<br />
;18 May 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30918|Build 139.30918]] update released.<br />
::{{MajorUpdate}} New Uranium Solvent Extraction demo project using PHREEQC<br />
::{{MinorUpdate}} Energy balance correction for CCD and Classifier<br />
::{{MinorUpdate}} Various stability improvements<br />
;11 May 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30874|Build 139.30874]] update released.<br />
::{{MajorUpdate}} New Waveform Controller options<br />
::{{MinorUpdate}} Improved display for multi-component VLE<br />
::{{MinorUpdate}} Various TCE improvements<br />
;03 May 2022<br />
:{{Info}} Conference attendance: We are presenting at [https://www.syscad.net/syscad-at-alta-2022/ ALTA 2022]<br />
;27 Apr 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30807|Build 139.30807]] update released.<br />
::{{MajorUpdate}} Fix for Precip3 PSD method with PSD Create/Modify in Product stream.<br />
::{{MajorUpdate}} TCE improvements including new TCE Feeder unit model.<br />
::{{MinorUpdate}} Various new PGM functions and improvements.<br />
;13 Apr 2022<br />
:{{Article}} Discussion Page: [[Discussion: Annual Climate Data for Dynamic Modelling|Annual Climate Data for Dynamic Modelling]]<br />
;05 Apr 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30670|Build 139.30670]] update released.<br />
::{{MajorUpdate}} New Link to Makeup Source option.<br />
::{{MinorUpdate}} Access window and TCE fixes.<br />
;23 Mar 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30613|Build 139.30613]] update released.<br />
::{{MajorUpdate}} New Alumina Precip3 agglomeration kernel David-Rijkeboer.<br />
;21 Mar 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30599|Build 139.30599]] update released.<br />
::{{MajorUpdate}} New PGM functions for Classes and Arrays.<br />
::{{MinorUpdate}} Stricter checking of TCE ion definitions (ionlist.txt).<br />
::{{MinorUpdate}} Various Access Window display improvements.<br />
;04 Mar 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30498|Build 139.30498]] update released.<br />
::{{MajorUpdate}} New Filter Press WashCalc option.<br />
;25 Feb 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30448|Build 139.30448]] update released.<br />
::{{MajorUpdate}} New access window auto-layout option.<br />
::{{MinorUpdate}} Crash fixes for ChemApp and TagList.<br />
;22 Feb 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30427|Build 139.30427]] update released.<br />
::{{MinorUpdate}} Fixed critical solver convergence error in Builds 30316 and 30376.<br />
;15 Feb 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30376|Build 139.30376]] update released.<br />
::{{MinorUpdate}} Further reduced memory usage, various bug fixes and improvements.<br />
:{{Article}} Discussion Page: [[Discussion: Transfer Push and Pull for Batch Processes|Transfer Push and Pull for Batch Processes]]<br />
;04 Feb 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30316|Build 139.30316]] update released.<br />
;02 Feb 2022<br />
:{{Article}} Discussion Page: [[Discussion: Air in Modelling|Air in Modelling]]<br />
;01 Feb 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30270|Build 139.30270]] update released.<br />
::{{MinorUpdate}} Reduced memory usage.<br />
::{{MinorUpdate}} Various TCE model improvements.<br />
;31 Jan 2022<br />
:{{Article}} Discussion Page: [[Discussion: New Reaction Heat Features in Alumina Precipitation Models|New Reaction Heat Features in Alumina Precipitation Models]]<br />
;12 Jan 2022<br />
:{{Release}} [[Build_139_Revision_History#Build 30140|Build 139.30140]] update released.<br />
::{{MajorUpdate}} Official release of [[AQSol Add-On]], plus new [[Example - 08 AQSol Projects|AQSol example projects]].<br />
::{{MajorUpdate}} Reaction Editor 1.4 including improved reaction balancing.<br />
::{{MinorUpdate}} Various species database, energy balance, PGM, feeder and makeup improvements.<br />
;21 Dec 2021<br />
:{{Info}} Happy Holidays! Our office is closed 22 Dec - 5 Jan. For any issues please [mailto:support@syscad.net contact support].<br />
;15 Dec 2021<br />
:{{Article}} Spotlight Article: [https://www.syscad.net/potash-process-modelling-for-a-growing-industry/ Potash - Process Modelling for a Growing Industry]<br />
;29 Nov 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29945|Build 139.29945]] update released.<br />
;23 Nov 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29907|Build 139.29907]] update released.<br />
::{{MajorUpdate}} New search function for Insert Symbol/Unit graphics.<br />
::{{MinorUpdate}} Improved TCE Configuration for AQSol.<br />
::{{MinorUpdate}} Various visual, project crash and bug fixes.<br />
;03 Nov 2021<br />
:{{Article}} Discussion Page: [[Discussion: Rare Earths Example Project|Rare Earths Example Project]]<br />
;27 Oct 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29722|Build 139.29722]] update released.<br />
::{{MinorUpdate}} Improved entropy calculation for water below 0°C.<br />
;26 Oct 2021<br />
:{{Article}} Discussion Page: [[Discussion: Alumina Precipitation and Classification with PSD|Alumina Precipitation and Classification with PSD]]<br />
;22 Oct 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29706|Build 139.29706]] update released.<br />
::{{MajorUpdate}} New configuration editor for Thermodynamic Calculation Engine (TCE) databases.<br />
::{{MinorUpdate}} Reaction Block (RB), TCE and FEM improvements.<br />
;22 Sep 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29552|Build 139.29552]] update released.<br />
::{{MajorUpdate}} New example project - [[Precipitation Projects#Example 5: Precipitation and Classification Example Project using Full Particle Size Data (PSD)|Alumina Precipitation and Classification with PSD]]<br />
::{{MajorUpdate}} Added column to sort configuration (cfg) files by access date.<br />
::{{MinorUpdate}} Improved project save/load.<br />
;14 Sep 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29506|Build 139.29506]] update released.<br />
::{{MinorUpdate}} Improvements for Shell and Tube Heat Exchanger 2 condensing mode.<br />
:{{Article}} Spotlight Article: [https://www.syscad.net/bayer-process-modelling-for-the-alumina-industry/ Bayer Process Modelling for the Alumina Industry]<br />
;06 Sep 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29465|Build 139.29465]] update released.<br />
;01 Sep 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29437|Build 139.29437]] update released.<br />
::{{MajorUpdate}} New option to zip project files (Project > Zip Project).<br />
;27 Aug 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29390|Build 139.29390]] update released.<br />
::{{MinorUpdate}} Improved handling for multiple users on same project file.<br />
;26 Aug 2021<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=kxLHuw3P91s Modelling Solvent Extraction Separation of Neodymium from Praseodymium]<br />
;25 Aug 2021<br />
:{{Release}} '''Build 139 official release''' - [[Build_139_Revision_History#Build 29370|Build 139.29370]]<br />
::{{MajorUpdate}} See [[Build 139 Release Notes]] for full list of changes and new features.<br />
::{{Tip}} Now available on the [https://www.syscad.net/login/ Downloads page] for users with active Upgrade & Support.<br />
::{{Info}} If required, please [mailto:support@syscad.net contact us] for upgrade support.<br />
;19 Aug 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29334 (BETA)|Build 139.29334 BETA]] update released.<br />
::{{MajorUpdate}} New [[Alumina3 Precip - Full PSD#Kernel Builder|Agglomeration Kernel Builder]] added to Alumina [[Precipitation3]].<br />
;12 Aug 2021<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=0zde5f7-NeA Particle Size Distribution Visualisation]<br />
;06 Aug 2021<br />
:{{Info}} Conference attendance: We are presenting at [https://www.syscad.net/syscad-at-com-2021/ COM 2021]<br />
;28 Jul 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29199 (BETA)|Build 139.29199 BETA]] update released.<br />
;15 Jul 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 29102 (BETA)|Build 139.29102 BETA]] update released.<br />
;23 Jun 2021<br />
:{{Article}} Spotlight Article: [https://www.syscad.net/syscad-in-the-life-cycle-of-plant-development/ SysCAD in the Life Cycle of Plant Development]<br />
;18 Jun 2021<br />
:{{Info}} Follow us on [https://www.linkedin.com/company/syscad LinkedIn] for company news and process modelling highlights.<br />
;17 Jun 2021<br />
:{{Video}} Video: [https://www.youtube.com/watch?v=SA3nlthmg-c SysCAD Reporting Tools]<br />
;10 Jun 2021<br />
:{{Release}} [[Build_139_Revision_History#Build 28898 (BETA)|Build 139.28898 BETA]] released.<br />
::{{MajorUpdate}} See [[Build 139 Release Notes]] for full list of changes and new features.<br />
::{{Info}} Please [mailto:info@syscad.net contact us] for BETA access.<br />
;09 Jun 2021<br />
:{{Info}} Welcome to the '''Product Blog'''! Check back here for the latest SysCAD news and updates.<br />
== Icon Legend ==<br />
:{{Release}} Build Release<br />
::{{MajorUpdate}} Major Update<br />
::{{MinorUpdate}} Minor Update<br />
:{{Tip}} [[Tips and Tricks|Tips & Tricks]]<br />
:{{Article}} [https://www.syscad.net/category/articles/ Spotlight Articles] and [[Discussion Pages]]<br />
:{{Video}} [https://www.youtube.com/SysCADVideos Videos]<br />
:{{Info}} [https://www.syscad.net/category/news/ News] and General Information<br />
}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:TPS_Input_Output_Diff_Tabs&diff=78713Template:TPS Input Output Diff Tabs2024-03-07T12:55:25Z<p>Kevin.Heppner: </p>
<hr />
<div>{| border="1" cellpadding="5" cellspacing="0" <br />
| '''Tag (Long/Short)''' || '''Input / Calc''' || '''Description/Calculated Variables / Options'''<br />
|-<br />
| colspan="3" font style="background: #ebebeb" | ''Stream Properties Summary''<br />
|-<br />
| colspan="3" font style="background: #ebebeb" | {{#switch: {{{Type}}}|<br />
Input=Feed|<br />
Output=Prod|<br />
Diff=Diff|<br />
MembraneInterface=MembraneInterface|<br />
}}...<br />
|-<br />
| Temperature / T || style="background: #ebebeb"| Display || The Temperature {{#switch: {{{Type}}}|<br />
Input=of the feed solution. This is calculated using the SysCAD enthalpy context.|<br />
Output=of the product solution. This is calculated by {{#ifeq: {{{TPS}}} | PHREEQC | SysCAD enthalpy context | {{{TPS}}} }}.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
|- <br />
| Pressure / P || style="background: #ebebeb"| Display || The Pressure {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
|- <br />
| MassFlow / Qm || style="background: #ebebeb"| Display || The Mass Flow {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
|- <br />
{{#ifeq: {{{displayH}}}|N|<br />
|<br />
<td> Hf@T <td style="background: #ebebeb"> Display <td> The Enthalpy {{#switch: {{{Type}}}|<br />
Input=of the feed solution per unit mass.|<br />
Output=of the product solution per unit mass.|<br />
Diff=difference between the feed and product solutions per unit mass.|<br />
MembraneInterface=of the solution at the reject side of the membrane per unit mass.|<br />
}} This is calculated by {{{TPS}}}.<br />
<tr><br />
<td> Enthalpy / totHf@T <td style="background: #ebebeb"> Display <td> The Enthalpy {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}} This is calculated by {{{TPS}}}.<br />
<tr><br />
}}<br />
|- <br />
{{#ifeq: {{{TPS}}}| ChemApp|<br />
<td> FreeEnergy / Gf@T <td style="background: #ebebeb" > Display <td> The Free Energy {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
<tr><br />
<td> Entropy <td font style="background: #ebebeb"> Display <td> The entropy {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
<tr><br />
|<br />
}}<br />
{{#ifeq: {{{Type}}}| Output|<br />
<!--{{#ifeq: {{{139only}}}| Yes|<br />
|<br />
<td> HeatFlow <td style="background: #ebebeb" > Display <td> Only displayed in Build 138. The heat flow required to achieve the product conditions relative to the feed conditions. Includes environmental heat loss if applicable.<br />
<tr><br />
}}--><br />
{{#ifeq: {{{TPS}}}| PHREEQC|<br />
<td> AqDensity / AqRho <td style="background: #ebebeb" > Display <td> The density of aqueous species (solution) in the final solution.<br />
<tr> <br />
<td> IonicStrength / I <td style="background: #ebebeb" > Display <td> The molal Ionic Strength of the final solution, based on the molality (moles/mass of H2O) and charge of the individual ions.<br />
<tr><br />
<td> pH <td style="background: #ebebeb" > Display <td> The pH of the final solution.<br />
<tr><br />
<td> Alkalinity <td style="background: #ebebeb" > Display <td> The alkalinity of the final solution.<br />
<tr><br />
<td> WaterActivity <td style="background: #ebebeb" > Display <td> The water activity of the final solution.<br />
<tr><br />
<td> TotalDissolvedSolids / TDS <td style="background: #ebebeb" > Display <td> The mass concentration of Total Dissolved Solids (total aqueous-water) in the final solution.<br />
<tr><br />
<td> OsmoticPressure / OsmP <td style="background: #ebebeb" > Display <td> The Osmotic Pressure of the final solution. Please refer to [[#Calculation of Osmotic Pressure|Model Theory - Calculation of Osmotic Pressure]] for more information.<br />
<tr><br />
<td> ORP <td style="background: #ebebeb" > Display <td> {{Available139|33865}} The oxidation reduction potential (ORP) of the final solution referenced to the standard hydrogen electrode (SHE). This is also known as <math>E_h</math>.<br />
<tr><br />
{{#ifeq: {{{139only}}}| Yes|<br />
<td> pKw <td font style="background: #ebebeb"> Display <td> The pKw of the final solution.<br />
<tr>|<br />
<!--<br />
<td> CheckpKwOfEqmSolution <td> [[Image:Check pKW.png]] <td> Only available in Build 138. If the user clicks on this button, SysCAD will calculate pKw.<br />
<tr><br />
--><br />
<td> pKw <td font style="background: #ebebeb"> Display <td> The pKw of the final solution. <!--In Build 138, this will only be calculated when the ''CheckpKwOfEqmSolution'' button is pressed.--><br />
<tr><br />
}}<br />
<td> RevMap.IonRxns <td> [[Image:Copy to Clipboard Button.png]] <td> A table of Ion Rebuild Reactions (ions->species) and their extents will be copied to the clipboard.<br />
<tr><br />
|<br />
}}<br />
{{#ifeq: {{{TPS}}}| AQSol|<br />
<td> IonicStrength / I <td style="background: #ebebeb" > Display <td> The molar Ionic Strength of the final solution.<br />
<tr><br />
<td> pH <td style="background: #ebebeb" > Display <td> The pH of the final solution.<br />
<tr><br />
<td> WaterActivity <td style="background: #ebebeb" > Display <td> The water activity of the final solution.<br />
<tr><br />
<td> TotalDissolvedSolids / TDS <td style="background: #ebebeb" > Display <td> The mass concentration of Total Dissolved Solids (total aqueous-water) in the final solution.<br />
<tr><br />
<td> OsmoticPressure / OsmP <td style="background: #ebebeb" > Display <td> The Osmotic Pressure of the final solution as calculated by AQSol.<br />
<tr><br />
{{#ifeq: {{{139only}}}| Yes|<br />
<td> pKw <td font style="background: #ebebeb"> Display <td> The pKw of the final solution.<br />
<tr>|<br />
<!--<br />
<td> CheckpKwOfEqmSolution <td> [[Image:Check pKW.png]] <td> Only available in Build 138. If the user clicks on this button, SysCAD will calculate pKw. <br />
<tr> --><br />
<td> pKw <td font style="background: #ebebeb"> Display <td> The pKw of the final solution. <!--In Build 138, this will only be calculated when the ''CheckpKwOfEqmSolution'' button is pressed.<br />
<tr>--><br />
}}<br />
<td> RevMap.IonRxns <td> [[Image:Copy to Clipboard Button.png]] <td> A table of Ion Rebuild Reactions (ions->species) and their extents will be copied to the clipboard.<br />
<tr><br />
|<br />
}}<br />
{{#ifeq: {{{TPS}}}| OLI|<br />
<td> ElecConductivity / kappa@T <td font style="background: #ebebeb"> Display <td> The electric conductivity of the final solution. Only available if CalcElectricalConductivity is checked.<br />
<tr><br />
<td> Viscosity / Visc <td font style="background: #ebebeb"> Display <td> The viscosity of the final solution. Only available if CalcViscosity is checked.<br />
<tr><br />
<td> HeatCapacity / Cp <td font style="background: #ebebeb"> Display <td> The heat capacity of the final solution. Only available if CalcHeatCapacity is checked.<br />
<tr><br />
<td> HeatCapacityLiq / Liq.Cp <td font style="background: #ebebeb"> Display <td> The liquid heat capacity of the final solution. Only available if CalcHeatCapacity is checked.<br />
<tr><br />
<td> HeatCapacitySol / Sol.Cp <td font style="background: #ebebeb"> Display <td> The solid heat capacity of the final solution. Only available if CalcHeatCapacity is checked.<br />
<tr><br />
<td> HeatCapacityVap / Vap.Cp <td font style="background: #ebebeb"> Display <td> The vapour heat capacity of the final solution. Only available if CalcHeatCapacity is checked.<br />
<tr><br />
<td> RedoxPotential / ORP <td style="background: #ebebeb" > Display <td> <br />
<tr><br />
<td> VapCompressibility / VapCompress <td style="background: #ebebeb" > Display <td> The vapour compressibility of the final solution.<br />
<tr><br />
<td> Liq.VolumeFlow / Liq.Qv <td style="background: #ebebeb" > Display <td> The liquid volume flow of the final solution.<br />
<tr><br />
<td> Liq.Enthalpy / Liq.Hf@T <td style="background: #ebebeb" > Display <td> The liquid enthalpy of the final solution.<br />
<tr><br />
<td> Liq.ThermCond / Liq.k_cond <td style="background: #ebebeb" > Display <td> The liquid thermal conductivity of the final solution. Only available if CalcTransportProps is checked.<br />
<tr><br />
<td> Vap.ThermCond / Vap.k_cond <td style="background: #ebebeb" > Display <td> The vapour thermal conductivity of the final solution. Only available if CalcTransportProps is checked.<br />
<tr><br />
<td> Liq2.Density / Liq2.Rho <td style="background: #ebebeb" > Display <td> The density of the 2nd liquid. Only available if the 2nd liquid functionality is enabled in the OLI model being used.<br />
<tr><br />
<td> Liq2.ThermCond / Liq2.k_cond <td style="background: #ebebeb" > Display <td> The density of the 2nd liquid. Only available if the 2nd liquid functionality is enabled in the OLI model being used and CalcTransportProps is checked.<br />
<tr><br />
<td> Liq2.pH / Liq2.pH <td style="background: #ebebeb" > Display <td> The pH of the 2nd liquid. Only available if the 2nd liquid functionality is enabled in the OLI model being used.<br />
<tr><br />
<td> Liq2.IonicStrength / Liq2.I_cond <td style="background: #ebebeb" > Display <td> The ionic strength of the 2nd liquid. Only available if the 2nd liquid functionality is enabled in the OLI model being used.<br />
<tr><br />
<td> Liq2.HeatCapacity / Liq2.Cp <td style="background: #ebebeb" > Display <td> The heat capacity of the 2nd liquid. Only available if the 2nd liquid functionality is enabled in the OLI model being used and if CalcHeatCapacity is checked.<br />
<tr><br />
<td> Liq2.ElecConductivity / Liq2.kappa@T <td style="background: #ebebeb" > Display <td> The electrical conductivity of the 2nd liquid. Only available if the 2nd liquid functionality is enabled in the OLI model being used and if CalcElectricalConductivity is checked.<br />
<tr><br />
<td> Liq2.Viscosity / Liq2.Visc <td style="background: #ebebeb" > Display <td> The viscosity of the 2nd liquid. Only available if the 2nd liquid functionality is enabled in the OLI model being used and if CalcViscosity is checked.<br />
<tr><br />
<td> Liq.IntSurfTension / Liq.IntSigma <td style="background: #ebebeb" > Display <td> The interfacial surface tension felt by the liquid phase. Only available if the 2nd liquid functionality is enabled in the OLI model and if CalcTransportProperties is checked.<br />
<tr><br />
<td> Liq2.IntSurfTension / Liq2.IntSigma <td style="background: #ebebeb" > Display <td> The interfacial surface tension felt by the 2nd liquid phase. Only available if the 2nd liquid functionality is enabled in the OLI model and if CalcTransportProperties is checked.<br />
<tr><br />
<td> OLIStream <td> [[Image:Copy to Clipboard Button.png]] <td> Input suitable for direct use in an OLI Studio stream will be copied to the clipboard. To use this, press the copy button, then go to OLI Studio and paste into the stream composition section of the stream input. Note that pressure and temperature of the stream is not included in the copy.<br />
<tr><br />
<td> RevMap.IonRxns <td> [[Image:Copy to Clipboard Button.png]] <td> A table of Ion Rebuild Reactions (ions->species) and their extents will be copied to the clipboard.<br />
<tr><br />
|<br />
}}<br />
|<br />
}}<br />
| colspan="3" font style="background: #ebebeb" | {{#switch: {{{Type}}}|<br />
Input=Feed|<br />
Output=Prod|<br />
Diff=Diff|<br />
MembraneInterface=MembraneInterface|<br />
}}...<br />
{{#switch: {{{Type}}}|<br />
Input={{Common Data on TPS Input Page|TPS={{{TPS}}}|139only={{{139only}}}|masstype=mass|moletype=mole|speciesstreamtype=species in the feed stream|Stream={{{Type}}}}}|<br />
Output={{Common Data on TPS Input Page|TPS={{{TPS}}}|139only={{{139only}}}|masstype=mass|moletype=mole|speciesstreamtype=species in the product stream|Stream={{{Type}}}}}|<br />
Diff={{Common Data on TPS Input Page|TPS={{{TPS}}}|139only={{{139only}}}|masstype=difference in mass|moletype=difference in mole|speciesstreamtype=species|Stream={{{Type}}}}}|<br />
MembraneInterface={{Common Data on TPS Input Page|TPS={{{TPS}}}|139only={{{139only}}}|masstype=mass|moletype=mole|speciesstreamtype=species in the membrane interface stream|Stream={{{Type}}}}}|<br />
}}<br />
{{#ifeq: {{{Type}}}| Output|<br />
<tr> <br />
{{#ifeq: {{{TPS}}}| ChemApp|<br />
<td> Activity <td style="background: #ebebeb" > Display <td> Only shown for non-gaseous species. The activity of the species.<br />
<tr> <br />
<td> Fugacity <td style="background: #ebebeb" > Display <td> Only shown for gaseous species. The fugacity of the species.<br />
<tr> <br />
|<br />
<td> ActivityCoeff <td style="background: #ebebeb" > Display <td> Only shown for liquid/aqueous species. The activity coefficient of the species.<br />
<tr> <br />
<td> SatIdx <td style="background: #ebebeb" > Display <td> Only shown for solid species. The saturation index of the species relative to its equilibrium solubility.<br />
<tr> <br />
<td> SatIdx.Eff <td style="background: #ebebeb" > Display <td> Only shown for solid species. The saturation index of the species adjusted for user specified Saturation Index as defined in the [[{{{TPS}}} Model Configuration]].<br />
<tr> <br />
<td> Fugacity <td style="background: #ebebeb" > Display <td> Only shown for gaseous species. The fugacity of the species.<br />
<tr> <br />
<td> Fugacity.Eff <td style="background: #ebebeb" > Display <td> Only shown for gaseous species.<br />
}}<br />
|<br />
}}<br />
{{#ifeq: {{{Type}}}| MembraneInterface|<br />
<tr> <br />
<td> ActivityCoeff <td style="background: #ebebeb" > Display <td> Only shown for liquid/aqueous species. The activity coefficient of the species.<br />
<tr> <br />
<td> Fugacity <td style="background: #ebebeb" > Display <td> Only shown for gaseous species. The fugacity of the species.<br />
|<br />
}}<br />
|}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:TPS_Utility_Config&diff=78712Template:TPS Utility Config2024-03-06T18:56:34Z<p>Kevin.Heppner: </p>
<hr />
<div>*#:<b>''Config.txt''</b><br>[[File:TPS_Config_File.png]]<br />
*#*''INCLUDE_ELEMENTS'': specify in the line below this keyword the elements you want to include, comma separated list.<br />
*#*''EXCLUDE_ELEMENTS'': specify in the line below this keyword the elements you want to exclude, comma separated list.<br />
*#*''INCLUDE_OCCURRENCES'': specify in the line below this keyword the occurrences you want to include, comma separated list. Can be s, l, or g.<br />
*#*''INCLUDE_PHASES'': specify in the line below this keyword the phases you want to include, comma separated list. These are substrings, thus, in the example above, any phase which contains slag (case insensitive) would be included.<br />
*#*''EXCLUDE_SUBSTRINGS'': specify in the line below this keyword any substrings within species that you want to exclude, comma separated list. For example, entering C2, C3, C4 (case sensitive) would exclude ethyl, propyl, and butyl species.<br />
*#*''ALLOW_DUPLICATE_SHORT_NAME'': specify in the line below this keyword either 0 (false) or 1 (true). If you allow duplicate short names, the short names will be appended with _1, then _2, etc. For example, if you have multiple types of silica, you would get SiO2, SiO2_1, SiO2_2, etc.<br />
*#*''CREATE_DEFAULT_SPECIES_IF_NO_MATCHES_FOUND'': specify in the line below this keyword either 0 (false) or 1 (true). If you allow default species to be created, you will get default species (with no thermodynamic or properties data) as placeholders when a matching species is not found. If false, only matched species will be added to the database (with thermodynamic and properties data taken from the db3 file). Default value is true.<br />
*#*''MIN_TEMP_CP'': specify in the line below this keyword the desired lower bound temperature of the heat capacity correlation for selection, in K. The utility will use this if, in the selection of the database, you choose -1. It will then find the matching database entry with the greatest Cp range within the desired range.<br />
*#*''MAX_TEMP_CP'': specify in the line below this keyword the desired upper bound temperature of the heat capacity correlation for selection, in K. The utility will use this if, in the selection of the database, you choose -1. It will then find the matching database entry with the greatest Cp range within the desired range.<br />
*#::Example for Cp Range: Consider where ''MIN_TEMP_CP'' is 273 K and ''MAX_TEMP_CP'' is 423 K. There are two possible species matching, one with a range of Range(K,273,450), and another with a Range (K,500,1500). Even though the second has a greater Cp Range than the first, its range is fully outside of the desired range, and thus, it will be rejected in favour of the first, which has a smaller range, but its range fully encompasses the desired range defined by ''MIN_TEMP_CP'' and ''MAX_TEMP_CP''. Selections by this method are logged in the ''ErrorLog.txt'' file.<br />
{{#if: {{{IncludeIonList|}}}<br />
|*#*''CREATE_ION_LIST'': specify in the line below this keyword 1 (true) or 0 (false). If true, an IonList.dat file will be created which contains all ionic species (for ion mapping). All combinations of cations/anions will be used to add whole salt, acid, and base aqueous species to the species database. If false, ions will be added directly to the SysCAD database, usually using default thermochemical data for the liquid species (unless you have data for these ionic species and specify an appropriate source database.<br />
*#*The '''IonList.txt''' is created by executing the utility (if Create_Ion_List = 1 in Config.txt).<br />
|*#*If no Config.txt file exists, all species are loaded unfiltered.<br />
}}<br />
{{#if: {{{IncludePhaseMapping|}}}<br />
|*#*''FORCE_UPPER_CASE_PHASE_NAMES'': specify in the line below this keyword 1 (true) or 0 (false). If true, all phases read from the database file will be forced to all upper case. Default is false. Only applicable when the phase names are derived from actual names (applicable to ChemApp).<br />
|*#*If no Config.txt file exists, all species are loaded unfiltered.<br />
}}<br />
{{#if: {{{IncludeParentFolder|}}}<br />
|*#*''AQSOL_INSTALL_PARENT_FOLDER'': specify in the line below the installation path where all of the AQSol DLLs are installed. The default location when AQSol is installed is c:\Program Files (x86)<br />
|<br />
}}<br />
*#*''USE_HARDWIRED_DATA'': specify in the line below a value of 1 (true) or 0 (false). If true, it will use "hardwired" data from SysCAD and some additional data from NBS Tables when no data is available for a specific property and species.</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:TPS_-_General_Description&diff=78684Template:TPS - General Description2024-03-05T14:16:41Z<p>Kevin.Heppner: </p>
<hr />
<div>{{#if:{{{TPS|}}} <br />
|The {{{TPS}}} solver is called to determine the state of a SysCAD stream. The composition, temperature and pressure of the 'Feed' stream are based on the feed to the unit. The unit will then determine the equilibrium conditions of the resulting stream.<br />
|<br />
}}<br />
<!--<br />
{{#ifeq: {{{TPS}}}| AQSol|The results can be applied to the product stream or just performed as a side calculation (similar to use of the [[{{{TPS}}} Side Calc Model]]). <br />
|<br />
}}<br />
--><br />
{{#switch: {{{UnitOp}}}| Reverse Osmosis=<br />
*This model is designed to simulate a reverse osmosis membrane process, often used in water treatment, especially for desalination of sea water.<br />
*The user may specify the yield and efficiency of the process, as well as the outlet pressure requirements.<br />
*The unit expects the feed to be free of solids. If solids are fed to the unit, the user will receive a warning and any solids will be sent to the Brine stream.<br />
*If a vent stream is connected, then all gases will exit via the Vent. If gases are present and there is no vent connection then the user will receive a warning and all gases will be sent to the Brine stream. <br />
|Flash Tank=<br />
*The {{{TPS}}} Flash Tank is used to 'flash' a feed stream to produce a liquid and vapour product at a set pressure or temperature. <br />
*There are two operational modes for the {{{TPS}}} Flash Tank: (1) as a stand-alone unit; or (2) as part of a [[Flash Train]]. The user sets the operational mode of the Flash Tank. However, if the user sets the mode as ''Flash Train'' and the Flash Tank is NOT connected to any Flash Train aware destination unit, the model will go to an error state.<br />
*The {{{TPS}}} Flash Tank model may be used as a Crystallizer. Vapour is flashed off and the remaining solution is then supersaturated with the required species. This species then precipitates out as the crystal product. <br />
|Mixer Settler=<br />
*The Solvent Extraction unit will mix perfectly all the input streams, complete species transfer across phases, then separate the output based on individual phase or density.<br />
*User can set up the unit for solvent extraction or organic stripping. The model also allows imperfect separation of products, to do this, specify aqueous loss in organic and/or organic loss in aqueous.<br />
*User is responsible for setting up a suite of species which accurately portrays the application that is being evaluated. As the separation of the mixture will be based on individual phase or density, we recommend defining all aqueous species with individual phase (aq) and all organic species with individual phase (o). If using separation by density, please ensure the organic species are defined with a lower density than the aqueous species.<br />
{{#ifeq: {{{TPS}}}| PHREEQC|<br />
*This requires the specification of appropriate data for organic-aqueous exchange reactions within the {{{TPS}}} database. These are typically determined using pure system shakeout tests. As an example, contacting fresh extractant dissolved in diluent at a known concentration with pure metal chloride salt solution over a range of organic/aqueous ratios would provide suitable data for fitting. Knowledge of the extraction and stripping mechanisms are required to successfully fit the equilibrium values required to model the reactions.<br />
*We have experience in generating appropriate data inputs and can provide simulation services to clients as required to generate appropriate models. Examples of conference papers we have written on this topic can be provided upon request.<br />
|<br />
}}<br />
|<br />
}}<br />
{{#if:{{{TPS|}}} <br />
|<br />
'''Notes'''<br />
# The user '''MUST''' have added and configured a [[{{{TPS}}} Model Configuration]] unit in the SysCAD project before this unit can function.<br />
# The user '''MUST''' have installed a version of {{{TPS}}} on their computer to make use of the {{{TPS}}} functionality in SysCAD. {{#switch: {{{TPS}}}|<br />
PHREEQC=Please see [https://www.usgs.gov/software/phreeqc-version-3 https://www.usgs.gov/software/phreeqc-version-3] for more information.|<br />
AQSol=Please see [https://www.phasediagram.dk www.phasediagram.dk] for more information.| <br />
}}<br />
|<br />
}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:TPS_Input_Output_Diff_Tabs&diff=78656Template:TPS Input Output Diff Tabs2024-03-03T13:45:23Z<p>Kevin.Heppner: </p>
<hr />
<div>{| border="1" cellpadding="5" cellspacing="0" <br />
| '''Tag (Long/Short)''' || '''Input / Calc''' || '''Description/Calculated Variables / Options'''<br />
|-<br />
| colspan="3" font style="background: #ebebeb" | ''Stream Properties Summary''<br />
|-<br />
| colspan="3" font style="background: #ebebeb" | {{#switch: {{{Type}}}|<br />
Input=Feed|<br />
Output=Prod|<br />
Diff=Diff|<br />
MembraneInterface=MembraneInterface|<br />
}}...<br />
|-<br />
| Temperature / T || style="background: #ebebeb"| Display || The Temperature {{#switch: {{{Type}}}|<br />
Input=of the feed solution. This is calculated using the SysCAD enthalpy context.|<br />
Output=of the product solution. This is calculated by {{#ifeq: {{{TPS}}} | PHREEQC | SysCAD enthalpy context | {{{TPS}}} }}.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
|- <br />
| Pressure / P || style="background: #ebebeb"| Display || The Pressure {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
|- <br />
| MassFlow / Qm || style="background: #ebebeb"| Display || The Mass Flow {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
|- <br />
{{#ifeq: {{{displayH}}}|N|<br />
|<br />
<td> Hf@T <td style="background: #ebebeb"> Display <td> The Enthalpy {{#switch: {{{Type}}}|<br />
Input=of the feed solution per unit mass.|<br />
Output=of the product solution per unit mass.|<br />
Diff=difference between the feed and product solutions per unit mass.|<br />
MembraneInterface=of the solution at the reject side of the membrane per unit mass.|<br />
}} This is calculated by {{{TPS}}}.<br />
<tr><br />
<td> Enthalpy / totHf@T <td style="background: #ebebeb"> Display <td> The Enthalpy {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}} This is calculated by {{{TPS}}}.<br />
<tr><br />
}}<br />
|- <br />
{{#ifeq: {{{TPS}}}| ChemApp|<br />
<td> FreeEnergy / Gf@T <td style="background: #ebebeb" > Display <td> The Free Energy {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
<tr><br />
<td> Entropy <td font style="background: #ebebeb"> Display <td> The entropy {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
<tr><br />
|<br />
}}<br />
{{#ifeq: {{{Type}}}| Output|<br />
<!--{{#ifeq: {{{139only}}}| Yes|<br />
|<br />
<td> HeatFlow <td style="background: #ebebeb" > Display <td> Only displayed in Build 138. The heat flow required to achieve the product conditions relative to the feed conditions. Includes environmental heat loss if applicable.<br />
<tr><br />
}}--><br />
{{#ifeq: {{{TPS}}}| PHREEQC|<br />
<td> AqDensity / AqRho <td style="background: #ebebeb" > Display <td> The density of aqueous species (solution) in the final solution.<br />
<tr> <br />
<td> IonicStrength / I <td style="background: #ebebeb" > Display <td> The molal Ionic Strength of the final solution, based on the molality (moles/mass of H2O) and charge of the individual ions.<br />
<tr><br />
<td> pH <td style="background: #ebebeb" > Display <td> The pH of the final solution.<br />
<tr><br />
<td> Alkalinity <td style="background: #ebebeb" > Display <td> The alkalinity of the final solution.<br />
<tr><br />
<td> WaterActivity <td style="background: #ebebeb" > Display <td> The water activity of the final solution.<br />
<tr><br />
<td> TotalDissolvedSolids / TDS <td style="background: #ebebeb" > Display <td> The mass concentration of Total Dissolved Solids (total aqueous-water) in the final solution.<br />
<tr><br />
<td> OsmoticPressure / OsmP <td style="background: #ebebeb" > Display <td> The Osmotic Pressure of the final solution. Please refer to [[#Calculation of Osmotic Pressure|Model Theory - Calculation of Osmotic Pressure]] for more information.<br />
<tr><br />
<td> ORP <td style="background: #ebebeb" > Display <td> {{Available139|33865}} The oxidation reduction potential (ORP) of the final solution referenced to the standard hydrogen electrode (SHE). This is also known as <math>E_h</math>.<br />
<tr><br />
{{#ifeq: {{{139only}}}| Yes|<br />
<td> pKw <td font style="background: #ebebeb"> Display <td> The pKw of the final solution.<br />
<tr>|<br />
<!--<br />
<td> CheckpKwOfEqmSolution <td> [[Image:Check pKW.png]] <td> Only available in Build 138. If the user clicks on this button, SysCAD will calculate pKw.<br />
<tr><br />
--><br />
<td> pKw <td font style="background: #ebebeb"> Display <td> The pKw of the final solution. <!--In Build 138, this will only be calculated when the ''CheckpKwOfEqmSolution'' button is pressed.--><br />
<tr><br />
}}<br />
<td> RevMap.IonRxns <td> [[Image:Copy to Clipboard Button.png]] <td> A table of Ion Rebuild Reactions (ions->species) and their extents will be copied to the clipboard.<br />
<tr><br />
|<br />
}}<br />
{{#ifeq: {{{TPS}}}| AQSol|<br />
<td> IonicStrength / I <td style="background: #ebebeb" > Display <td> The molar Ionic Strength of the final solution.<br />
<tr><br />
<td> pH <td style="background: #ebebeb" > Display <td> The pH of the final solution.<br />
<tr><br />
<td> WaterActivity <td style="background: #ebebeb" > Display <td> The water activity of the final solution.<br />
<tr><br />
<td> TotalDissolvedSolids / TDS <td style="background: #ebebeb" > Display <td> The mass concentration of Total Dissolved Solids (total aqueous-water) in the final solution.<br />
<tr><br />
<td> OsmoticPressure / OsmP <td style="background: #ebebeb" > Display <td> The Osmotic Pressure of the final solution as calculated by AQSol.<br />
<tr><br />
{{#ifeq: {{{139only}}}| Yes|<br />
<td> pKw <td font style="background: #ebebeb"> Display <td> The pKw of the final solution.<br />
<tr>|<br />
<!--<br />
<td> CheckpKwOfEqmSolution <td> [[Image:Check pKW.png]] <td> Only available in Build 138. If the user clicks on this button, SysCAD will calculate pKw. --><br />
<tr><br />
<td> pKw <td font style="background: #ebebeb"> Display <td> The pKw of the final solution. <!--In Build 138, this will only be calculated when the ''CheckpKwOfEqmSolution'' button is pressed.--><br />
<tr><br />
}}<br />
<td> RevMap.IonRxns <td> [[Image:Copy to Clipboard Button.png]] <td> A table of Ion Rebuild Reactions (ions->species) and their extents will be copied to the clipboard.<br />
<tr><br />
|<br />
}}<br />
{{#ifeq: {{{TPS}}}| OLI|<br />
<td> RedoxPotential / ORP <td style="background: #ebebeb" > Display <td> <br />
<tr><br />
<td> VapCompressibility / VapCompress <td style="background: #ebebeb" > Display <td> <br />
<tr><br />
<td> Liquid1.VolumeFlow / Liq1.Qv <td style="background: #ebebeb" > Display <td> <br />
<tr><br />
<td> Liquid1.Enthalpy / Liq1.Hf@T <td style="background: #ebebeb" > Display <td> <br />
<tr><br />
<td> Liquid1.ThermCond / Liq1.k_cond <td style="background: #ebebeb" > Display <td> <br />
<tr><br />
<td> Vapour.ThermCond / Vap.k_cond <td style="background: #ebebeb" > Display <td> <br />
<tr><br />
<td> ElecConductivity / kappa@T <td font style="background: #ebebeb"> Display <td> The electric conductivity of the final solution.<br />
<tr><br />
<td> RevMap.IonRxns <td> [[Image:Copy to Clipboard Button.png]] <td> A table of Ion Rebuild Reactions (ions->species) and their extents will be copied to the clipboard.<br />
<tr><br />
|<br />
}}<br />
|<br />
}}<br />
| colspan="3" font style="background: #ebebeb" | {{#switch: {{{Type}}}|<br />
Input=Feed|<br />
Output=Prod|<br />
Diff=Diff|<br />
MembraneInterface=MembraneInterface|<br />
}}...<br />
{{#switch: {{{Type}}}|<br />
Input={{Common Data on TPS Input Page|TPS={{{TPS}}}|139only={{{139only}}}|masstype=mass|moletype=mole|speciesstreamtype=species in the feed stream|Stream={{{Type}}}}}|<br />
Output={{Common Data on TPS Input Page|TPS={{{TPS}}}|139only={{{139only}}}|masstype=mass|moletype=mole|speciesstreamtype=species in the product stream|Stream={{{Type}}}}}|<br />
Diff={{Common Data on TPS Input Page|TPS={{{TPS}}}|139only={{{139only}}}|masstype=difference in mass|moletype=difference in mole|speciesstreamtype=species|Stream={{{Type}}}}}|<br />
MembraneInterface={{Common Data on TPS Input Page|TPS={{{TPS}}}|139only={{{139only}}}|masstype=mass|moletype=mole|speciesstreamtype=species in the membrane interface stream|Stream={{{Type}}}}}|<br />
}}<br />
{{#ifeq: {{{Type}}}| Output|<br />
<tr> <br />
{{#ifeq: {{{TPS}}}| ChemApp|<br />
<td> Activity <td style="background: #ebebeb" > Display <td> Only shown for non-gaseous species. The activity of the species.<br />
<tr> <br />
<td> Fugacity <td style="background: #ebebeb" > Display <td> Only shown for gaseous species. The fugacity of the species.<br />
<tr> <br />
|<br />
<td> ActivityCoeff <td style="background: #ebebeb" > Display <td> Only shown for liquid/aqueous species. The activity coefficient of the species.<br />
<tr> <br />
<td> SatIdx <td style="background: #ebebeb" > Display <td> Only shown for solid species. The saturation index of the species relative to its equilibrium solubility.<br />
<tr> <br />
<td> SatIdx.Eff <td style="background: #ebebeb" > Display <td> Only shown for solid species. The saturation index of the species adjusted for user specified Saturation Index as defined in the [[{{{TPS}}} Model Configuration]].<br />
<tr> <br />
<td> Fugacity <td style="background: #ebebeb" > Display <td> Only shown for gaseous species. The fugacity of the species.<br />
<tr> <br />
<td> Fugacity.Eff <td style="background: #ebebeb" > Display <td> Only shown for gaseous species.<br />
}}<br />
|<br />
}}<br />
{{#ifeq: {{{Type}}}| MembraneInterface|<br />
<tr> <br />
<td> ActivityCoeff <td style="background: #ebebeb" > Display <td> Only shown for liquid/aqueous species. The activity coefficient of the species.<br />
<tr> <br />
<td> Fugacity <td style="background: #ebebeb" > Display <td> Only shown for gaseous species. The fugacity of the species.<br />
|<br />
}}<br />
|}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:Common_Data_on_TPS_Input_Page&diff=78655Template:Common Data on TPS Input Page2024-03-03T13:43:39Z<p>Kevin.Heppner: </p>
<hr />
<div>|-<br />
| SpeciesName || [[Image: SpeciesLongButton.png]]<br>[[Image: SpeciesShortButton.png]]|| The Species:Long or Short button is used to change the display of the Species names between the Short form, the Chemical compound, or the longer species names.<br />
|-<br />
| Zeros || [[Image: Hide Zeros.png]]<br> [[Image: Show Zeros.png]] || If the Hide Zeros button is clicked, all species that have NO mass flow will be hidden.<br>If the Show Zeros button is clicked, all species will be displayed, including those with zero mass flow.<br />
|-<br />
| StreamView|| [[Image:Mass.png]]<br>[[Image:Molar.png]] || If the '''Mass''' button is clicked, the species will be shown in mass flow view. <br>If the '''Mole''' button is clicked, the species will be shown in mole flow view.<br />
|-<br />
|rowspan=4|Stream [[Image:Copy to Clipboard Button.png]] || Mass || Copy stream contents to clipboard, mass basis, for pasting into Excel. If ''Zeros'' is set to hide, zero values will not be copied to the clipboard.<br />
|-<br />
| Mole || Copy stream contents to clipboard, mole basis, for pasting into Excel. If ''Zeros'' is set to hide, zero values will not be copied to the clipboard.<br />
|-<br />
| Unmapped Mass || Copy unmapped stream contents to clipboard, mass basis, for pasting into Excel. If ''Zeros'' is set to hide, zero values will not be copied to the clipboard. Unmapped species are those which will not be mapped to the exiting SysCAD stream.<br />
|-<br />
| Unmapped Mole || Copy unmapped stream contents to clipboard, mole basis, for pasting into Excel. If ''Zeros'' is set to hide, zero values will not be copied to the clipboard. Unmapped species are those which will not be mapped to the exiting SysCAD stream.<br />
|-<br />
| colspan="3" font style="background: #ebebeb" |''Filter View''<br />
|-<br />
| Filter || [[File: Button - Filter On.png]]<br>[[Image: Button - Filter Off.png]] || This button will enable or disable the species filter options.<br />
|-<br />
| ShowUnmapped<br>(Only visible if Filter is enabled) || Tickbox|| When enabled, all species will be displayed. When disabled, only species that are mapped to a SysCAD species will be shown.<br />
|-<br />
| valign="top" rowspan="8" | Phases<br>(Only visible if Filter is enabled)|| All || No filtering of species based on phase.<br />
|-<br />
| Solids || Only show solid phase species, hide other species.<br />
|-<br />
| Liquids || Only show liquid phase species, hide other species.<br />
|-<br />
| Vapours || Only show vapour (gaseous) phase species, hide other species.<br />
|-<br />
| Solids & Liquids || Only show solid and liquid phase species, hide other species.<br />
|-<br />
| Solids & Vapours || Only show solid and vapour (gaseous) phase species, hide other species.<br />
|-<br />
| Liquids & Vapours || Only show liquid and vapour (gaseous) phase species, hide other species.<br />
|-<br />
| ''IPhase''|| Only show "IPhase" individual phase species, hide other species. The individual phases shown will depend on the {{{TPS}}} database chosen.<br />
|-<br />
{{#ifeq: {{{139only}}}| Yes|<br />
<td valign="top" rowspan="7" > Filters<br>(Only visible if Filter is enabled) <td> Content <td> All species which meet the Phase and Content criteria will be displayed.<br />
<tr><br />
<td> Content & MassFrac Limit <td> Only species which meet the Phase and Content criteria AND have a mass fraction greater than or equal to the user specified MassFrac.Limit will be displayed.<br />
<tr><br />
<td> Content & MassFrac Largest <td> Only the top N species (based on Mass Fraction) which meet the Phase and Content criteria will be displayed, where N = the user specified MassFrac.Count.<br />
<tr><br />
<td> Content & MassFrac Smallest <td> Only the bottom N species (based on Mass Fraction) which meet the Phase and Content criteria will be displayed, where N = the user specified MassFrac.Count.<br />
<tr><br />
|<br />
<td valign="top" rowspan="7" > Filters<br>(Only visible if Filter is enabled) <td> Content <td> All species which meet the Phase and Content criteria will be displayed.<br />
<tr><br />
<td> Content & MassFrac Limit <td> Only species which meet the Phase and Content criteria AND have a mass fraction greater than or equal to the user specified MassFrac.Limit will be displayed.<br />
<tr><br />
<td> Content & MassFrac Largest <td> Only the top N species (based on Mass Fraction) which meet the Phase and Content criteria will be displayed, where N = the user specified MassFrac.Count.<br />
<tr><br />
<td> Content & MassFrac Smallest <td> Only the bottom N species (based on Mass Fraction) which meet the Phase and Content criteria will be displayed, where N = the user specified MassFrac.Count.<br />
<tr><br />
}}<br />
|MassFrac Limit || Only species which meet the Phase criteria AND have a mass fraction greater than or equal to the user specified MassFrac.Limit will be displayed.<br />
|-<br />
|MassFrac Largest || Only the top N species (based on Mass Fraction) which meet the Phase criteria will be displayed, where N = the user specified MassFrac.Count.<br />
|-<br />
|MassFrac Smallest || Only the bottom N species (based on Mass Fraction) which meet the Phase criteria will be displayed, where N = the user specified MassFrac.Count.<br />
|-<br />
| valign="top" rowspan="6" | Content<br>(Only visible when one of <br>the ''Content'' '''Filter''' options<br> is selected)|| All || No filtering of species based on element or name.<br />
|-<br />
|Contains Any Element || This will display all species that contain any of the elements entered in their elemental definition.<br />
|-<br />
|Contains All Elements || This will display only species that contain ALL of the elements entered in their elemental definition.<br />
|-<br />
|Starts with ... || This will display species that start with the text entered based on the short or long species tag depending on the current SpeciesTag selection.<br />
|-<br />
|Contains any ... || This will display species that contain the text entered in the currently displayed short or long species tag.<br />
|-<br />
|Contains All ... || This will display species that contain ALL the separate text entered in the currently displayed short or long species tag.<br />
|-<br />
| Select || Input || Only visible if '''Content''' is NOT set to ''All''. The user specified Elements or text to filter the species list. Refer to [[Species Filter]] for more information and examples.<br />
|-<br />
|MassFrac.Limit ||Input|| Only visible if '''Filters''' = ''Content & MassFrac Limit'' or ''MassFrac Limit''. The user specified MassFrac Limit, the maximum mass fraction to be displayed.<br />
|-<br />
|MassFrac.Count ||Input|| Only visible if '''Filters''' = ''Content & MassFrac Largest'', ''Content & MassFrac Smallest'', ''MassFrac Largest'' or ''MassFrac Smallest''. The user specified Mass Frac Count, the maximum number of species to be displayed.<br />
|-<br />
| colspan="3" font style="background: #ebebeb" | (The following tables display the mass/mole flow, mass/mole fraction of the individual species.)<br>(Each table (one for each phase) has the following columns (one row for each species). {{#ifeq:{{{Stream}}}|Output|Totals for fractions/flows and maximum values for SatIdx are on the last row of each phase section.|}})<br />
|-<br />
| MassFlow / Qm || style="background: #ebebeb"| Display || Visible when ''StreamView'' = '''Mass'''. The {{{masstype}}} flow of the {{{speciesstreamtype}}}.<br />
|- <br />
| MassFrac / Mf || style="background: #ebebeb"| Display || Visible when ''StreamView'' = '''Mass'''. The {{{masstype}}} fraction of the {{{speciesstreamtype}}}.<br />
|- <br />
| PhaseMassFrac / IPh:Mf || style="background: #ebebeb"| Display ||Visible when ''StreamView'' = '''Mass'''. The {{{masstype}}} fraction of the species in the displayed phase.<br />
|-<br />
| MoleFlow / QMl || style="background: #ebebeb"| Display ||Visible when ''StreamView'' = '''Mole'''. The {{{moletype}}} flow of the {{{speciesstreamtype}}}.<br />
|- <br />
| MoleFrac / Mlf || style="background: #ebebeb"| Display ||Visible when ''StreamView'' = '''Mole'''. The {{{moletype}}} fraction of the {{{speciesstreamtype}}}.<br />
|- <br />
| PhaseMoleFrac / IPh:Mlf || style="background: #ebebeb"| Display ||Visible when ''StreamView'' = '''Mole'''. The {{{moletype}}} fraction of the species in the displayed phase.</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:Common_Data_on_TPS_Input_Page&diff=78654Template:Common Data on TPS Input Page2024-03-03T13:40:07Z<p>Kevin.Heppner: </p>
<hr />
<div>|-<br />
| SpeciesName || [[Image: SpeciesLongButton.png]]<br>[[Image: SpeciesShortButton.png]]|| The Species:Long or Short button is used to change the display of the Species names between the Short form, the Chemical compound, or the longer species names.<br />
|-<br />
| Zeros || [[Image: Hide Zeros.png]]<br> [[Image: Show Zeros.png]] || If the Hide Zeros button is clicked, all species that have NO mass flow will be hidden.<br>If the Show Zeros button is clicked, all species will be displayed, including those with zero mass flow.<br />
|-<br />
| StreamView|| [[Image:Mass.png]]<br>[[Image:Molar.png]] || If the '''Mass''' button is clicked, the species will be shown in mass flow view. <br>If the '''Mole''' button is clicked, the species will be shown in mole flow view.<br />
|-<br />
|rowspan=4|Stream [[Image:Copy to Clipboard Button.png]] || Mass || Copy stream contents to clipboard, mass basis, for pasting into Excel. If ''Zeros'' is set to hide, zero values will not be copied to the clipboard.<br />
|-<br />
| Mole || Copy stream contents to clipboard, mole basis, for pasting into Excel. If ''Zeros'' is set to hide, zero values will not be copied to the clipboard.<br />
|-<br />
| Unmapped Mass || Copy unmapped stream contents to clipboard, mass basis, for pasting into Excel. If ''Zeros'' is set to hide, zero values will not be copied to the clipboard. Unmapped species are those which will not be mapped to the exiting SysCAD stream.<br />
|-<br />
| Unmapped Mole || Copy unmapped stream contents to clipboard, mole basis, for pasting into Excel. If ''Zeros'' is set to hide, zero values will not be copied to the clipboard. Unmapped species are those which will not be mapped to the exiting SysCAD stream.<br />
|-<br />
| colspan="3" font style="background: #ebebeb" |''Filter View''<br />
|-<br />
| Filter || [[File: Button - Filter On.png]]<br>[[Image: Button - Filter Off.png]] || This button will enable or disable the species filter options.<br />
|-<br />
| ShowUnmapped<br>(Only visible if Filter is enabled) || Tickbox|| When enabled, all species will be displayed. When disabled, only species that are mapped to a SysCAD species will be shown.<br />
|-<br />
| valign="top" rowspan="8" | Phases<br>(Only visible if Filter is enabled)|| All || No filtering of species based on phase.<br />
|-<br />
| Solids || Only show solid phase species, hide other species.<br />
|-<br />
| Liquids || Only show liquid phase species, hide other species.<br />
|-<br />
| Vapours || Only show vapour (gaseous) phase species, hide other species.<br />
|-<br />
| Solids & Liquids || Only show solid and liquid phase species, hide other species.<br />
|-<br />
| Solids & Vapours || Only show solid and vapour (gaseous) phase species, hide other species.<br />
|-<br />
| Liquids & Vapours || Only show liquid and vapour (gaseous) phase species, hide other species.<br />
|-<br />
| ''IPhase''|| Only show "IPhase" individual phase species, hide other species. The individual phases shown will depend on the {{{TPS}}} database chosen.<br />
|-<br />
{{#ifeq: {{{139only}}}| Yes|<br />
<td valign="top" rowspan="7" > Filters<br>(Only visible if Filter is enabled) <td> Content <td> All species which meet the Phase and Content criteria will be displayed.<br />
<tr><br />
<td> Content & MassFrac Limit <td> Only species which meet the Phase and Content criteria AND have a mass fraction greater than or equal to the user specified MassFrac.Limit will be displayed.<br />
<tr><br />
<td> Content & MassFrac Largest <td> Only the top N species (based on Mass Fraction) which meet the Phase and Content criteria will be displayed, where N = the user specified MassFrac.Count.<br />
<tr><br />
<td> Content & MassFrac Smallest <td> Only the bottom N species (based on Mass Fraction) which meet the Phase and Content criteria will be displayed, where N = the user specified MassFrac.Count.<br />
<tr><br />
|<br />
<td valign="top" rowspan="7" > Filters<br>(Only visible if Filter is enabled) <td> Content <td> All species which meet the Phase and Content criteria will be displayed.<br />
<tr><br />
<td> Content & MassFrac Limit <td> Only species which meet the Phase and Content criteria AND have a mass fraction greater than or equal to the user specified MassFrac.Limit will be displayed.<br />
<tr><br />
<td> Content & MassFrac Largest <td> Only the top N species (based on Mass Fraction) which meet the Phase and Content criteria will be displayed, where N = the user specified MassFrac.Count.<br />
<tr><br />
<td> Content & MassFrac Smallest <td> Only the bottom N species (based on Mass Fraction) which meet the Phase and Content criteria will be displayed, where N = the user specified MassFrac.Count.<br />
<tr><br />
}}<br />
|MassFrac Limit || Only species which meet the Phase criteria AND have a mass fraction greater than or equal to the user specified MassFrac.Limit will be displayed.<br />
|-<br />
|MassFrac Largest || Only the top N species (based on Mass Fraction) which meet the Phase criteria will be displayed, where N = the user specified MassFrac.Count.<br />
|-<br />
|MassFrac Smallest || Only the bottom N species (based on Mass Fraction) which meet the Phase criteria will be displayed, where N = the user specified MassFrac.Count.<br />
|-<br />
| valign="top" rowspan="6" | Content<br>(Only visible when one of <br>the ''Content'' '''Filter''' options<br> is selected)|| All || No filtering of species based on element or name.<br />
|-<br />
|Contains Any Element || This will display all species that contain any of the elements entered in their elemental definition.<br />
|-<br />
|Contains All Elements || This will display only species that contain ALL of the elements entered in their elemental definition.<br />
|-<br />
|Starts with ... || This will display species that start with the text entered based on the short or long species tag depending on the current SpeciesTag selection.<br />
|-<br />
|Contains any ... || This will display species that contain the text entered in the currently displayed short or long species tag.<br />
|-<br />
|Contains All ... || This will display species that contain ALL the separate text entered in the currently displayed short or long species tag.<br />
|-<br />
| Select || Input || Only visible if '''Content''' is NOT set to ''All''. The user specified Elements or text to filter the species list. Refer to [[Species Filter]] for more information and examples.<br />
|-<br />
|MassFrac.Limit ||Input|| Only visible if '''Filters''' = ''Content & MassFrac Limit'' or ''MassFrac Limit''. The user specified MassFrac Limit, the maximum mass fraction to be displayed.<br />
|-<br />
|MassFrac.Count ||Input|| Only visible if '''Filters''' = ''Content & MassFrac Largest'', ''Content & MassFrac Smallest'', ''MassFrac Largest'' or ''MassFrac Smallest''. The user specified Mass Frac Count, the maximum number of species to be displayed.<br />
|-<br />
| colspan="3" font style="background: #ebebeb" | (The following tables display the mass/mole flow, mass/mole fraction of the individual species.)<br>(Each table (one for each phase) has the following columns (one row for each species). Totals for fractions/flows and maximum values for SatIdx are on the last row of each phase section.)<br />
|-<br />
| MassFlow / Qm || style="background: #ebebeb"| Display || Visible when ''StreamView'' = '''Mass'''. The {{{masstype}}} flow of the {{{speciesstreamtype}}}.<br />
|- <br />
| MassFrac / Mf || style="background: #ebebeb"| Display || Visible when ''StreamView'' = '''Mass'''. The {{{masstype}}} fraction of the {{{speciesstreamtype}}}.<br />
|- <br />
| PhaseMassFrac / IPh:Mf || style="background: #ebebeb"| Display ||Visible when ''StreamView'' = '''Mass'''. The {{{masstype}}} fraction of the species in the displayed phase.<br />
|-<br />
| MoleFlow / QMl || style="background: #ebebeb"| Display ||Visible when ''StreamView'' = '''Mole'''. The {{{moletype}}} flow of the {{{speciesstreamtype}}}.<br />
|- <br />
| MoleFrac / Mlf || style="background: #ebebeb"| Display ||Visible when ''StreamView'' = '''Mole'''. The {{{moletype}}} fraction of the {{{speciesstreamtype}}}.<br />
|- <br />
| PhaseMoleFrac / IPh:Mlf || style="background: #ebebeb"| Display ||Visible when ''StreamView'' = '''Mole'''. The {{{moletype}}} fraction of the species in the displayed phase.</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:TPS_Input_Output_Diff_Tabs&diff=78653Template:TPS Input Output Diff Tabs2024-03-03T13:15:13Z<p>Kevin.Heppner: </p>
<hr />
<div>{| border="1" cellpadding="5" cellspacing="0" <br />
| '''Tag (Long/Short)''' || '''Input / Calc''' || '''Description/Calculated Variables / Options'''<br />
|-<br />
| colspan="3" font style="background: #ebebeb" | ''Stream Properties Summary''<br />
|-<br />
| colspan="3" font style="background: #ebebeb" | {{#switch: {{{Type}}}|<br />
Input=Feed|<br />
Output=Prod|<br />
Diff=Diff|<br />
MembraneInterface=MembraneInterface|<br />
}}...<br />
|-<br />
| Temperature / T || style="background: #ebebeb"| Display || The Temperature {{#switch: {{{Type}}}|<br />
Input=of the feed solution. This is calculated using the SysCAD enthalpy context.|<br />
Output=of the product solution. This is calculated by {{#ifeq: {{{TPS}}} | PHREEQC | SysCAD enthalpy context | {{{TPS}}} }}.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
|- <br />
| Pressure / P || style="background: #ebebeb"| Display || The Pressure {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
|- <br />
| MassFlow / Qm || style="background: #ebebeb"| Display || The Mass Flow {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
|- <br />
{{#ifeq: {{{displayH}}}|N|<br />
|<br />
<td> Hf@T <td style="background: #ebebeb"> Display <td> The Enthalpy {{#switch: {{{Type}}}|<br />
Input=of the feed solution per unit mass.|<br />
Output=of the product solution per unit mass.|<br />
Diff=difference between the feed and product solutions per unit mass.|<br />
MembraneInterface=of the solution at the reject side of the membrane per unit mass.|<br />
}} This is calculated by {{{TPS}}}.<br />
<tr><br />
<td> Enthalpy / totHf@T <td style="background: #ebebeb"> Display <td> The Enthalpy {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}} This is calculated by {{{TPS}}}.<br />
<tr><br />
}}<br />
|- <br />
{{#ifeq: {{{TPS}}}| ChemApp|<br />
<td> FreeEnergy / Gf@T <td style="background: #ebebeb" > Display <td> The Free Energy {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
<tr><br />
<td> Entropy <td font style="background: #ebebeb"> Display <td> The entropy {{#switch: {{{Type}}}|<br />
Input=of the feed solution.|<br />
Output=of the product solution.|<br />
Diff=difference between the feed and product solutions.|<br />
MembraneInterface=of the solution at the reject side of the membrane.|<br />
}}<br />
<tr><br />
|<br />
}}<br />
{{#ifeq: {{{Type}}}| Output|<br />
<!--{{#ifeq: {{{139only}}}| Yes|<br />
|<br />
<td> HeatFlow <td style="background: #ebebeb" > Display <td> Only displayed in Build 138. The heat flow required to achieve the product conditions relative to the feed conditions. Includes environmental heat loss if applicable.<br />
<tr><br />
}}--><br />
{{#ifeq: {{{TPS}}}| PHREEQC|<br />
<td> AqDensity / AqRho <td style="background: #ebebeb" > Display <td> The density of aqueous species (solution) in the final solution.<br />
<tr> <br />
<td> IonicStrength / I <td style="background: #ebebeb" > Display <td> The molal Ionic Strength of the final solution, based on the molality (moles/mass of H2O) and charge of the individual ions.<br />
<tr><br />
<td> pH <td style="background: #ebebeb" > Display <td> The pH of the final solution.<br />
<tr><br />
<td> Alkalinity <td style="background: #ebebeb" > Display <td> The alkalinity of the final solution.<br />
<tr><br />
<td> WaterActivity <td style="background: #ebebeb" > Display <td> The water activity of the final solution.<br />
<tr><br />
<td> TotalDissolvedSolids / TDS <td style="background: #ebebeb" > Display <td> The mass concentration of Total Dissolved Solids (total aqueous-water) in the final solution.<br />
<tr><br />
<td> OsmoticPressure / OsmP <td style="background: #ebebeb" > Display <td> The Osmotic Pressure of the final solution. Please refer to [[#Calculation of Osmotic Pressure|Model Theory - Calculation of Osmotic Pressure]] for more information.<br />
<tr><br />
<td> ORP <td style="background: #ebebeb" > Display <td> {{Available139|33865}} The oxidation reduction potential (ORP) of the final solution referenced to the standard hydrogen electrode (SHE). This is also known as <math>E_h</math>.<br />
<tr><br />
{{#ifeq: {{{139only}}}| Yes|<br />
<td> pKw <td font style="background: #ebebeb"> Display <td> The pKw of the final solution.<br />
<tr>|<br />
<!--<br />
<td> CheckpKwOfEqmSolution <td> [[Image:Check pKW.png]] <td> Only available in Build 138. If the user clicks on this button, SysCAD will calculate pKw.<br />
<tr><br />
--><br />
<td> pKw <td font style="background: #ebebeb"> Display <td> The pKw of the final solution. <!--In Build 138, this will only be calculated when the ''CheckpKwOfEqmSolution'' button is pressed.--><br />
<tr><br />
}}<br />
<td> RevMap.IonRxns <td> [[Image:Copy to Clipboard Button.png]] <td> A table of Ion Rebuild Reactions (ions->species) and their extents will be copied to the clipboard.<br />
<tr><br />
|<br />
}}<br />
{{#ifeq: {{{TPS}}}| AQSol|<br />
<td> IonicStrength / I <td style="background: #ebebeb" > Display <td> The molar Ionic Strength of the final solution.<br />
<tr><br />
<td> pH <td style="background: #ebebeb" > Display <td> The pH of the final solution.<br />
<tr><br />
<td> WaterActivity <td style="background: #ebebeb" > Display <td> The water activity of the final solution.<br />
<tr><br />
<td> TotalDissolvedSolids / TDS <td style="background: #ebebeb" > Display <td> The mass concentration of Total Dissolved Solids (total aqueous-water) in the final solution.<br />
<tr><br />
<td> OsmoticPressure / OsmP <td style="background: #ebebeb" > Display <td> The Osmotic Pressure of the final solution as calculated by AQSol.<br />
<tr><br />
{{#ifeq: {{{139only}}}| Yes|<br />
<td> pKw <td font style="background: #ebebeb"> Display <td> The pKw of the final solution.<br />
<tr>|<br />
<!--<br />
<td> CheckpKwOfEqmSolution <td> [[Image:Check pKW.png]] <td> Only available in Build 138. If the user clicks on this button, SysCAD will calculate pKw. --><br />
<tr><br />
<td> pKw <td font style="background: #ebebeb"> Display <td> The pKw of the final solution. <!--In Build 138, this will only be calculated when the ''CheckpKwOfEqmSolution'' button is pressed.--><br />
<tr><br />
}}<br />
<td> RevMap.IonRxns <td> [[Image:Copy to Clipboard Button.png]] <td> A table of Ion Rebuild Reactions (ions->species) and their extents will be copied to the clipboard.<br />
<tr><br />
|<br />
}}<br />
{{#ifeq: {{{TPS}}}| OLI|<br />
<td> RedoxPotential / ORP <td style="background: #ebebeb" > Display <td> <br />
<tr><br />
<td> VapCompressibility / VapCompress <td style="background: #ebebeb" > Display <td> <br />
<tr><br />
<td> Liquid1.VolumeFlow / Liq1.Qv <td style="background: #ebebeb" > Display <td> <br />
<tr><br />
<td> Liquid1.Enthalpy / Liq1.Hf@T <td style="background: #ebebeb" > Display <td> <br />
<tr><br />
<td> Liquid1.ThermCond / Liq1.k_cond <td style="background: #ebebeb" > Display <td> <br />
<tr><br />
<td> Vapour.ThermCond / Vap.k_cond <td style="background: #ebebeb" > Display <td> <br />
<tr><br />
<td> ElecConductivity / kappa@T <td font style="background: #ebebeb"> Display <td> The electric conductivity of the final solution.<br />
<tr><br />
<td> RevMap.IonRxns <td> [[Image:Copy to Clipboard Button.png]] <td> A table of Ion Rebuild Reactions (ions->species) and their extents will be copied to the clipboard.<br />
<tr><br />
|<br />
}}<br />
|<br />
}}<br />
| colspan="3" font style="background: #ebebeb" | {{#switch: {{{Type}}}|<br />
Input=Feed|<br />
Output=Prod|<br />
Diff=Diff|<br />
MembraneInterface=MembraneInterface|<br />
}}...<br />
{{#switch: {{{Type}}}|<br />
Input={{Common Data on TPS Input Page|TPS={{{TPS}}}|139only={{{139only}}}|masstype=mass|moletype=mole|speciesstreamtype=species in the feed stream}}|<br />
Output={{Common Data on TPS Input Page|TPS={{{TPS}}}|139only={{{139only}}}|masstype=mass|moletype=mole|speciesstreamtype=species in the product stream}}|<br />
Diff={{Common Data on TPS Input Page|TPS={{{TPS}}}|139only={{{139only}}}|masstype=difference in mass|moletype=difference in mole|speciesstreamtype=species}}|<br />
MembraneInterface={{Common Data on TPS Input Page|TPS={{{TPS}}}|139only={{{139only}}}|masstype=mass|moletype=mole|speciesstreamtype=species in the membrane interface stream}}|<br />
}}<br />
{{#ifeq: {{{Type}}}| Output|<br />
<tr> <br />
{{#ifeq: {{{TPS}}}| ChemApp|<br />
<td> Activity <td style="background: #ebebeb" > Display <td> Only shown for non-gaseous species. The activity of the species.<br />
<tr> <br />
<td> Fugacity <td style="background: #ebebeb" > Display <td> Only shown for gaseous species. The fugacity of the species.<br />
<tr> <br />
|<br />
<td> ActivityCoeff <td style="background: #ebebeb" > Display <td> Only shown for liquid/aqueous species. The activity coefficient of the species.<br />
<tr> <br />
<td> SatIdx <td style="background: #ebebeb" > Display <td> Only shown for solid species. The saturation index of the species relative to its equilibrium solubility.<br />
<tr> <br />
<td> SatIdx.Eff <td style="background: #ebebeb" > Display <td> Only shown for solid species. The saturation index of the species adjusted for user specified Saturation Index as defined in the [[{{{TPS}}} Model Configuration]].<br />
<tr> <br />
<td> Fugacity <td style="background: #ebebeb" > Display <td> Only shown for gaseous species. The fugacity of the species.<br />
<tr> <br />
<td> Fugacity.Eff <td style="background: #ebebeb" > Display <td> Only shown for gaseous species.<br />
}}<br />
|<br />
}}<br />
{{#ifeq: {{{Type}}}| MembraneInterface|<br />
<tr> <br />
<td> ActivityCoeff <td style="background: #ebebeb" > Display <td> Only shown for liquid/aqueous species. The activity coefficient of the species.<br />
<tr> <br />
<td> Fugacity <td style="background: #ebebeb" > Display <td> Only shown for gaseous species. The fugacity of the species.<br />
|<br />
}}<br />
|}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Overview&diff=78651OLI Overview2024-02-29T20:37:57Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category:Models]] [[Category:OLI]]<br />
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{OLI Header Tabs|currentpage=1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from OLI Database File]], [[Example - 06 OLI Projects|OLI Example Projects]]<br />
----<br />
<br />
{{Available139|31866}} - Next generation of OLI models in SysCAD as part of TCE. Older models have been archived as legacy models.<br />
{{TOC}}<br />
== Overview ==<br />
<br />
OLI Systems is a leading Electrolyte Simulation Software used to predicate equilibrium conditions and properties (such as pH) for aqueous chemistry.<br />
*It is developed and maintained by OLI Systems. ([https://www.olisystems.com/ olisystems.com])<br />
*To use OLI in SysCAD it is assumed that the user has some familiarity with the theory and use of the OLI Systems software programs.<br />
*The SysCAD OLI library option (in ScdOLI2.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons.<br />
*'''OLI Engine Runtime (32-bit)''' is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option.<br />
*"OLI Engine Runtime" includes '''OLI Chemistry Wizard''' which can be used to create the OLI database (dbs) files required by SysCAD.<br />
*The user may also purchase '''OLI Studio: Stream Analyzer''' from OLI Systems Inc. OLI Studio can also be used to create OLI database files required by SysCAD.<br />
<br />
Additional Notes:<br />
*The "OLI Engine: Developer Edition" License is NOT required to use OLI in SysCAD.<br />
*"OLI Studio" or "OLI Studio: Stream Analyzer" does not include an "OLI Engine Runtime" license, this needs to be purchased separately from OLI Systems.<br />
*"OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine" - this is the same thing.<br />
*KWA Kenwalt Australia (SysCAD) are OLI Alliance Partners. ([https://www.olisystems.com/partners/ Alliance Partners])<br />
*From {{Available139|||y}}, a TCE add-on is required instead of a legacy separate individual "SysCAD OLI" License add-on.<br />
*For legacy OLI models (ScdOLI.DLL) SysCAD version of Build 137, 138 or 139 is required. It cannot be used within the same project as the new TCE OLI Option. The legacy version will be discontinued in the next SysCAD Build.<br />
*OLI in SysCAD is not implemented as a Species Properties Model but as unit models for use at appropriate locations in a plant model.<br />
<br />
== OLI Systems Software ==<br />
[https://www.olisystems.com/software/oli-studio/ [[File:OLI_Logo.png |link=]]]<br />
<br />
The following are direct quotes from the OLI website:<br />
:''Analyze chemical streams, predict mineral scaling and corrosion in industrial chemical processes.''<br />
:''The behavior of electrolyte and water chemistry governs industrial chemical processes performance. OLI Systems makes it possible to deeply understand these behaviors to drive effective and efficient equipment design and process operations.''<br />
<br />
Please visit the [https://www.olisystems.com/software/oli-studio/ OLI Studio] for more information.<br />
<br />
The TCE add-on in SysCAD does not require "OLI Engine: Developer Edition" to be installed. However, users must obtain the "OLI Engine Runtime (32 bit)" license from OLI Systems, also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
== Checking that OLI SysCAD integration is working == <br />
<br />
We recommend performing the following checks prior to creating user OLI projects to ensure OLI SysCAD intergration is working correctly.<br />
# [[Licensing#Checking_Current_License_Information|Check the '''License Information''']], the following add-ons must be allowed (Yes)<br />
#* Energy Balance <br />
#* Integration Libraries (formerly SMDK Runtime)<br />
#* Models: TCE (PHREEQC, OLI, AQSol and ChemApp)<br />
# Check that "'''OLI Engine Runtime''' 32 bit" (also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine") is installed and licensed from OLI systems.<br />
#* SysCAD requires a valid OLI Engine to work. See [[#OLI Engine Version support|OLI Engine Version]]<br />
# Check that the distributed SysCAD OLI example project will run without issues.<br />
#*Open any of the \SysCAD139\Examples\06 OLI\OLIFull [[Example_-_06_OLI_Projects|example projects]], after project load, check the message window for any reported errors.<br />
#*If errors were encountered, use the messages provided to fix the errors and try again.<br />
<br />
== Models ==<br />
<br />
'''OLI Option unit models:'''<br />
* [[OLI Model Configuration]] - Used to define and view various options for the selected OLI database, including management of mapping of SysCAD species list to species list used in OLI.<br />
* [[OLI Direct Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a user defined OLI stream.<br />
* [[OLI Side Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a SysCAD stream in the current project.<br />
* [[OLI Reactor 2]] - Include this model in a SysCAD stream to use OLI to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
* [[OLI Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded OLI calculations.<br />
* [[OLI Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded OLI calculations.<br />
* [[OLI Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded OLI calculations. OLI can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[OLI Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using OLI species.<br />
* [[OLI Solvent Extraction]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded OLI calculations.<br />
* [[OLI Pond Model]] - Include this model in a SysCAD flowsheet (Dynamic mode) to specify a dynamic pond using embedded OLI calculations.<br />
'''OLI Legacy unit models:'''<br />
<br />
The following models are used for backward compatibility purposes only. These will be discontinued from Build 140 and users should convert any existing projects to use the TCE OLI models. See [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for suggested work flow.<br />
*[[OLI Chemistry Model]] - please change to the new model [[OLI Model Configuration]] <br />
*[[OLI Sample Model]] - please change to the new model [[OLI Direct Calc Model]] <br />
*[[OLI Reactor]] - please change to the new model [[OLI Reactor 2]]<br />
<br />
'''Species Mapping:'''<br />
*Ionlist is used to breakdown the species to ions. Please see [[TCE Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
OLI evaporation models using OLI dlls that do not incorporate VLE calculations are suitable for water evaporation only.<br />
<br />
== OLI SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new OLI SysCAD project group. <br />
<br />
If user only intend to use OLI for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use OLI to evaluate SysCAD streams, then follow (B).<br />
<br />
'''Important Notes''': <br />
<br />
#OLI software requires an OLI configuration file (*.dbs).<br />
#see [[#Referenced_File|OLI Referenced File]] for instructions.<br />
<br />
'''<big>(A)</big>''' Using OLI as stand-alone thermodynamic calculation engine to perform OLI equilibrium calculations:<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[OLI Model Configuration]]<br />
#*load in the OLI Model Definition file <br />
#Inset a [[OLI Direct Calc Model]]. Use the direct calc to perform OLI equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using OLI to evaluate SysCAD streams or as part of the SysCAD flowsheet:<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the OLI model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, OLI Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the OLI SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the required Species from the [[Species Configuration|Species Tab]].<br />
#*select the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create a SysCAD project. <br />
#Add [[OLI Model Configuration]], <br />
#*load in the OLI Model .dll file <br />
#*complete the OLI Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add OLI unit models to the project where appropriate.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from OLI Database File|Generate SysCAD database from OLI Database File]]<br />
<br />
== Referenced File ==<br />
<br />
The file that will be referenced by the SysCAD OLI Chemistry Model is the OLI Chemistry Model Database file created in OLI, e.g. NickelSpecies.dbs. <br />
<br />
The "OLI Chemistry Model" (dbs file), can be generated using "'''OLI Chemistry Wizard'''" or "'''OLI Studio'''".<br />
<br />
To generate an "OLI Chemistry Model" in OLI Studio perform the following steps:<br />
* Create a stream in a new project or for an existing OLI project (*.oad) file.<br />
* Select MSE or AQ databank.<br />
* On the Definition tab, add the components of interest.<br />
* Run an isothermal single point calculation.<br />
* If File Viewer tab is not visible, select menu Tools|Options. Then for Plug-Ins select the "OLI File Viewer" option and press OK.<br />
* On the File Viewer tab, for "File Type" select "Generated Model File". Push "Save File" button which will prompt to save a file with .dbs extension. This is the file required by SysCAD.<br />
<br />
'''Notes:'''<br />
# This file is essential for the OLI Chemistry Model in SysCAD to function. <br />
# The file can be saved at any location - it does not have to be saved in the SysCAD project.<br />
<br />
== OLI Engine Version support ==<br />
<br />
OLI Engine Runtime (32-bit) is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option. "OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
Multiple versions support of installed OLI engine is {{Available139|33127|y}}. This applies to both OLI_Legacy and OLI_TCE SysCAD integration. Therefore, it is possible to<br />
#use “SysCAD OLI Legacy” (scdoli.dll) with OLI engine version 10.x or 11.x, OR<br />
#use “SysCAD TCE OLI” (scdoli2.dll) with OLI engine version 10.x or 11.x. (Recommended)<br />
<br />
'''NOTES:'''<br />
*User must select the required OLI SysCAD integration (scdoli.dll OR scdoli2.dll) to use in the project, it is NOT possible to include both in the same project. <br />
*The OLI legacy integration models will be discontinued in future versions. User should convert any projects using OLI Legacy integration models to use the new OLI TCE suite of models. Please see [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for hints about project conversion.<br />
<br />
== Converting OLI Legacy Project to use OLI TCE models ==<br />
<br />
The new OLI TCE Integration suite of models were completely re-design from the ground up. There is no “automated” upgrade path for converting projects using OLI_Legacy models to OLI_TCE models. <br />
<br />
A recommended conversion workflow is:<br />
# Create folder '''"OLI_Legacy"''' + '''Cfgfiles''' subfolder: <br />
#*Store your OLI_Legacy project here<br />
#*make sure the Cfgfiles is set up to open the legacy project (using scdoli.dll)<br />
#*The purpose of this folder is so you can still open the legacy project for reference and comparison. <br />
# Create folder "'''OLI_Preparation'''" + '''Cfgfiles''' subfolder <br />
#*make a copy of the legacy project here, this is the project you need to work on in preparation for OLI_TCE model changes.<br />
#*The cfgfiles subfolder can be the same as OLI_Legacy.<br />
#*Open the project and remove all the OLI_Legacy models, do these in the following order:<br />
#**use "Change Unit" to change all the [[OLI Reactor]] to "Tank"<br />
#**Delete any [[OLI Sample Model]]<br />
#**Delete the [[OLI Chemistry Model]]<br />
#*Save the Project. The project should be free of any OLI_legacy models.<br />
#*''Edit the configuration file to remove the '''scdoli.dll''' group of models.''<br />
#*Reopen the model to check if the project can be loaded. If successful, then the project is ready for OLI_TCE model changes.<br />
# Create folder "'''OLI_TCE'''" + '''Cfgfiles''' subfolder: <br />
#*make a copy of the "OLI_Preparation" project here.<br />
#*''Edit the configuration file to use the '''scdoli2.dll''' group of models.''<br />
#*Edit the TCE tab to select the correct OLI options (engine version, dll path, database selection, etc.)<br />
#*Open the project using the edited configuration file.<br />
#*Edit the project in the following order:<br />
#**Add and setup [[OLI Model Configuration]] to replace the [[OLI Chemistry Model]]<br />
#**Add and setup [[OLI Direct Calc Model]] to replace the [[OLI Sample Model]]<br />
#**For any [[OLI Reactor]] that were changed to "Tank", use "Change Unit" to change them to [[OLI Reactor 2]] or any other more relevant OLI unit [[#Models|models]]. <br />
#*Fix the controls and reports.<br />
#*Save the project. <br />
#*Solve and debug the project as usual.<br />
#*If possible, open the OLI_Legacy model for reference or comparison.<br />
<!--<br />
== Liquid 2 Functionality in SysCAD ==<br />
<br />
{{Available139|XXXXX}} liquid 2 functionality is available for use in the SysCAD-OLI interface. This functionality allows for the modelling of unit operations where two immiscible liquids are present, such as [[OLI Solvent Extraction]]. To use this functionality, the SysCAD configuration file must be manually updated to indicate the individual phase in the SysCAD database which corresponds with the second liquid phase in the OLI dbs file. To do this, please do the following:<br />
<br />
#Open the cfg file within the CfgFiles folder using a text editor<br />
#Do a search for "[OLI]" to locate the OLI section of the file<br />
#Update the cfg file in a similar manner to that shown in the following example.<br />
<br />
==== Example ====<br />
Given an OLI section that looks like this in the cfg file:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
<br />
where:<br />
*SolvEx.dbs contains a second liquid phase<br />
*The SysCAD database contains corresponding species for mapping to the second liquid phase using the individual phase "o" for organic, i.e.:<br />
**C12H26(o)<br />
**R3NH2SO4(o)<br />
**etc...<br />
<br />
the cfg file [OLI] section should be modified to this:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
'''Second_Liquid_Phase_Name0=o'''<br />
--></div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Overview&diff=78650OLI Overview2024-02-29T20:37:03Z<p>Kevin.Heppner: /* Liquid 2 Functionality in SysCAD */</p>
<hr />
<div>[[Category:Models]] [[Category:OLI]]<br />
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{OLI Header Tabs|currentpage=1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from OLI Database File]], [[Example - 06 OLI Projects|OLI Example Projects]]<br />
----<br />
<br />
{{Available139|31866}} - Next generation of OLI models in SysCAD as part of TCE. Older models have been archived as legacy models.<br />
{{TOC}}<br />
== Overview ==<br />
<br />
OLI Systems is a leading Electrolyte Simulation Software used to predicate equilibrium conditions and properties (such as pH) for aqueous chemistry.<br />
*It is developed and maintained by OLI Systems. ([https://www.olisystems.com/ olisystems.com])<br />
*To use OLI in SysCAD it is assumed that the user has some familiarity with the theory and use of the OLI Systems software programs.<br />
*The SysCAD OLI library option (in ScdOLI2.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons.<br />
*'''OLI Engine Runtime (32-bit)''' is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option.<br />
*"OLI Engine Runtime" includes '''OLI Chemistry Wizard''' which can be used to create the OLI database (dbs) files required by SysCAD.<br />
*The user may also purchase '''OLI Studio: Stream Analyzer''' from OLI Systems Inc. OLI Studio can also be used to create OLI database files required by SysCAD.<br />
<br />
Additional Notes:<br />
*The "OLI Engine: Developer Edition" License is NOT required to use OLI in SysCAD.<br />
*"OLI Studio" or "OLI Studio: Stream Analyzer" does not include an "OLI Engine Runtime" license, this needs to be purchased separately from OLI Systems.<br />
*"OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine" - this is the same thing.<br />
*KWA Kenwalt Australia (SysCAD) are OLI Alliance Partners. ([https://www.olisystems.com/partners/ Alliance Partners])<br />
*From {{Available139|||y}}, a TCE add-on is required instead of a legacy separate individual "SysCAD OLI" License add-on.<br />
*For legacy OLI models (ScdOLI.DLL) SysCAD version of Build 137, 138 or 139 is required. It cannot be used within the same project as the new TCE OLI Option. The legacy version will be discontinued in the next SysCAD Build.<br />
*OLI in SysCAD is not implemented as a Species Properties Model but as unit models for use at appropriate locations in a plant model.<br />
<br />
== OLI Systems Software ==<br />
[https://www.olisystems.com/software/oli-studio/ [[File:OLI_Logo.png |link=]]]<br />
<br />
The following are direct quotes from the OLI website:<br />
:''Analyze chemical streams, predict mineral scaling and corrosion in industrial chemical processes.''<br />
:''The behavior of electrolyte and water chemistry governs industrial chemical processes performance. OLI Systems makes it possible to deeply understand these behaviors to drive effective and efficient equipment design and process operations.''<br />
<br />
Please visit the [https://www.olisystems.com/software/oli-studio/ OLI Studio] for more information.<br />
<br />
The TCE add-on in SysCAD does not require "OLI Engine: Developer Edition" to be installed. However, users must obtain the "OLI Engine Runtime (32 bit)" license from OLI Systems, also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
== Checking that OLI SysCAD integration is working == <br />
<br />
We recommend performing the following checks prior to creating user OLI projects to ensure OLI SysCAD intergration is working correctly.<br />
# [[Licensing#Checking_Current_License_Information|Check the '''License Information''']], the following add-ons must be allowed (Yes)<br />
#* Energy Balance <br />
#* Integration Libraries (formerly SMDK Runtime)<br />
#* Models: TCE (PHREEQC, OLI, AQSol and ChemApp)<br />
# Check that "'''OLI Engine Runtime''' 32 bit" (also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine") is installed and licensed from OLI systems.<br />
#* SysCAD requires a valid OLI Engine to work. See [[#OLI Engine Version support|OLI Engine Version]]<br />
# Check that the distributed SysCAD OLI example project will run without issues.<br />
#*Open any of the \SysCAD139\Examples\06 OLI\OLIFull [[Example_-_06_OLI_Projects|example projects]], after project load, check the message window for any reported errors.<br />
#*If errors were encountered, use the messages provided to fix the errors and try again.<br />
<br />
== Models ==<br />
<br />
'''OLI Option unit models:'''<br />
* [[OLI Model Configuration]] - Used to define and view various options for the selected OLI database, including management of mapping of SysCAD species list to species list used in OLI.<br />
* [[OLI Direct Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a user defined OLI stream.<br />
* [[OLI Side Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a SysCAD stream in the current project.<br />
* [[OLI Reactor 2]] - Include this model in a SysCAD stream to use OLI to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
* [[OLI Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded OLI calculations.<br />
* [[OLI Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded OLI calculations.<br />
* [[OLI Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded OLI calculations. OLI can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[OLI Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using OLI species.<br />
* [[OLI Solvent Extraction]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded OLI calculations.<br />
* [[OLI Pond Model]] - Include this model in a SysCAD flowsheet (Dynamic mode) to specify a dynamic pond using embedded OLI calculations.<br />
'''OLI Legacy unit models:'''<br />
<br />
The following models are used for backward compatibility purposes only. These will be discontinued from Build 140 and users should convert any existing projects to use the TCE OLI models. See [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for suggested work flow.<br />
*[[OLI Chemistry Model]] - please change to the new model [[OLI Model Configuration]] <br />
*[[OLI Sample Model]] - please change to the new model [[OLI Direct Calc Model]] <br />
*[[OLI Reactor]] - please change to the new model [[OLI Reactor 2]]<br />
<br />
'''Species Mapping:'''<br />
*Ionlist is used to breakdown the species to ions. Please see [[TCE Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
OLI evaporation models using OLI dlls that do not incorporate VLE calculations are suitable for water evaporation only.<br />
<br />
== OLI SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new OLI SysCAD project group. <br />
<br />
If user only intend to use OLI for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use OLI to evaluate SysCAD streams, then follow (B).<br />
<br />
'''Important Notes''': <br />
<br />
#OLI software requires an OLI configuration file (*.dbs).<br />
#see [[#Referenced_File|OLI Referenced File]] for instructions.<br />
<br />
'''<big>(A)</big>''' Using OLI as stand-alone thermodynamic calculation engine to perform OLI equilibrium calculations:<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[OLI Model Configuration]]<br />
#*load in the OLI Model Definition file <br />
#Inset a [[OLI Direct Calc Model]]. Use the direct calc to perform OLI equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using OLI to evaluate SysCAD streams or as part of the SysCAD flowsheet:<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the OLI model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, OLI Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the OLI SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the required Species from the [[Species Configuration|Species Tab]].<br />
#*select the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create a SysCAD project. <br />
#Add [[OLI Model Configuration]], <br />
#*load in the OLI Model .dll file <br />
#*complete the OLI Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add OLI unit models to the project where appropriate.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from OLI Database File|Generate SysCAD database from OLI Database File]]<br />
<br />
== Referenced File ==<br />
<br />
The file that will be referenced by the SysCAD OLI Chemistry Model is the OLI Chemistry Model Database file created in OLI, e.g. NickelSpecies.dbs. <br />
<br />
The "OLI Chemistry Model" (dbs file), can be generated using "'''OLI Chemistry Wizard'''" or "'''OLI Studio'''".<br />
<br />
To generate an "OLI Chemistry Model" in OLI Studio perform the following steps:<br />
* Create a stream in a new project or for an existing OLI project (*.oad) file.<br />
* Select MSE or AQ databank.<br />
* On the Definition tab, add the components of interest.<br />
* Run an isothermal single point calculation.<br />
* If File Viewer tab is not visible, select menu Tools|Options. Then for Plug-Ins select the "OLI File Viewer" option and press OK.<br />
* On the File Viewer tab, for "File Type" select "Generated Model File". Push "Save File" button which will prompt to save a file with .dbs extension. This is the file required by SysCAD.<br />
<br />
'''Notes:'''<br />
# This file is essential for the OLI Chemistry Model in SysCAD to function. <br />
# The file can be saved at any location - it does not have to be saved in the SysCAD project.<br />
<br />
== OLI Engine Version support ==<br />
<br />
OLI Engine Runtime (32-bit) is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option. "OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
Multiple versions support of installed OLI engine is {{Available139|33127|y}}. This applies to both OLI_Legacy and OLI_TCE SysCAD integration. Therefore, it is possible to<br />
#use “SysCAD OLI Legacy” (scdoli.dll) with OLI engine version 10.x or 11.x, OR<br />
#use “SysCAD TCE OLI” (scdoli2.dll) with OLI engine version 10.x or 11.x. (Recommended)<br />
<br />
'''NOTES:'''<br />
*User must select the required OLI SysCAD integration (scdoli.dll OR scdoli2.dll) to use in the project, it is NOT possible to include both in the same project. <br />
*The OLI legacy integration models will be discontinued in future versions. User should convert any projects using OLI Legacy integration models to use the new OLI TCE suite of models. Please see [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for hints about project conversion.<br />
<br />
== Converting OLI Legacy Project to use OLI TCE models ==<br />
<br />
The new OLI TCE Integration suite of models were completely re-design from the ground up. There is no “automated” upgrade path for converting projects using OLI_Legacy models to OLI_TCE models. <br />
<br />
A recommended conversion workflow is:<br />
# Create folder '''"OLI_Legacy"''' + '''Cfgfiles''' subfolder: <br />
#*Store your OLI_Legacy project here<br />
#*make sure the Cfgfiles is set up to open the legacy project (using scdoli.dll)<br />
#*The purpose of this folder is so you can still open the legacy project for reference and comparison. <br />
# Create folder "'''OLI_Preparation'''" + '''Cfgfiles''' subfolder <br />
#*make a copy of the legacy project here, this is the project you need to work on in preparation for OLI_TCE model changes.<br />
#*The cfgfiles subfolder can be the same as OLI_Legacy.<br />
#*Open the project and remove all the OLI_Legacy models, do these in the following order:<br />
#**use "Change Unit" to change all the [[OLI Reactor]] to "Tank"<br />
#**Delete any [[OLI Sample Model]]<br />
#**Delete the [[OLI Chemistry Model]]<br />
#*Save the Project. The project should be free of any OLI_legacy models.<br />
#*''Edit the configuration file to remove the '''scdoli.dll''' group of models.''<br />
#*Reopen the model to check if the project can be loaded. If successful, then the project is ready for OLI_TCE model changes.<br />
# Create folder "'''OLI_TCE'''" + '''Cfgfiles''' subfolder: <br />
#*make a copy of the "OLI_Preparation" project here.<br />
#*''Edit the configuration file to use the '''scdoli2.dll''' group of models.''<br />
#*Edit the TCE tab to select the correct OLI options (engine version, dll path, database selection, etc.)<br />
#*Open the project using the edited configuration file.<br />
#*Edit the project in the following order:<br />
#**Add and setup [[OLI Model Configuration]] to replace the [[OLI Chemistry Model]]<br />
#**Add and setup [[OLI Direct Calc Model]] to replace the [[OLI Sample Model]]<br />
#**For any [[OLI Reactor]] that were changed to "Tank", use "Change Unit" to change them to [[OLI Reactor 2]] or any other more relevant OLI unit [[#Models|models]]. <br />
#*Fix the controls and reports.<br />
#*Save the project. <br />
#*Solve and debug the project as usual.<br />
#*If possible, open the OLI_Legacy model for reference or comparison.<br />
<br />
== Liquid 2 Functionality in SysCAD ==<br />
<br />
{{Available139|XXXXX}} liquid 2 functionality is available for use in the SysCAD-OLI interface. This functionality allows for the modelling of unit operations where two immiscible liquids are present, such as [[OLI Solvent Extraction]]. To use this functionality, the SysCAD configuration file must be manually updated to indicate the individual phase in the SysCAD database which corresponds with the second liquid phase in the OLI dbs file. To do this, please do the following:<br />
<br />
#Open the cfg file within the CfgFiles folder using a text editor<br />
#Do a search for "[OLI]" to locate the OLI section of the file<br />
#Update the cfg file in a similar manner to that shown in the following example.<br />
<br />
==== Example ====<br />
Given an OLI section that looks like this in the cfg file:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
<br />
where:<br />
*SolvEx.dbs contains a second liquid phase<br />
*The SysCAD database contains corresponding species for mapping to the second liquid phase using the individual phase "o" for organic, i.e.:<br />
**C12H26(o)<br />
**R3NH2SO4(o)<br />
**etc...<br />
<br />
the cfg file [OLI] section should be modified to this:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
'''Second_Liquid_Phase_Name0=o'''</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Overview&diff=78649OLI Overview2024-02-29T20:36:40Z<p>Kevin.Heppner: /* Liquid 2 Functionality in SysCAD */</p>
<hr />
<div>[[Category:Models]] [[Category:OLI]]<br />
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{OLI Header Tabs|currentpage=1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from OLI Database File]], [[Example - 06 OLI Projects|OLI Example Projects]]<br />
----<br />
<br />
{{Available139|31866}} - Next generation of OLI models in SysCAD as part of TCE. Older models have been archived as legacy models.<br />
{{TOC}}<br />
== Overview ==<br />
<br />
OLI Systems is a leading Electrolyte Simulation Software used to predicate equilibrium conditions and properties (such as pH) for aqueous chemistry.<br />
*It is developed and maintained by OLI Systems. ([https://www.olisystems.com/ olisystems.com])<br />
*To use OLI in SysCAD it is assumed that the user has some familiarity with the theory and use of the OLI Systems software programs.<br />
*The SysCAD OLI library option (in ScdOLI2.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons.<br />
*'''OLI Engine Runtime (32-bit)''' is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option.<br />
*"OLI Engine Runtime" includes '''OLI Chemistry Wizard''' which can be used to create the OLI database (dbs) files required by SysCAD.<br />
*The user may also purchase '''OLI Studio: Stream Analyzer''' from OLI Systems Inc. OLI Studio can also be used to create OLI database files required by SysCAD.<br />
<br />
Additional Notes:<br />
*The "OLI Engine: Developer Edition" License is NOT required to use OLI in SysCAD.<br />
*"OLI Studio" or "OLI Studio: Stream Analyzer" does not include an "OLI Engine Runtime" license, this needs to be purchased separately from OLI Systems.<br />
*"OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine" - this is the same thing.<br />
*KWA Kenwalt Australia (SysCAD) are OLI Alliance Partners. ([https://www.olisystems.com/partners/ Alliance Partners])<br />
*From {{Available139|||y}}, a TCE add-on is required instead of a legacy separate individual "SysCAD OLI" License add-on.<br />
*For legacy OLI models (ScdOLI.DLL) SysCAD version of Build 137, 138 or 139 is required. It cannot be used within the same project as the new TCE OLI Option. The legacy version will be discontinued in the next SysCAD Build.<br />
*OLI in SysCAD is not implemented as a Species Properties Model but as unit models for use at appropriate locations in a plant model.<br />
<br />
== OLI Systems Software ==<br />
[https://www.olisystems.com/software/oli-studio/ [[File:OLI_Logo.png |link=]]]<br />
<br />
The following are direct quotes from the OLI website:<br />
:''Analyze chemical streams, predict mineral scaling and corrosion in industrial chemical processes.''<br />
:''The behavior of electrolyte and water chemistry governs industrial chemical processes performance. OLI Systems makes it possible to deeply understand these behaviors to drive effective and efficient equipment design and process operations.''<br />
<br />
Please visit the [https://www.olisystems.com/software/oli-studio/ OLI Studio] for more information.<br />
<br />
The TCE add-on in SysCAD does not require "OLI Engine: Developer Edition" to be installed. However, users must obtain the "OLI Engine Runtime (32 bit)" license from OLI Systems, also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
== Checking that OLI SysCAD integration is working == <br />
<br />
We recommend performing the following checks prior to creating user OLI projects to ensure OLI SysCAD intergration is working correctly.<br />
# [[Licensing#Checking_Current_License_Information|Check the '''License Information''']], the following add-ons must be allowed (Yes)<br />
#* Energy Balance <br />
#* Integration Libraries (formerly SMDK Runtime)<br />
#* Models: TCE (PHREEQC, OLI, AQSol and ChemApp)<br />
# Check that "'''OLI Engine Runtime''' 32 bit" (also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine") is installed and licensed from OLI systems.<br />
#* SysCAD requires a valid OLI Engine to work. See [[#OLI Engine Version support|OLI Engine Version]]<br />
# Check that the distributed SysCAD OLI example project will run without issues.<br />
#*Open any of the \SysCAD139\Examples\06 OLI\OLIFull [[Example_-_06_OLI_Projects|example projects]], after project load, check the message window for any reported errors.<br />
#*If errors were encountered, use the messages provided to fix the errors and try again.<br />
<br />
== Models ==<br />
<br />
'''OLI Option unit models:'''<br />
* [[OLI Model Configuration]] - Used to define and view various options for the selected OLI database, including management of mapping of SysCAD species list to species list used in OLI.<br />
* [[OLI Direct Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a user defined OLI stream.<br />
* [[OLI Side Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a SysCAD stream in the current project.<br />
* [[OLI Reactor 2]] - Include this model in a SysCAD stream to use OLI to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
* [[OLI Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded OLI calculations.<br />
* [[OLI Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded OLI calculations.<br />
* [[OLI Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded OLI calculations. OLI can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[OLI Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using OLI species.<br />
* [[OLI Solvent Extraction]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded OLI calculations.<br />
* [[OLI Pond Model]] - Include this model in a SysCAD flowsheet (Dynamic mode) to specify a dynamic pond using embedded OLI calculations.<br />
'''OLI Legacy unit models:'''<br />
<br />
The following models are used for backward compatibility purposes only. These will be discontinued from Build 140 and users should convert any existing projects to use the TCE OLI models. See [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for suggested work flow.<br />
*[[OLI Chemistry Model]] - please change to the new model [[OLI Model Configuration]] <br />
*[[OLI Sample Model]] - please change to the new model [[OLI Direct Calc Model]] <br />
*[[OLI Reactor]] - please change to the new model [[OLI Reactor 2]]<br />
<br />
'''Species Mapping:'''<br />
*Ionlist is used to breakdown the species to ions. Please see [[TCE Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
OLI evaporation models using OLI dlls that do not incorporate VLE calculations are suitable for water evaporation only.<br />
<br />
== OLI SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new OLI SysCAD project group. <br />
<br />
If user only intend to use OLI for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use OLI to evaluate SysCAD streams, then follow (B).<br />
<br />
'''Important Notes''': <br />
<br />
#OLI software requires an OLI configuration file (*.dbs).<br />
#see [[#Referenced_File|OLI Referenced File]] for instructions.<br />
<br />
'''<big>(A)</big>''' Using OLI as stand-alone thermodynamic calculation engine to perform OLI equilibrium calculations:<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[OLI Model Configuration]]<br />
#*load in the OLI Model Definition file <br />
#Inset a [[OLI Direct Calc Model]]. Use the direct calc to perform OLI equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using OLI to evaluate SysCAD streams or as part of the SysCAD flowsheet:<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the OLI model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, OLI Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the OLI SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the required Species from the [[Species Configuration|Species Tab]].<br />
#*select the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create a SysCAD project. <br />
#Add [[OLI Model Configuration]], <br />
#*load in the OLI Model .dll file <br />
#*complete the OLI Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add OLI unit models to the project where appropriate.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from OLI Database File|Generate SysCAD database from OLI Database File]]<br />
<br />
== Referenced File ==<br />
<br />
The file that will be referenced by the SysCAD OLI Chemistry Model is the OLI Chemistry Model Database file created in OLI, e.g. NickelSpecies.dbs. <br />
<br />
The "OLI Chemistry Model" (dbs file), can be generated using "'''OLI Chemistry Wizard'''" or "'''OLI Studio'''".<br />
<br />
To generate an "OLI Chemistry Model" in OLI Studio perform the following steps:<br />
* Create a stream in a new project or for an existing OLI project (*.oad) file.<br />
* Select MSE or AQ databank.<br />
* On the Definition tab, add the components of interest.<br />
* Run an isothermal single point calculation.<br />
* If File Viewer tab is not visible, select menu Tools|Options. Then for Plug-Ins select the "OLI File Viewer" option and press OK.<br />
* On the File Viewer tab, for "File Type" select "Generated Model File". Push "Save File" button which will prompt to save a file with .dbs extension. This is the file required by SysCAD.<br />
<br />
'''Notes:'''<br />
# This file is essential for the OLI Chemistry Model in SysCAD to function. <br />
# The file can be saved at any location - it does not have to be saved in the SysCAD project.<br />
<br />
== OLI Engine Version support ==<br />
<br />
OLI Engine Runtime (32-bit) is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option. "OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
Multiple versions support of installed OLI engine is {{Available139|33127|y}}. This applies to both OLI_Legacy and OLI_TCE SysCAD integration. Therefore, it is possible to<br />
#use “SysCAD OLI Legacy” (scdoli.dll) with OLI engine version 10.x or 11.x, OR<br />
#use “SysCAD TCE OLI” (scdoli2.dll) with OLI engine version 10.x or 11.x. (Recommended)<br />
<br />
'''NOTES:'''<br />
*User must select the required OLI SysCAD integration (scdoli.dll OR scdoli2.dll) to use in the project, it is NOT possible to include both in the same project. <br />
*The OLI legacy integration models will be discontinued in future versions. User should convert any projects using OLI Legacy integration models to use the new OLI TCE suite of models. Please see [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for hints about project conversion.<br />
<br />
== Converting OLI Legacy Project to use OLI TCE models ==<br />
<br />
The new OLI TCE Integration suite of models were completely re-design from the ground up. There is no “automated” upgrade path for converting projects using OLI_Legacy models to OLI_TCE models. <br />
<br />
A recommended conversion workflow is:<br />
# Create folder '''"OLI_Legacy"''' + '''Cfgfiles''' subfolder: <br />
#*Store your OLI_Legacy project here<br />
#*make sure the Cfgfiles is set up to open the legacy project (using scdoli.dll)<br />
#*The purpose of this folder is so you can still open the legacy project for reference and comparison. <br />
# Create folder "'''OLI_Preparation'''" + '''Cfgfiles''' subfolder <br />
#*make a copy of the legacy project here, this is the project you need to work on in preparation for OLI_TCE model changes.<br />
#*The cfgfiles subfolder can be the same as OLI_Legacy.<br />
#*Open the project and remove all the OLI_Legacy models, do these in the following order:<br />
#**use "Change Unit" to change all the [[OLI Reactor]] to "Tank"<br />
#**Delete any [[OLI Sample Model]]<br />
#**Delete the [[OLI Chemistry Model]]<br />
#*Save the Project. The project should be free of any OLI_legacy models.<br />
#*''Edit the configuration file to remove the '''scdoli.dll''' group of models.''<br />
#*Reopen the model to check if the project can be loaded. If successful, then the project is ready for OLI_TCE model changes.<br />
# Create folder "'''OLI_TCE'''" + '''Cfgfiles''' subfolder: <br />
#*make a copy of the "OLI_Preparation" project here.<br />
#*''Edit the configuration file to use the '''scdoli2.dll''' group of models.''<br />
#*Edit the TCE tab to select the correct OLI options (engine version, dll path, database selection, etc.)<br />
#*Open the project using the edited configuration file.<br />
#*Edit the project in the following order:<br />
#**Add and setup [[OLI Model Configuration]] to replace the [[OLI Chemistry Model]]<br />
#**Add and setup [[OLI Direct Calc Model]] to replace the [[OLI Sample Model]]<br />
#**For any [[OLI Reactor]] that were changed to "Tank", use "Change Unit" to change them to [[OLI Reactor 2]] or any other more relevant OLI unit [[#Models|models]]. <br />
#*Fix the controls and reports.<br />
#*Save the project. <br />
#*Solve and debug the project as usual.<br />
#*If possible, open the OLI_Legacy model for reference or comparison.<br />
<br />
== Liquid 2 Functionality in SysCAD ==<br />
<br />
{{Available139|XXXXX}} liquid 2 functionality is available for use in the SysCAD-OLI interface. This functionality allows for the modelling of unit operations where two immiscible liquids are present, such as [[OLI Solvent Extraction]]. To use this functionality, the SysCAD configuration file must be manually updated to indicate the individual phase in the SysCAD database which corresponds with the second liquid phase in the OLI dbs file. To do this, please do the following:<br />
<br />
#Open the cfg file within the CfgFiles folder using a text editor<br />
#Do a search for "[OLI]" to locate the OLI section of the file<br />
#Update the cfg file in a similar manner to that shown in the following example.<br />
<br />
==== DBS File (Containing a Second Liquid Phase) Update Example ====<br />
Given an OLI section that looks like this in the cfg file:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
<br />
where:<br />
*SolvEx.dbs contains a second liquid phase<br />
*The SysCAD database contains corresponding species for mapping to the second liquid phase using the individual phase "o" for organic, i.e.:<br />
**C12H26(o)<br />
**R3NH2SO4(o)<br />
**etc...<br />
<br />
the cfg file [OLI] section should be modified to this:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
'''Second_Liquid_Phase_Name0=o'''</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Overview&diff=78648OLI Overview2024-02-29T20:35:30Z<p>Kevin.Heppner: /* Liquid 2 Functionality in SysCAD */</p>
<hr />
<div>[[Category:Models]] [[Category:OLI]]<br />
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{OLI Header Tabs|currentpage=1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from OLI Database File]], [[Example - 06 OLI Projects|OLI Example Projects]]<br />
----<br />
<br />
{{Available139|31866}} - Next generation of OLI models in SysCAD as part of TCE. Older models have been archived as legacy models.<br />
{{TOC}}<br />
== Overview ==<br />
<br />
OLI Systems is a leading Electrolyte Simulation Software used to predicate equilibrium conditions and properties (such as pH) for aqueous chemistry.<br />
*It is developed and maintained by OLI Systems. ([https://www.olisystems.com/ olisystems.com])<br />
*To use OLI in SysCAD it is assumed that the user has some familiarity with the theory and use of the OLI Systems software programs.<br />
*The SysCAD OLI library option (in ScdOLI2.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons.<br />
*'''OLI Engine Runtime (32-bit)''' is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option.<br />
*"OLI Engine Runtime" includes '''OLI Chemistry Wizard''' which can be used to create the OLI database (dbs) files required by SysCAD.<br />
*The user may also purchase '''OLI Studio: Stream Analyzer''' from OLI Systems Inc. OLI Studio can also be used to create OLI database files required by SysCAD.<br />
<br />
Additional Notes:<br />
*The "OLI Engine: Developer Edition" License is NOT required to use OLI in SysCAD.<br />
*"OLI Studio" or "OLI Studio: Stream Analyzer" does not include an "OLI Engine Runtime" license, this needs to be purchased separately from OLI Systems.<br />
*"OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine" - this is the same thing.<br />
*KWA Kenwalt Australia (SysCAD) are OLI Alliance Partners. ([https://www.olisystems.com/partners/ Alliance Partners])<br />
*From {{Available139|||y}}, a TCE add-on is required instead of a legacy separate individual "SysCAD OLI" License add-on.<br />
*For legacy OLI models (ScdOLI.DLL) SysCAD version of Build 137, 138 or 139 is required. It cannot be used within the same project as the new TCE OLI Option. The legacy version will be discontinued in the next SysCAD Build.<br />
*OLI in SysCAD is not implemented as a Species Properties Model but as unit models for use at appropriate locations in a plant model.<br />
<br />
== OLI Systems Software ==<br />
[https://www.olisystems.com/software/oli-studio/ [[File:OLI_Logo.png |link=]]]<br />
<br />
The following are direct quotes from the OLI website:<br />
:''Analyze chemical streams, predict mineral scaling and corrosion in industrial chemical processes.''<br />
:''The behavior of electrolyte and water chemistry governs industrial chemical processes performance. OLI Systems makes it possible to deeply understand these behaviors to drive effective and efficient equipment design and process operations.''<br />
<br />
Please visit the [https://www.olisystems.com/software/oli-studio/ OLI Studio] for more information.<br />
<br />
The TCE add-on in SysCAD does not require "OLI Engine: Developer Edition" to be installed. However, users must obtain the "OLI Engine Runtime (32 bit)" license from OLI Systems, also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
== Checking that OLI SysCAD integration is working == <br />
<br />
We recommend performing the following checks prior to creating user OLI projects to ensure OLI SysCAD intergration is working correctly.<br />
# [[Licensing#Checking_Current_License_Information|Check the '''License Information''']], the following add-ons must be allowed (Yes)<br />
#* Energy Balance <br />
#* Integration Libraries (formerly SMDK Runtime)<br />
#* Models: TCE (PHREEQC, OLI, AQSol and ChemApp)<br />
# Check that "'''OLI Engine Runtime''' 32 bit" (also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine") is installed and licensed from OLI systems.<br />
#* SysCAD requires a valid OLI Engine to work. See [[#OLI Engine Version support|OLI Engine Version]]<br />
# Check that the distributed SysCAD OLI example project will run without issues.<br />
#*Open any of the \SysCAD139\Examples\06 OLI\OLIFull [[Example_-_06_OLI_Projects|example projects]], after project load, check the message window for any reported errors.<br />
#*If errors were encountered, use the messages provided to fix the errors and try again.<br />
<br />
== Models ==<br />
<br />
'''OLI Option unit models:'''<br />
* [[OLI Model Configuration]] - Used to define and view various options for the selected OLI database, including management of mapping of SysCAD species list to species list used in OLI.<br />
* [[OLI Direct Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a user defined OLI stream.<br />
* [[OLI Side Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a SysCAD stream in the current project.<br />
* [[OLI Reactor 2]] - Include this model in a SysCAD stream to use OLI to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
* [[OLI Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded OLI calculations.<br />
* [[OLI Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded OLI calculations.<br />
* [[OLI Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded OLI calculations. OLI can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[OLI Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using OLI species.<br />
* [[OLI Solvent Extraction]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded OLI calculations.<br />
* [[OLI Pond Model]] - Include this model in a SysCAD flowsheet (Dynamic mode) to specify a dynamic pond using embedded OLI calculations.<br />
'''OLI Legacy unit models:'''<br />
<br />
The following models are used for backward compatibility purposes only. These will be discontinued from Build 140 and users should convert any existing projects to use the TCE OLI models. See [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for suggested work flow.<br />
*[[OLI Chemistry Model]] - please change to the new model [[OLI Model Configuration]] <br />
*[[OLI Sample Model]] - please change to the new model [[OLI Direct Calc Model]] <br />
*[[OLI Reactor]] - please change to the new model [[OLI Reactor 2]]<br />
<br />
'''Species Mapping:'''<br />
*Ionlist is used to breakdown the species to ions. Please see [[TCE Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
OLI evaporation models using OLI dlls that do not incorporate VLE calculations are suitable for water evaporation only.<br />
<br />
== OLI SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new OLI SysCAD project group. <br />
<br />
If user only intend to use OLI for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use OLI to evaluate SysCAD streams, then follow (B).<br />
<br />
'''Important Notes''': <br />
<br />
#OLI software requires an OLI configuration file (*.dbs).<br />
#see [[#Referenced_File|OLI Referenced File]] for instructions.<br />
<br />
'''<big>(A)</big>''' Using OLI as stand-alone thermodynamic calculation engine to perform OLI equilibrium calculations:<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[OLI Model Configuration]]<br />
#*load in the OLI Model Definition file <br />
#Inset a [[OLI Direct Calc Model]]. Use the direct calc to perform OLI equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using OLI to evaluate SysCAD streams or as part of the SysCAD flowsheet:<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the OLI model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, OLI Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the OLI SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the required Species from the [[Species Configuration|Species Tab]].<br />
#*select the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create a SysCAD project. <br />
#Add [[OLI Model Configuration]], <br />
#*load in the OLI Model .dll file <br />
#*complete the OLI Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add OLI unit models to the project where appropriate.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from OLI Database File|Generate SysCAD database from OLI Database File]]<br />
<br />
== Referenced File ==<br />
<br />
The file that will be referenced by the SysCAD OLI Chemistry Model is the OLI Chemistry Model Database file created in OLI, e.g. NickelSpecies.dbs. <br />
<br />
The "OLI Chemistry Model" (dbs file), can be generated using "'''OLI Chemistry Wizard'''" or "'''OLI Studio'''".<br />
<br />
To generate an "OLI Chemistry Model" in OLI Studio perform the following steps:<br />
* Create a stream in a new project or for an existing OLI project (*.oad) file.<br />
* Select MSE or AQ databank.<br />
* On the Definition tab, add the components of interest.<br />
* Run an isothermal single point calculation.<br />
* If File Viewer tab is not visible, select menu Tools|Options. Then for Plug-Ins select the "OLI File Viewer" option and press OK.<br />
* On the File Viewer tab, for "File Type" select "Generated Model File". Push "Save File" button which will prompt to save a file with .dbs extension. This is the file required by SysCAD.<br />
<br />
'''Notes:'''<br />
# This file is essential for the OLI Chemistry Model in SysCAD to function. <br />
# The file can be saved at any location - it does not have to be saved in the SysCAD project.<br />
<br />
== OLI Engine Version support ==<br />
<br />
OLI Engine Runtime (32-bit) is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option. "OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
Multiple versions support of installed OLI engine is {{Available139|33127|y}}. This applies to both OLI_Legacy and OLI_TCE SysCAD integration. Therefore, it is possible to<br />
#use “SysCAD OLI Legacy” (scdoli.dll) with OLI engine version 10.x or 11.x, OR<br />
#use “SysCAD TCE OLI” (scdoli2.dll) with OLI engine version 10.x or 11.x. (Recommended)<br />
<br />
'''NOTES:'''<br />
*User must select the required OLI SysCAD integration (scdoli.dll OR scdoli2.dll) to use in the project, it is NOT possible to include both in the same project. <br />
*The OLI legacy integration models will be discontinued in future versions. User should convert any projects using OLI Legacy integration models to use the new OLI TCE suite of models. Please see [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for hints about project conversion.<br />
<br />
== Converting OLI Legacy Project to use OLI TCE models ==<br />
<br />
The new OLI TCE Integration suite of models were completely re-design from the ground up. There is no “automated” upgrade path for converting projects using OLI_Legacy models to OLI_TCE models. <br />
<br />
A recommended conversion workflow is:<br />
# Create folder '''"OLI_Legacy"''' + '''Cfgfiles''' subfolder: <br />
#*Store your OLI_Legacy project here<br />
#*make sure the Cfgfiles is set up to open the legacy project (using scdoli.dll)<br />
#*The purpose of this folder is so you can still open the legacy project for reference and comparison. <br />
# Create folder "'''OLI_Preparation'''" + '''Cfgfiles''' subfolder <br />
#*make a copy of the legacy project here, this is the project you need to work on in preparation for OLI_TCE model changes.<br />
#*The cfgfiles subfolder can be the same as OLI_Legacy.<br />
#*Open the project and remove all the OLI_Legacy models, do these in the following order:<br />
#**use "Change Unit" to change all the [[OLI Reactor]] to "Tank"<br />
#**Delete any [[OLI Sample Model]]<br />
#**Delete the [[OLI Chemistry Model]]<br />
#*Save the Project. The project should be free of any OLI_legacy models.<br />
#*''Edit the configuration file to remove the '''scdoli.dll''' group of models.''<br />
#*Reopen the model to check if the project can be loaded. If successful, then the project is ready for OLI_TCE model changes.<br />
# Create folder "'''OLI_TCE'''" + '''Cfgfiles''' subfolder: <br />
#*make a copy of the "OLI_Preparation" project here.<br />
#*''Edit the configuration file to use the '''scdoli2.dll''' group of models.''<br />
#*Edit the TCE tab to select the correct OLI options (engine version, dll path, database selection, etc.)<br />
#*Open the project using the edited configuration file.<br />
#*Edit the project in the following order:<br />
#**Add and setup [[OLI Model Configuration]] to replace the [[OLI Chemistry Model]]<br />
#**Add and setup [[OLI Direct Calc Model]] to replace the [[OLI Sample Model]]<br />
#**For any [[OLI Reactor]] that were changed to "Tank", use "Change Unit" to change them to [[OLI Reactor 2]] or any other more relevant OLI unit [[#Models|models]]. <br />
#*Fix the controls and reports.<br />
#*Save the project. <br />
#*Solve and debug the project as usual.<br />
#*If possible, open the OLI_Legacy model for reference or comparison.<br />
<br />
== Liquid 2 Functionality in SysCAD ==<br />
<br />
{{Available139|XXXXX}} liquid 2 functionality is available for use in the SysCAD-OLI interface. This functionality allows for the modelling of unit operations where two immiscible liquids are present, such as [[OLI Solvent Extraction]]. To use this functionality, the SysCAD configuration file must be manually updated to indicate the individual phase in the SysCAD database which corresponds with the second liquid phase in the OLI dbs file. To do this, please do the following:<br />
<br />
#Open the cfg file within the CfgFiles folder using a text editor<br />
#Do a search for "[OLI]" to locate the OLI section of the file<br />
#Update the cfg file in a similar manner to that shown in the following example.<br />
<br />
==== Example Update of SysCAD Configuration File for OLI dbs File Containing a Second Liquid ====<br />
Given an OLI section that looks like this in the cfg file:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
<br />
where:<br />
*SolvEx.dbs contains a second liquid phase<br />
*The SysCAD database contains corresponding species for mapping to the second liquid phase using the individual phase "o" for organic, i.e.:<br />
**C12H26(o)<br />
**R3NH2SO4(o)<br />
**etc...<br />
<br />
the cfg file [OLI] section should be modified to this:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
'''Second_Liquid_Phase_Name0=o'''</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Overview&diff=78647OLI Overview2024-02-29T20:34:48Z<p>Kevin.Heppner: /* Liquid 2 Functionality in SysCAD */</p>
<hr />
<div>[[Category:Models]] [[Category:OLI]]<br />
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{OLI Header Tabs|currentpage=1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from OLI Database File]], [[Example - 06 OLI Projects|OLI Example Projects]]<br />
----<br />
<br />
{{Available139|31866}} - Next generation of OLI models in SysCAD as part of TCE. Older models have been archived as legacy models.<br />
{{TOC}}<br />
== Overview ==<br />
<br />
OLI Systems is a leading Electrolyte Simulation Software used to predicate equilibrium conditions and properties (such as pH) for aqueous chemistry.<br />
*It is developed and maintained by OLI Systems. ([https://www.olisystems.com/ olisystems.com])<br />
*To use OLI in SysCAD it is assumed that the user has some familiarity with the theory and use of the OLI Systems software programs.<br />
*The SysCAD OLI library option (in ScdOLI2.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons.<br />
*'''OLI Engine Runtime (32-bit)''' is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option.<br />
*"OLI Engine Runtime" includes '''OLI Chemistry Wizard''' which can be used to create the OLI database (dbs) files required by SysCAD.<br />
*The user may also purchase '''OLI Studio: Stream Analyzer''' from OLI Systems Inc. OLI Studio can also be used to create OLI database files required by SysCAD.<br />
<br />
Additional Notes:<br />
*The "OLI Engine: Developer Edition" License is NOT required to use OLI in SysCAD.<br />
*"OLI Studio" or "OLI Studio: Stream Analyzer" does not include an "OLI Engine Runtime" license, this needs to be purchased separately from OLI Systems.<br />
*"OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine" - this is the same thing.<br />
*KWA Kenwalt Australia (SysCAD) are OLI Alliance Partners. ([https://www.olisystems.com/partners/ Alliance Partners])<br />
*From {{Available139|||y}}, a TCE add-on is required instead of a legacy separate individual "SysCAD OLI" License add-on.<br />
*For legacy OLI models (ScdOLI.DLL) SysCAD version of Build 137, 138 or 139 is required. It cannot be used within the same project as the new TCE OLI Option. The legacy version will be discontinued in the next SysCAD Build.<br />
*OLI in SysCAD is not implemented as a Species Properties Model but as unit models for use at appropriate locations in a plant model.<br />
<br />
== OLI Systems Software ==<br />
[https://www.olisystems.com/software/oli-studio/ [[File:OLI_Logo.png |link=]]]<br />
<br />
The following are direct quotes from the OLI website:<br />
:''Analyze chemical streams, predict mineral scaling and corrosion in industrial chemical processes.''<br />
:''The behavior of electrolyte and water chemistry governs industrial chemical processes performance. OLI Systems makes it possible to deeply understand these behaviors to drive effective and efficient equipment design and process operations.''<br />
<br />
Please visit the [https://www.olisystems.com/software/oli-studio/ OLI Studio] for more information.<br />
<br />
The TCE add-on in SysCAD does not require "OLI Engine: Developer Edition" to be installed. However, users must obtain the "OLI Engine Runtime (32 bit)" license from OLI Systems, also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
== Checking that OLI SysCAD integration is working == <br />
<br />
We recommend performing the following checks prior to creating user OLI projects to ensure OLI SysCAD intergration is working correctly.<br />
# [[Licensing#Checking_Current_License_Information|Check the '''License Information''']], the following add-ons must be allowed (Yes)<br />
#* Energy Balance <br />
#* Integration Libraries (formerly SMDK Runtime)<br />
#* Models: TCE (PHREEQC, OLI, AQSol and ChemApp)<br />
# Check that "'''OLI Engine Runtime''' 32 bit" (also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine") is installed and licensed from OLI systems.<br />
#* SysCAD requires a valid OLI Engine to work. See [[#OLI Engine Version support|OLI Engine Version]]<br />
# Check that the distributed SysCAD OLI example project will run without issues.<br />
#*Open any of the \SysCAD139\Examples\06 OLI\OLIFull [[Example_-_06_OLI_Projects|example projects]], after project load, check the message window for any reported errors.<br />
#*If errors were encountered, use the messages provided to fix the errors and try again.<br />
<br />
== Models ==<br />
<br />
'''OLI Option unit models:'''<br />
* [[OLI Model Configuration]] - Used to define and view various options for the selected OLI database, including management of mapping of SysCAD species list to species list used in OLI.<br />
* [[OLI Direct Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a user defined OLI stream.<br />
* [[OLI Side Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a SysCAD stream in the current project.<br />
* [[OLI Reactor 2]] - Include this model in a SysCAD stream to use OLI to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
* [[OLI Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded OLI calculations.<br />
* [[OLI Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded OLI calculations.<br />
* [[OLI Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded OLI calculations. OLI can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[OLI Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using OLI species.<br />
* [[OLI Solvent Extraction]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded OLI calculations.<br />
* [[OLI Pond Model]] - Include this model in a SysCAD flowsheet (Dynamic mode) to specify a dynamic pond using embedded OLI calculations.<br />
'''OLI Legacy unit models:'''<br />
<br />
The following models are used for backward compatibility purposes only. These will be discontinued from Build 140 and users should convert any existing projects to use the TCE OLI models. See [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for suggested work flow.<br />
*[[OLI Chemistry Model]] - please change to the new model [[OLI Model Configuration]] <br />
*[[OLI Sample Model]] - please change to the new model [[OLI Direct Calc Model]] <br />
*[[OLI Reactor]] - please change to the new model [[OLI Reactor 2]]<br />
<br />
'''Species Mapping:'''<br />
*Ionlist is used to breakdown the species to ions. Please see [[TCE Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
OLI evaporation models using OLI dlls that do not incorporate VLE calculations are suitable for water evaporation only.<br />
<br />
== OLI SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new OLI SysCAD project group. <br />
<br />
If user only intend to use OLI for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use OLI to evaluate SysCAD streams, then follow (B).<br />
<br />
'''Important Notes''': <br />
<br />
#OLI software requires an OLI configuration file (*.dbs).<br />
#see [[#Referenced_File|OLI Referenced File]] for instructions.<br />
<br />
'''<big>(A)</big>''' Using OLI as stand-alone thermodynamic calculation engine to perform OLI equilibrium calculations:<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[OLI Model Configuration]]<br />
#*load in the OLI Model Definition file <br />
#Inset a [[OLI Direct Calc Model]]. Use the direct calc to perform OLI equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using OLI to evaluate SysCAD streams or as part of the SysCAD flowsheet:<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the OLI model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, OLI Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the OLI SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the required Species from the [[Species Configuration|Species Tab]].<br />
#*select the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create a SysCAD project. <br />
#Add [[OLI Model Configuration]], <br />
#*load in the OLI Model .dll file <br />
#*complete the OLI Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add OLI unit models to the project where appropriate.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from OLI Database File|Generate SysCAD database from OLI Database File]]<br />
<br />
== Referenced File ==<br />
<br />
The file that will be referenced by the SysCAD OLI Chemistry Model is the OLI Chemistry Model Database file created in OLI, e.g. NickelSpecies.dbs. <br />
<br />
The "OLI Chemistry Model" (dbs file), can be generated using "'''OLI Chemistry Wizard'''" or "'''OLI Studio'''".<br />
<br />
To generate an "OLI Chemistry Model" in OLI Studio perform the following steps:<br />
* Create a stream in a new project or for an existing OLI project (*.oad) file.<br />
* Select MSE or AQ databank.<br />
* On the Definition tab, add the components of interest.<br />
* Run an isothermal single point calculation.<br />
* If File Viewer tab is not visible, select menu Tools|Options. Then for Plug-Ins select the "OLI File Viewer" option and press OK.<br />
* On the File Viewer tab, for "File Type" select "Generated Model File". Push "Save File" button which will prompt to save a file with .dbs extension. This is the file required by SysCAD.<br />
<br />
'''Notes:'''<br />
# This file is essential for the OLI Chemistry Model in SysCAD to function. <br />
# The file can be saved at any location - it does not have to be saved in the SysCAD project.<br />
<br />
== OLI Engine Version support ==<br />
<br />
OLI Engine Runtime (32-bit) is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option. "OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
Multiple versions support of installed OLI engine is {{Available139|33127|y}}. This applies to both OLI_Legacy and OLI_TCE SysCAD integration. Therefore, it is possible to<br />
#use “SysCAD OLI Legacy” (scdoli.dll) with OLI engine version 10.x or 11.x, OR<br />
#use “SysCAD TCE OLI” (scdoli2.dll) with OLI engine version 10.x or 11.x. (Recommended)<br />
<br />
'''NOTES:'''<br />
*User must select the required OLI SysCAD integration (scdoli.dll OR scdoli2.dll) to use in the project, it is NOT possible to include both in the same project. <br />
*The OLI legacy integration models will be discontinued in future versions. User should convert any projects using OLI Legacy integration models to use the new OLI TCE suite of models. Please see [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for hints about project conversion.<br />
<br />
== Converting OLI Legacy Project to use OLI TCE models ==<br />
<br />
The new OLI TCE Integration suite of models were completely re-design from the ground up. There is no “automated” upgrade path for converting projects using OLI_Legacy models to OLI_TCE models. <br />
<br />
A recommended conversion workflow is:<br />
# Create folder '''"OLI_Legacy"''' + '''Cfgfiles''' subfolder: <br />
#*Store your OLI_Legacy project here<br />
#*make sure the Cfgfiles is set up to open the legacy project (using scdoli.dll)<br />
#*The purpose of this folder is so you can still open the legacy project for reference and comparison. <br />
# Create folder "'''OLI_Preparation'''" + '''Cfgfiles''' subfolder <br />
#*make a copy of the legacy project here, this is the project you need to work on in preparation for OLI_TCE model changes.<br />
#*The cfgfiles subfolder can be the same as OLI_Legacy.<br />
#*Open the project and remove all the OLI_Legacy models, do these in the following order:<br />
#**use "Change Unit" to change all the [[OLI Reactor]] to "Tank"<br />
#**Delete any [[OLI Sample Model]]<br />
#**Delete the [[OLI Chemistry Model]]<br />
#*Save the Project. The project should be free of any OLI_legacy models.<br />
#*''Edit the configuration file to remove the '''scdoli.dll''' group of models.''<br />
#*Reopen the model to check if the project can be loaded. If successful, then the project is ready for OLI_TCE model changes.<br />
# Create folder "'''OLI_TCE'''" + '''Cfgfiles''' subfolder: <br />
#*make a copy of the "OLI_Preparation" project here.<br />
#*''Edit the configuration file to use the '''scdoli2.dll''' group of models.''<br />
#*Edit the TCE tab to select the correct OLI options (engine version, dll path, database selection, etc.)<br />
#*Open the project using the edited configuration file.<br />
#*Edit the project in the following order:<br />
#**Add and setup [[OLI Model Configuration]] to replace the [[OLI Chemistry Model]]<br />
#**Add and setup [[OLI Direct Calc Model]] to replace the [[OLI Sample Model]]<br />
#**For any [[OLI Reactor]] that were changed to "Tank", use "Change Unit" to change them to [[OLI Reactor 2]] or any other more relevant OLI unit [[#Models|models]]. <br />
#*Fix the controls and reports.<br />
#*Save the project. <br />
#*Solve and debug the project as usual.<br />
#*If possible, open the OLI_Legacy model for reference or comparison.<br />
<br />
== Liquid 2 Functionality in SysCAD ==<br />
<br />
{{Available139|XXXXX}} liquid 2 functionality is available for use in the SysCAD-OLI interface. This functionality allows for the modelling of unit operations where two immiscible liquids are present, such as [[OLI Solvent Extraction]]. To use this functionality, the SysCAD configuration file must be manually updated to indicate the individual phase in the SysCAD database which corresponds with the second liquid phase in the OLI dbs file. To do this, please do the following:<br />
<br />
#Open the cfg file within the CfgFiles folder using a text editor<br />
#Do a search for "[OLI]" to locate the OLI section of the file<br />
#Update the cfg file in a similar manner to that shown in the following example.<br />
<br />
=== Example Update of SysCAD Configuration File for OLI dbs File Containing a Second Liquid ===<br />
Given an OLI section that looks like this in the cfg file:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
<br />
where:<br />
*SolvEx.dbs contains a second liquid phase<br />
*The SysCAD database contains corresponding species for mapping to the second liquid phase using the individual phase "o" for organic, i.e.:<br />
**C12H26(o)<br />
**R3NH2SO4(o)<br />
**etc...<br />
<br />
the cfg file [OLI] section should be modified to this:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
'''Second_Liquid_Phase_Name0=o'''</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Overview&diff=78646OLI Overview2024-02-29T20:33:38Z<p>Kevin.Heppner: /* Liquid 2 Functionality in SysCAD */</p>
<hr />
<div>[[Category:Models]] [[Category:OLI]]<br />
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{OLI Header Tabs|currentpage=1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from OLI Database File]], [[Example - 06 OLI Projects|OLI Example Projects]]<br />
----<br />
<br />
{{Available139|31866}} - Next generation of OLI models in SysCAD as part of TCE. Older models have been archived as legacy models.<br />
{{TOC}}<br />
== Overview ==<br />
<br />
OLI Systems is a leading Electrolyte Simulation Software used to predicate equilibrium conditions and properties (such as pH) for aqueous chemistry.<br />
*It is developed and maintained by OLI Systems. ([https://www.olisystems.com/ olisystems.com])<br />
*To use OLI in SysCAD it is assumed that the user has some familiarity with the theory and use of the OLI Systems software programs.<br />
*The SysCAD OLI library option (in ScdOLI2.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons.<br />
*'''OLI Engine Runtime (32-bit)''' is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option.<br />
*"OLI Engine Runtime" includes '''OLI Chemistry Wizard''' which can be used to create the OLI database (dbs) files required by SysCAD.<br />
*The user may also purchase '''OLI Studio: Stream Analyzer''' from OLI Systems Inc. OLI Studio can also be used to create OLI database files required by SysCAD.<br />
<br />
Additional Notes:<br />
*The "OLI Engine: Developer Edition" License is NOT required to use OLI in SysCAD.<br />
*"OLI Studio" or "OLI Studio: Stream Analyzer" does not include an "OLI Engine Runtime" license, this needs to be purchased separately from OLI Systems.<br />
*"OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine" - this is the same thing.<br />
*KWA Kenwalt Australia (SysCAD) are OLI Alliance Partners. ([https://www.olisystems.com/partners/ Alliance Partners])<br />
*From {{Available139|||y}}, a TCE add-on is required instead of a legacy separate individual "SysCAD OLI" License add-on.<br />
*For legacy OLI models (ScdOLI.DLL) SysCAD version of Build 137, 138 or 139 is required. It cannot be used within the same project as the new TCE OLI Option. The legacy version will be discontinued in the next SysCAD Build.<br />
*OLI in SysCAD is not implemented as a Species Properties Model but as unit models for use at appropriate locations in a plant model.<br />
<br />
== OLI Systems Software ==<br />
[https://www.olisystems.com/software/oli-studio/ [[File:OLI_Logo.png |link=]]]<br />
<br />
The following are direct quotes from the OLI website:<br />
:''Analyze chemical streams, predict mineral scaling and corrosion in industrial chemical processes.''<br />
:''The behavior of electrolyte and water chemistry governs industrial chemical processes performance. OLI Systems makes it possible to deeply understand these behaviors to drive effective and efficient equipment design and process operations.''<br />
<br />
Please visit the [https://www.olisystems.com/software/oli-studio/ OLI Studio] for more information.<br />
<br />
The TCE add-on in SysCAD does not require "OLI Engine: Developer Edition" to be installed. However, users must obtain the "OLI Engine Runtime (32 bit)" license from OLI Systems, also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
== Checking that OLI SysCAD integration is working == <br />
<br />
We recommend performing the following checks prior to creating user OLI projects to ensure OLI SysCAD intergration is working correctly.<br />
# [[Licensing#Checking_Current_License_Information|Check the '''License Information''']], the following add-ons must be allowed (Yes)<br />
#* Energy Balance <br />
#* Integration Libraries (formerly SMDK Runtime)<br />
#* Models: TCE (PHREEQC, OLI, AQSol and ChemApp)<br />
# Check that "'''OLI Engine Runtime''' 32 bit" (also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine") is installed and licensed from OLI systems.<br />
#* SysCAD requires a valid OLI Engine to work. See [[#OLI Engine Version support|OLI Engine Version]]<br />
# Check that the distributed SysCAD OLI example project will run without issues.<br />
#*Open any of the \SysCAD139\Examples\06 OLI\OLIFull [[Example_-_06_OLI_Projects|example projects]], after project load, check the message window for any reported errors.<br />
#*If errors were encountered, use the messages provided to fix the errors and try again.<br />
<br />
== Models ==<br />
<br />
'''OLI Option unit models:'''<br />
* [[OLI Model Configuration]] - Used to define and view various options for the selected OLI database, including management of mapping of SysCAD species list to species list used in OLI.<br />
* [[OLI Direct Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a user defined OLI stream.<br />
* [[OLI Side Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a SysCAD stream in the current project.<br />
* [[OLI Reactor 2]] - Include this model in a SysCAD stream to use OLI to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
* [[OLI Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded OLI calculations.<br />
* [[OLI Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded OLI calculations.<br />
* [[OLI Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded OLI calculations. OLI can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[OLI Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using OLI species.<br />
* [[OLI Solvent Extraction]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded OLI calculations.<br />
* [[OLI Pond Model]] - Include this model in a SysCAD flowsheet (Dynamic mode) to specify a dynamic pond using embedded OLI calculations.<br />
'''OLI Legacy unit models:'''<br />
<br />
The following models are used for backward compatibility purposes only. These will be discontinued from Build 140 and users should convert any existing projects to use the TCE OLI models. See [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for suggested work flow.<br />
*[[OLI Chemistry Model]] - please change to the new model [[OLI Model Configuration]] <br />
*[[OLI Sample Model]] - please change to the new model [[OLI Direct Calc Model]] <br />
*[[OLI Reactor]] - please change to the new model [[OLI Reactor 2]]<br />
<br />
'''Species Mapping:'''<br />
*Ionlist is used to breakdown the species to ions. Please see [[TCE Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
OLI evaporation models using OLI dlls that do not incorporate VLE calculations are suitable for water evaporation only.<br />
<br />
== OLI SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new OLI SysCAD project group. <br />
<br />
If user only intend to use OLI for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use OLI to evaluate SysCAD streams, then follow (B).<br />
<br />
'''Important Notes''': <br />
<br />
#OLI software requires an OLI configuration file (*.dbs).<br />
#see [[#Referenced_File|OLI Referenced File]] for instructions.<br />
<br />
'''<big>(A)</big>''' Using OLI as stand-alone thermodynamic calculation engine to perform OLI equilibrium calculations:<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[OLI Model Configuration]]<br />
#*load in the OLI Model Definition file <br />
#Inset a [[OLI Direct Calc Model]]. Use the direct calc to perform OLI equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using OLI to evaluate SysCAD streams or as part of the SysCAD flowsheet:<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the OLI model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, OLI Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the OLI SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the required Species from the [[Species Configuration|Species Tab]].<br />
#*select the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create a SysCAD project. <br />
#Add [[OLI Model Configuration]], <br />
#*load in the OLI Model .dll file <br />
#*complete the OLI Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add OLI unit models to the project where appropriate.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from OLI Database File|Generate SysCAD database from OLI Database File]]<br />
<br />
== Referenced File ==<br />
<br />
The file that will be referenced by the SysCAD OLI Chemistry Model is the OLI Chemistry Model Database file created in OLI, e.g. NickelSpecies.dbs. <br />
<br />
The "OLI Chemistry Model" (dbs file), can be generated using "'''OLI Chemistry Wizard'''" or "'''OLI Studio'''".<br />
<br />
To generate an "OLI Chemistry Model" in OLI Studio perform the following steps:<br />
* Create a stream in a new project or for an existing OLI project (*.oad) file.<br />
* Select MSE or AQ databank.<br />
* On the Definition tab, add the components of interest.<br />
* Run an isothermal single point calculation.<br />
* If File Viewer tab is not visible, select menu Tools|Options. Then for Plug-Ins select the "OLI File Viewer" option and press OK.<br />
* On the File Viewer tab, for "File Type" select "Generated Model File". Push "Save File" button which will prompt to save a file with .dbs extension. This is the file required by SysCAD.<br />
<br />
'''Notes:'''<br />
# This file is essential for the OLI Chemistry Model in SysCAD to function. <br />
# The file can be saved at any location - it does not have to be saved in the SysCAD project.<br />
<br />
== OLI Engine Version support ==<br />
<br />
OLI Engine Runtime (32-bit) is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option. "OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
Multiple versions support of installed OLI engine is {{Available139|33127|y}}. This applies to both OLI_Legacy and OLI_TCE SysCAD integration. Therefore, it is possible to<br />
#use “SysCAD OLI Legacy” (scdoli.dll) with OLI engine version 10.x or 11.x, OR<br />
#use “SysCAD TCE OLI” (scdoli2.dll) with OLI engine version 10.x or 11.x. (Recommended)<br />
<br />
'''NOTES:'''<br />
*User must select the required OLI SysCAD integration (scdoli.dll OR scdoli2.dll) to use in the project, it is NOT possible to include both in the same project. <br />
*The OLI legacy integration models will be discontinued in future versions. User should convert any projects using OLI Legacy integration models to use the new OLI TCE suite of models. Please see [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for hints about project conversion.<br />
<br />
== Converting OLI Legacy Project to use OLI TCE models ==<br />
<br />
The new OLI TCE Integration suite of models were completely re-design from the ground up. There is no “automated” upgrade path for converting projects using OLI_Legacy models to OLI_TCE models. <br />
<br />
A recommended conversion workflow is:<br />
# Create folder '''"OLI_Legacy"''' + '''Cfgfiles''' subfolder: <br />
#*Store your OLI_Legacy project here<br />
#*make sure the Cfgfiles is set up to open the legacy project (using scdoli.dll)<br />
#*The purpose of this folder is so you can still open the legacy project for reference and comparison. <br />
# Create folder "'''OLI_Preparation'''" + '''Cfgfiles''' subfolder <br />
#*make a copy of the legacy project here, this is the project you need to work on in preparation for OLI_TCE model changes.<br />
#*The cfgfiles subfolder can be the same as OLI_Legacy.<br />
#*Open the project and remove all the OLI_Legacy models, do these in the following order:<br />
#**use "Change Unit" to change all the [[OLI Reactor]] to "Tank"<br />
#**Delete any [[OLI Sample Model]]<br />
#**Delete the [[OLI Chemistry Model]]<br />
#*Save the Project. The project should be free of any OLI_legacy models.<br />
#*''Edit the configuration file to remove the '''scdoli.dll''' group of models.''<br />
#*Reopen the model to check if the project can be loaded. If successful, then the project is ready for OLI_TCE model changes.<br />
# Create folder "'''OLI_TCE'''" + '''Cfgfiles''' subfolder: <br />
#*make a copy of the "OLI_Preparation" project here.<br />
#*''Edit the configuration file to use the '''scdoli2.dll''' group of models.''<br />
#*Edit the TCE tab to select the correct OLI options (engine version, dll path, database selection, etc.)<br />
#*Open the project using the edited configuration file.<br />
#*Edit the project in the following order:<br />
#**Add and setup [[OLI Model Configuration]] to replace the [[OLI Chemistry Model]]<br />
#**Add and setup [[OLI Direct Calc Model]] to replace the [[OLI Sample Model]]<br />
#**For any [[OLI Reactor]] that were changed to "Tank", use "Change Unit" to change them to [[OLI Reactor 2]] or any other more relevant OLI unit [[#Models|models]]. <br />
#*Fix the controls and reports.<br />
#*Save the project. <br />
#*Solve and debug the project as usual.<br />
#*If possible, open the OLI_Legacy model for reference or comparison.<br />
<br />
== Liquid 2 Functionality in SysCAD ==<br />
<br />
{{Available139|XXXXX}} liquid 2 functionality is available for use in the SysCAD-OLI interface. This functionality allows for the modelling of unit operations where two immiscible liquids are present, such as [[OLI Solvent Extraction]]. To use this functionality, the SysCAD configuration file must be manually updated to indicate the individual phase in the SysCAD database which corresponds with the second liquid phase in the OLI dbs file. To do this, please do the following:<br />
<br />
#Open the cfg file within the CfgFiles folder using a text editor<br />
#Do a search for "[OLI]" to locate the OLI section of the file<br />
#Update the cfg file in a similar manner to that shown in the following example.<br />
<br />
=== Example Update of SysCAD Configuration File for OLI dbs File Containing a Second Liquid ===<br />
Given an OLI section that looks like this in the cfg file (you can edit the cfg file using any text editor):<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
<br />
where:<br />
*SolvEx.dbs contains a second liquid phase<br />
*The SysCAD database contains corresponding species for mapping to the second liquid phase using the individual phase "o" for organic, i.e.:<br />
**C12H26(o)<br />
**R3NH2SO4(o)<br />
**etc...<br />
<br />
In this case, we would modify the above to:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
'''Second_Liquid_Phase_Name0=o'''</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Overview&diff=78645OLI Overview2024-02-29T20:29:49Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category:Models]] [[Category:OLI]]<br />
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{OLI Header Tabs|currentpage=1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from OLI Database File]], [[Example - 06 OLI Projects|OLI Example Projects]]<br />
----<br />
<br />
{{Available139|31866}} - Next generation of OLI models in SysCAD as part of TCE. Older models have been archived as legacy models.<br />
{{TOC}}<br />
== Overview ==<br />
<br />
OLI Systems is a leading Electrolyte Simulation Software used to predicate equilibrium conditions and properties (such as pH) for aqueous chemistry.<br />
*It is developed and maintained by OLI Systems. ([https://www.olisystems.com/ olisystems.com])<br />
*To use OLI in SysCAD it is assumed that the user has some familiarity with the theory and use of the OLI Systems software programs.<br />
*The SysCAD OLI library option (in ScdOLI2.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons.<br />
*'''OLI Engine Runtime (32-bit)''' is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option.<br />
*"OLI Engine Runtime" includes '''OLI Chemistry Wizard''' which can be used to create the OLI database (dbs) files required by SysCAD.<br />
*The user may also purchase '''OLI Studio: Stream Analyzer''' from OLI Systems Inc. OLI Studio can also be used to create OLI database files required by SysCAD.<br />
<br />
Additional Notes:<br />
*The "OLI Engine: Developer Edition" License is NOT required to use OLI in SysCAD.<br />
*"OLI Studio" or "OLI Studio: Stream Analyzer" does not include an "OLI Engine Runtime" license, this needs to be purchased separately from OLI Systems.<br />
*"OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine" - this is the same thing.<br />
*KWA Kenwalt Australia (SysCAD) are OLI Alliance Partners. ([https://www.olisystems.com/partners/ Alliance Partners])<br />
*From {{Available139|||y}}, a TCE add-on is required instead of a legacy separate individual "SysCAD OLI" License add-on.<br />
*For legacy OLI models (ScdOLI.DLL) SysCAD version of Build 137, 138 or 139 is required. It cannot be used within the same project as the new TCE OLI Option. The legacy version will be discontinued in the next SysCAD Build.<br />
*OLI in SysCAD is not implemented as a Species Properties Model but as unit models for use at appropriate locations in a plant model.<br />
<br />
== OLI Systems Software ==<br />
[https://www.olisystems.com/software/oli-studio/ [[File:OLI_Logo.png |link=]]]<br />
<br />
The following are direct quotes from the OLI website:<br />
:''Analyze chemical streams, predict mineral scaling and corrosion in industrial chemical processes.''<br />
:''The behavior of electrolyte and water chemistry governs industrial chemical processes performance. OLI Systems makes it possible to deeply understand these behaviors to drive effective and efficient equipment design and process operations.''<br />
<br />
Please visit the [https://www.olisystems.com/software/oli-studio/ OLI Studio] for more information.<br />
<br />
The TCE add-on in SysCAD does not require "OLI Engine: Developer Edition" to be installed. However, users must obtain the "OLI Engine Runtime (32 bit)" license from OLI Systems, also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
== Checking that OLI SysCAD integration is working == <br />
<br />
We recommend performing the following checks prior to creating user OLI projects to ensure OLI SysCAD intergration is working correctly.<br />
# [[Licensing#Checking_Current_License_Information|Check the '''License Information''']], the following add-ons must be allowed (Yes)<br />
#* Energy Balance <br />
#* Integration Libraries (formerly SMDK Runtime)<br />
#* Models: TCE (PHREEQC, OLI, AQSol and ChemApp)<br />
# Check that "'''OLI Engine Runtime''' 32 bit" (also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine") is installed and licensed from OLI systems.<br />
#* SysCAD requires a valid OLI Engine to work. See [[#OLI Engine Version support|OLI Engine Version]]<br />
# Check that the distributed SysCAD OLI example project will run without issues.<br />
#*Open any of the \SysCAD139\Examples\06 OLI\OLIFull [[Example_-_06_OLI_Projects|example projects]], after project load, check the message window for any reported errors.<br />
#*If errors were encountered, use the messages provided to fix the errors and try again.<br />
<br />
== Models ==<br />
<br />
'''OLI Option unit models:'''<br />
* [[OLI Model Configuration]] - Used to define and view various options for the selected OLI database, including management of mapping of SysCAD species list to species list used in OLI.<br />
* [[OLI Direct Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a user defined OLI stream.<br />
* [[OLI Side Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a SysCAD stream in the current project.<br />
* [[OLI Reactor 2]] - Include this model in a SysCAD stream to use OLI to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
* [[OLI Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded OLI calculations.<br />
* [[OLI Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded OLI calculations.<br />
* [[OLI Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded OLI calculations. OLI can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[OLI Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using OLI species.<br />
* [[OLI Solvent Extraction]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded OLI calculations.<br />
* [[OLI Pond Model]] - Include this model in a SysCAD flowsheet (Dynamic mode) to specify a dynamic pond using embedded OLI calculations.<br />
'''OLI Legacy unit models:'''<br />
<br />
The following models are used for backward compatibility purposes only. These will be discontinued from Build 140 and users should convert any existing projects to use the TCE OLI models. See [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for suggested work flow.<br />
*[[OLI Chemistry Model]] - please change to the new model [[OLI Model Configuration]] <br />
*[[OLI Sample Model]] - please change to the new model [[OLI Direct Calc Model]] <br />
*[[OLI Reactor]] - please change to the new model [[OLI Reactor 2]]<br />
<br />
'''Species Mapping:'''<br />
*Ionlist is used to breakdown the species to ions. Please see [[TCE Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
OLI evaporation models using OLI dlls that do not incorporate VLE calculations are suitable for water evaporation only.<br />
<br />
== OLI SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new OLI SysCAD project group. <br />
<br />
If user only intend to use OLI for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use OLI to evaluate SysCAD streams, then follow (B).<br />
<br />
'''Important Notes''': <br />
<br />
#OLI software requires an OLI configuration file (*.dbs).<br />
#see [[#Referenced_File|OLI Referenced File]] for instructions.<br />
<br />
'''<big>(A)</big>''' Using OLI as stand-alone thermodynamic calculation engine to perform OLI equilibrium calculations:<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[OLI Model Configuration]]<br />
#*load in the OLI Model Definition file <br />
#Inset a [[OLI Direct Calc Model]]. Use the direct calc to perform OLI equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using OLI to evaluate SysCAD streams or as part of the SysCAD flowsheet:<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the OLI model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, OLI Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the OLI SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the required Species from the [[Species Configuration|Species Tab]].<br />
#*select the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create a SysCAD project. <br />
#Add [[OLI Model Configuration]], <br />
#*load in the OLI Model .dll file <br />
#*complete the OLI Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add OLI unit models to the project where appropriate.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from OLI Database File|Generate SysCAD database from OLI Database File]]<br />
<br />
== Referenced File ==<br />
<br />
The file that will be referenced by the SysCAD OLI Chemistry Model is the OLI Chemistry Model Database file created in OLI, e.g. NickelSpecies.dbs. <br />
<br />
The "OLI Chemistry Model" (dbs file), can be generated using "'''OLI Chemistry Wizard'''" or "'''OLI Studio'''".<br />
<br />
To generate an "OLI Chemistry Model" in OLI Studio perform the following steps:<br />
* Create a stream in a new project or for an existing OLI project (*.oad) file.<br />
* Select MSE or AQ databank.<br />
* On the Definition tab, add the components of interest.<br />
* Run an isothermal single point calculation.<br />
* If File Viewer tab is not visible, select menu Tools|Options. Then for Plug-Ins select the "OLI File Viewer" option and press OK.<br />
* On the File Viewer tab, for "File Type" select "Generated Model File". Push "Save File" button which will prompt to save a file with .dbs extension. This is the file required by SysCAD.<br />
<br />
'''Notes:'''<br />
# This file is essential for the OLI Chemistry Model in SysCAD to function. <br />
# The file can be saved at any location - it does not have to be saved in the SysCAD project.<br />
<br />
== OLI Engine Version support ==<br />
<br />
OLI Engine Runtime (32-bit) is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option. "OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
Multiple versions support of installed OLI engine is {{Available139|33127|y}}. This applies to both OLI_Legacy and OLI_TCE SysCAD integration. Therefore, it is possible to<br />
#use “SysCAD OLI Legacy” (scdoli.dll) with OLI engine version 10.x or 11.x, OR<br />
#use “SysCAD TCE OLI” (scdoli2.dll) with OLI engine version 10.x or 11.x. (Recommended)<br />
<br />
'''NOTES:'''<br />
*User must select the required OLI SysCAD integration (scdoli.dll OR scdoli2.dll) to use in the project, it is NOT possible to include both in the same project. <br />
*The OLI legacy integration models will be discontinued in future versions. User should convert any projects using OLI Legacy integration models to use the new OLI TCE suite of models. Please see [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for hints about project conversion.<br />
<br />
== Converting OLI Legacy Project to use OLI TCE models ==<br />
<br />
The new OLI TCE Integration suite of models were completely re-design from the ground up. There is no “automated” upgrade path for converting projects using OLI_Legacy models to OLI_TCE models. <br />
<br />
A recommended conversion workflow is:<br />
# Create folder '''"OLI_Legacy"''' + '''Cfgfiles''' subfolder: <br />
#*Store your OLI_Legacy project here<br />
#*make sure the Cfgfiles is set up to open the legacy project (using scdoli.dll)<br />
#*The purpose of this folder is so you can still open the legacy project for reference and comparison. <br />
# Create folder "'''OLI_Preparation'''" + '''Cfgfiles''' subfolder <br />
#*make a copy of the legacy project here, this is the project you need to work on in preparation for OLI_TCE model changes.<br />
#*The cfgfiles subfolder can be the same as OLI_Legacy.<br />
#*Open the project and remove all the OLI_Legacy models, do these in the following order:<br />
#**use "Change Unit" to change all the [[OLI Reactor]] to "Tank"<br />
#**Delete any [[OLI Sample Model]]<br />
#**Delete the [[OLI Chemistry Model]]<br />
#*Save the Project. The project should be free of any OLI_legacy models.<br />
#*''Edit the configuration file to remove the '''scdoli.dll''' group of models.''<br />
#*Reopen the model to check if the project can be loaded. If successful, then the project is ready for OLI_TCE model changes.<br />
# Create folder "'''OLI_TCE'''" + '''Cfgfiles''' subfolder: <br />
#*make a copy of the "OLI_Preparation" project here.<br />
#*''Edit the configuration file to use the '''scdoli2.dll''' group of models.''<br />
#*Edit the TCE tab to select the correct OLI options (engine version, dll path, database selection, etc.)<br />
#*Open the project using the edited configuration file.<br />
#*Edit the project in the following order:<br />
#**Add and setup [[OLI Model Configuration]] to replace the [[OLI Chemistry Model]]<br />
#**Add and setup [[OLI Direct Calc Model]] to replace the [[OLI Sample Model]]<br />
#**For any [[OLI Reactor]] that were changed to "Tank", use "Change Unit" to change them to [[OLI Reactor 2]] or any other more relevant OLI unit [[#Models|models]]. <br />
#*Fix the controls and reports.<br />
#*Save the project. <br />
#*Solve and debug the project as usual.<br />
#*If possible, open the OLI_Legacy model for reference or comparison.<br />
<br />
== Liquid 2 Functionality in SysCAD ==<br />
<br />
{{Available139|XXXXX}} liquid 2 functionality is available for use in the SysCAD-OLI interface. This functionality allows for the modelling of unit operations where two immiscible liquids are present, such as [[OLI Solvent Extraction]]. To use this functionality, the following line must be manually added to the [OLI] section of the SysCAD configuration file.<br />
<br />
Given an OLI section that looks like this in the cfg file (you can edit the cfg file using any text editor):<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
<br />
where:<br />
*SolvEx.dbs contains a second liquid phase<br />
*The SysCAD database contains corresponding species for mapping to the second liquid phase using the individual phase "o" for organic, i.e.:<br />
**C12H26(o)<br />
**R3NH2SO4(o)<br />
**etc...<br />
<br />
In this case, we would modify the above to:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
'''Second_Liquid_Phase_Name0=o'''</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Overview&diff=78644OLI Overview2024-02-29T20:29:23Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category:Models]] [[Category:OLI]]<br />
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{OLI Header Tabs|currentpage=1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from OLI Database File]], [[Example - 06 OLI Projects|OLI Example Projects]]<br />
----<br />
<br />
{{Available139|31866}} - Next generation of OLI models in SysCAD as part of TCE. Older models have been archived as legacy models.<br />
{{TOC}}<br />
== Overview ==<br />
<br />
OLI Systems is a leading Electrolyte Simulation Software used to predicate equilibrium conditions and properties (such as pH) for aqueous chemistry.<br />
*It is developed and maintained by OLI Systems. ([https://www.olisystems.com/ olisystems.com])<br />
*To use OLI in SysCAD it is assumed that the user has some familiarity with the theory and use of the OLI Systems software programs.<br />
*The SysCAD OLI library option (in ScdOLI2.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons.<br />
*'''OLI Engine Runtime (32-bit)''' is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option.<br />
*"OLI Engine Runtime" includes '''OLI Chemistry Wizard''' which can be used to create the OLI database (dbs) files required by SysCAD.<br />
*The user may also purchase '''OLI Studio: Stream Analyzer''' from OLI Systems Inc. OLI Studio can also be used to create OLI database files required by SysCAD.<br />
<br />
Additional Notes:<br />
*The "OLI Engine: Developer Edition" License is NOT required to use OLI in SysCAD.<br />
*"OLI Studio" or "OLI Studio: Stream Analyzer" does not include an "OLI Engine Runtime" license, this needs to be purchased separately from OLI Systems.<br />
*"OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine" - this is the same thing.<br />
*KWA Kenwalt Australia (SysCAD) are OLI Alliance Partners. ([https://www.olisystems.com/partners/ Alliance Partners])<br />
*From {{Available139|||y}}, a TCE add-on is required instead of a legacy separate individual "SysCAD OLI" License add-on.<br />
*For legacy OLI models (ScdOLI.DLL) SysCAD version of Build 137, 138 or 139 is required. It cannot be used within the same project as the new TCE OLI Option. The legacy version will be discontinued in the next SysCAD Build.<br />
*OLI in SysCAD is not implemented as a Species Properties Model but as unit models for use at appropriate locations in a plant model.<br />
<br />
== OLI Systems Software ==<br />
[https://www.olisystems.com/software/oli-studio/ [[File:OLI_Logo.png |link=]]]<br />
<br />
The following are direct quotes from the OLI website:<br />
:''Analyze chemical streams, predict mineral scaling and corrosion in industrial chemical processes.''<br />
:''The behavior of electrolyte and water chemistry governs industrial chemical processes performance. OLI Systems makes it possible to deeply understand these behaviors to drive effective and efficient equipment design and process operations.''<br />
<br />
Please visit the [https://www.olisystems.com/software/oli-studio/ OLI Studio] for more information.<br />
<br />
The TCE add-on in SysCAD does not require "OLI Engine: Developer Edition" to be installed. However, users must obtain the "OLI Engine Runtime (32 bit)" license from OLI Systems, also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
== Checking that OLI SysCAD integration is working == <br />
<br />
We recommend performing the following checks prior to creating user OLI projects to ensure OLI SysCAD intergration is working correctly.<br />
# [[Licensing#Checking_Current_License_Information|Check the '''License Information''']], the following add-ons must be allowed (Yes)<br />
#* Energy Balance <br />
#* Integration Libraries (formerly SMDK Runtime)<br />
#* Models: TCE (PHREEQC, OLI, AQSol and ChemApp)<br />
# Check that "'''OLI Engine Runtime''' 32 bit" (also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine") is installed and licensed from OLI systems.<br />
#* SysCAD requires a valid OLI Engine to work. See [[#OLI Engine Version support|OLI Engine Version]]<br />
# Check that the distributed SysCAD OLI example project will run without issues.<br />
#*Open any of the \SysCAD139\Examples\06 OLI\OLIFull [[Example_-_06_OLI_Projects|example projects]], after project load, check the message window for any reported errors.<br />
#*If errors were encountered, use the messages provided to fix the errors and try again.<br />
<br />
== Models ==<br />
<br />
'''OLI Option unit models:'''<br />
* [[OLI Model Configuration]] - Used to define and view various options for the selected OLI database, including management of mapping of SysCAD species list to species list used in OLI.<br />
* [[OLI Direct Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a user defined OLI stream.<br />
* [[OLI Side Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a SysCAD stream in the current project.<br />
* [[OLI Reactor 2]] - Include this model in a SysCAD stream to use OLI to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
* [[OLI Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded OLI calculations.<br />
* [[OLI Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded OLI calculations.<br />
* [[OLI Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded OLI calculations. OLI can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[OLI Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using OLI species.<br />
* [[OLI Solvent Extraction]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded OLI calculations.<br />
* [[OLI Pond Model]] - Include this model in a SysCAD flowsheet (Dynamic mode) to specify a dynamic pond using embedded OLI calculations.<br />
'''OLI Legacy unit models:'''<br />
<br />
The following models are used for backward compatibility purposes only. These will be discontinued from Build 140 and users should convert any existing projects to use the TCE OLI models. See [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for suggested work flow.<br />
*[[OLI Chemistry Model]] - please change to the new model [[OLI Model Configuration]] <br />
*[[OLI Sample Model]] - please change to the new model [[OLI Direct Calc Model]] <br />
*[[OLI Reactor]] - please change to the new model [[OLI Reactor 2]]<br />
<br />
'''Species Mapping:'''<br />
*Ionlist is used to breakdown the species to ions. Please see [[TCE Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
OLI evaporation models using OLI dlls that do not incorporate VLE calculations are suitable for water evaporation only.<br />
<br />
== OLI SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new OLI SysCAD project group. <br />
<br />
If user only intend to use OLI for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use OLI to evaluate SysCAD streams, then follow (B).<br />
<br />
'''Important Notes''': <br />
<br />
#OLI software requires an OLI configuration file (*.dbs).<br />
#see [[#Referenced_File|OLI Referenced File]] for instructions.<br />
<br />
'''<big>(A)</big>''' Using OLI as stand-alone thermodynamic calculation engine to perform OLI equilibrium calculations:<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[OLI Model Configuration]]<br />
#*load in the OLI Model Definition file <br />
#Inset a [[OLI Direct Calc Model]]. Use the direct calc to perform OLI equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using OLI to evaluate SysCAD streams or as part of the SysCAD flowsheet:<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the OLI model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, OLI Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the OLI SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the required Species from the [[Species Configuration|Species Tab]].<br />
#*select the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create a SysCAD project. <br />
#Add [[OLI Model Configuration]], <br />
#*load in the OLI Model .dll file <br />
#*complete the OLI Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add OLI unit models to the project where appropriate.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from OLI Database File|Generate SysCAD database from OLI Database File]]<br />
<br />
== Referenced File ==<br />
<br />
The file that will be referenced by the SysCAD OLI Chemistry Model is the OLI Chemistry Model Database file created in OLI, e.g. NickelSpecies.dbs. <br />
<br />
The "OLI Chemistry Model" (dbs file), can be generated using "'''OLI Chemistry Wizard'''" or "'''OLI Studio'''".<br />
<br />
To generate an "OLI Chemistry Model" in OLI Studio perform the following steps:<br />
* Create a stream in a new project or for an existing OLI project (*.oad) file.<br />
* Select MSE or AQ databank.<br />
* On the Definition tab, add the components of interest.<br />
* Run an isothermal single point calculation.<br />
* If File Viewer tab is not visible, select menu Tools|Options. Then for Plug-Ins select the "OLI File Viewer" option and press OK.<br />
* On the File Viewer tab, for "File Type" select "Generated Model File". Push "Save File" button which will prompt to save a file with .dbs extension. This is the file required by SysCAD.<br />
<br />
'''Notes:'''<br />
# This file is essential for the OLI Chemistry Model in SysCAD to function. <br />
# The file can be saved at any location - it does not have to be saved in the SysCAD project.<br />
<br />
== OLI Engine Version support ==<br />
<br />
OLI Engine Runtime (32-bit) is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option. "OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
Multiple versions support of installed OLI engine is {{Available139|33127|y}}. This applies to both OLI_Legacy and OLI_TCE SysCAD integration. Therefore, it is possible to<br />
#use “SysCAD OLI Legacy” (scdoli.dll) with OLI engine version 10.x or 11.x, OR<br />
#use “SysCAD TCE OLI” (scdoli2.dll) with OLI engine version 10.x or 11.x. (Recommended)<br />
<br />
'''NOTES:'''<br />
*User must select the required OLI SysCAD integration (scdoli.dll OR scdoli2.dll) to use in the project, it is NOT possible to include both in the same project. <br />
*The OLI legacy integration models will be discontinued in future versions. User should convert any projects using OLI Legacy integration models to use the new OLI TCE suite of models. Please see [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for hints about project conversion.<br />
<br />
== Converting OLI Legacy Project to use OLI TCE models ==<br />
<br />
The new OLI TCE Integration suite of models were completely re-design from the ground up. There is no “automated” upgrade path for converting projects using OLI_Legacy models to OLI_TCE models. <br />
<br />
A recommended conversion workflow is:<br />
# Create folder '''"OLI_Legacy"''' + '''Cfgfiles''' subfolder: <br />
#*Store your OLI_Legacy project here<br />
#*make sure the Cfgfiles is set up to open the legacy project (using scdoli.dll)<br />
#*The purpose of this folder is so you can still open the legacy project for reference and comparison. <br />
# Create folder "'''OLI_Preparation'''" + '''Cfgfiles''' subfolder <br />
#*make a copy of the legacy project here, this is the project you need to work on in preparation for OLI_TCE model changes.<br />
#*The cfgfiles subfolder can be the same as OLI_Legacy.<br />
#*Open the project and remove all the OLI_Legacy models, do these in the following order:<br />
#**use "Change Unit" to change all the [[OLI Reactor]] to "Tank"<br />
#**Delete any [[OLI Sample Model]]<br />
#**Delete the [[OLI Chemistry Model]]<br />
#*Save the Project. The project should be free of any OLI_legacy models.<br />
#*''Edit the configuration file to remove the '''scdoli.dll''' group of models.''<br />
#*Reopen the model to check if the project can be loaded. If successful, then the project is ready for OLI_TCE model changes.<br />
# Create folder "'''OLI_TCE'''" + '''Cfgfiles''' subfolder: <br />
#*make a copy of the "OLI_Preparation" project here.<br />
#*''Edit the configuration file to use the '''scdoli2.dll''' group of models.''<br />
#*Edit the TCE tab to select the correct OLI options (engine version, dll path, database selection, etc.)<br />
#*Open the project using the edited configuration file.<br />
#*Edit the project in the following order:<br />
#**Add and setup [[OLI Model Configuration]] to replace the [[OLI Chemistry Model]]<br />
#**Add and setup [[OLI Direct Calc Model]] to replace the [[OLI Sample Model]]<br />
#**For any [[OLI Reactor]] that were changed to "Tank", use "Change Unit" to change them to [[OLI Reactor 2]] or any other more relevant OLI unit [[#Models|models]]. <br />
#*Fix the controls and reports.<br />
#*Save the project. <br />
#*Solve and debug the project as usual.<br />
#*If possible, open the OLI_Legacy model for reference or comparison.<br />
<!--<br />
== Liquid 2 Functionality in SysCAD ==<br />
<br />
{{Available139|XXXXX}} liquid 2 functionality is available for use in the SysCAD-OLI interface. This functionality allows for the modelling of unit operations where two immiscible liquids are present, such as [[OLI Solvent Extraction]]. To use this functionality, the following line must be manually added to the [OLI] section of the SysCAD configuration file.<br />
<br />
Given an OLI section that looks like this in the cfg file (you can edit the cfg file using any text editor):<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
<br />
where:<br />
*SolvEx.dbs contains a second liquid phase<br />
*The SysCAD database contains corresponding species for mapping to the second liquid phase using the individual phase "o" for organic, i.e.:<br />
**C12H26(o)<br />
**R3NH2SO4(o)<br />
**etc...<br />
<br />
In this case, we would modify the above to:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
'''Second_Liquid_Phase_Name0=o'''<br />
<br />
--></div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Overview&diff=78643OLI Overview2024-02-29T20:23:06Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category:Models]] [[Category:OLI]]<br />
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{OLI Header Tabs|currentpage=1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from OLI Database File]], [[Example - 06 OLI Projects|OLI Example Projects]]<br />
----<br />
<br />
{{Available139|31866}} - Next generation of OLI models in SysCAD as part of TCE. Older models have been archived as legacy models.<br />
{{TOC}}<br />
== Overview ==<br />
<br />
OLI Systems is a leading Electrolyte Simulation Software used to predicate equilibrium conditions and properties (such as pH) for aqueous chemistry.<br />
*It is developed and maintained by OLI Systems. ([https://www.olisystems.com/ olisystems.com])<br />
*To use OLI in SysCAD it is assumed that the user has some familiarity with the theory and use of the OLI Systems software programs.<br />
*The SysCAD OLI library option (in ScdOLI2.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons.<br />
*'''OLI Engine Runtime (32-bit)''' is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option.<br />
*"OLI Engine Runtime" includes '''OLI Chemistry Wizard''' which can be used to create the OLI database (dbs) files required by SysCAD.<br />
*The user may also purchase '''OLI Studio: Stream Analyzer''' from OLI Systems Inc. OLI Studio can also be used to create OLI database files required by SysCAD.<br />
<br />
Additional Notes:<br />
*The "OLI Engine: Developer Edition" License is NOT required to use OLI in SysCAD.<br />
*"OLI Studio" or "OLI Studio: Stream Analyzer" does not include an "OLI Engine Runtime" license, this needs to be purchased separately from OLI Systems.<br />
*"OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine" - this is the same thing.<br />
*KWA Kenwalt Australia (SysCAD) are OLI Alliance Partners. ([https://www.olisystems.com/partners/ Alliance Partners])<br />
*From {{Available139|||y}}, a TCE add-on is required instead of a legacy separate individual "SysCAD OLI" License add-on.<br />
*For legacy OLI models (ScdOLI.DLL) SysCAD version of Build 137, 138 or 139 is required. It cannot be used within the same project as the new TCE OLI Option. The legacy version will be discontinued in the next SysCAD Build.<br />
*OLI in SysCAD is not implemented as a Species Properties Model but as unit models for use at appropriate locations in a plant model.<br />
<br />
== OLI Systems Software ==<br />
[https://www.olisystems.com/software/oli-studio/ [[File:OLI_Logo.png |link=]]]<br />
<br />
The following are direct quotes from the OLI website:<br />
:''Analyze chemical streams, predict mineral scaling and corrosion in industrial chemical processes.''<br />
:''The behavior of electrolyte and water chemistry governs industrial chemical processes performance. OLI Systems makes it possible to deeply understand these behaviors to drive effective and efficient equipment design and process operations.''<br />
<br />
Please visit the [https://www.olisystems.com/software/oli-studio/ OLI Studio] for more information.<br />
<br />
The TCE add-on in SysCAD does not require "OLI Engine: Developer Edition" to be installed. However, users must obtain the "OLI Engine Runtime (32 bit)" license from OLI Systems, also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
== Checking that OLI SysCAD integration is working == <br />
<br />
We recommend performing the following checks prior to creating user OLI projects to ensure OLI SysCAD intergration is working correctly.<br />
# [[Licensing#Checking_Current_License_Information|Check the '''License Information''']], the following add-ons must be allowed (Yes)<br />
#* Energy Balance <br />
#* Integration Libraries (formerly SMDK Runtime)<br />
#* Models: TCE (PHREEQC, OLI, AQSol and ChemApp)<br />
# Check that "'''OLI Engine Runtime''' 32 bit" (also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine") is installed and licensed from OLI systems.<br />
#* SysCAD requires a valid OLI Engine to work. See [[#OLI Engine Version support|OLI Engine Version]]<br />
# Check that the distributed SysCAD OLI example project will run without issues.<br />
#*Open any of the \SysCAD139\Examples\06 OLI\OLIFull [[Example_-_06_OLI_Projects|example projects]], after project load, check the message window for any reported errors.<br />
#*If errors were encountered, use the messages provided to fix the errors and try again.<br />
<br />
== Models ==<br />
<br />
'''OLI Option unit models:'''<br />
* [[OLI Model Configuration]] - Used to define and view various options for the selected OLI database, including management of mapping of SysCAD species list to species list used in OLI.<br />
* [[OLI Direct Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a user defined OLI stream.<br />
* [[OLI Side Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a SysCAD stream in the current project.<br />
* [[OLI Reactor 2]] - Include this model in a SysCAD stream to use OLI to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
* [[OLI Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded OLI calculations.<br />
* [[OLI Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded OLI calculations.<br />
* [[OLI Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded OLI calculations. OLI can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[OLI Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using OLI species.<br />
* [[OLI Solvent Extraction]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded OLI calculations.<br />
* [[OLI Pond Model]] - Include this model in a SysCAD flowsheet (Dynamic mode) to specify a dynamic pond using embedded OLI calculations.<br />
'''OLI Legacy unit models:'''<br />
<br />
The following models are used for backward compatibility purposes only. These will be discontinued from Build 140 and users should convert any existing projects to use the TCE OLI models. See [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for suggested work flow.<br />
*[[OLI Chemistry Model]] - please change to the new model [[OLI Model Configuration]] <br />
*[[OLI Sample Model]] - please change to the new model [[OLI Direct Calc Model]] <br />
*[[OLI Reactor]] - please change to the new model [[OLI Reactor 2]]<br />
<br />
'''Species Mapping:'''<br />
*Ionlist is used to breakdown the species to ions. Please see [[TCE Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
OLI evaporation models using OLI dlls that do not incorporate VLE calculations are suitable for water evaporation only.<br />
<br />
== OLI SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new OLI SysCAD project group. <br />
<br />
If user only intend to use OLI for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use OLI to evaluate SysCAD streams, then follow (B).<br />
<br />
'''Important Notes''': <br />
<br />
#OLI software requires an OLI configuration file (*.dbs).<br />
#see [[#Referenced_File|OLI Referenced File]] for instructions.<br />
<br />
'''<big>(A)</big>''' Using OLI as stand-alone thermodynamic calculation engine to perform OLI equilibrium calculations:<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[OLI Model Configuration]]<br />
#*load in the OLI Model Definition file <br />
#Inset a [[OLI Direct Calc Model]]. Use the direct calc to perform OLI equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using OLI to evaluate SysCAD streams or as part of the SysCAD flowsheet:<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the OLI model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, OLI Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the OLI SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the required Species from the [[Species Configuration|Species Tab]].<br />
#*select the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create a SysCAD project. <br />
#Add [[OLI Model Configuration]], <br />
#*load in the OLI Model .dll file <br />
#*complete the OLI Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add OLI unit models to the project where appropriate.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from OLI Database File|Generate SysCAD database from OLI Database File]]<br />
<br />
== Referenced File ==<br />
<br />
The file that will be referenced by the SysCAD OLI Chemistry Model is the OLI Chemistry Model Database file created in OLI, e.g. NickelSpecies.dbs. <br />
<br />
The "OLI Chemistry Model" (dbs file), can be generated using "'''OLI Chemistry Wizard'''" or "'''OLI Studio'''".<br />
<br />
To generate an "OLI Chemistry Model" in OLI Studio perform the following steps:<br />
* Create a stream in a new project or for an existing OLI project (*.oad) file.<br />
* Select MSE or AQ databank.<br />
* On the Definition tab, add the components of interest.<br />
* Run an isothermal single point calculation.<br />
* If File Viewer tab is not visible, select menu Tools|Options. Then for Plug-Ins select the "OLI File Viewer" option and press OK.<br />
* On the File Viewer tab, for "File Type" select "Generated Model File". Push "Save File" button which will prompt to save a file with .dbs extension. This is the file required by SysCAD.<br />
<br />
'''Notes:'''<br />
# This file is essential for the OLI Chemistry Model in SysCAD to function. <br />
# The file can be saved at any location - it does not have to be saved in the SysCAD project.<br />
<br />
== OLI Engine Version support ==<br />
<br />
OLI Engine Runtime (32-bit) is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option. "OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
Multiple versions support of installed OLI engine is {{Available139|33127|y}}. This applies to both OLI_Legacy and OLI_TCE SysCAD integration. Therefore, it is possible to<br />
#use “SysCAD OLI Legacy” (scdoli.dll) with OLI engine version 10.x or 11.x, OR<br />
#use “SysCAD TCE OLI” (scdoli2.dll) with OLI engine version 10.x or 11.x. (Recommended)<br />
<br />
'''NOTES:'''<br />
*User must select the required OLI SysCAD integration (scdoli.dll OR scdoli2.dll) to use in the project, it is NOT possible to include both in the same project. <br />
*The OLI legacy integration models will be discontinued in future versions. User should convert any projects using OLI Legacy integration models to use the new OLI TCE suite of models. Please see [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for hints about project conversion.<br />
<br />
== Converting OLI Legacy Project to use OLI TCE models ==<br />
<br />
The new OLI TCE Integration suite of models were completely re-design from the ground up. There is no “automated” upgrade path for converting projects using OLI_Legacy models to OLI_TCE models. <br />
<br />
A recommended conversion workflow is:<br />
# Create folder '''"OLI_Legacy"''' + '''Cfgfiles''' subfolder: <br />
#*Store your OLI_Legacy project here<br />
#*make sure the Cfgfiles is set up to open the legacy project (using scdoli.dll)<br />
#*The purpose of this folder is so you can still open the legacy project for reference and comparison. <br />
# Create folder "'''OLI_Preparation'''" + '''Cfgfiles''' subfolder <br />
#*make a copy of the legacy project here, this is the project you need to work on in preparation for OLI_TCE model changes.<br />
#*The cfgfiles subfolder can be the same as OLI_Legacy.<br />
#*Open the project and remove all the OLI_Legacy models, do these in the following order:<br />
#**use "Change Unit" to change all the [[OLI Reactor]] to "Tank"<br />
#**Delete any [[OLI Sample Model]]<br />
#**Delete the [[OLI Chemistry Model]]<br />
#*Save the Project. The project should be free of any OLI_legacy models.<br />
#*''Edit the configuration file to remove the '''scdoli.dll''' group of models.''<br />
#*Reopen the model to check if the project can be loaded. If successful, then the project is ready for OLI_TCE model changes.<br />
# Create folder "'''OLI_TCE'''" + '''Cfgfiles''' subfolder: <br />
#*make a copy of the "OLI_Preparation" project here.<br />
#*''Edit the configuration file to use the '''scdoli2.dll''' group of models.''<br />
#*Edit the TCE tab to select the correct OLI options (engine version, dll path, database selection, etc.)<br />
#*Open the project using the edited configuration file.<br />
#*Edit the project in the following order:<br />
#**Add and setup [[OLI Model Configuration]] to replace the [[OLI Chemistry Model]]<br />
#**Add and setup [[OLI Direct Calc Model]] to replace the [[OLI Sample Model]]<br />
#**For any [[OLI Reactor]] that were changed to "Tank", use "Change Unit" to change them to [[OLI Reactor 2]] or any other more relevant OLI unit [[#Models|models]]. <br />
#*Fix the controls and reports.<br />
#*Save the project. <br />
#*Solve and debug the project as usual.<br />
#*If possible, open the OLI_Legacy model for reference or comparison.<br />
<!--<br />
== Liquid 2 Functionality in SysCAD ==<br />
<br />
{{Available139|XXXXX}} liquid 2 functionality is available for use in the SysCAD-OLI interface. This functionality allows for the modelling of unit operations where two immiscible liquids are present, such as [[OLI Solvent Extraction]]. To use this functionality, the following line must be manually added to the [OLI] section of the SysCAD configuration file.<br />
<br />
Suppose we have an OLI section that looks like this in the cfg file (you can edit the cfg file using any text editor):<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
<br />
<br />
Let us also suppose that we have added species to the SysCAD database using "o" as the individual phase for organic. Thus, in our SysCAD database we have species such as:<br />
<br />
C12H26(o)<br />
R3NH2SO4(o)<br />
etc...<br />
<br />
In this case, we would modify the above to:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
'''Second_Liquid_Phase_Name0=o'''<br />
<br />
--></div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Overview&diff=78642OLI Overview2024-02-29T20:21:59Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category:Models]] [[Category:OLI]]<br />
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{OLI Header Tabs|currentpage=1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from OLI Database File]], [[Example - 06 OLI Projects|OLI Example Projects]]<br />
----<br />
<br />
{{Available139|31866}} - Next generation of OLI models in SysCAD as part of TCE. Older models have been archived as legacy models.<br />
{{TOC}}<br />
== Overview ==<br />
<br />
OLI Systems is a leading Electrolyte Simulation Software used to predicate equilibrium conditions and properties (such as pH) for aqueous chemistry.<br />
*It is developed and maintained by OLI Systems. ([https://www.olisystems.com/ olisystems.com])<br />
*To use OLI in SysCAD it is assumed that the user has some familiarity with the theory and use of the OLI Systems software programs.<br />
*The SysCAD OLI library option (in ScdOLI2.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons.<br />
*'''OLI Engine Runtime (32-bit)''' is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option.<br />
*"OLI Engine Runtime" includes '''OLI Chemistry Wizard''' which can be used to create the OLI database (dbs) files required by SysCAD.<br />
*The user may also purchase '''OLI Studio: Stream Analyzer''' from OLI Systems Inc. OLI Studio can also be used to create OLI database files required by SysCAD.<br />
<br />
Additional Notes:<br />
*The "OLI Engine: Developer Edition" License is NOT required to use OLI in SysCAD.<br />
*"OLI Studio" or "OLI Studio: Stream Analyzer" does not include an "OLI Engine Runtime" license, this needs to be purchased separately from OLI Systems.<br />
*"OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine" - this is the same thing.<br />
*KWA Kenwalt Australia (SysCAD) are OLI Alliance Partners. ([https://www.olisystems.com/partners/ Alliance Partners])<br />
*From {{Available139|||y}}, a TCE add-on is required instead of a legacy separate individual "SysCAD OLI" License add-on.<br />
*For legacy OLI models (ScdOLI.DLL) SysCAD version of Build 137, 138 or 139 is required. It cannot be used within the same project as the new TCE OLI Option. The legacy version will be discontinued in the next SysCAD Build.<br />
*OLI in SysCAD is not implemented as a Species Properties Model but as unit models for use at appropriate locations in a plant model.<br />
<br />
== OLI Systems Software ==<br />
[https://www.olisystems.com/software/oli-studio/ [[File:OLI_Logo.png |link=]]]<br />
<br />
The following are direct quotes from the OLI website:<br />
:''Analyze chemical streams, predict mineral scaling and corrosion in industrial chemical processes.''<br />
:''The behavior of electrolyte and water chemistry governs industrial chemical processes performance. OLI Systems makes it possible to deeply understand these behaviors to drive effective and efficient equipment design and process operations.''<br />
<br />
Please visit the [https://www.olisystems.com/software/oli-studio/ OLI Studio] for more information.<br />
<br />
The TCE add-on in SysCAD does not require "OLI Engine: Developer Edition" to be installed. However, users must obtain the "OLI Engine Runtime (32 bit)" license from OLI Systems, also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
== Checking that OLI SysCAD integration is working == <br />
<br />
We recommend performing the following checks prior to creating user OLI projects to ensure OLI SysCAD intergration is working correctly.<br />
# [[Licensing#Checking_Current_License_Information|Check the '''License Information''']], the following add-ons must be allowed (Yes)<br />
#* Energy Balance <br />
#* Integration Libraries (formerly SMDK Runtime)<br />
#* Models: TCE (PHREEQC, OLI, AQSol and ChemApp)<br />
# Check that "'''OLI Engine Runtime''' 32 bit" (also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine") is installed and licensed from OLI systems.<br />
#* SysCAD requires a valid OLI Engine to work. See [[#OLI Engine Version support|OLI Engine Version]]<br />
# Check that the distributed SysCAD OLI example project will run without issues.<br />
#*Open any of the \SysCAD139\Examples\06 OLI\OLIFull [[Example_-_06_OLI_Projects|example projects]], after project load, check the message window for any reported errors.<br />
#*If errors were encountered, use the messages provided to fix the errors and try again.<br />
<br />
== Models ==<br />
<br />
'''OLI Option unit models:'''<br />
* [[OLI Model Configuration]] - Used to define and view various options for the selected OLI database, including management of mapping of SysCAD species list to species list used in OLI.<br />
* [[OLI Direct Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a user defined OLI stream.<br />
* [[OLI Side Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a SysCAD stream in the current project.<br />
* [[OLI Reactor 2]] - Include this model in a SysCAD stream to use OLI to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
* [[OLI Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded OLI calculations.<br />
* [[OLI Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded OLI calculations.<br />
* [[OLI Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded OLI calculations. OLI can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[OLI Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using OLI species.<br />
* [[OLI Solvent Extraction]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded OLI calculations.<br />
* [[OLI Pond Model]] - Include this model in a SysCAD flowsheet (Dynamic mode) to specify a dynamic pond using embedded OLI calculations.<br />
'''OLI Legacy unit models:'''<br />
<br />
The following models are used for backward compatibility purposes only. These will be discontinued from Build 140 and users should convert any existing projects to use the TCE OLI models. See [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for suggested work flow.<br />
*[[OLI Chemistry Model]] - please change to the new model [[OLI Model Configuration]] <br />
*[[OLI Sample Model]] - please change to the new model [[OLI Direct Calc Model]] <br />
*[[OLI Reactor]] - please change to the new model [[OLI Reactor 2]]<br />
<br />
'''Species Mapping:'''<br />
*Ionlist is used to breakdown the species to ions. Please see [[TCE Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
OLI evaporation models using OLI dlls that do not incorporate VLE calculations are suitable for water evaporation only.<br />
<br />
== OLI SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new OLI SysCAD project group. <br />
<br />
If user only intend to use OLI for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use OLI to evaluate SysCAD streams, then follow (B).<br />
<br />
'''Important Notes''': <br />
<br />
#OLI software requires an OLI configuration file (*.dbs).<br />
#see [[#Referenced_File|OLI Referenced File]] for instructions.<br />
<br />
'''<big>(A)</big>''' Using OLI as stand-alone thermodynamic calculation engine to perform OLI equilibrium calculations:<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[OLI Model Configuration]]<br />
#*load in the OLI Model Definition file <br />
#Inset a [[OLI Direct Calc Model]]. Use the direct calc to perform OLI equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using OLI to evaluate SysCAD streams or as part of the SysCAD flowsheet:<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the OLI model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, OLI Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the OLI SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the required Species from the [[Species Configuration|Species Tab]].<br />
#*select the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create a SysCAD project. <br />
#Add [[OLI Model Configuration]], <br />
#*load in the OLI Model .dll file <br />
#*complete the OLI Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add OLI unit models to the project where appropriate.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from OLI Database File|Generate SysCAD database from OLI Database File]]<br />
<br />
== Referenced File ==<br />
<br />
The file that will be referenced by the SysCAD OLI Chemistry Model is the OLI Chemistry Model Database file created in OLI, e.g. NickelSpecies.dbs. <br />
<br />
The "OLI Chemistry Model" (dbs file), can be generated using "'''OLI Chemistry Wizard'''" or "'''OLI Studio'''".<br />
<br />
To generate an "OLI Chemistry Model" in OLI Studio perform the following steps:<br />
* Create a stream in a new project or for an existing OLI project (*.oad) file.<br />
* Select MSE or AQ databank.<br />
* On the Definition tab, add the components of interest.<br />
* Run an isothermal single point calculation.<br />
* If File Viewer tab is not visible, select menu Tools|Options. Then for Plug-Ins select the "OLI File Viewer" option and press OK.<br />
* On the File Viewer tab, for "File Type" select "Generated Model File". Push "Save File" button which will prompt to save a file with .dbs extension. This is the file required by SysCAD.<br />
<br />
'''Notes:'''<br />
# This file is essential for the OLI Chemistry Model in SysCAD to function. <br />
# The file can be saved at any location - it does not have to be saved in the SysCAD project.<br />
<br />
== OLI Engine Version support ==<br />
<br />
OLI Engine Runtime (32-bit) is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option. "OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
Multiple versions support of installed OLI engine is {{Available139|33127|y}}. This applies to both OLI_Legacy and OLI_TCE SysCAD integration. Therefore, it is possible to<br />
#use “SysCAD OLI Legacy” (scdoli.dll) with OLI engine version 10.x or 11.x, OR<br />
#use “SysCAD TCE OLI” (scdoli2.dll) with OLI engine version 10.x or 11.x. (Recommended)<br />
<br />
'''NOTES:'''<br />
*User must select the required OLI SysCAD integration (scdoli.dll OR scdoli2.dll) to use in the project, it is NOT possible to include both in the same project. <br />
*The OLI legacy integration models will be discontinued in future versions. User should convert any projects using OLI Legacy integration models to use the new OLI TCE suite of models. Please see [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for hints about project conversion.<br />
<br />
== Converting OLI Legacy Project to use OLI TCE models ==<br />
<br />
The new OLI TCE Integration suite of models were completely re-design from the ground up. There is no “automated” upgrade path for converting projects using OLI_Legacy models to OLI_TCE models. <br />
<br />
A recommended conversion workflow is:<br />
# Create folder '''"OLI_Legacy"''' + '''Cfgfiles''' subfolder: <br />
#*Store your OLI_Legacy project here<br />
#*make sure the Cfgfiles is set up to open the legacy project (using scdoli.dll)<br />
#*The purpose of this folder is so you can still open the legacy project for reference and comparison. <br />
# Create folder "'''OLI_Preparation'''" + '''Cfgfiles''' subfolder <br />
#*make a copy of the legacy project here, this is the project you need to work on in preparation for OLI_TCE model changes.<br />
#*The cfgfiles subfolder can be the same as OLI_Legacy.<br />
#*Open the project and remove all the OLI_Legacy models, do these in the following order:<br />
#**use "Change Unit" to change all the [[OLI Reactor]] to "Tank"<br />
#**Delete any [[OLI Sample Model]]<br />
#**Delete the [[OLI Chemistry Model]]<br />
#*Save the Project. The project should be free of any OLI_legacy models.<br />
#*''Edit the configuration file to remove the '''scdoli.dll''' group of models.''<br />
#*Reopen the model to check if the project can be loaded. If successful, then the project is ready for OLI_TCE model changes.<br />
# Create folder "'''OLI_TCE'''" + '''Cfgfiles''' subfolder: <br />
#*make a copy of the "OLI_Preparation" project here.<br />
#*''Edit the configuration file to use the '''scdoli2.dll''' group of models.''<br />
#*Edit the TCE tab to select the correct OLI options (engine version, dll path, database selection, etc.)<br />
#*Open the project using the edited configuration file.<br />
#*Edit the project in the following order:<br />
#**Add and setup [[OLI Model Configuration]] to replace the [[OLI Chemistry Model]]<br />
#**Add and setup [[OLI Direct Calc Model]] to replace the [[OLI Sample Model]]<br />
#**For any [[OLI Reactor]] that were changed to "Tank", use "Change Unit" to change them to [[OLI Reactor 2]] or any other more relevant OLI unit [[#Models|models]]. <br />
#*Fix the controls and reports.<br />
#*Save the project. <br />
#*Solve and debug the project as usual.<br />
#*If possible, open the OLI_Legacy model for reference or comparison.<br />
<!--<br />
== Liquid 2 Functionality in SysCAD ==<br />
<br />
Starting in Build 139.XXXXX, liquid 2 functionality is available for use in the SysCAD-OLI interface. This functionality allows for the modelling of unit operations where two immiscible liquids are present, such as [[OLI Solvent Extraction]]. To use this functionality, the following line must be manually added to the [OLI] section of the SysCAD configuration file.<br />
<br />
Suppose we have an OLI section that looks like this in the cfg file (you can edit the cfg file using any text editor):<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
<br />
<br />
Let us also suppose that we have added species to the SysCAD database using "o" as the individual phase for organic. Thus, in our SysCAD database we have species such as:<br />
<br />
C12H26(o)<br />
R3NH2SO4(o)<br />
etc...<br />
<br />
In this case, we would modify the above to:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
'''Second_Liquid_Phase_Name0=o'''<br />
<br />
--></div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Overview&diff=78641OLI Overview2024-02-29T20:20:46Z<p>Kevin.Heppner: /* Liquid 2 Functionality in SysCAD */</p>
<hr />
<div>[[Category:Models]] [[Category:OLI]]<br />
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{OLI Header Tabs|currentpage=1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from OLI Database File]], [[Example - 06 OLI Projects|OLI Example Projects]]<br />
----<br />
<br />
{{Available139|31866}} - Next generation of OLI models in SysCAD as part of TCE. Older models have been archived as legacy models.<br />
{{TOC}}<br />
== Overview ==<br />
<br />
OLI Systems is a leading Electrolyte Simulation Software used to predicate equilibrium conditions and properties (such as pH) for aqueous chemistry.<br />
*It is developed and maintained by OLI Systems. ([https://www.olisystems.com/ olisystems.com])<br />
*To use OLI in SysCAD it is assumed that the user has some familiarity with the theory and use of the OLI Systems software programs.<br />
*The SysCAD OLI library option (in ScdOLI2.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons.<br />
*'''OLI Engine Runtime (32-bit)''' is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option.<br />
*"OLI Engine Runtime" includes '''OLI Chemistry Wizard''' which can be used to create the OLI database (dbs) files required by SysCAD.<br />
*The user may also purchase '''OLI Studio: Stream Analyzer''' from OLI Systems Inc. OLI Studio can also be used to create OLI database files required by SysCAD.<br />
<br />
Additional Notes:<br />
*The "OLI Engine: Developer Edition" License is NOT required to use OLI in SysCAD.<br />
*"OLI Studio" or "OLI Studio: Stream Analyzer" does not include an "OLI Engine Runtime" license, this needs to be purchased separately from OLI Systems.<br />
*"OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine" - this is the same thing.<br />
*KWA Kenwalt Australia (SysCAD) are OLI Alliance Partners. ([https://www.olisystems.com/partners/ Alliance Partners])<br />
*From {{Available139|||y}}, a TCE add-on is required instead of a legacy separate individual "SysCAD OLI" License add-on.<br />
*For legacy OLI models (ScdOLI.DLL) SysCAD version of Build 137, 138 or 139 is required. It cannot be used within the same project as the new TCE OLI Option. The legacy version will be discontinued in the next SysCAD Build.<br />
*OLI in SysCAD is not implemented as a Species Properties Model but as unit models for use at appropriate locations in a plant model.<br />
<br />
== OLI Systems Software ==<br />
[https://www.olisystems.com/software/oli-studio/ [[File:OLI_Logo.png |link=]]]<br />
<br />
The following are direct quotes from the OLI website:<br />
:''Analyze chemical streams, predict mineral scaling and corrosion in industrial chemical processes.''<br />
:''The behavior of electrolyte and water chemistry governs industrial chemical processes performance. OLI Systems makes it possible to deeply understand these behaviors to drive effective and efficient equipment design and process operations.''<br />
<br />
Please visit the [https://www.olisystems.com/software/oli-studio/ OLI Studio] for more information.<br />
<br />
The TCE add-on in SysCAD does not require "OLI Engine: Developer Edition" to be installed. However, users must obtain the "OLI Engine Runtime (32 bit)" license from OLI Systems, also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
== Checking that OLI SysCAD integration is working == <br />
<br />
We recommend performing the following checks prior to creating user OLI projects to ensure OLI SysCAD intergration is working correctly.<br />
# [[Licensing#Checking_Current_License_Information|Check the '''License Information''']], the following add-ons must be allowed (Yes)<br />
#* Energy Balance <br />
#* Integration Libraries (formerly SMDK Runtime)<br />
#* Models: TCE (PHREEQC, OLI, AQSol and ChemApp)<br />
# Check that "'''OLI Engine Runtime''' 32 bit" (also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine") is installed and licensed from OLI systems.<br />
#* SysCAD requires a valid OLI Engine to work. See [[#OLI Engine Version support|OLI Engine Version]]<br />
# Check that the distributed SysCAD OLI example project will run without issues.<br />
#*Open any of the \SysCAD139\Examples\06 OLI\OLIFull [[Example_-_06_OLI_Projects|example projects]], after project load, check the message window for any reported errors.<br />
#*If errors were encountered, use the messages provided to fix the errors and try again.<br />
<br />
== Models ==<br />
<br />
'''OLI Option unit models:'''<br />
* [[OLI Model Configuration]] - Used to define and view various options for the selected OLI database, including management of mapping of SysCAD species list to species list used in OLI.<br />
* [[OLI Direct Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a user defined OLI stream.<br />
* [[OLI Side Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a SysCAD stream in the current project.<br />
* [[OLI Reactor 2]] - Include this model in a SysCAD stream to use OLI to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
* [[OLI Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded OLI calculations.<br />
* [[OLI Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded OLI calculations.<br />
* [[OLI Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded OLI calculations. OLI can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[OLI Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using OLI species.<br />
* [[OLI Solvent Extraction]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded OLI calculations.<br />
* [[OLI Pond Model]] - Include this model in a SysCAD flowsheet (Dynamic mode) to specify a dynamic pond using embedded OLI calculations.<br />
'''OLI Legacy unit models:'''<br />
<br />
The following models are used for backward compatibility purposes only. These will be discontinued from Build 140 and users should convert any existing projects to use the TCE OLI models. See [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for suggested work flow.<br />
*[[OLI Chemistry Model]] - please change to the new model [[OLI Model Configuration]] <br />
*[[OLI Sample Model]] - please change to the new model [[OLI Direct Calc Model]] <br />
*[[OLI Reactor]] - please change to the new model [[OLI Reactor 2]]<br />
<br />
'''Species Mapping:'''<br />
*Ionlist is used to breakdown the species to ions. Please see [[TCE Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
OLI evaporation models using OLI dlls that do not incorporate VLE calculations are suitable for water evaporation only.<br />
<br />
== OLI SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new OLI SysCAD project group. <br />
<br />
If user only intend to use OLI for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use OLI to evaluate SysCAD streams, then follow (B).<br />
<br />
'''Important Notes''': <br />
<br />
#OLI software requires an OLI configuration file (*.dbs).<br />
#see [[#Referenced_File|OLI Referenced File]] for instructions.<br />
<br />
'''<big>(A)</big>''' Using OLI as stand-alone thermodynamic calculation engine to perform OLI equilibrium calculations:<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[OLI Model Configuration]]<br />
#*load in the OLI Model Definition file <br />
#Inset a [[OLI Direct Calc Model]]. Use the direct calc to perform OLI equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using OLI to evaluate SysCAD streams or as part of the SysCAD flowsheet:<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the OLI model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, OLI Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the OLI SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the required Species from the [[Species Configuration|Species Tab]].<br />
#*select the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create a SysCAD project. <br />
#Add [[OLI Model Configuration]], <br />
#*load in the OLI Model .dll file <br />
#*complete the OLI Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add OLI unit models to the project where appropriate.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from OLI Database File|Generate SysCAD database from OLI Database File]]<br />
<br />
== Referenced File ==<br />
<br />
The file that will be referenced by the SysCAD OLI Chemistry Model is the OLI Chemistry Model Database file created in OLI, e.g. NickelSpecies.dbs. <br />
<br />
The "OLI Chemistry Model" (dbs file), can be generated using "'''OLI Chemistry Wizard'''" or "'''OLI Studio'''".<br />
<br />
To generate an "OLI Chemistry Model" in OLI Studio perform the following steps:<br />
* Create a stream in a new project or for an existing OLI project (*.oad) file.<br />
* Select MSE or AQ databank.<br />
* On the Definition tab, add the components of interest.<br />
* Run an isothermal single point calculation.<br />
* If File Viewer tab is not visible, select menu Tools|Options. Then for Plug-Ins select the "OLI File Viewer" option and press OK.<br />
* On the File Viewer tab, for "File Type" select "Generated Model File". Push "Save File" button which will prompt to save a file with .dbs extension. This is the file required by SysCAD.<br />
<br />
'''Notes:'''<br />
# This file is essential for the OLI Chemistry Model in SysCAD to function. <br />
# The file can be saved at any location - it does not have to be saved in the SysCAD project.<br />
<br />
== OLI Engine Version support ==<br />
<br />
OLI Engine Runtime (32-bit) is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option. "OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
Multiple versions support of installed OLI engine is {{Available139|33127|y}}. This applies to both OLI_Legacy and OLI_TCE SysCAD integration. Therefore, it is possible to<br />
#use “SysCAD OLI Legacy” (scdoli.dll) with OLI engine version 10.x or 11.x, OR<br />
#use “SysCAD TCE OLI” (scdoli2.dll) with OLI engine version 10.x or 11.x. (Recommended)<br />
<br />
'''NOTES:'''<br />
*User must select the required OLI SysCAD integration (scdoli.dll OR scdoli2.dll) to use in the project, it is NOT possible to include both in the same project. <br />
*The OLI legacy integration models will be discontinued in future versions. User should convert any projects using OLI Legacy integration models to use the new OLI TCE suite of models. Please see [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for hints about project conversion.<br />
<br />
== Converting OLI Legacy Project to use OLI TCE models ==<br />
<br />
The new OLI TCE Integration suite of models were completely re-design from the ground up. There is no “automated” upgrade path for converting projects using OLI_Legacy models to OLI_TCE models. <br />
<br />
A recommended conversion workflow is:<br />
# Create folder '''"OLI_Legacy"''' + '''Cfgfiles''' subfolder: <br />
#*Store your OLI_Legacy project here<br />
#*make sure the Cfgfiles is set up to open the legacy project (using scdoli.dll)<br />
#*The purpose of this folder is so you can still open the legacy project for reference and comparison. <br />
# Create folder "'''OLI_Preparation'''" + '''Cfgfiles''' subfolder <br />
#*make a copy of the legacy project here, this is the project you need to work on in preparation for OLI_TCE model changes.<br />
#*The cfgfiles subfolder can be the same as OLI_Legacy.<br />
#*Open the project and remove all the OLI_Legacy models, do these in the following order:<br />
#**use "Change Unit" to change all the [[OLI Reactor]] to "Tank"<br />
#**Delete any [[OLI Sample Model]]<br />
#**Delete the [[OLI Chemistry Model]]<br />
#*Save the Project. The project should be free of any OLI_legacy models.<br />
#*''Edit the configuration file to remove the '''scdoli.dll''' group of models.''<br />
#*Reopen the model to check if the project can be loaded. If successful, then the project is ready for OLI_TCE model changes.<br />
# Create folder "'''OLI_TCE'''" + '''Cfgfiles''' subfolder: <br />
#*make a copy of the "OLI_Preparation" project here.<br />
#*''Edit the configuration file to use the '''scdoli2.dll''' group of models.''<br />
#*Edit the TCE tab to select the correct OLI options (engine version, dll path, database selection, etc.)<br />
#*Open the project using the edited configuration file.<br />
#*Edit the project in the following order:<br />
#**Add and setup [[OLI Model Configuration]] to replace the [[OLI Chemistry Model]]<br />
#**Add and setup [[OLI Direct Calc Model]] to replace the [[OLI Sample Model]]<br />
#**For any [[OLI Reactor]] that were changed to "Tank", use "Change Unit" to change them to [[OLI Reactor 2]] or any other more relevant OLI unit [[#Models|models]]. <br />
#*Fix the controls and reports.<br />
#*Save the project. <br />
#*Solve and debug the project as usual.<br />
#*If possible, open the OLI_Legacy model for reference or comparison.<br />
<--<br />
== Liquid 2 Functionality in SysCAD ==<br />
<br />
Starting in Build 139.XXXXX, liquid 2 functionality is available for use in the SysCAD-OLI interface. This functionality allows for the modelling of unit operations where two immiscible liquids are present, such as [[OLI Solvent Extraction]]. To use this functionality, the following line must be manually added to the [OLI] section of the SysCAD configuration file.<br />
<br />
Suppose we have an OLI section that looks like this in the cfg file (you can edit the cfg file using any text editor):<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
<br />
<br />
Let us also suppose that we have added species to the SysCAD database using "o" as the individual phase for organic. Thus, in our SysCAD database we have species such as:<br />
<br />
C12H26(o)<br />
R3NH2SO4(o)<br />
etc...<br />
<br />
In this case, we would modify the above to:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
'''Second_Liquid_Phase_Name0=o'''<br />
<br />
--></div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Overview&diff=78640OLI Overview2024-02-29T20:19:31Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category:Models]] [[Category:OLI]]<br />
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{OLI Header Tabs|currentpage=1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from OLI Database File]], [[Example - 06 OLI Projects|OLI Example Projects]]<br />
----<br />
<br />
{{Available139|31866}} - Next generation of OLI models in SysCAD as part of TCE. Older models have been archived as legacy models.<br />
{{TOC}}<br />
== Overview ==<br />
<br />
OLI Systems is a leading Electrolyte Simulation Software used to predicate equilibrium conditions and properties (such as pH) for aqueous chemistry.<br />
*It is developed and maintained by OLI Systems. ([https://www.olisystems.com/ olisystems.com])<br />
*To use OLI in SysCAD it is assumed that the user has some familiarity with the theory and use of the OLI Systems software programs.<br />
*The SysCAD OLI library option (in ScdOLI2.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons.<br />
*'''OLI Engine Runtime (32-bit)''' is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option.<br />
*"OLI Engine Runtime" includes '''OLI Chemistry Wizard''' which can be used to create the OLI database (dbs) files required by SysCAD.<br />
*The user may also purchase '''OLI Studio: Stream Analyzer''' from OLI Systems Inc. OLI Studio can also be used to create OLI database files required by SysCAD.<br />
<br />
Additional Notes:<br />
*The "OLI Engine: Developer Edition" License is NOT required to use OLI in SysCAD.<br />
*"OLI Studio" or "OLI Studio: Stream Analyzer" does not include an "OLI Engine Runtime" license, this needs to be purchased separately from OLI Systems.<br />
*"OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine" - this is the same thing.<br />
*KWA Kenwalt Australia (SysCAD) are OLI Alliance Partners. ([https://www.olisystems.com/partners/ Alliance Partners])<br />
*From {{Available139|||y}}, a TCE add-on is required instead of a legacy separate individual "SysCAD OLI" License add-on.<br />
*For legacy OLI models (ScdOLI.DLL) SysCAD version of Build 137, 138 or 139 is required. It cannot be used within the same project as the new TCE OLI Option. The legacy version will be discontinued in the next SysCAD Build.<br />
*OLI in SysCAD is not implemented as a Species Properties Model but as unit models for use at appropriate locations in a plant model.<br />
<br />
== OLI Systems Software ==<br />
[https://www.olisystems.com/software/oli-studio/ [[File:OLI_Logo.png |link=]]]<br />
<br />
The following are direct quotes from the OLI website:<br />
:''Analyze chemical streams, predict mineral scaling and corrosion in industrial chemical processes.''<br />
:''The behavior of electrolyte and water chemistry governs industrial chemical processes performance. OLI Systems makes it possible to deeply understand these behaviors to drive effective and efficient equipment design and process operations.''<br />
<br />
Please visit the [https://www.olisystems.com/software/oli-studio/ OLI Studio] for more information.<br />
<br />
The TCE add-on in SysCAD does not require "OLI Engine: Developer Edition" to be installed. However, users must obtain the "OLI Engine Runtime (32 bit)" license from OLI Systems, also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
== Checking that OLI SysCAD integration is working == <br />
<br />
We recommend performing the following checks prior to creating user OLI projects to ensure OLI SysCAD intergration is working correctly.<br />
# [[Licensing#Checking_Current_License_Information|Check the '''License Information''']], the following add-ons must be allowed (Yes)<br />
#* Energy Balance <br />
#* Integration Libraries (formerly SMDK Runtime)<br />
#* Models: TCE (PHREEQC, OLI, AQSol and ChemApp)<br />
# Check that "'''OLI Engine Runtime''' 32 bit" (also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine") is installed and licensed from OLI systems.<br />
#* SysCAD requires a valid OLI Engine to work. See [[#OLI Engine Version support|OLI Engine Version]]<br />
# Check that the distributed SysCAD OLI example project will run without issues.<br />
#*Open any of the \SysCAD139\Examples\06 OLI\OLIFull [[Example_-_06_OLI_Projects|example projects]], after project load, check the message window for any reported errors.<br />
#*If errors were encountered, use the messages provided to fix the errors and try again.<br />
<br />
== Models ==<br />
<br />
'''OLI Option unit models:'''<br />
* [[OLI Model Configuration]] - Used to define and view various options for the selected OLI database, including management of mapping of SysCAD species list to species list used in OLI.<br />
* [[OLI Direct Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a user defined OLI stream.<br />
* [[OLI Side Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a SysCAD stream in the current project.<br />
* [[OLI Reactor 2]] - Include this model in a SysCAD stream to use OLI to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
* [[OLI Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded OLI calculations.<br />
* [[OLI Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded OLI calculations.<br />
* [[OLI Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded OLI calculations. OLI can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[OLI Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using OLI species.<br />
* [[OLI Solvent Extraction]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded OLI calculations.<br />
* [[OLI Pond Model]] - Include this model in a SysCAD flowsheet (Dynamic mode) to specify a dynamic pond using embedded OLI calculations.<br />
'''OLI Legacy unit models:'''<br />
<br />
The following models are used for backward compatibility purposes only. These will be discontinued from Build 140 and users should convert any existing projects to use the TCE OLI models. See [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for suggested work flow.<br />
*[[OLI Chemistry Model]] - please change to the new model [[OLI Model Configuration]] <br />
*[[OLI Sample Model]] - please change to the new model [[OLI Direct Calc Model]] <br />
*[[OLI Reactor]] - please change to the new model [[OLI Reactor 2]]<br />
<br />
'''Species Mapping:'''<br />
*Ionlist is used to breakdown the species to ions. Please see [[TCE Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
OLI evaporation models using OLI dlls that do not incorporate VLE calculations are suitable for water evaporation only.<br />
<br />
== OLI SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new OLI SysCAD project group. <br />
<br />
If user only intend to use OLI for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use OLI to evaluate SysCAD streams, then follow (B).<br />
<br />
'''Important Notes''': <br />
<br />
#OLI software requires an OLI configuration file (*.dbs).<br />
#see [[#Referenced_File|OLI Referenced File]] for instructions.<br />
<br />
'''<big>(A)</big>''' Using OLI as stand-alone thermodynamic calculation engine to perform OLI equilibrium calculations:<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[OLI Model Configuration]]<br />
#*load in the OLI Model Definition file <br />
#Inset a [[OLI Direct Calc Model]]. Use the direct calc to perform OLI equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using OLI to evaluate SysCAD streams or as part of the SysCAD flowsheet:<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the OLI model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, OLI Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the OLI SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the required Species from the [[Species Configuration|Species Tab]].<br />
#*select the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create a SysCAD project. <br />
#Add [[OLI Model Configuration]], <br />
#*load in the OLI Model .dll file <br />
#*complete the OLI Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add OLI unit models to the project where appropriate.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from OLI Database File|Generate SysCAD database from OLI Database File]]<br />
<br />
== Referenced File ==<br />
<br />
The file that will be referenced by the SysCAD OLI Chemistry Model is the OLI Chemistry Model Database file created in OLI, e.g. NickelSpecies.dbs. <br />
<br />
The "OLI Chemistry Model" (dbs file), can be generated using "'''OLI Chemistry Wizard'''" or "'''OLI Studio'''".<br />
<br />
To generate an "OLI Chemistry Model" in OLI Studio perform the following steps:<br />
* Create a stream in a new project or for an existing OLI project (*.oad) file.<br />
* Select MSE or AQ databank.<br />
* On the Definition tab, add the components of interest.<br />
* Run an isothermal single point calculation.<br />
* If File Viewer tab is not visible, select menu Tools|Options. Then for Plug-Ins select the "OLI File Viewer" option and press OK.<br />
* On the File Viewer tab, for "File Type" select "Generated Model File". Push "Save File" button which will prompt to save a file with .dbs extension. This is the file required by SysCAD.<br />
<br />
'''Notes:'''<br />
# This file is essential for the OLI Chemistry Model in SysCAD to function. <br />
# The file can be saved at any location - it does not have to be saved in the SysCAD project.<br />
<br />
== OLI Engine Version support ==<br />
<br />
OLI Engine Runtime (32-bit) is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option. "OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
Multiple versions support of installed OLI engine is {{Available139|33127|y}}. This applies to both OLI_Legacy and OLI_TCE SysCAD integration. Therefore, it is possible to<br />
#use “SysCAD OLI Legacy” (scdoli.dll) with OLI engine version 10.x or 11.x, OR<br />
#use “SysCAD TCE OLI” (scdoli2.dll) with OLI engine version 10.x or 11.x. (Recommended)<br />
<br />
'''NOTES:'''<br />
*User must select the required OLI SysCAD integration (scdoli.dll OR scdoli2.dll) to use in the project, it is NOT possible to include both in the same project. <br />
*The OLI legacy integration models will be discontinued in future versions. User should convert any projects using OLI Legacy integration models to use the new OLI TCE suite of models. Please see [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for hints about project conversion.<br />
<br />
== Converting OLI Legacy Project to use OLI TCE models ==<br />
<br />
The new OLI TCE Integration suite of models were completely re-design from the ground up. There is no “automated” upgrade path for converting projects using OLI_Legacy models to OLI_TCE models. <br />
<br />
A recommended conversion workflow is:<br />
# Create folder '''"OLI_Legacy"''' + '''Cfgfiles''' subfolder: <br />
#*Store your OLI_Legacy project here<br />
#*make sure the Cfgfiles is set up to open the legacy project (using scdoli.dll)<br />
#*The purpose of this folder is so you can still open the legacy project for reference and comparison. <br />
# Create folder "'''OLI_Preparation'''" + '''Cfgfiles''' subfolder <br />
#*make a copy of the legacy project here, this is the project you need to work on in preparation for OLI_TCE model changes.<br />
#*The cfgfiles subfolder can be the same as OLI_Legacy.<br />
#*Open the project and remove all the OLI_Legacy models, do these in the following order:<br />
#**use "Change Unit" to change all the [[OLI Reactor]] to "Tank"<br />
#**Delete any [[OLI Sample Model]]<br />
#**Delete the [[OLI Chemistry Model]]<br />
#*Save the Project. The project should be free of any OLI_legacy models.<br />
#*''Edit the configuration file to remove the '''scdoli.dll''' group of models.''<br />
#*Reopen the model to check if the project can be loaded. If successful, then the project is ready for OLI_TCE model changes.<br />
# Create folder "'''OLI_TCE'''" + '''Cfgfiles''' subfolder: <br />
#*make a copy of the "OLI_Preparation" project here.<br />
#*''Edit the configuration file to use the '''scdoli2.dll''' group of models.''<br />
#*Edit the TCE tab to select the correct OLI options (engine version, dll path, database selection, etc.)<br />
#*Open the project using the edited configuration file.<br />
#*Edit the project in the following order:<br />
#**Add and setup [[OLI Model Configuration]] to replace the [[OLI Chemistry Model]]<br />
#**Add and setup [[OLI Direct Calc Model]] to replace the [[OLI Sample Model]]<br />
#**For any [[OLI Reactor]] that were changed to "Tank", use "Change Unit" to change them to [[OLI Reactor 2]] or any other more relevant OLI unit [[#Models|models]]. <br />
#*Fix the controls and reports.<br />
#*Save the project. <br />
#*Solve and debug the project as usual.<br />
#*If possible, open the OLI_Legacy model for reference or comparison.<br />
<--<br />
== Liquid 2 Functionality in SysCAD ==<br />
<br />
Starting in Build 139.XXXXX, liquid 2 functionality is available for use in the SysCAD-OLI interface. This functionality allows for the modelling of unit operations where two immiscible liquids are present, such as [[OLI Solvent Extraction]]. To use this functionality, the following line must be manually added to the [OLI] section of the SysCAD configuration file.<br />
<br />
Suppose we have an OLI section that looks like this in the cfg file (you can edit the cfg file using any text editor):<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
<br />
<br />
Let us also suppose that we have added species to the SysCAD database using "o" as the individual phase for organic. Thus, in our SysCAD database we have species such as:<br />
<br />
C12H26(o)<br />
R3NH2SO4(o)<br />
etc...<br />
<br />
In this case, we would modify the above to:<br />
<br />
[OLI]<br />
NumEngines=3<br />
MinWaterContentForSolve=0.2<br />
DatabaseFolder=C:\SysCAD Projects\OLItest\OLI\<br />
Database0=SolvEx.dbs<br />
'''Second_Liquid_Phase_Name0=o'''<br />
<br />
--!></div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Overview&diff=78639OLI Overview2024-02-29T20:03:22Z<p>Kevin.Heppner: /* Models */</p>
<hr />
<div>[[Category:Models]] [[Category:OLI]]<br />
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{OLI Header Tabs|currentpage=1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from OLI Database File]], [[Example - 06 OLI Projects|OLI Example Projects]]<br />
----<br />
<br />
{{Available139|31866}} - Next generation of OLI models in SysCAD as part of TCE. Older models have been archived as legacy models.<br />
{{TOC}}<br />
== Overview ==<br />
<br />
OLI Systems is a leading Electrolyte Simulation Software used to predicate equilibrium conditions and properties (such as pH) for aqueous chemistry.<br />
*It is developed and maintained by OLI Systems. ([https://www.olisystems.com/ olisystems.com])<br />
*To use OLI in SysCAD it is assumed that the user has some familiarity with the theory and use of the OLI Systems software programs.<br />
*The SysCAD OLI library option (in ScdOLI2.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons.<br />
*'''OLI Engine Runtime (32-bit)''' is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option.<br />
*"OLI Engine Runtime" includes '''OLI Chemistry Wizard''' which can be used to create the OLI database (dbs) files required by SysCAD.<br />
*The user may also purchase '''OLI Studio: Stream Analyzer''' from OLI Systems Inc. OLI Studio can also be used to create OLI database files required by SysCAD.<br />
<br />
Additional Notes:<br />
*The "OLI Engine: Developer Edition" License is NOT required to use OLI in SysCAD.<br />
*"OLI Studio" or "OLI Studio: Stream Analyzer" does not include an "OLI Engine Runtime" license, this needs to be purchased separately from OLI Systems.<br />
*"OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine" - this is the same thing.<br />
*KWA Kenwalt Australia (SysCAD) are OLI Alliance Partners. ([https://www.olisystems.com/partners/ Alliance Partners])<br />
*From {{Available139|||y}}, a TCE add-on is required instead of a legacy separate individual "SysCAD OLI" License add-on.<br />
*For legacy OLI models (ScdOLI.DLL) SysCAD version of Build 137, 138 or 139 is required. It cannot be used within the same project as the new TCE OLI Option. The legacy version will be discontinued in the next SysCAD Build.<br />
*OLI in SysCAD is not implemented as a Species Properties Model but as unit models for use at appropriate locations in a plant model.<br />
<br />
== OLI Systems Software ==<br />
[https://www.olisystems.com/software/oli-studio/ [[File:OLI_Logo.png |link=]]]<br />
<br />
The following are direct quotes from the OLI website:<br />
:''Analyze chemical streams, predict mineral scaling and corrosion in industrial chemical processes.''<br />
:''The behavior of electrolyte and water chemistry governs industrial chemical processes performance. OLI Systems makes it possible to deeply understand these behaviors to drive effective and efficient equipment design and process operations.''<br />
<br />
Please visit the [https://www.olisystems.com/software/oli-studio/ OLI Studio] for more information.<br />
<br />
The TCE add-on in SysCAD does not require "OLI Engine: Developer Edition" to be installed. However, users must obtain the "OLI Engine Runtime (32 bit)" license from OLI Systems, also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
== Checking that OLI SysCAD integration is working == <br />
<br />
We recommend performing the following checks prior to creating user OLI projects to ensure OLI SysCAD intergration is working correctly.<br />
# [[Licensing#Checking_Current_License_Information|Check the '''License Information''']], the following add-ons must be allowed (Yes)<br />
#* Energy Balance <br />
#* Integration Libraries (formerly SMDK Runtime)<br />
#* Models: TCE (PHREEQC, OLI, AQSol and ChemApp)<br />
# Check that "'''OLI Engine Runtime''' 32 bit" (also known as "OLI Runtime for SysCAD" or "OLI Alliance Engine") is installed and licensed from OLI systems.<br />
#* SysCAD requires a valid OLI Engine to work. See [[#OLI Engine Version support|OLI Engine Version]]<br />
# Check that the distributed SysCAD OLI example project will run without issues.<br />
#*Open any of the \SysCAD139\Examples\06 OLI\OLIFull [[Example_-_06_OLI_Projects|example projects]], after project load, check the message window for any reported errors.<br />
#*If errors were encountered, use the messages provided to fix the errors and try again.<br />
<br />
== Models ==<br />
<br />
'''OLI Option unit models:'''<br />
* [[OLI Model Configuration]] - Used to define and view various options for the selected OLI database, including management of mapping of SysCAD species list to species list used in OLI.<br />
* [[OLI Direct Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a user defined OLI stream.<br />
* [[OLI Side Calc Model]] - Standalone unit model to perform side calculations using OLI for predicting aqueous chemistry equilibrium conditions and properties on a SysCAD stream in the current project.<br />
* [[OLI Reactor 2]] - Include this model in a SysCAD stream to use OLI to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
* [[OLI Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded OLI calculations.<br />
* [[OLI Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded OLI calculations.<br />
* [[OLI Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded OLI calculations. OLI can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[OLI Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using OLI species.<br />
* [[OLI Solvent Extraction]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded OLI calculations.<br />
* [[OLI Pond Model]] - Include this model in a SysCAD flowsheet (Dynamic mode) to specify a dynamic pond using embedded OLI calculations.<br />
'''OLI Legacy unit models:'''<br />
<br />
The following models are used for backward compatibility purposes only. These will be discontinued from Build 140 and users should convert any existing projects to use the TCE OLI models. See [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for suggested work flow.<br />
*[[OLI Chemistry Model]] - please change to the new model [[OLI Model Configuration]] <br />
*[[OLI Sample Model]] - please change to the new model [[OLI Direct Calc Model]] <br />
*[[OLI Reactor]] - please change to the new model [[OLI Reactor 2]]<br />
<br />
'''Species Mapping:'''<br />
*Ionlist is used to breakdown the species to ions. Please see [[TCE Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
OLI evaporation models using OLI dlls that do not incorporate VLE calculations are suitable for water evaporation only.<br />
<br />
== OLI SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new OLI SysCAD project group. <br />
<br />
If user only intend to use OLI for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use OLI to evaluate SysCAD streams, then follow (B).<br />
<br />
'''Important Notes''': <br />
<br />
#OLI software requires an OLI configuration file (*.dbs).<br />
#see [[#Referenced_File|OLI Referenced File]] for instructions.<br />
<br />
'''<big>(A)</big>''' Using OLI as stand-alone thermodynamic calculation engine to perform OLI equilibrium calculations:<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[OLI Model Configuration]]<br />
#*load in the OLI Model Definition file <br />
#Inset a [[OLI Direct Calc Model]]. Use the direct calc to perform OLI equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using OLI to evaluate SysCAD streams or as part of the SysCAD flowsheet:<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the OLI model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, OLI Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the OLI SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#Create a Configuration File, <br />
#*select the OLI models in step 1 of 2 of edit configuration file, <br />
#*In Step 2 of 2 of edit configuration file, select the required Species from the [[Species Configuration|Species Tab]].<br />
#*select the OLI dll from the [[TCE Configuration|TCE tab]] . <br />
#Create a SysCAD project. <br />
#Add [[OLI Model Configuration]], <br />
#*load in the OLI Model .dll file <br />
#*complete the OLI Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add OLI unit models to the project where appropriate.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from OLI Database File|Generate SysCAD database from OLI Database File]]<br />
<br />
== Referenced File ==<br />
<br />
The file that will be referenced by the SysCAD OLI Chemistry Model is the OLI Chemistry Model Database file created in OLI, e.g. NickelSpecies.dbs. <br />
<br />
The "OLI Chemistry Model" (dbs file), can be generated using "'''OLI Chemistry Wizard'''" or "'''OLI Studio'''".<br />
<br />
To generate an "OLI Chemistry Model" in OLI Studio perform the following steps:<br />
* Create a stream in a new project or for an existing OLI project (*.oad) file.<br />
* Select MSE or AQ databank.<br />
* On the Definition tab, add the components of interest.<br />
* Run an isothermal single point calculation.<br />
* If File Viewer tab is not visible, select menu Tools|Options. Then for Plug-Ins select the "OLI File Viewer" option and press OK.<br />
* On the File Viewer tab, for "File Type" select "Generated Model File". Push "Save File" button which will prompt to save a file with .dbs extension. This is the file required by SysCAD.<br />
<br />
'''Notes:'''<br />
# This file is essential for the OLI Chemistry Model in SysCAD to function. <br />
# The file can be saved at any location - it does not have to be saved in the SysCAD project.<br />
<br />
== OLI Engine Version support ==<br />
<br />
OLI Engine Runtime (32-bit) is licensed separately by OLI Systems and is required to be installed to use SysCAD TCE OLI Option. "OLI Engine Runtime" is sometimes referred to as "OLI Runtime for SysCAD" or "OLI Alliance Engine".<br />
<br />
Multiple versions support of installed OLI engine is {{Available139|33127|y}}. This applies to both OLI_Legacy and OLI_TCE SysCAD integration. Therefore, it is possible to<br />
#use “SysCAD OLI Legacy” (scdoli.dll) with OLI engine version 10.x or 11.x, OR<br />
#use “SysCAD TCE OLI” (scdoli2.dll) with OLI engine version 10.x or 11.x. (Recommended)<br />
<br />
'''NOTES:'''<br />
*User must select the required OLI SysCAD integration (scdoli.dll OR scdoli2.dll) to use in the project, it is NOT possible to include both in the same project. <br />
*The OLI legacy integration models will be discontinued in future versions. User should convert any projects using OLI Legacy integration models to use the new OLI TCE suite of models. Please see [[#Converting OLI Legacy Project to use OLI TCE models|Converting OLI Legacy Project to use OLI TCE models]] for hints about project conversion.<br />
<br />
== Converting OLI Legacy Project to use OLI TCE models ==<br />
<br />
The new OLI TCE Integration suite of models were completely re-design from the ground up. There is no “automated” upgrade path for converting projects using OLI_Legacy models to OLI_TCE models. <br />
<br />
A recommended conversion workflow is:<br />
# Create folder '''"OLI_Legacy"''' + '''Cfgfiles''' subfolder: <br />
#*Store your OLI_Legacy project here<br />
#*make sure the Cfgfiles is set up to open the legacy project (using scdoli.dll)<br />
#*The purpose of this folder is so you can still open the legacy project for reference and comparison. <br />
# Create folder "'''OLI_Preparation'''" + '''Cfgfiles''' subfolder <br />
#*make a copy of the legacy project here, this is the project you need to work on in preparation for OLI_TCE model changes.<br />
#*The cfgfiles subfolder can be the same as OLI_Legacy.<br />
#*Open the project and remove all the OLI_Legacy models, do these in the following order:<br />
#**use "Change Unit" to change all the [[OLI Reactor]] to "Tank"<br />
#**Delete any [[OLI Sample Model]]<br />
#**Delete the [[OLI Chemistry Model]]<br />
#*Save the Project. The project should be free of any OLI_legacy models.<br />
#*''Edit the configuration file to remove the '''scdoli.dll''' group of models.''<br />
#*Reopen the model to check if the project can be loaded. If successful, then the project is ready for OLI_TCE model changes.<br />
# Create folder "'''OLI_TCE'''" + '''Cfgfiles''' subfolder: <br />
#*make a copy of the "OLI_Preparation" project here.<br />
#*''Edit the configuration file to use the '''scdoli2.dll''' group of models.''<br />
#*Edit the TCE tab to select the correct OLI options (engine version, dll path, database selection, etc.)<br />
#*Open the project using the edited configuration file.<br />
#*Edit the project in the following order:<br />
#**Add and setup [[OLI Model Configuration]] to replace the [[OLI Chemistry Model]]<br />
#**Add and setup [[OLI Direct Calc Model]] to replace the [[OLI Sample Model]]<br />
#**For any [[OLI Reactor]] that were changed to "Tank", use "Change Unit" to change them to [[OLI Reactor 2]] or any other more relevant OLI unit [[#Models|models]]. <br />
#*Fix the controls and reports.<br />
#*Save the project. <br />
#*Solve and debug the project as usual.<br />
#*If possible, open the OLI_Legacy model for reference or comparison.</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:TPSModelCfg_Tab_Page&diff=78638Template:TPSModelCfg Tab Page2024-02-29T19:54:10Z<p>Kevin.Heppner: </p>
<hr />
<div>'''Unit Type: {{{TPS}}}ModelCfg''' - The first tab page in the access window will have this name.<br />
<br />
{| border="1" cellpadding="5" cellspacing="0" <br />
| '''Tag (Long/Short)''' || '''Input / Calc''' || '''Description/Calculated Variables / Options'''<br />
|-<br />
{{Common Data on First Tab Page}}<br />
|-<br />
| colspan="3" font style="background: #ebebeb" | ''{{#switch: {{{TPS}}}|<br />
PHREEQC=This program contains PHREEQC Copyright U.S. Geological Survey (USGS)|<br />
AQSol=This program contains AQSol Copyright Aqueous Solutions Aps, Denmark|<br />
ChemApp= This program contains ChemApp Copyright GTT-Technologies, Kaiserstrasse 103, D-52134 Herzogenrath, Germany http://www.gtt-technologies.de|<br />
OLI=This program contains OLI Engine Copyright OLI Systems, USA|<br />
}}''<br />
|-<br />
| colspan="3" font style="background: #ebebeb" |Interface...<br />
|-<br />
| Acknowledgement || style="background: #ebebeb"| Display |||''This program contains {{#switch: {{{TPS}}}|<br />
PHREEQC=PHREEQC Copyright U.S. Geological Survey (USGS)|<br />
AQSol=AQSol Copyright Aqueous Solutions Aps, Denmark|<br />
ChemApp= ChemApp Copyright GTT-Technologies, Kaiserstrasse 103, D-52134 Herzogenrath, Germany http://www.gtt-technologies.de|<br />
OLI= OLI Engine Copyright OLI Systems, USA|<br />
}}''<br />
|-<br />
| Website || style="background: #ebebeb"| Web Link ||{{#switch: {{{TPS}}}|<br />
PHREEQC=''https://www.usgs.gov/software/phreeqc''|<br />
AQSol=''https://www.phasediagram.dk''|<br />
ChemApp= ''https://gtt-technologies.de/software/chemapp''|<br />
OLI=''https://www.olisystems.com''|<br />
}}<br />
|-<br />
| Version || style="background: #ebebeb"| Display || This displays the version of {{{TPS}}} installed on the user's computer<br />
|-<br />
{{#ifeq: {{{TPS}}}| ChemApp|<br />
<td> License.ID <td font style="background: #ebebeb"> Display <td> This displays the ChemApp License ID number. (This is purchased separately from GTT). For ChemApp light, it may display 0001.<br />
<tr><br />
<td> License.User <td font style="background: #ebebeb"> Display <td>This displays the Registered ChemApp User. For ChemApp light, it may display "Demonstration Version".<br />
<tr><br />
<td> License.Expiration <td font style="background: #ebebeb"> Display <td>This displays the ChemApp License Expiration Date.<br />
<tr>|<br />
}}<br />
{{#ifeq: {{{TPS}}}| AQSol|<br />
<td colspan="3" font style="background: #ebebeb"> Displays the AQSol software license information and expiration date. (This is purchased separately from Aqueous Solutions). For Demonstration Version, it may display the following: <br><br />
''AQSOL001, Version 02.00.00 '':<br><br />
''License issued to: Internet user''<br><br />
''Valid until: 2024-05-01''<br><br />
''www.phasediagram.dk'' <br> <br />
<tr>|<br />
}}<br />
<!--<br />
<td> License.ID <td> style="background: #ebebeb"<td> Display <td> This displays the ChemApp License ID number. (This is purchased separately from GTT). For ChemApp light, it may display 0001.<br />
<tr><br />
<td> License.User <td> style="background: #ebebeb"<td> Display <td>This displays the Registered ChemApp User. For ChemApp light, it may display "Demonstration Version".<br />
<tr><br />
<td> License.Expiration <td> style="background: #ebebeb"<td> Display <td>This displays the ChemApp License Expiration Date. <br />
<tr>|<br />
<br />
| rowspan=2| SelectDLLType || Full || This tells SysCAD you are entitled to use the Full Version of ChemApp, with no functionality restrictions. SysCAD will expect to find<br />
* a valid ChemApp license (from GTT)<br />
* a valid SysCAD ChemApp Addon license option (part of the SysCAD license)<br />
* the file ca_sc_e.dll (inside the SysCADxxx bin folder)<br />
* a valid ChemApp Model definition file (.cst or .dat)<br />
|-<br />
| Light || This tells SysCAD you are using the Demonstration mode of ChemApp, in this mode, ChemApp species is restricted (maximum 30 species). Some ChemApp model functionalities are also disabled. SysCAD will expect to find<br />
* the file ca_vc_l.dll (inside the SysCADxxx bin folder)<br />
* a valid ChemApp Model definition file (.cst or .dat)<br />
|-<br />
--><br />
| colspan="3" font style="background: #ebebeb" | Model...<br />
|-<br />
{{#ifeq: {{{TPS}}}| AQSol|<br />
|<br />
<td colspan="3" font style="background: #ebebeb" > ''Select {{{TPS}}} database file''<br />
<tr><br />
<td> DatabaseFile/DBFile <td> Input <td> This is the name of the database file that was created by {{{TPS}}}, e.g. {{{example DB}}}. It is chosen from a dropdown list of available databases, which are defined in the cfg file for the project.<br />
<tr><br />
<td> DatabaseFilePath/DBFilePath <td style="background: #ebebeb"> Display <td> The folder where the database file shown above is saved.<br />
}}<br />
<!-- <br />
{{#ifeq: {{{TPS}}}| PHREEQC|<br />
<td> IncludeGasPhase <td> Tickbox <td> Include gas mixture phase in calculations. DO NOT use this on a unit model that uses SysCAD VLE. Note that PHREEQC Evaporator and PHREEQC Flash Tank use SysCAD VLE by default. Other units can use SysCAD VLE by checking the UseSysCADVLE check box.<br />
<tr>|<br />
}}<br />
--><br />
{{#ifeq: {{{CheckDuplicates}}}|true|<br />
<tr><br />
<td> CheckSpListForDuplicates<td> Tickbox <td> If enabled this will check the {{{TPS}}} species list for duplicates.<br />
<tr>|<br />
}}<br />
|-<br />
| CheckForSteam|| Tickbox || If ticked, SysCAD will check if steam (H2O(g)) is included in the list of {{{TPS}}} species.<br />
|-<br />
| Load || <!--[[Image:Init and Load.png]]<br>-->[[Image:Load.png]] || Click on this button to load the required database file. <!--If the model has not been initialised, then the button will show "Init and Load" and when pressed the model will first be initialised and then the database file will be loaded.--><br />
|-<br />
| DefnStatus|| style="background: #ebebeb"| List|| If the {{{TPS}}} database file has been loaded and no errors have been detected then will show OK, otherwise will show error message.<br />
|- <br />
| SpDBCount || style="background: #ebebeb"| Display || The number of species loaded from the {{{TPS}}} database file.<br />
|- <br />
| Sol.Count || style="background: #ebebeb"| Display || The number of solid species loaded from the {{{TPS}}} database file.<br />
|- <br />
| Liq.Count || style="background: #ebebeb"| Display || The number of liquid species loaded from the {{{TPS}}} database file.<br />
|- <br />
| Vap.Count || style="background: #ebebeb"| Display || The number of gaseous species loaded from the {{{TPS}}} database file.<br />
|- <br />
| ElemCount || style="background: #ebebeb"| Display || The number of elements loaded from the {{{TPS}}} database file.<br />
|- <br />
{{#ifeq:{{{TPS}}}|OLI|<br />
<td> RedoxEnabled <td font style="background: #ebebeb"> Display <td> Indicates whether the model has oxidation-reduction reactions enabled.<br />
<tr><br />
<td> Liq2Enabled <td font style="background: #ebebeb"> Display <td> Indicates whether the model has a second liquid enabled. This is required for OLI Solvent Extraction.<br />
<tr><br />
|}}<br />
| ElemList || style="background: #ebebeb"| Display || The list of the elements used in the {{{TPS}}} database file.<br />
<!--<br />
|-<br />
| NumUnitsUsingCfg|| style="background: #ebebeb"| Display || The number of units models that are using this Model Configuration.<br />
--><br />
|-<br />
{{#ifeq: {{{TPS}}}| PHREEQC|<br />
<td colspan="3" font style="background: #ebebeb"> ''Equilibrium Model Details''<br />
<tr><br />
<td colspan="3" font style="background: #ebebeb"> (Based on the equilibrium model specified in the PHREEQC database file. If none is specified, then ''Davies'' will be used.)<br />
<tr><br />
<td valign="top" rowspan="3"> EquilibriumModel <td> Davies <td> Use the Davies equilibrium model to perform equilibrium calculations. <br />
<tr><br />
<td> Pitzer <td> Use the Pitzer equilibrium model to perform equilibrium calculations.<br />
<tr><br />
<td> SIT <td> Use the SIT (Specific ion Interaction Theory) equilibrium model to perform equilibrium calculations.<br />
<tr><br />
<td> ShowLogKTuning <td> Tickbox <td> Enable LogK mode for entering LogK values directly into SysCAD. If ticked, then the [[#LogKAdjust tab page|LogKAdjust]] tab page will appear.<br />
<tr>|<br />
}}<br />
| colspan="3" font style="background: #ebebeb" | ''Mapping Tolerances''<br />
|- <br />
| Discard.Tol.SigDigits || Input || This provides an easy way to change the Discard.Tol.Rel value. For example, 4 here will set 1.00e-4 to Discard.Tol.Rel. If user changes the Discard.Tol.Rel value, this value will also be updated.<br />
|- <br />
| Discard.Tol.Rel || Input || The relative tolerance for ignoring species produced from the {{{TPS}}} calculations. If the mass fraction of a species is > DiscardTol and it is not mapped to a SysCAD species/ion then an error is generated.<br />
|-<br />
| ElemBal.Tol.SigDigits || Input || This provides an easy way to change the ElemBal.Tol.Rel value. For example, 4 here will set 1.00e-4 to ElemBal.Tol.Rel. If user changes the ElemBal.Tol.Rel value, this value will also be updated.<br />
|- <br />
| ElemBal.Tol.Rel || Input || The relative tolerance for Element Balance (Input - Output). If the relative error is > ElemBal.Tol.Rel then an error is generated. The ElemBal is used in all {{{TPS}}} unit models.<br />
|- <br />
| ElemBal.Tol.Abs || Input || The absolute tolerance for Element Balance (Input - Output). If the absolute error is > ElemBal.Tol.Abs then an error is generated. The ElemBal is used in all {{{TPS}}} unit models.<br />
|- <br />
| colspan="3" font style="background: #ebebeb" | ''Convergence Tolerances''<br />
|- <br />
| EnthConv.Tol.SigDigits || Input || This provides an easy way to change the EnthConv.Tol.Rel value. For example, 4 here will set 1.00e-4 to EnthConv.Tol.Rel. If user changes the EnthConv.Tol.Rel value, this value will also be updated.<br />
|- <br />
| EnthConv.Tol.Rel || Input || Enthalpy convergence tolerance. This is used for iterative enthalpy convergence calculations in SysCAD.<br />
|-<br />
{{#ifeq: {{{TPS}}}| PHREEQC|<br />
<td> {{{TPS}}}.MaxIter<td> Input <td> Maximum number of iterations allowed by {{{TPS}}} in its internal calculation routines.<br />
<tr><br />
<td> {{{TPS}}}.Tol<td> Input <td> Tolerance used by {{{TPS}}} in its internal calculation routines.<br />
<tr><br />
<tr>|<br />
}}<br />
|-<br />
{{#ifeq: {{{AcidBase}}}|true|<br />
<td colspan="3" font style="background: #ebebeb"> ''Acid base coexistence mass fraction warning tolerance''<br />
<tr> <br />
<td> AcidBase.Tol<td> Input<td> Tolerance used to determine if warning for existence of acids and bases in product stream needs to be given.<br />
<tr>|<br />
}}<br />
|-<br />
| colspan="3" font style="background: #ebebeb" | ''Species Without Enthalpy Data Tolerance (Mass Fraction)''<br />
|- <br />
| SpHfMissing.Tol || Input || For species which do not have complete enthalpy information, i.e. either H25 or Cp is missing, the mass fraction of the species above which a warning is issued.<br />
|- <br />
| TotHfMissing.Tol || Input || The total mass fraction of all species with missing Cp or H25 data above which a warning is issued.<br />
|- <br />
{{#ifeq: {{{TPS}}}| AQSol|<br />
<td colspan="3" font style="background: #ebebeb"> ''AQSol timeout for calculations''<br />
<tr><br />
<td> Timeout <td> Input <td> This is the maximum time that AQSol will attempt to find a solution. If this time is surpassed by the solver, AQSol will report that it is unable to find a solution.<br />
<tr> <br />
|<br />
}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:TPSModelCfg_Tab_Page&diff=78637Template:TPSModelCfg Tab Page2024-02-29T19:51:22Z<p>Kevin.Heppner: </p>
<hr />
<div>'''Unit Type: {{{TPS}}}ModelCfg''' - The first tab page in the access window will have this name.<br />
<br />
{| border="1" cellpadding="5" cellspacing="0" <br />
| '''Tag (Long/Short)''' || '''Input / Calc''' || '''Description/Calculated Variables / Options'''<br />
|-<br />
{{Common Data on First Tab Page}}<br />
|-<br />
| colspan="3" font style="background: #ebebeb" | ''{{#switch: {{{TPS}}}|<br />
PHREEQC=This program contains PHREEQC Copyright U.S. Geological Survey (USGS)|<br />
AQSol=This program contains AQSol Copyright Aqueous Solutions Aps, Denmark|<br />
ChemApp= This program contains ChemApp Copyright GTT-Technologies, Kaiserstrasse 103, D-52134 Herzogenrath, Germany http://www.gtt-technologies.de|<br />
OLI=This program contains OLI Engine Copyright OLI Systems, USA|<br />
}}''<br />
|-<br />
| colspan="3" font style="background: #ebebeb" |Interface...<br />
|-<br />
| Acknowledgement || style="background: #ebebeb"| Display |||''This program contains {{#switch: {{{TPS}}}|<br />
PHREEQC=PHREEQC Copyright U.S. Geological Survey (USGS)|<br />
AQSol=AQSol Copyright Aqueous Solutions Aps, Denmark|<br />
ChemApp= ChemApp Copyright GTT-Technologies, Kaiserstrasse 103, D-52134 Herzogenrath, Germany http://www.gtt-technologies.de|<br />
OLI= OLI Engine Copyright OLI Systems, USA|<br />
}}''<br />
|-<br />
| Website || style="background: #ebebeb"| Web Link ||{{#switch: {{{TPS}}}|<br />
PHREEQC=''https://www.usgs.gov/software/phreeqc''|<br />
AQSol=''https://www.phasediagram.dk''|<br />
ChemApp= ''https://gtt-technologies.de/software/chemapp''|<br />
OLI=''https://www.olisystems.com''|<br />
}}<br />
|-<br />
| Version || style="background: #ebebeb"| Display || This displays the version of {{{TPS}}} installed on the user's computer<br />
|-<br />
{{#ifeq: {{{TPS}}}| ChemApp|<br />
<td> License.ID <td font style="background: #ebebeb"> Display <td> This displays the ChemApp License ID number. (This is purchased separately from GTT). For ChemApp light, it may display 0001.<br />
<tr><br />
<td> License.User <td font style="background: #ebebeb"> Display <td>This displays the Registered ChemApp User. For ChemApp light, it may display "Demonstration Version".<br />
<tr><br />
<td> License.Expiration <td font style="background: #ebebeb"> Display <td>This displays the ChemApp License Expiration Date.<br />
<tr>|<br />
}}<br />
{{#ifeq: {{{TPS}}}| AQSol|<br />
<td colspan="3" font style="background: #ebebeb"> Displays the AQSol software license information and expiration date. (This is purchased separately from Aqueous Solutions). For Demonstration Version, it may display the following: <br><br />
''AQSOL001, Version 02.00.00 '':<br><br />
''License issued to: Internet user''<br><br />
''Valid until: 2024-05-01''<br><br />
''www.phasediagram.dk'' <br> <br />
<tr>|<br />
}}<br />
<!--<br />
<td> License.ID <td> style="background: #ebebeb"<td> Display <td> This displays the ChemApp License ID number. (This is purchased separately from GTT). For ChemApp light, it may display 0001.<br />
<tr><br />
<td> License.User <td> style="background: #ebebeb"<td> Display <td>This displays the Registered ChemApp User. For ChemApp light, it may display "Demonstration Version".<br />
<tr><br />
<td> License.Expiration <td> style="background: #ebebeb"<td> Display <td>This displays the ChemApp License Expiration Date. <br />
<tr>|<br />
<br />
| rowspan=2| SelectDLLType || Full || This tells SysCAD you are entitled to use the Full Version of ChemApp, with no functionality restrictions. SysCAD will expect to find<br />
* a valid ChemApp license (from GTT)<br />
* a valid SysCAD ChemApp Addon license option (part of the SysCAD license)<br />
* the file ca_sc_e.dll (inside the SysCADxxx bin folder)<br />
* a valid ChemApp Model definition file (.cst or .dat)<br />
|-<br />
| Light || This tells SysCAD you are using the Demonstration mode of ChemApp, in this mode, ChemApp species is restricted (maximum 30 species). Some ChemApp model functionalities are also disabled. SysCAD will expect to find<br />
* the file ca_vc_l.dll (inside the SysCADxxx bin folder)<br />
* a valid ChemApp Model definition file (.cst or .dat)<br />
|-<br />
--><br />
| colspan="3" font style="background: #ebebeb" | Model...<br />
|-<br />
{{#ifeq: {{{TPS}}}| AQSol|<br />
|<br />
<td colspan="3" font style="background: #ebebeb" > ''Select {{{TPS}}} database file''<br />
<tr><br />
<td> DatabaseFile/DBFile <td> Input <td> This is the name of the database file that was created by {{{TPS}}}, e.g. {{{example DB}}}. It is chosen from a dropdown list of available databases, which are defined in the cfg file for the project.<br />
<tr><br />
<td> DatabaseFilePath/DBFilePath <td style="background: #ebebeb"> Display <td> The folder where the database file shown above is saved.<br />
}}<br />
<!-- <br />
{{#ifeq: {{{TPS}}}| PHREEQC|<br />
<td> IncludeGasPhase <td> Tickbox <td> Include gas mixture phase in calculations. DO NOT use this on a unit model that uses SysCAD VLE. Note that PHREEQC Evaporator and PHREEQC Flash Tank use SysCAD VLE by default. Other units can use SysCAD VLE by checking the UseSysCADVLE check box.<br />
<tr>|<br />
}}<br />
--><br />
{{#ifeq: {{{CheckDuplicates}}}|true|<br />
<tr><br />
<td> CheckSpListForDuplicates<td> Tickbox <td> If enabled this will check the {{{TPS}}} species list for duplicates.<br />
<tr>|<br />
}}<br />
|-<br />
| CheckForSteam|| Tickbox || If ticked, SysCAD will check if steam (H2O(g)) is included in the list of {{{TPS}}} species.<br />
|-<br />
| Load || <!--[[Image:Init and Load.png]]<br>-->[[Image:Load.png]] || Click on this button to load the required database file. <!--If the model has not been initialised, then the button will show "Init and Load" and when pressed the model will first be initialised and then the database file will be loaded.--><br />
|-<br />
| DefnStatus|| style="background: #ebebeb"| List|| If the {{{TPS}}} database file has been loaded and no errors have been detected then will show OK, otherwise will show error message.<br />
|- <br />
| SpDBCount || style="background: #ebebeb"| Display || The number of species loaded from the {{{TPS}}} database file.<br />
|- <br />
| Sol.Count || style="background: #ebebeb"| Display || The number of solid species loaded from the {{{TPS}}} database file.<br />
|- <br />
| Liq.Count || style="background: #ebebeb"| Display || The number of liquid species loaded from the {{{TPS}}} database file.<br />
|- <br />
| Vap.Count || style="background: #ebebeb"| Display || The number of gaseous species loaded from the {{{TPS}}} database file.<br />
|- <br />
| ElemCount || style="background: #ebebeb"| Display || The number of elements loaded from the {{{TPS}}} database file.<br />
|- <br />
{{#ifeq:{{{TPS}}}|OLI|<br />
<td> RedoxEnabled <td> Display <td> Indicates whether the model has oxidation-reduction reactions enabled.<br />
<tr><br />
<td> Liq2Enabled <td> Display <td> Indicates whether the model has a second liquid enabled. This is required for OLI Solvent Extraction.<br />
<tr><br />
|}}<br />
| ElemList || style="background: #ebebeb"| Display || The list of the elements used in the {{{TPS}}} database file.<br />
<!--<br />
|-<br />
| NumUnitsUsingCfg|| style="background: #ebebeb"| Display || The number of units models that are using this Model Configuration.<br />
--><br />
|-<br />
{{#ifeq: {{{TPS}}}| PHREEQC|<br />
<td colspan="3" font style="background: #ebebeb"> ''Equilibrium Model Details''<br />
<tr><br />
<td colspan="3" font style="background: #ebebeb"> (Based on the equilibrium model specified in the PHREEQC database file. If none is specified, then ''Davies'' will be used.)<br />
<tr><br />
<td valign="top" rowspan="3"> EquilibriumModel <td> Davies <td> Use the Davies equilibrium model to perform equilibrium calculations. <br />
<tr><br />
<td> Pitzer <td> Use the Pitzer equilibrium model to perform equilibrium calculations.<br />
<tr><br />
<td> SIT <td> Use the SIT (Specific ion Interaction Theory) equilibrium model to perform equilibrium calculations.<br />
<tr><br />
<td> ShowLogKTuning <td> Tickbox <td> Enable LogK mode for entering LogK values directly into SysCAD. If ticked, then the [[#LogKAdjust tab page|LogKAdjust]] tab page will appear.<br />
<tr>|<br />
}}<br />
| colspan="3" font style="background: #ebebeb" | ''Mapping Tolerances''<br />
|- <br />
| Discard.Tol.SigDigits || Input || This provides an easy way to change the Discard.Tol.Rel value. For example, 4 here will set 1.00e-4 to Discard.Tol.Rel. If user changes the Discard.Tol.Rel value, this value will also be updated.<br />
|- <br />
| Discard.Tol.Rel || Input || The relative tolerance for ignoring species produced from the {{{TPS}}} calculations. If the mass fraction of a species is > DiscardTol and it is not mapped to a SysCAD species/ion then an error is generated.<br />
|-<br />
| ElemBal.Tol.SigDigits || Input || This provides an easy way to change the ElemBal.Tol.Rel value. For example, 4 here will set 1.00e-4 to ElemBal.Tol.Rel. If user changes the ElemBal.Tol.Rel value, this value will also be updated.<br />
|- <br />
| ElemBal.Tol.Rel || Input || The relative tolerance for Element Balance (Input - Output). If the relative error is > ElemBal.Tol.Rel then an error is generated. The ElemBal is used in all {{{TPS}}} unit models.<br />
|- <br />
| ElemBal.Tol.Abs || Input || The absolute tolerance for Element Balance (Input - Output). If the absolute error is > ElemBal.Tol.Abs then an error is generated. The ElemBal is used in all {{{TPS}}} unit models.<br />
|- <br />
| colspan="3" font style="background: #ebebeb" | ''Convergence Tolerances''<br />
|- <br />
| EnthConv.Tol.SigDigits || Input || This provides an easy way to change the EnthConv.Tol.Rel value. For example, 4 here will set 1.00e-4 to EnthConv.Tol.Rel. If user changes the EnthConv.Tol.Rel value, this value will also be updated.<br />
|- <br />
| EnthConv.Tol.Rel || Input || Enthalpy convergence tolerance. This is used for iterative enthalpy convergence calculations in SysCAD.<br />
|-<br />
{{#ifeq: {{{TPS}}}| PHREEQC|<br />
<td> {{{TPS}}}.MaxIter<td> Input <td> Maximum number of iterations allowed by {{{TPS}}} in its internal calculation routines.<br />
<tr><br />
<td> {{{TPS}}}.Tol<td> Input <td> Tolerance used by {{{TPS}}} in its internal calculation routines.<br />
<tr><br />
<tr>|<br />
}}<br />
|-<br />
{{#ifeq: {{{AcidBase}}}|true|<br />
<td colspan="3" font style="background: #ebebeb"> ''Acid base coexistence mass fraction warning tolerance''<br />
<tr> <br />
<td> AcidBase.Tol<td> Input<td> Tolerance used to determine if warning for existence of acids and bases in product stream needs to be given.<br />
<tr>|<br />
}}<br />
|-<br />
| colspan="3" font style="background: #ebebeb" | ''Species Without Enthalpy Data Tolerance (Mass Fraction)''<br />
|- <br />
| SpHfMissing.Tol || Input || For species which do not have complete enthalpy information, i.e. either H25 or Cp is missing, the mass fraction of the species above which a warning is issued.<br />
|- <br />
| TotHfMissing.Tol || Input || The total mass fraction of all species with missing Cp or H25 data above which a warning is issued.<br />
|- <br />
{{#ifeq: {{{TPS}}}| AQSol|<br />
<td colspan="3" font style="background: #ebebeb"> ''AQSol timeout for calculations''<br />
<tr><br />
<td> Timeout <td> Input <td> This is the maximum time that AQSol will attempt to find a solution. If this time is surpassed by the solver, AQSol will report that it is unable to find a solution.<br />
<tr> <br />
|<br />
}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:TPSModelCfg_Tab_Page&diff=78636Template:TPSModelCfg Tab Page2024-02-29T19:05:12Z<p>Kevin.Heppner: </p>
<hr />
<div>'''Unit Type: {{{TPS}}}ModelCfg''' - The first tab page in the access window will have this name.<br />
<br />
{| border="1" cellpadding="5" cellspacing="0" <br />
| '''Tag (Long/Short)''' || '''Input / Calc''' || '''Description/Calculated Variables / Options'''<br />
|-<br />
{{Common Data on First Tab Page}}<br />
|-<br />
| colspan="3" font style="background: #ebebeb" | ''{{#switch: {{{TPS}}}|<br />
PHREEQC=This program contains PHREEQC Copyright U.S. Geological Survey (USGS)|<br />
AQSol=This program contains AQSol Copyright Aqueous Solutions Aps, Denmark|<br />
ChemApp= This program contains ChemApp Copyright GTT-Technologies, Kaiserstrasse 103, D-52134 Herzogenrath, Germany http://www.gtt-technologies.de|<br />
OLI=This program contains OLI Engine Copyright OLI Systems, USA|<br />
}}''<br />
|-<br />
| colspan="3" font style="background: #ebebeb" |Interface...<br />
|-<br />
| Acknowledgement || style="background: #ebebeb"| Display |||''This program contains {{#switch: {{{TPS}}}|<br />
PHREEQC=PHREEQC Copyright U.S. Geological Survey (USGS)|<br />
AQSol=AQSol Copyright Aqueous Solutions Aps, Denmark|<br />
ChemApp= ChemApp Copyright GTT-Technologies, Kaiserstrasse 103, D-52134 Herzogenrath, Germany http://www.gtt-technologies.de|<br />
OLI= OLI Engine Copyright OLI Systems, USA|<br />
}}''<br />
|-<br />
| Website || style="background: #ebebeb"| Web Link ||{{#switch: {{{TPS}}}|<br />
PHREEQC=''https://www.usgs.gov/software/phreeqc''|<br />
AQSol=''https://www.phasediagram.dk''|<br />
ChemApp= ''https://gtt-technologies.de/software/chemapp''|<br />
OLI=''https://www.olisystems.com''|<br />
}}<br />
|-<br />
| Version || style="background: #ebebeb"| Display || This displays the version of {{{TPS}}} installed on the user's computer<br />
|-<br />
{{#ifeq: {{{TPS}}}| ChemApp|<br />
<td> License.ID <td font style="background: #ebebeb"> Display <td> This displays the ChemApp License ID number. (This is purchased separately from GTT). For ChemApp light, it may display 0001.<br />
<tr><br />
<td> License.User <td font style="background: #ebebeb"> Display <td>This displays the Registered ChemApp User. For ChemApp light, it may display "Demonstration Version".<br />
<tr><br />
<td> License.Expiration <td font style="background: #ebebeb"> Display <td>This displays the ChemApp License Expiration Date.<br />
<tr>|<br />
}}<br />
{{#ifeq: {{{TPS}}}| AQSol|<br />
<td colspan="3" font style="background: #ebebeb"> Displays the AQSol software license information and expiration date. (This is purchased separately from Aqueous Solutions). For Demonstration Version, it may display the following: <br><br />
''AQSOL001, Version 02.00.00 '':<br><br />
''License issued to: Internet user''<br><br />
''Valid until: 2024-05-01''<br><br />
''www.phasediagram.dk'' <br> <br />
<tr>|<br />
}}<br />
<!--<br />
<td> License.ID <td> style="background: #ebebeb"<td> Display <td> This displays the ChemApp License ID number. (This is purchased separately from GTT). For ChemApp light, it may display 0001.<br />
<tr><br />
<td> License.User <td> style="background: #ebebeb"<td> Display <td>This displays the Registered ChemApp User. For ChemApp light, it may display "Demonstration Version".<br />
<tr><br />
<td> License.Expiration <td> style="background: #ebebeb"<td> Display <td>This displays the ChemApp License Expiration Date. <br />
<tr>|<br />
<br />
| rowspan=2| SelectDLLType || Full || This tells SysCAD you are entitled to use the Full Version of ChemApp, with no functionality restrictions. SysCAD will expect to find<br />
* a valid ChemApp license (from GTT)<br />
* a valid SysCAD ChemApp Addon license option (part of the SysCAD license)<br />
* the file ca_sc_e.dll (inside the SysCADxxx bin folder)<br />
* a valid ChemApp Model definition file (.cst or .dat)<br />
|-<br />
| Light || This tells SysCAD you are using the Demonstration mode of ChemApp, in this mode, ChemApp species is restricted (maximum 30 species). Some ChemApp model functionalities are also disabled. SysCAD will expect to find<br />
* the file ca_vc_l.dll (inside the SysCADxxx bin folder)<br />
* a valid ChemApp Model definition file (.cst or .dat)<br />
|-<br />
--><br />
| colspan="3" font style="background: #ebebeb" | Model...<br />
|-<br />
{{#ifeq: {{{TPS}}}| AQSol|<br />
|<br />
<td colspan="3" font style="background: #ebebeb" > ''Select {{{TPS}}} database file''<br />
<tr><br />
<td> DatabaseFile/DBFile <td> Input <td> This is the name of the database file that was created by {{{TPS}}}, e.g. {{{example DB}}}. It is chosen from a dropdown list of available databases, which are defined in the cfg file for the project.<br />
<tr><br />
<td> DatabaseFilePath/DBFilePath <td style="background: #ebebeb"> Display <td> The folder where the database file shown above is saved.<br />
}}<br />
<!-- <br />
{{#ifeq: {{{TPS}}}| PHREEQC|<br />
<td> IncludeGasPhase <td> Tickbox <td> Include gas mixture phase in calculations. DO NOT use this on a unit model that uses SysCAD VLE. Note that PHREEQC Evaporator and PHREEQC Flash Tank use SysCAD VLE by default. Other units can use SysCAD VLE by checking the UseSysCADVLE check box.<br />
<tr>|<br />
}}<br />
--><br />
{{#ifeq: {{{CheckDuplicates}}}|true|<br />
<tr><br />
<td> CheckSpListForDuplicates<td> Tickbox <td> If enabled this will check the {{{TPS}}} species list for duplicates.<br />
<tr>|<br />
}}<br />
|-<br />
| CheckForSteam|| Tickbox || If ticked, SysCAD will check if steam (H2O(g)) is included in the list of {{{TPS}}} species.<br />
|-<br />
| Load || <!--[[Image:Init and Load.png]]<br>-->[[Image:Load.png]] || Click on this button to load the required database file. <!--If the model has not been initialised, then the button will show "Init and Load" and when pressed the model will first be initialised and then the database file will be loaded.--><br />
|-<br />
| DefnStatus|| style="background: #ebebeb"| List|| If the {{{TPS}}} database file has been loaded and no errors have been detected then will show OK, otherwise will show error message.<br />
|- <br />
| SpDBCount || style="background: #ebebeb"| Display || The number of species loaded from the {{{TPS}}} database file.<br />
|- <br />
| Sol.Count || style="background: #ebebeb"| Display || The number of solid species loaded from the {{{TPS}}} database file.<br />
|- <br />
| Liq.Count || style="background: #ebebeb"| Display || The number of liquid species loaded from the {{{TPS}}} database file.<br />
|- <br />
| Vap.Count || style="background: #ebebeb"| Display || The number of gaseous species loaded from the {{{TPS}}} database file.<br />
|- <br />
| ElemCount || style="background: #ebebeb"| Display || The number of elements loaded from the {{{TPS}}} database file.<br />
|- <br />
{{#ifeq:{{{TPS}}}|OLI|<br />
<td> RedoxEnabled <td> Indicates whether the model has oxidation-reduction reactions enabled.<br />
<tr><br />
<td> Liq2Enabled <td> Indicates whether the model has a second liquid enabled. This is required for OLI Solvent Extraction.<br />
<tr><br />
|}}<br />
| ElemList || style="background: #ebebeb"| Display || The list of the elements used in the {{{TPS}}} database file.<br />
<!--<br />
|-<br />
| NumUnitsUsingCfg|| style="background: #ebebeb"| Display || The number of units models that are using this Model Configuration.<br />
--><br />
|-<br />
{{#ifeq: {{{TPS}}}| PHREEQC|<br />
<td colspan="3" font style="background: #ebebeb"> ''Equilibrium Model Details''<br />
<tr><br />
<td colspan="3" font style="background: #ebebeb"> (Based on the equilibrium model specified in the PHREEQC database file. If none is specified, then ''Davies'' will be used.)<br />
<tr><br />
<td valign="top" rowspan="3"> EquilibriumModel <td> Davies <td> Use the Davies equilibrium model to perform equilibrium calculations. <br />
<tr><br />
<td> Pitzer <td> Use the Pitzer equilibrium model to perform equilibrium calculations.<br />
<tr><br />
<td> SIT <td> Use the SIT (Specific ion Interaction Theory) equilibrium model to perform equilibrium calculations.<br />
<tr><br />
<td> ShowLogKTuning <td> Tickbox <td> Enable LogK mode for entering LogK values directly into SysCAD. If ticked, then the [[#LogKAdjust tab page|LogKAdjust]] tab page will appear.<br />
<tr>|<br />
}}<br />
| colspan="3" font style="background: #ebebeb" | ''Mapping Tolerances''<br />
|- <br />
| Discard.Tol.SigDigits || Input || This provides an easy way to change the Discard.Tol.Rel value. For example, 4 here will set 1.00e-4 to Discard.Tol.Rel. If user changes the Discard.Tol.Rel value, this value will also be updated.<br />
|- <br />
| Discard.Tol.Rel || Input || The relative tolerance for ignoring species produced from the {{{TPS}}} calculations. If the mass fraction of a species is > DiscardTol and it is not mapped to a SysCAD species/ion then an error is generated.<br />
|-<br />
| ElemBal.Tol.SigDigits || Input || This provides an easy way to change the ElemBal.Tol.Rel value. For example, 4 here will set 1.00e-4 to ElemBal.Tol.Rel. If user changes the ElemBal.Tol.Rel value, this value will also be updated.<br />
|- <br />
| ElemBal.Tol.Rel || Input || The relative tolerance for Element Balance (Input - Output). If the relative error is > ElemBal.Tol.Rel then an error is generated. The ElemBal is used in all {{{TPS}}} unit models.<br />
|- <br />
| ElemBal.Tol.Abs || Input || The absolute tolerance for Element Balance (Input - Output). If the absolute error is > ElemBal.Tol.Abs then an error is generated. The ElemBal is used in all {{{TPS}}} unit models.<br />
|- <br />
| colspan="3" font style="background: #ebebeb" | ''Convergence Tolerances''<br />
|- <br />
| EnthConv.Tol.SigDigits || Input || This provides an easy way to change the EnthConv.Tol.Rel value. For example, 4 here will set 1.00e-4 to EnthConv.Tol.Rel. If user changes the EnthConv.Tol.Rel value, this value will also be updated.<br />
|- <br />
| EnthConv.Tol.Rel || Input || Enthalpy convergence tolerance. This is used for iterative enthalpy convergence calculations in SysCAD.<br />
|-<br />
{{#ifeq: {{{TPS}}}| PHREEQC|<br />
<td> {{{TPS}}}.MaxIter<td> Input <td> Maximum number of iterations allowed by {{{TPS}}} in its internal calculation routines.<br />
<tr><br />
<td> {{{TPS}}}.Tol<td> Input <td> Tolerance used by {{{TPS}}} in its internal calculation routines.<br />
<tr><br />
<tr>|<br />
}}<br />
|-<br />
{{#ifeq: {{{AcidBase}}}|true|<br />
<td colspan="3" font style="background: #ebebeb"> ''Acid base coexistence mass fraction warning tolerance''<br />
<tr> <br />
<td> AcidBase.Tol<td> Input<td> Tolerance used to determine if warning for existence of acids and bases in product stream needs to be given.<br />
<tr>|<br />
}}<br />
|-<br />
| colspan="3" font style="background: #ebebeb" | ''Species Without Enthalpy Data Tolerance (Mass Fraction)''<br />
|- <br />
| SpHfMissing.Tol || Input || For species which do not have complete enthalpy information, i.e. either H25 or Cp is missing, the mass fraction of the species above which a warning is issued.<br />
|- <br />
| TotHfMissing.Tol || Input || The total mass fraction of all species with missing Cp or H25 data above which a warning is issued.<br />
|- <br />
{{#ifeq: {{{TPS}}}| AQSol|<br />
<td colspan="3" font style="background: #ebebeb"> ''AQSol timeout for calculations''<br />
<tr><br />
<td> Timeout <td> Input <td> This is the maximum time that AQSol will attempt to find a solution. If this time is surpassed by the solver, AQSol will report that it is unable to find a solution.<br />
<tr> <br />
|<br />
}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Solvent_Extraction&diff=78635OLI Solvent Extraction2024-02-29T18:59:51Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category: OLI]] [[Category:Models]]<br />
{{Navigation | [[Models]] |[[Models#Thermodynamic Calculation Engines|TCE Models]]| [[OLI Overview|OLI]]}}<br />
{{OLI Header Tabs | currentpage = 9}}<br />
<br />
'''Related Links:''' [[OLI_Overview#OLI_SysCAD_Project_Workflow|OLI SysCAD Project Workflow]]<br />
----<br />
{{TOC}}<br />
== General Description ==<br />
<br />
{{TPS - General Description | TPS=OLI | UnitOp=Mixer Settler}}<br />
<br />
=== Diagram ===<br />
<br />
:[[Image:SolventExtraction.png]]<br />
<br />
* The diagram shows default drawing of the Mixer Settler unit with connecting streams.<br />
* The physical location of the streams connecting to the unit is unimportant. The user may connect the streams to any position on the unit.<br />
* When inserting a Solvent Extraction Mixer Settler unit into a flowsheet, the user may choose a different symbol from the menu.<br />
<br />
== Inputs and Outputs ==<br />
<br />
:{| border="1" cellpadding="5" cellspacing="0" <br />
|- <br />
| valign="top" rowspan="2" | '''Label''' || valign="top" rowspan="2" | '''Required<br>Optional''' || valign="top" rowspan="2" | '''Input<br>Output ''' || colspan="2" | '''Number of Connections''' || valign="top" rowspan="2" | '''Description'''<br />
|- <br />
| '''Min''' || '''Max''' <br />
|-<br />
| Aqueous Inlet || 1 Required || In || 1 || 20 || Aqueous feed to Solvent Extraction unit.<br />
|-<br />
| Organic Inlet || 1 Required || In || 1 || 20 || Organic feed to Solvent Extraction unit.<br />
|-<br />
| Aqueous Outlet || Required || Out || 1 || 1 || Aqueous outlet from Solvent Extraction unit.<br />
|-<br />
| Organic Outlet || Required || Out || 1 || 1 || Organic outlet from Solvent Extraction unit.<br />
|-<br />
| Vent || Optional|| Out || 0 || 1 || Vent Stream. (Vapour Only)<br />
|}<br />
<br />
== Behaviour when Model is OFF ==<br />
<br />
If the user disables the unit, by un-ticking the ''On'' tick box, then the following actions occur:<br />
* All streams connected to the 'Aqueous' inlet will flow straight out of the 'Aqueous' outlet;<br />
* All streams connected to the 'Organic' inlet will flow straight out of the 'Organic' outlet;<br />
* No reactions will occur.<br />
<br />
So basically, the unit will be 'bypassed' without the user having to change any connections.<br />
<br />
== Model Theory ==<br />
<br />
{{TPS Unit Model Theory | TPS=OLI | UnitOp=Mixer Settler |OutputStream=aqueous solution | DBFile= OLI database file (.dat) |AllowSideCalc=No}}<br />
<br />
== WorkFlow == <br />
<br />
{{TPS - Workflow | TPS=OLI | UnitOp=SolventExtraction|Unit_Op=Solvent Extraction}}<br />
<br />
== Data Sections ==<br />
<br />
The tabs and variable names are described in detail in the following tables.<br />
<br />
# '''[[#OLISolventExtraction tab page|OLISolventExtraction]]''' - The first tab contains general information relating to the unit and allows the user to configure the unit.<br />
# '''[[#TCE tab page|TCE]]''' tab - This tab allows the user to choose the corresponding [[OLI Model Configuration]] unit and set other TCE options.<br />
# '''[[#CFE tab page|CFE]]''' - Optional tab, only visible if the ''UseCFE'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#Bypass tab page|Bypass]]''' - Optional tab, only visible if the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#RxnBypass tab page|RxnBypass]]''' - Optional tab, only visible if the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#OLIResults tab page|OLIResults]]''' tab - This tab displays the key results of the calculations.<br />
# '''[[#Input tab page|Input]]''' tab - This tab displays a summary of the mapped Input stream as OLI species.<br />
# '''[[#Output tab page|Output]]''' tab - This tab displays the Output stream results including the amounts of each OLI species present in the final mixture.<br />
# '''[[#Diff tab page|Diff]]''' tab - Optional tab, only visible if the ''ShowRxnDiff'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab displays the amounts of each species which are formed or reacted as part of the calculations.<br />
# '''[[#ElemBal tab page|ElemBal]]''' tab - This tab displays an elemental balance between the Input and Output streams.<br />
<!-- # '''[[#EnergyAudit tab page|EnergyAudit]]''' tab - This tab displays the overall energy values for the unit model. <br />
# '''[[#SpIonRxns tab page|SpIonRxns]]''' - Optional tab, only visible if the ''ShowSpIonRebuildRxns'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows how ions from the OLI product stream were assembled into SysCAD species.--><br />
# '''[[#PhDeport tab page|PhDeport]]''' tab - Optional tab, only visible if the ''PhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the Solid, Liquid and Gas phases.<br />
# '''[[#IPhDeport tab page|IPhDeport]]''' tab - Optional tab, only visible if the ''IPhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the individual OLI phases.<br />
# '''UnitTag.[[#ParamSweep tab page|ParamSweep]]''' tab - Optional tab, only visible if the ''ShowPlotter'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab allows the user to generate sets of data.<br />
# '''[[#SpForPlot tab page|SpForPlot]]''' tab - Optional tab, only visible if the ''SelectSp'' option is enabled on the UnitTag.[[#ParamSweep tab page|ParamSweep]] tab. This tab allows the user to select which species to be reported in the sets of data to be generated.<br />
# '''[[Material Flow Section|QUnmapped]]''' - Optional tab, only visible if ''ShowQUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnUnmapped]]''' - Optional tab, only visible if ''ShowQRxnUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QBypass]]''' - Optional tab, only visible if ''ShowQBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnBypass]]''' - Optional tab, only visible if ''ShowQRxnBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QAqFeed]]''' - Optional tab, only visible if ''ShowAqQFeed'' is enabled on the first tab page. This page shows the properties of the mixed aqueous stream, useful when multiple aqueous feed streams are present.<br />
# '''[[Material Flow Section|QOrgFeed]]''' - Optional tab, only visible if ''ShowOrgQFeed'' is enabled on the first tab page. This page shows the properties of the mixed organic stream, useful when multiple organic feed streams are present.<br />
# '''[[Material Flow Section|QFeed]]''' - Optional tab, only visible if ''ShowQFeed'' is enabled on the first tab page. This page shows the properties of the mixed stream as the feed to the unit. If user has specified a required pressure in the unit, the mixed feed will be set to this pressure. This may cause the temperature of the mixture to change if the delta P is significantly different. <br />
# '''[[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.<br />
# '''[[Links Table|Links]]''' tab, contains a summary table for all the input and output streams. <br />
# '''[[Audit]]''' tab - contains summary information required for Mass and Energy balance. See [[Model Examples]] for enthalpy calculation Examples.<br />
<br />
=== OLISolventExtraction tab page===<br />
<br />
{{TCESolventExtraction Tab Page|TCE =OLI}}<br />
<br />
=== TCE tab page ===<br />
<br />
{{TCE - no OpMode Tab Page | TCE =OLI | UnitOp=Solvent Extraction| IncludeVLE=Yes|IncludeCFE=Yes|IncludeIons=Yes|IncludeHeatLoss=Yes}}<br />
<br />
=== CFE tab page ===<br />
<br />
{{TPS CFE Tab Page|TPS=OLI}}<br />
<br />
=== Bypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS=OLI|139only=Yes}}<br />
<br />
=== RxnBypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS=OLI|RxnBypass=Yes}}<br />
<br />
=== OLIResults tab page ===<br />
<br />
{{TPS Results Tab|TPS=OLI|139only=Yes}}<br />
<br />
=== Input tab page ===<br />
<br />
{{TPS Input Output Diff Tabs|Type=Input|TPS=OLI|139only=Yes}}<br />
<br />
=== Output tab page ===<br />
<br />
{{TPS Input Output Diff Tabs|Type=Output|TPS=OLI|139only=Yes}}<br />
<br />
=== Diff tab page ===<br />
This tab is only visible if ''ShowRxnDiff'' is ticked. The displayed results are the difference between input and output streams.<br />
<br />
{{TPS Input Output Diff Tabs|Type=Diff|TPS=OLI|139only=Yes}}<br />
<br />
=== ElemBal tab page ===<br />
<br />
{{TPS ElemBal Tab|TPS=OLI|139only=Yes}}<br />
<br />
<!--<br />
=== EnergyAudit tab page ===<br />
Only displayed once model is successfully run.<br />
<br />
{{TPS EnergyAudit Tab}}<br />
--><br />
<br />
<!--<br />
=== SpIonRxns tab page ===<br />
<br />
This tab is only visible if ''ShowSpIonRebuildRxns'' is ticked.<br />
<br />
{{TPS SpIonRxns Tab}}<br />
--><br />
<br />
=== PhDeport tab page ===<br />
<br />
{{TPS PhDeport Tab|TPS=OLI|139only=Yes}}<br />
<br />
=== IPhDeport tab page ===<br />
<br />
{{TPS IPhDeport Tab|TPS=OLI|139only=Yes}}<br />
<br />
=== ParamSweep tab page ===<br />
<br />
This tab is only visible if ''ShowPlotter'' is ticked. This option is only shown if this model has been successfully run.<br />
<br />
{{TPS ParamSweep Tab|TPS=OLI|139only=Yes}}<br />
<br />
=== SpForPlot tab page ===<br />
<br />
{{TPS SpForPlot Tab|TPS=OLI|139only=Yes}}<br />
<br />
== Adding this Model to a Project ==<br />
<br />
{{TPS Add Model|TPS =OLI|UnitOp=Solvent Extraction (Mixer Settler)|Group=Mass Separation}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Solvent_Extraction&diff=78634OLI Solvent Extraction2024-02-29T18:59:22Z<p>Kevin.Heppner: </p>
<hr />
<div>{{BETA|y}}<br />
[[Category: OLI]] [[Category:Models]]<br />
{{Navigation | [[Models]] |[[Models#Thermodynamic Calculation Engines|TCE Models]]| [[OLI Overview|OLI]]}}<br />
{{OLI Header Tabs | currentpage = 9}}<br />
<br />
'''Related Links:''' [[OLI_Overview#OLI_SysCAD_Project_Workflow|OLI SysCAD Project Workflow]]<br />
----<br />
{{TOC}}<br />
== General Description ==<br />
<br />
{{TPS - General Description | TPS=OLI | UnitOp=Mixer Settler}}<br />
<br />
=== Diagram ===<br />
<br />
:[[Image:SolventExtraction.png]]<br />
<br />
* The diagram shows default drawing of the Mixer Settler unit with connecting streams.<br />
* The physical location of the streams connecting to the unit is unimportant. The user may connect the streams to any position on the unit.<br />
* When inserting a Solvent Extraction Mixer Settler unit into a flowsheet, the user may choose a different symbol from the menu.<br />
<br />
== Inputs and Outputs ==<br />
<br />
:{| border="1" cellpadding="5" cellspacing="0" <br />
|- <br />
| valign="top" rowspan="2" | '''Label''' || valign="top" rowspan="2" | '''Required<br>Optional''' || valign="top" rowspan="2" | '''Input<br>Output ''' || colspan="2" | '''Number of Connections''' || valign="top" rowspan="2" | '''Description'''<br />
|- <br />
| '''Min''' || '''Max''' <br />
|-<br />
| Aqueous Inlet || 1 Required || In || 1 || 20 || Aqueous feed to Solvent Extraction unit.<br />
|-<br />
| Organic Inlet || 1 Required || In || 1 || 20 || Organic feed to Solvent Extraction unit.<br />
|-<br />
| Aqueous Outlet || Required || Out || 1 || 1 || Aqueous outlet from Solvent Extraction unit.<br />
|-<br />
| Organic Outlet || Required || Out || 1 || 1 || Organic outlet from Solvent Extraction unit.<br />
|-<br />
| Vent || Optional|| Out || 0 || 1 || Vent Stream. (Vapour Only)<br />
|}<br />
<br />
== Behaviour when Model is OFF ==<br />
<br />
If the user disables the unit, by un-ticking the ''On'' tick box, then the following actions occur:<br />
* All streams connected to the 'Aqueous' inlet will flow straight out of the 'Aqueous' outlet;<br />
* All streams connected to the 'Organic' inlet will flow straight out of the 'Organic' outlet;<br />
* No reactions will occur.<br />
<br />
So basically, the unit will be 'bypassed' without the user having to change any connections.<br />
<br />
== Model Theory ==<br />
<br />
{{TPS Unit Model Theory | TPS=OLI | UnitOp=Mixer Settler |OutputStream=aqueous solution | DBFile= OLI database file (.dat) |AllowSideCalc=No}}<br />
<br />
== WorkFlow == <br />
<br />
{{TPS - Workflow | TPS=OLI | UnitOp=SolventExtraction|Unit_Op=Solvent Extraction}}<br />
<br />
== Data Sections ==<br />
<br />
The tabs and variable names are described in detail in the following tables.<br />
<br />
# '''[[#OLISolventExtraction tab page|OLISolventExtraction]]''' - The first tab contains general information relating to the unit and allows the user to configure the unit.<br />
# '''[[#TCE tab page|TCE]]''' tab - This tab allows the user to choose the corresponding [[OLI Model Configuration]] unit and set other TCE options.<br />
# '''[[#CFE tab page|CFE]]''' - Optional tab, only visible if the ''UseCFE'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#Bypass tab page|Bypass]]''' - Optional tab, only visible if the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#RxnBypass tab page|RxnBypass]]''' - Optional tab, only visible if the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#OLIResults tab page|OLIResults]]''' tab - This tab displays the key results of the calculations.<br />
# '''[[#Input tab page|Input]]''' tab - This tab displays a summary of the mapped Input stream as OLI species.<br />
# '''[[#Output tab page|Output]]''' tab - This tab displays the Output stream results including the amounts of each OLI species present in the final mixture.<br />
# '''[[#Diff tab page|Diff]]''' tab - Optional tab, only visible if the ''ShowRxnDiff'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab displays the amounts of each species which are formed or reacted as part of the calculations.<br />
# '''[[#ElemBal tab page|ElemBal]]''' tab - This tab displays an elemental balance between the Input and Output streams.<br />
<!-- # '''[[#EnergyAudit tab page|EnergyAudit]]''' tab - This tab displays the overall energy values for the unit model. <br />
# '''[[#SpIonRxns tab page|SpIonRxns]]''' - Optional tab, only visible if the ''ShowSpIonRebuildRxns'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows how ions from the OLI product stream were assembled into SysCAD species.--><br />
# '''[[#PhDeport tab page|PhDeport]]''' tab - Optional tab, only visible if the ''PhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the Solid, Liquid and Gas phases.<br />
# '''[[#IPhDeport tab page|IPhDeport]]''' tab - Optional tab, only visible if the ''IPhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the individual OLI phases.<br />
# '''UnitTag.[[#ParamSweep tab page|ParamSweep]]''' tab - Optional tab, only visible if the ''ShowPlotter'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab allows the user to generate sets of data.<br />
# '''[[#SpForPlot tab page|SpForPlot]]''' tab - Optional tab, only visible if the ''SelectSp'' option is enabled on the UnitTag.[[#ParamSweep tab page|ParamSweep]] tab. This tab allows the user to select which species to be reported in the sets of data to be generated.<br />
# '''[[Material Flow Section|QUnmapped]]''' - Optional tab, only visible if ''ShowQUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnUnmapped]]''' - Optional tab, only visible if ''ShowQRxnUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QBypass]]''' - Optional tab, only visible if ''ShowQBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnBypass]]''' - Optional tab, only visible if ''ShowQRxnBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QAqFeed]]''' - Optional tab, only visible if ''ShowAqQFeed'' is enabled on the first tab page. This page shows the properties of the mixed aqueous stream, useful when multiple aqueous feed streams are present.<br />
# '''[[Material Flow Section|QOrgFeed]]''' - Optional tab, only visible if ''ShowOrgQFeed'' is enabled on the first tab page. This page shows the properties of the mixed organic stream, useful when multiple organic feed streams are present.<br />
# '''[[Material Flow Section|QFeed]]''' - Optional tab, only visible if ''ShowQFeed'' is enabled on the first tab page. This page shows the properties of the mixed stream as the feed to the unit. If user has specified a required pressure in the unit, the mixed feed will be set to this pressure. This may cause the temperature of the mixture to change if the delta P is significantly different. <br />
# '''[[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.<br />
# '''[[Links Table|Links]]''' tab, contains a summary table for all the input and output streams. <br />
# '''[[Audit]]''' tab - contains summary information required for Mass and Energy balance. See [[Model Examples]] for enthalpy calculation Examples.<br />
<br />
=== OLISolventExtraction tab page===<br />
<br />
{{TCESolventExtraction Tab Page|TCE =OLI}}<br />
<br />
=== TCE tab page ===<br />
<br />
{{TCE - no OpMode Tab Page | TCE =OLI | UnitOp=Solvent Extraction| IncludeVLE=Yes|IncludeCFE=Yes|IncludeIons=Yes|IncludeHeatLoss=Yes}}<br />
<br />
=== CFE tab page ===<br />
<br />
{{TPS CFE Tab Page|TPS=OLI}}<br />
<br />
=== Bypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS=OLI|139only=Yes}}<br />
<br />
=== RxnBypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS=OLI|RxnBypass=Yes}}<br />
<br />
=== OLIResults tab page ===<br />
<br />
{{TPS Results Tab|TPS=OLI|139only=Yes}}<br />
<br />
=== Input tab page ===<br />
<br />
{{TPS Input Output Diff Tabs|Type=Input|TPS=OLI|139only=Yes}}<br />
<br />
=== Output tab page ===<br />
<br />
{{TPS Input Output Diff Tabs|Type=Output|TPS=OLI|139only=Yes}}<br />
<br />
=== Diff tab page ===<br />
This tab is only visible if ''ShowRxnDiff'' is ticked. The displayed results are the difference between input and output streams.<br />
<br />
{{TPS Input Output Diff Tabs|Type=Diff|TPS=OLI|139only=Yes}}<br />
<br />
=== ElemBal tab page ===<br />
<br />
{{TPS ElemBal Tab|TPS=OLI|139only=Yes}}<br />
<br />
<!--<br />
=== EnergyAudit tab page ===<br />
Only displayed once model is successfully run.<br />
<br />
{{TPS EnergyAudit Tab}}<br />
--><br />
<br />
<!--<br />
=== SpIonRxns tab page ===<br />
<br />
This tab is only visible if ''ShowSpIonRebuildRxns'' is ticked.<br />
<br />
{{TPS SpIonRxns Tab}}<br />
--><br />
<br />
=== PhDeport tab page ===<br />
<br />
{{TPS PhDeport Tab|TPS=OLI|139only=Yes}}<br />
<br />
=== IPhDeport tab page ===<br />
<br />
{{TPS IPhDeport Tab|TPS=OLI|139only=Yes}}<br />
<br />
=== ParamSweep tab page ===<br />
<br />
This tab is only visible if ''ShowPlotter'' is ticked. This option is only shown if this model has been successfully run.<br />
<br />
{{TPS ParamSweep Tab|TPS=OLI|139only=Yes}}<br />
<br />
=== SpForPlot tab page ===<br />
<br />
{{TPS SpForPlot Tab|TPS=OLI|139only=Yes}}<br />
<br />
== Adding this Model to a Project ==<br />
<br />
{{TPS Add Model|TPS =OLI|UnitOp=Solvent Extraction (Mixer Settler)|Group=Mass Separation}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Solvent_Extraction&diff=78633OLI Solvent Extraction2024-02-29T18:56:47Z<p>Kevin.Heppner: Created page with "Category: OLI Category:Models {{Navigation | Models |TCE Models| OLI}} {{OLI Header Tabs | currentpage = 9}} '''Related Links:''' OLI SysCAD Project Workflow ---- {{TOC}} == General Description == {{TPS - General Description | TPS=OLI | UnitOp=Mixer Settler}} === Diagram === :Image:SolventExtraction.png * The diagram shows default drawing of the..."</p>
<hr />
<div>[[Category: OLI]] [[Category:Models]]<br />
{{Navigation | [[Models]] |[[Models#Thermodynamic Calculation Engines|TCE Models]]| [[OLI Overview|OLI]]}}<br />
{{OLI Header Tabs | currentpage = 9}}<br />
<br />
'''Related Links:''' [[OLI_Overview#OLI_SysCAD_Project_Workflow|OLI SysCAD Project Workflow]]<br />
----<br />
{{TOC}}<br />
== General Description ==<br />
<br />
{{TPS - General Description | TPS=OLI | UnitOp=Mixer Settler}}<br />
<br />
=== Diagram ===<br />
<br />
:[[Image:SolventExtraction.png]]<br />
<br />
* The diagram shows default drawing of the Mixer Settler unit with connecting streams.<br />
* The physical location of the streams connecting to the unit is unimportant. The user may connect the streams to any position on the unit.<br />
* When inserting a Solvent Extraction Mixer Settler unit into a flowsheet, the user may choose a different symbol from the menu.<br />
<br />
== Inputs and Outputs ==<br />
<br />
:{| border="1" cellpadding="5" cellspacing="0" <br />
|- <br />
| valign="top" rowspan="2" | '''Label''' || valign="top" rowspan="2" | '''Required<br>Optional''' || valign="top" rowspan="2" | '''Input<br>Output ''' || colspan="2" | '''Number of Connections''' || valign="top" rowspan="2" | '''Description'''<br />
|- <br />
| '''Min''' || '''Max''' <br />
|-<br />
| Aqueous Inlet || 1 Required || In || 1 || 20 || Aqueous feed to Solvent Extraction unit.<br />
|-<br />
| Organic Inlet || 1 Required || In || 1 || 20 || Organic feed to Solvent Extraction unit.<br />
|-<br />
| Aqueous Outlet || Required || Out || 1 || 1 || Aqueous outlet from Solvent Extraction unit.<br />
|-<br />
| Organic Outlet || Required || Out || 1 || 1 || Organic outlet from Solvent Extraction unit.<br />
|-<br />
| Vent || Optional|| Out || 0 || 1 || Vent Stream. (Vapour Only)<br />
|}<br />
<br />
== Behaviour when Model is OFF ==<br />
<br />
If the user disables the unit, by un-ticking the ''On'' tick box, then the following actions occur:<br />
* All streams connected to the 'Aqueous' inlet will flow straight out of the 'Aqueous' outlet;<br />
* All streams connected to the 'Organic' inlet will flow straight out of the 'Organic' outlet;<br />
* No reactions will occur.<br />
<br />
So basically, the unit will be 'bypassed' without the user having to change any connections.<br />
<br />
== Model Theory ==<br />
<br />
{{TPS Unit Model Theory | TPS=OLI | UnitOp=Mixer Settler |OutputStream=aqueous solution | DBFile= OLI database file (.dat) |AllowSideCalc=No}}<br />
<br />
== WorkFlow == <br />
<br />
{{TPS - Workflow | TPS=OLI | UnitOp=SolventExtraction|Unit_Op=Solvent Extraction}}<br />
<br />
== Data Sections ==<br />
<br />
The tabs and variable names are described in detail in the following tables.<br />
<br />
# '''[[#OLISolventExtraction tab page|OLISolventExtraction]]''' - The first tab contains general information relating to the unit and allows the user to configure the unit.<br />
# '''[[#TCE tab page|TCE]]''' tab - This tab allows the user to choose the corresponding [[OLI Model Configuration]] unit and set other TCE options.<br />
# '''[[#CFE tab page|CFE]]''' - Optional tab, only visible if the ''UseCFE'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#Bypass tab page|Bypass]]''' - Optional tab, only visible if the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#RxnBypass tab page|RxnBypass]]''' - Optional tab, only visible if the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#OLIResults tab page|OLIResults]]''' tab - This tab displays the key results of the calculations.<br />
# '''[[#Input tab page|Input]]''' tab - This tab displays a summary of the mapped Input stream as OLI species.<br />
# '''[[#Output tab page|Output]]''' tab - This tab displays the Output stream results including the amounts of each OLI species present in the final mixture.<br />
# '''[[#Diff tab page|Diff]]''' tab - Optional tab, only visible if the ''ShowRxnDiff'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab displays the amounts of each species which are formed or reacted as part of the calculations.<br />
# '''[[#ElemBal tab page|ElemBal]]''' tab - This tab displays an elemental balance between the Input and Output streams.<br />
<!-- # '''[[#EnergyAudit tab page|EnergyAudit]]''' tab - This tab displays the overall energy values for the unit model. <br />
# '''[[#SpIonRxns tab page|SpIonRxns]]''' - Optional tab, only visible if the ''ShowSpIonRebuildRxns'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows how ions from the OLI product stream were assembled into SysCAD species.--><br />
# '''[[#PhDeport tab page|PhDeport]]''' tab - Optional tab, only visible if the ''PhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the Solid, Liquid and Gas phases.<br />
# '''[[#IPhDeport tab page|IPhDeport]]''' tab - Optional tab, only visible if the ''IPhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the individual OLI phases.<br />
# '''UnitTag.[[#ParamSweep tab page|ParamSweep]]''' tab - Optional tab, only visible if the ''ShowPlotter'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab allows the user to generate sets of data.<br />
# '''[[#SpForPlot tab page|SpForPlot]]''' tab - Optional tab, only visible if the ''SelectSp'' option is enabled on the UnitTag.[[#ParamSweep tab page|ParamSweep]] tab. This tab allows the user to select which species to be reported in the sets of data to be generated.<br />
# '''[[Material Flow Section|QUnmapped]]''' - Optional tab, only visible if ''ShowQUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnUnmapped]]''' - Optional tab, only visible if ''ShowQRxnUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QBypass]]''' - Optional tab, only visible if ''ShowQBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnBypass]]''' - Optional tab, only visible if ''ShowQRxnBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QAqFeed]]''' - Optional tab, only visible if ''ShowAqQFeed'' is enabled on the first tab page. This page shows the properties of the mixed aqueous stream, useful when multiple aqueous feed streams are present.<br />
# '''[[Material Flow Section|QOrgFeed]]''' - Optional tab, only visible if ''ShowOrgQFeed'' is enabled on the first tab page. This page shows the properties of the mixed organic stream, useful when multiple organic feed streams are present.<br />
# '''[[Material Flow Section|QFeed]]''' - Optional tab, only visible if ''ShowQFeed'' is enabled on the first tab page. This page shows the properties of the mixed stream as the feed to the unit. If user has specified a required pressure in the unit, the mixed feed will be set to this pressure. This may cause the temperature of the mixture to change if the delta P is significantly different. <br />
# '''[[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.<br />
# '''[[Links Table|Links]]''' tab, contains a summary table for all the input and output streams. <br />
# '''[[Audit]]''' tab - contains summary information required for Mass and Energy balance. See [[Model Examples]] for enthalpy calculation Examples.<br />
<br />
=== OLISolventExtraction tab page===<br />
<br />
{{TCESolventExtraction Tab Page|TCE =OLI}}<br />
<br />
=== TCE tab page ===<br />
<br />
{{TCE - no OpMode Tab Page | TCE =OLI | UnitOp=Solvent Extraction| IncludeVLE=Yes|IncludeCFE=Yes|IncludeIons=Yes|IncludeHeatLoss=Yes}}<br />
<br />
=== CFE tab page ===<br />
<br />
{{TPS CFE Tab Page|TPS=OLI}}<br />
<br />
=== Bypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS=OLI|139only=Yes}}<br />
<br />
=== RxnBypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS=OLI|RxnBypass=Yes}}<br />
<br />
=== OLIResults tab page ===<br />
<br />
{{TPS Results Tab|TPS=OLI|139only=Yes}}<br />
<br />
=== Input tab page ===<br />
<br />
{{TPS Input Output Diff Tabs|Type=Input|TPS=OLI|139only=Yes}}<br />
<br />
=== Output tab page ===<br />
<br />
{{TPS Input Output Diff Tabs|Type=Output|TPS=OLI|139only=Yes}}<br />
<br />
=== Diff tab page ===<br />
This tab is only visible if ''ShowRxnDiff'' is ticked. The displayed results are the difference between input and output streams.<br />
<br />
{{TPS Input Output Diff Tabs|Type=Diff|TPS=OLI|139only=Yes}}<br />
<br />
=== ElemBal tab page ===<br />
<br />
{{TPS ElemBal Tab|TPS=OLI|139only=Yes}}<br />
<br />
<!--<br />
=== EnergyAudit tab page ===<br />
Only displayed once model is successfully run.<br />
<br />
{{TPS EnergyAudit Tab}}<br />
--><br />
<br />
<!--<br />
=== SpIonRxns tab page ===<br />
<br />
This tab is only visible if ''ShowSpIonRebuildRxns'' is ticked.<br />
<br />
{{TPS SpIonRxns Tab}}<br />
--><br />
<br />
=== PhDeport tab page ===<br />
<br />
{{TPS PhDeport Tab|TPS=OLI|139only=Yes}}<br />
<br />
=== IPhDeport tab page ===<br />
<br />
{{TPS IPhDeport Tab|TPS=OLI|139only=Yes}}<br />
<br />
=== ParamSweep tab page ===<br />
<br />
This tab is only visible if ''ShowPlotter'' is ticked. This option is only shown if this model has been successfully run.<br />
<br />
{{TPS ParamSweep Tab|TPS=OLI|139only=Yes}}<br />
<br />
=== SpForPlot tab page ===<br />
<br />
{{TPS SpForPlot Tab|TPS=OLI|139only=Yes}}<br />
<br />
== Adding this Model to a Project ==<br />
<br />
{{TPS Add Model|TPS =OLI|UnitOp=Solvent Extraction (Mixer Settler)|Group=Mass Separation}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:OLI_Header_Tabs&diff=78632Template:OLI Header Tabs2024-02-29T18:56:25Z<p>Kevin.Heppner: </p>
<hr />
<div>{| border="1" cellpadding="5" cellspacing="0"<br />
|-<br />
{{Header table template 11Terms | currentpage = {{{currentpage}}}<br />
| Name1= [[OLI Overview|OLI <br>Overview]]<br />
| Name2= [[OLI Model Configuration|OLI <br>Model Configuration]]<br />
| Name3= [[OLI Direct Calc Model|OLI <br>Direct Calc Model]]<br />
| Name4= [[OLI Side Calc Model|OLI <br>Side Calc Model]]<br />
| Name5= [[OLI Reactor 2|OLI <br>Reactor 2]] <br />
| Name6= [[OLI Evaporator|OLI <br>Evaporator]] <br />
| Name7= [[OLI Flash Tank|OLI <br>Flash Tank]]<br />
| Name8= [[OLI Reverse Osmosis Unit|OLI <br>Reverse Osmosis]]<br />
| Name9= [[OLI Solvent Extraction|OLI <br>Solvent Extraction]]<br />
| Name10= [[OLI Feeder Model|OLI <br>Feeder Model]]<br />
| Name11= [[OLI Pond Model|OLI <br>Pond Model (Dynamic)]]<br />
}}<br />
|}<br />
{{Latest SysCAD Version}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:OLI_Header_Tabs&diff=78631Template:OLI Header Tabs2024-02-29T18:56:01Z<p>Kevin.Heppner: </p>
<hr />
<div>{| border="1" cellpadding="5" cellspacing="0"<br />
|-<br />
{{Header table template 10Terms | currentpage = {{{currentpage}}}<br />
| Name1= [[OLI Overview|OLI <br>Overview]]<br />
| Name2= [[OLI Model Configuration|OLI <br>Model Configuration]]<br />
| Name3= [[OLI Direct Calc Model|OLI <br>Direct Calc Model]]<br />
| Name4= [[OLI Side Calc Model|OLI <br>Side Calc Model]]<br />
| Name5= [[OLI Reactor 2|OLI <br>Reactor 2]] <br />
| Name6= [[OLI Evaporator|OLI <br>Evaporator]] <br />
| Name7= [[OLI Flash Tank|OLI <br>Flash Tank]]<br />
| Name8= [[OLI Reverse Osmosis Unit|OLI <br>Reverse Osmosis]]<br />
| Name9= [[OLI Solvent Extraction|OLI <br>Solvent Extraction]]<br />
| Name10= [[OLI Feeder Model|OLI <br>Feeder Model]]<br />
| Name11= [[OLI Pond Model|OLI <br>Pond Model (Dynamic)]]<br />
}}<br />
|}<br />
{{Latest SysCAD Version}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=ChemApp_Tank&diff=78607ChemApp Tank2024-02-23T17:50:51Z<p>Kevin.Heppner: Kevin.Heppner moved page ChemApp Tank to Draft:ChemApp Tank: not yet released</p>
<hr />
<div>#REDIRECT [[Draft:ChemApp Tank]]</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=OLI_Reactor_2&diff=78605OLI Reactor 22024-02-23T17:46:45Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category:Models]] [[Category:OLI]]<br />
{{Navigation|[[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]] | [[OLI Overview|OLI]]}}<br />
{{OLI Header Tabs|currentpage=5}}<br />
<br />
'''Related Links:''' [[OLI Overview#OLI SysCAD Project Workflow|OLI SysCAD Project Workflow]], [[Example_-_06_OLI_Projects#Simple_Reactor_Example|OLI Example Project]]<br />
<br />
'''Legacy Models:''' [[OLI Reactor]] The legacy model is used for backward compatibility purposes. We highly recommend users convert any existing projects to use this new model: [[OLI Reactor 2]].<br />
<br />
----<br />
{{OLI version comment}} <br />
{{TOC}}<br />
== General Description ==<br />
<br />
{{TPS Reactor Description|TPS=OLI||Website=https://www.olisystems.com www.olisystems.com}}<br />
<br />
== Inputs and Outputs ==<br />
<br />
{{TPS Reactor Inputs Outputs|TPS =OLI}}<br />
<br />
== Model Theory ==<br />
<br />
{{TPS Unit Model Theory|TPS=OLI|UnitOp=Reactor|OutputStream=aqueous solution|DBFile= OLI database (.dbs) |AllowSideCalc=Yes}}<br />
<br />
== WorkFlow ==<br />
<br />
{{TPS Reactor WorkFlow|TPS =OLI}}<br />
<br />
== Data Sections ==<br />
<br />
The tabs and variable names are described in detail in the following tables.<br />
<br />
# '''[[#OLIReactor2 tab page|OLIReactor2]]''' tab - This first tab allows the user to set some general options.<br />
<!-- # '''[[RB]]''' - Optional tab, only visible if the Reactions are enabled in the Evaluation Block. --><br />
# '''[[MU]]''' - Optional tab, or multiple tabs if more than 1 Makeup is selected. Only visible if one of more Makeups are enabled in the Evaluation Block.<br />
# '''[[#TCE tab page|TCE]]''' tab - This tab allows the user to choose the corresponding [[OLI Model Configuration]] unit and set other TCE options including to choice of model (''Reactor'' or ''Side Calc'').<br />
# '''[[Material Flow Section|QFeed]]''' - Optional tab, only visible if ''ShowQFeed'' is enabled on the first tab page.<br />
# '''[[Material Flow Section|QTCEFeed]]''' - Optional tab, only visible if ''ShowQTCEFeed'' is enabled on the first tab page.<br />
# '''[[VLE]]''' - Optional tab, only visible if the ''UseSysCADVLE/VLE.On'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#Bypass tab page|Bypass]]''' - Optional tab, only visible if the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#RxnBypass tab page|RxnBypass]]''' - Optional tab, only visible if the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#OLIResults tab page|OLIResults]]''' tab - This tab displays the key results of the calculations.<br />
# '''[[#Input tab page|Input]]''' tab - This tab displays a summary of the mapped Input stream as OLI species.<br />
# '''[[#Output tab page|Output]]''' tab - This tab displays the Output stream results including the amounts of each OLI species present in the final mixture.<br />
# '''[[#Diff tab page|Diff]]''' tab - Optional tab, only visible if the ''ShowRxnDiff'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab displays the amounts of each species which are formed or reacted as part of the calculations.<br />
# '''[[#ElemBal tab page|ElemBal]]''' tab - This tab displays an elemental balance between the Input and Output streams.<br />
<!-- # '''[[#EnergyAudit tab page|EnergyAudit]]''' tab - Only available in Build 139 or later. This tab displays the overall energy values for the unit model. <br />
# '''[[#SpIonRxns tab page|SpIonRxns]]''' - Only available in Build 139 or later. Optional tab, only visible if the ''ShowSpIonRebuildRxns'' option is enabled on the first tab page. This tab shows how ions from the OLI product stream were assembled into SysCAD species. --><br />
# '''[[#PhDeport tab page|PhDeport]]''' tab - Optional tab, only visible if the ''PhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the Solid, Liquid and Gas phases.<br />
# '''[[#IPhDeport tab page|IPhDeport]]''' tab - Optional tab, only visible if the ''IPhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for individual OLI phases.<br />
# '''UnitTag.[[#ParamSweep tab page|ParamSweep]]''' tab - Optional tab, only visible if the ''ShowPlotter'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab allows the user to generate sets of data.<br />
# '''[[#SpForPlot tab page|SpForPlot]]''' tab - Optional tab, only visible if the ''SelectSp'' option is enabled on the UnitTag.[[#ParamSweep tab page|ParamSweep]] tab. This tab allows the user to select which species to be reported in the sets of data to be generated.<br />
# '''[[Material Flow Section|QUnmapped]]''' - Optional tab, only visible if ''ShowQUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnUnmapped]]''' - Optional tab, only visible if ''ShowQRxnUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QBypass]]''' - Optional tab, only visible if ''ShowQBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnBypass]]''' - Optional tab, only visible if ''ShowQRxnBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#AppSp tab page|AppSp]]''' tab - Optional tab, only visible if the ''ShowAppSp'' option is enabled on the [[#TCE tab page|TCE]] tab.<br />
# '''[[Material Flow Section|QProd]]''' - Optional tab, only visible if ''ShowQProd'' is enabled on the first tab page.<br />
# '''[[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.<br />
# '''[[Links Table|Links]]''' tab, contains a summary table for all the input and output streams. <br />
# '''[[Audit]]''' tab - contains summary information required for Mass and Energy balance. See [[Model Examples]] for enthalpy calculation Examples.<br />
<br />
=== OLIReactor2 tab page ===<br />
<br />
{{TPSReactor Tab Page|TPS =OLI|IncludeReactions=No}}<br />
<br />
=== TCE tab page ===<br />
<br />
{{TCE Tab Page | TCE =OLI| UnitOp=Reactor | IncludeVLE=No|IncludeCFE=No|IncludeIons=Yes}}<br />
<br />
=== Bypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS=OLI|139only=Yes}}<br />
<br />
=== RxnBypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS=OLI|RxnBypass=Yes}}<br />
<br />
=== OLIResults tab page ===<br />
<br />
In Build 138, this page was called '''Results'''.<br />
<br />
{{TPS Results Tab|TPS=OLI|UnitOp=Reactor}}<br />
<br />
=== Input tab page ===<br />
<br />
{{TPS Input Output Diff Tabs|Type=Input|TPS=OLI|139only=Yes}}<br />
<br />
=== Output tab page ===<br />
<br />
{{TPS Input Output Diff Tabs|Type=Output|TPS=OLI|139only=Yes}}<br />
<br />
=== Diff tab page ===<br />
This tab is only visible if ''ShowRxnDiff'' is ticked. The displayed results are the difference between input and output streams.<br />
<br />
{{TPS Input Output Diff Tabs|Type=Diff|TPS=OLI|139only=Yes}}<br />
<br />
=== ElemBal tab page ===<br />
<br />
{{TPS ElemBal Tab|TPS=OLI}}<br />
<!--<br />
=== EnergyAudit tab page ===<br />
Only available in Build 139 or later. Only displayed once model is successfully run. --><br />
<br />
<!--<br />
=== SpIonRxns tab page ===<br />
<br />
This tab is only visible if ''ShowSpIonRebuildRxns'' is ticked.<br />
<br />
{{TPS SpIonRxns Tab}}<br />
--><br />
<br />
=== PhDeport tab page ===<br />
<br />
{{TPS PhDeport Tab|TPS=OLI}}<br />
<br />
=== IPhDeport tab page ===<br />
<br />
{{TPS IPhDeport Tab|TPS=OLI|139only=Yes}}<br />
<br />
=== ParamSweep tab page ===<br />
<br />
This tab is only visible if ''ShowPlotter'' is ticked and the model has been successfully run.<br />
<br />
{{TPS ParamSweep Tab|TPS=OLI}}<br />
<br />
=== SpForPlot tab page ===<br />
<br />
{{TPS SpForPlot Tab|TPS=OLI}}<br />
<br />
=== AppSp tab page ===<br />
<br />
This shows the apparent species (whole salts, acids, and bases) predicted using the OLI algorithm for species assembly from ions listed in the [[#Output tab page|Output]]. Species are separated into individual phase tables.<br />
<br />
== Adding this Model to a Project ==<br />
<br />
{{TPS Add Model|TPS =OLI|UnitOp=Reactor2|Group=Energy Transfer}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:TCE_Pond&diff=78458Template:TCE Pond2024-02-16T14:21:09Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category: {{{TPS}}}]] [[Category:Models]]<br />
{{Navigation | [[Models]] |[[Models#Thermodynamic Calculation Engines|TCE Models]]| [[{{{TPS}}} Overview|{{{TPS}}}]]}}<br />
{{{{{TPS}}} Header Tabs| currentpage = 11}}<br />
<br />
'''Related Links:''' [[{{{TPS}}}_Overview#{{{TPS}}}_SysCAD_Project_Workflow|{{{TPS}}} SysCAD Project Workflow]]<br />
----<br />
Released as a BETA version in {{Available139|{{{AvailableBuildNo}}}||y}}.<br />
{{TOC}}<br />
== General Description ==<br />
The {{{TPS}}} Pond model is used in the Dynamic mode to emulate an Evaporation Pond. The user has the option to divide the pond into two layers, a bed where most of the solids settle and a clarified liquor layer for liquids, or consider the pond as a single layer. In any case, the concentration of the pore liquid in the bed layer and the concentration of the supernatant pond liquid is always equal and in equilibrium with the solids.<br />
<br />
The {{{TPS}}} Pond model allows the user to 'call' the {{{TPS}}} solver to determine the state of a pond contents.<br />
<br />
'''Notes'''<br />
<br />
#The user MUST have added and configured a [[{{{TPS}}} Model Configuration]] unit in the SysCAD project before this unit can function.<br />
{{#ifeq:{{{TPS}}}|PHREEQC|<br />
#Installation of {{{TPS}}} is not required to use the {{{TPS}}} functionality in SysCAD. If the user wishes to install {{{TPS}}}, please see [{{{Webpage}}} {{{Webpage}}}] for more information.<br />
|<br />
#Installation of {{{TPS}}} is required to use the {{{TPS}}} functionality in SysCAD. If the user wishes to install {{{TPS}}}, please see [{{{Webpage}}} {{{Webpage}}}] for more information.<br />
}}<br />
== Inputs and Outputs ==<br />
{| border="1" cellpadding="5" cellspacing="0" <br />
|- <br />
| valign="top" rowspan="2" | '''Label''' || valign="top" rowspan="2" | '''Required<br>Optional''' || valign="top" rowspan="2" | '''Input<br>Output ''' || colspan="2" | '''Number of Connections''' || valign="top" rowspan="2" | '''Description'''<br />
|- <br />
| '''Min''' || '''Max''' <br />
|-<br />
| Feed || Required || In || 1 || 10 || The feed to the Pond.<br />
|-<br />
| '''Overflow''' || '''Required''' || '''Out''' || '''1''' || '''1''' || '''Pond overflow stream.'''<br />
|-<br />
| CL_Out || Optional || Out || 0 || 1 || Outlet stream from the Clarified Liquor layer.<br />
|-<br />
| Bed_Out || Optional || Out || 0 || 1 || Outlet stream from the Bed layer.<br />
|-<br />
| Seepage || Optional || Out || 0 || 1 || Pond seepage.<br />
|-<br />
| Vent || Optional || Out || 0 || 1 || Vent Stream (Vapour Only).<br />
|}<br />
<br />
== Model Theory ==<br />
<br />
{{TPS Unit Model Theory|TPS={{{TPS}}}|UnitOp=Pond|OutputStream=aqueous solution|DBFile=database (.dat)||AllowSideCalc=No|IncludeMapEach=false}}<br />
<br />
== Workflow ==<br />
<br />
{{TPS - Workflow | TPS={{{TPS}}} | UnitOp=Pond|Unit_Op=Pond}}<br />
<br />
== Data Sections ==<br />
# '''[[#{{{TPS}}}Pond tab page|{{{TPS}}}Pond]]''' tab - The first tab contains general information relating to the unit and allows the user to configure the unit.<br />
# '''[[#Outlets tab page|Outlets]]''' tab - Optional tab, only visible if one of the optional slurry outlets are connected (CL_Out, Bed_Out or Seepage). This tab allows user to configure the various outputs from the pond as defined in the list of outputs above.<br />
# '''[[#Results tab page|Results]]''' tab - Contains results of the model including summary of content parameters.<br />
# '''[[#TCE tab page|TCE]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab allows the user to choose the corresponding [[{{{TPS}}} Model Configuration]] unit and set other TCE options.<br />
# '''[[#CFE tab page|CFE]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''UseCFE'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#Bypass tab page|Bypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#RxnBypass tab page|RxnBypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#{{{TPS}}}Results tab page|{{{TPS}}}Results]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays the key results of the calculations.<br />
# '''[[#Input tab page|Input]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays a summary of the mapped Input stream as {{{TPS}}} species.<br />
# '''[[#Output tab page|Output]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays the Output stream results including the amounts of each {{{TPS}}} species present in the final mixture.<br />
# '''[[#Diff tab page|Diff]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''ShowRxnDiff'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab displays the amounts of each species which are formed or reacted as part of the calculations.<br />
# '''[[#ElemBal tab page|ElemBal]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays an elemental balance between the Input and Output streams.<br />
# '''[[#PhDeport tab page|PhDeport]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''PhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the Solid, Liquid and Gas phases.<br />
# '''[[#IPhDeport tab page|IPhDeport]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''IPhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the individual {{{TPS}}} phases.<br />
# '''[[Material Flow Section|QUnmapped]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnUnmapped]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQRxnUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QBypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnBypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQRxnBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[RB|CRB]]''' - Optional tab, only visible if '''Rxns.Option''' = ''CRB''.<br />
# '''[[MU]]''' - Optional tab, or multiple tabs if more than 1 Makeup is selected. Only visible if one of more Makeups are enabled in the Evaluation Block on the first tab page.<br />
# '''[[Material Flow Section|QFeed]]''' - Optional tab, only visible if ''ShowQFeed'' is enabled on the first tab page. This page shows the properties of the mixed stream as the feed to the unit. If user has specified a required pressure in the unit, the mixed feed will be set to this pressure. This may cause the temperature of the mixture to change if the delta P is significantly different.<br />
# '''[[Material Content Section|Bed]]''' tab - Optional tab, only visible if ''BedLayer.Partition'' and ''ShowBed'' are enabled on the first tab page. Contains data on the material in the bed.<br />
# '''[[Material Content Section|Content]]''' tab - contains data on the material in the pond.<br />
# '''[[#Preset tab page|Preset]]''' tab - Optional tab, only visible if ''UsePreset'' option is enabled on the first tab page. Allows user to define the Preset composition.<br />
# '''[[Material Flow Section|QCL]]''' - Optional tab, only visible if the '''CL_Out''' outlet is connected and ''ShowQCL'' is enabled on the first tab page. This page shows the properties of the CL_Out stream.<br />
# '''[[Material Flow Section|QBed]]''' - Optional tab, only visible if the '''Bed_Out''' outlet is connected and ''ShowQBed'' is enabled on the first tab page. This page shows the properties of the Bed_Out stream.<br />
# '''[[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.<br />
# '''[[Links Table|Links]]''' tab, contains a summary table for all the input and output streams. <br />
# '''[[Audit]]''' tab - contains summary information required for Mass and Energy balance. See [[Model Examples]] for enthalpy calculation Examples.<br />
<br />
=== {{{TPS}}}Pond tab page ===<br />
<br />
{{TCEPond Tab Page|TCE ={{{TPS}}}}}<br />
<br />
=== Outlets tab page ===<br />
<br />
{{Pond Outlets Tab}}<br />
<br />
=== Results tab page ===<br />
<br />
{{Pond Results Tab}}<br />
<br />
=== TCE tab page ===<br />
<br />
{{TCE Tab Page | TCE ={{{TPS}}}| UnitOp=Pond | IncludeVLE=No|IncludeCFE=No|IncludeIons=Yes}}<br />
<br />
=== CFE tab page ===<br />
<br />
{{TPS CFE Tab Page|TPS={{{TPS}}}}}<br />
<br />
=== Bypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS={{{TPS}}}|139only=Yes}}<br />
<br />
=== RxnBypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS={{{TPS}}}|RxnBypass=Yes}}<br />
<br />
=== {{{TPS}}}Results tab page ===<br />
<br />
{{TCE Results Content Tab|TCE={{{TPS}}}}}<br />
<br />
=== Input tab page ===<br />
<br />
{{TCE Input Output Diff Content Tabs|Type=Input|TCE={{{TPS}}}}}<br />
<br />
=== Output tab page ===<br />
<br />
{{TCE Input Output Diff Content Tabs|Type=Output|TCE={{{TPS}}}}}<br />
<br />
=== Diff tab page ===<br />
This tab is only visible if ''ShowRxnDiff'' is ticked. The displayed results are the difference between input and output streams.<br />
<br />
{{TCE Input Output Diff Content Tabs|Type=Diff|TCE={{{TPS}}}}}<br />
<br />
=== ElemBal tab page ===<br />
<br />
{{TPS ElemBal Tab|TPS={{{TPS}}}|139only=Yes|UnitOp=Pond}}<br />
<br />
=== PhDeport tab page ===<br />
<br />
{{TPS PhDeport Tab|TPS={{{TPS}}}|139only=Yes|UnitOp=Pond}}<br />
<br />
=== IPhDeport tab page ===<br />
<br />
{{TPS IPhDeport Tab|TPS={{{TPS}}}|139only=Yes|UnitOp=Pond}}<br />
<br />
== Preset tab page ==<br />
<br />
The Preset page contains a ''Copy to Clipboard'' button which copies the current temperature, pressure and composition of the Preset to the clipboard for pasting into external programs such as Excel.<br />
<br />
This page is used to set the required composition of the Pond when it is Preset. This is identical in functionality to the [[Define Species (DSp) Section|DSp]] page used in Feeders.<br />
<br />
== Adding this Model to a Project ==<br />
<br />
{{TPS Add Model|TPS ={{{TPS}}}|UnitOp=Pond (Dynamic)|Group=Energy Transfer}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:TCE_Pond&diff=78457Template:TCE Pond2024-02-16T14:10:34Z<p>Kevin.Heppner: /* TCE tab page */</p>
<hr />
<div>[[Category: {{{TPS}}}]] [[Category:Models]]<br />
{{Navigation | [[Models]] |[[Models#Thermodynamic Calculation Engines|TCE Models]]| [[{{{TPS}}} Overview|{{{TPS}}}]]}}<br />
{{{{{TPS}}} Header Tabs| currentpage = 11}}<br />
<br />
'''Related Links:''' [[{{{TPS}}}_Overview#{{{TPS}}}_SysCAD_Project_Workflow|{{{TPS}}} SysCAD Project Workflow]]<br />
----<br />
Released as a BETA version in {{Available139|{{{AvailableBuildNo}}}||y}}.<br />
{{TOC}}<br />
== General Description ==<br />
The {{{TPS}}} Pond model is used in the Dynamic mode to emulate an Evaporation Pond. The user has the option to divide the pond into two layers, a bed where most of the solids settle and a clarified liquor layer for liquids, or consider the pond as a single layer. In any case, the concentration of the pore liquid in the bed layer and the concentration of the supernatant pond liquid is always equal and in equilibrium with the solids.<br />
<br />
The {{{TPS}}} Pond model allows the user to 'call' the {{{TPS}}} solver to determine the state of a pond contents.<br />
<br />
'''Notes'''<br />
<br />
#The user MUST have added and configured a [[{{{TPS}}} Model Configuration]] unit in the SysCAD project before this unit can function.<br />
{{#ifeq:{{{TPS}}}|PHREEQC|<br />
#Installation of {{{TPS}}} is not required to use the {{{TPS}}} functionality in SysCAD. If the user wishes to install {{{TPS}}}, please see [{{{Webpage}}} {{{Webpage}}}] for more information.<br />
|<br />
#Installation of {{{TPS}}} is required to use the {{{TPS}}} functionality in SysCAD. If the user wishes to install {{{TPS}}}, please see [{{{Webpage}}} {{{Webpage}}}] for more information.<br />
}}<br />
== Inputs and Outputs ==<br />
{| border="1" cellpadding="5" cellspacing="0" <br />
|- <br />
| valign="top" rowspan="2" | '''Label''' || valign="top" rowspan="2" | '''Required<br>Optional''' || valign="top" rowspan="2" | '''Input<br>Output ''' || colspan="2" | '''Number of Connections''' || valign="top" rowspan="2" | '''Description'''<br />
|- <br />
| '''Min''' || '''Max''' <br />
|-<br />
| Feed || Required || In || 1 || 10 || The feed to the Pond.<br />
|-<br />
| '''Overflow''' || '''Required''' || '''Out''' || '''1''' || '''1''' || '''Pond overflow stream.'''<br />
|-<br />
| CL_Out || Optional || Out || 0 || 1 || Outlet stream from the Clarified Liquor layer.<br />
|-<br />
| Bed_Out || Optional || Out || 0 || 1 || Outlet stream from the Bed layer.<br />
|-<br />
| Seepage || Optional || Out || 0 || 1 || Pond seepage.<br />
|-<br />
| Vent || Optional || Out || 0 || 1 || Vent Stream (Vapour Only).<br />
|}<br />
<br />
== Model Theory ==<br />
<br />
{{TPS Unit Model Theory|TPS={{{TPS}}}|UnitOp=Pond|OutputStream=aqueous solution|DBFile=database (.dat)||AllowSideCalc=No|IncludeMapEach=false}}<br />
<br />
== Workflow ==<br />
<br />
{{TPS - Workflow | TPS={{{TPS}}} | UnitOp=Pond|Unit_Op=Pond}}<br />
<br />
== Data Sections ==<br />
# '''[[#{{{TPS}}}Pond tab page|{{{TPS}}}Pond]]''' tab - The first tab contains general information relating to the unit and allows the user to configure the unit.<br />
# '''[[#Outlets tab page|Outlets]]''' tab - Optional tab, only visible if one of the optional slurry outlets are connected (CL_Out, Bed_Out or Seepage). This tab allows user to configure the various outputs from the pond as defined in the list of outputs above.<br />
# '''[[#Results tab page|Results]]''' tab - Contains results of the model including summary of content parameters.<br />
# '''[[#TCE tab page|TCE]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab allows the user to choose the corresponding [[{{{TPS}}} Model Configuration]] unit and set other TCE options.<br />
# '''[[#CFE tab page|CFE]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''UseCFE'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#Bypass tab page|Bypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#RxnBypass tab page|RxnBypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#{{{TPS}}}Results tab page|{{{TPS}}}Results]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays the key results of the calculations.<br />
# '''[[#Input tab page|Input]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays a summary of the mapped Input stream as {{{TPS}}} species.<br />
# '''[[#Output tab page|Output]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays the Output stream results including the amounts of each {{{TPS}}} species present in the final mixture.<br />
# '''[[#Diff tab page|Diff]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''ShowRxnDiff'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab displays the amounts of each species which are formed or reacted as part of the calculations.<br />
# '''[[#ElemBal tab page|ElemBal]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays an elemental balance between the Input and Output streams.<br />
# '''[[#PhDeport tab page|PhDeport]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''PhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the Solid, Liquid and Gas phases.<br />
# '''[[#IPhDeport tab page|IPhDeport]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''IPhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the individual {{{TPS}}} phases.<br />
# '''[[Material Flow Section|QUnmapped]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnUnmapped]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQRxnUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QBypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnBypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQRxnBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[RB|CRB]]''' - Optional tab, only visible if '''Rxns.Option''' = ''CRB''.<br />
# '''[[MU]]''' - Optional tab, or multiple tabs if more than 1 Makeup is selected. Only visible if one of more Makeups are enabled in the Evaluation Block on the first tab page.<br />
# '''[[Material Flow Section|QFeed]]''' - Optional tab, only visible if ''ShowQFeed'' is enabled on the first tab page. This page shows the properties of the mixed stream as the feed to the unit. If user has specified a required pressure in the unit, the mixed feed will be set to this pressure. This may cause the temperature of the mixture to change if the delta P is significantly different.<br />
# '''[[Material Content Section|Bed]]''' tab - Optional tab, only visible if ''BedLayer.Partition'' and ''ShowBed'' are enabled on the first tab page. Contains data on the material in the bed.<br />
# '''[[Material Content Section|Content]]''' tab - contains data on the material in the pond.<br />
# '''[[#Preset tab page|Preset]]''' tab - Optional tab, only visible if ''UsePreset'' option is enabled on the first tab page. Allows user to define the Preset composition.<br />
# '''[[Material Flow Section|QCL]]''' - Optional tab, only visible if the '''CL_Out''' outlet is connected and ''ShowQCL'' is enabled on the first tab page. This page shows the properties of the CL_Out stream.<br />
# '''[[Material Flow Section|QBed]]''' - Optional tab, only visible if the '''Bed_Out''' outlet is connected and ''ShowQBed'' is enabled on the first tab page. This page shows the properties of the Bed_Out stream.<br />
# '''[[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.<br />
# '''[[Links Table|Links]]''' tab, contains a summary table for all the input and output streams. <br />
# '''[[Audit]]''' tab - contains summary information required for Mass and Energy balance. See [[Model Examples]] for enthalpy calculation Examples.<br />
<br />
=== {{{TPS}}}Pond tab page ===<br />
<br />
{{TCEPond Tab Page|TCE ={{{TPS}}}}}<br />
<br />
=== Outlets tab page ===<br />
<br />
{{Pond Outlets Tab}}<br />
<br />
=== Results tab page ===<br />
<br />
{{Pond Results Tab}}<br />
<br />
=== TCE tab page ===<br />
<br />
{{TCE Tab Page | TCE ={{{TPS}}}| UnitOp=Pond | IncludeVLE=Yes|IncludeCFE=No|IncludeIons=Yes}}<br />
<br />
=== CFE tab page ===<br />
<br />
{{TPS CFE Tab Page|TPS={{{TPS}}}}}<br />
<br />
=== Bypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS={{{TPS}}}|139only=Yes}}<br />
<br />
=== RxnBypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS={{{TPS}}}|RxnBypass=Yes}}<br />
<br />
=== {{{TPS}}}Results tab page ===<br />
<br />
{{TCE Results Content Tab|TCE={{{TPS}}}}}<br />
<br />
=== Input tab page ===<br />
<br />
{{TCE Input Output Diff Content Tabs|Type=Input|TCE={{{TPS}}}}}<br />
<br />
=== Output tab page ===<br />
<br />
{{TCE Input Output Diff Content Tabs|Type=Output|TCE={{{TPS}}}}}<br />
<br />
=== Diff tab page ===<br />
This tab is only visible if ''ShowRxnDiff'' is ticked. The displayed results are the difference between input and output streams.<br />
<br />
{{TCE Input Output Diff Content Tabs|Type=Diff|TCE={{{TPS}}}}}<br />
<br />
=== ElemBal tab page ===<br />
<br />
{{TPS ElemBal Tab|TPS={{{TPS}}}|139only=Yes|UnitOp=Pond}}<br />
<br />
=== PhDeport tab page ===<br />
<br />
{{TPS PhDeport Tab|TPS={{{TPS}}}|139only=Yes|UnitOp=Pond}}<br />
<br />
=== IPhDeport tab page ===<br />
<br />
{{TPS IPhDeport Tab|TPS={{{TPS}}}|139only=Yes|UnitOp=Pond}}<br />
<br />
== Preset tab page ==<br />
<br />
The Preset page contains a ''Copy to Clipboard'' button which copies the current temperature, pressure and composition of the Preset to the clipboard for pasting into external programs such as Excel.<br />
<br />
This page is used to set the required composition of the Pond when it is Preset. This is identical in functionality to the [[Define Species (DSp) Section|DSp]] page used in Feeders.<br />
<br />
== Adding this Model to a Project ==<br />
<br />
{{TPS Add Model|TPS ={{{TPS}}}|UnitOp=Pond (Dynamic)|Group=Energy Transfer}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:TCE_Pond&diff=78456Template:TCE Pond2024-02-16T14:08:12Z<p>Kevin.Heppner: /* TCE tab page */</p>
<hr />
<div>[[Category: {{{TPS}}}]] [[Category:Models]]<br />
{{Navigation | [[Models]] |[[Models#Thermodynamic Calculation Engines|TCE Models]]| [[{{{TPS}}} Overview|{{{TPS}}}]]}}<br />
{{{{{TPS}}} Header Tabs| currentpage = 11}}<br />
<br />
'''Related Links:''' [[{{{TPS}}}_Overview#{{{TPS}}}_SysCAD_Project_Workflow|{{{TPS}}} SysCAD Project Workflow]]<br />
----<br />
Released as a BETA version in {{Available139|{{{AvailableBuildNo}}}||y}}.<br />
{{TOC}}<br />
== General Description ==<br />
The {{{TPS}}} Pond model is used in the Dynamic mode to emulate an Evaporation Pond. The user has the option to divide the pond into two layers, a bed where most of the solids settle and a clarified liquor layer for liquids, or consider the pond as a single layer. In any case, the concentration of the pore liquid in the bed layer and the concentration of the supernatant pond liquid is always equal and in equilibrium with the solids.<br />
<br />
The {{{TPS}}} Pond model allows the user to 'call' the {{{TPS}}} solver to determine the state of a pond contents.<br />
<br />
'''Notes'''<br />
<br />
#The user MUST have added and configured a [[{{{TPS}}} Model Configuration]] unit in the SysCAD project before this unit can function.<br />
{{#ifeq:{{{TPS}}}|PHREEQC|<br />
#Installation of {{{TPS}}} is not required to use the {{{TPS}}} functionality in SysCAD. If the user wishes to install {{{TPS}}}, please see [{{{Webpage}}} {{{Webpage}}}] for more information.<br />
|<br />
#Installation of {{{TPS}}} is required to use the {{{TPS}}} functionality in SysCAD. If the user wishes to install {{{TPS}}}, please see [{{{Webpage}}} {{{Webpage}}}] for more information.<br />
}}<br />
== Inputs and Outputs ==<br />
{| border="1" cellpadding="5" cellspacing="0" <br />
|- <br />
| valign="top" rowspan="2" | '''Label''' || valign="top" rowspan="2" | '''Required<br>Optional''' || valign="top" rowspan="2" | '''Input<br>Output ''' || colspan="2" | '''Number of Connections''' || valign="top" rowspan="2" | '''Description'''<br />
|- <br />
| '''Min''' || '''Max''' <br />
|-<br />
| Feed || Required || In || 1 || 10 || The feed to the Pond.<br />
|-<br />
| '''Overflow''' || '''Required''' || '''Out''' || '''1''' || '''1''' || '''Pond overflow stream.'''<br />
|-<br />
| CL_Out || Optional || Out || 0 || 1 || Outlet stream from the Clarified Liquor layer.<br />
|-<br />
| Bed_Out || Optional || Out || 0 || 1 || Outlet stream from the Bed layer.<br />
|-<br />
| Seepage || Optional || Out || 0 || 1 || Pond seepage.<br />
|-<br />
| Vent || Optional || Out || 0 || 1 || Vent Stream (Vapour Only).<br />
|}<br />
<br />
== Model Theory ==<br />
<br />
{{TPS Unit Model Theory|TPS={{{TPS}}}|UnitOp=Pond|OutputStream=aqueous solution|DBFile=database (.dat)||AllowSideCalc=No|IncludeMapEach=false}}<br />
<br />
== Workflow ==<br />
<br />
{{TPS - Workflow | TPS={{{TPS}}} | UnitOp=Pond|Unit_Op=Pond}}<br />
<br />
== Data Sections ==<br />
# '''[[#{{{TPS}}}Pond tab page|{{{TPS}}}Pond]]''' tab - The first tab contains general information relating to the unit and allows the user to configure the unit.<br />
# '''[[#Outlets tab page|Outlets]]''' tab - Optional tab, only visible if one of the optional slurry outlets are connected (CL_Out, Bed_Out or Seepage). This tab allows user to configure the various outputs from the pond as defined in the list of outputs above.<br />
# '''[[#Results tab page|Results]]''' tab - Contains results of the model including summary of content parameters.<br />
# '''[[#TCE tab page|TCE]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab allows the user to choose the corresponding [[{{{TPS}}} Model Configuration]] unit and set other TCE options.<br />
# '''[[#CFE tab page|CFE]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''UseCFE'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#Bypass tab page|Bypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#RxnBypass tab page|RxnBypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#{{{TPS}}}Results tab page|{{{TPS}}}Results]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays the key results of the calculations.<br />
# '''[[#Input tab page|Input]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays a summary of the mapped Input stream as {{{TPS}}} species.<br />
# '''[[#Output tab page|Output]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays the Output stream results including the amounts of each {{{TPS}}} species present in the final mixture.<br />
# '''[[#Diff tab page|Diff]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''ShowRxnDiff'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab displays the amounts of each species which are formed or reacted as part of the calculations.<br />
# '''[[#ElemBal tab page|ElemBal]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays an elemental balance between the Input and Output streams.<br />
# '''[[#PhDeport tab page|PhDeport]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''PhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the Solid, Liquid and Gas phases.<br />
# '''[[#IPhDeport tab page|IPhDeport]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''IPhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the individual {{{TPS}}} phases.<br />
# '''[[Material Flow Section|QUnmapped]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnUnmapped]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQRxnUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QBypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnBypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQRxnBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[RB|CRB]]''' - Optional tab, only visible if '''Rxns.Option''' = ''CRB''.<br />
# '''[[MU]]''' - Optional tab, or multiple tabs if more than 1 Makeup is selected. Only visible if one of more Makeups are enabled in the Evaluation Block on the first tab page.<br />
# '''[[Material Flow Section|QFeed]]''' - Optional tab, only visible if ''ShowQFeed'' is enabled on the first tab page. This page shows the properties of the mixed stream as the feed to the unit. If user has specified a required pressure in the unit, the mixed feed will be set to this pressure. This may cause the temperature of the mixture to change if the delta P is significantly different.<br />
# '''[[Material Content Section|Bed]]''' tab - Optional tab, only visible if ''BedLayer.Partition'' and ''ShowBed'' are enabled on the first tab page. Contains data on the material in the bed.<br />
# '''[[Material Content Section|Content]]''' tab - contains data on the material in the pond.<br />
# '''[[#Preset tab page|Preset]]''' tab - Optional tab, only visible if ''UsePreset'' option is enabled on the first tab page. Allows user to define the Preset composition.<br />
# '''[[Material Flow Section|QCL]]''' - Optional tab, only visible if the '''CL_Out''' outlet is connected and ''ShowQCL'' is enabled on the first tab page. This page shows the properties of the CL_Out stream.<br />
# '''[[Material Flow Section|QBed]]''' - Optional tab, only visible if the '''Bed_Out''' outlet is connected and ''ShowQBed'' is enabled on the first tab page. This page shows the properties of the Bed_Out stream.<br />
# '''[[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.<br />
# '''[[Links Table|Links]]''' tab, contains a summary table for all the input and output streams. <br />
# '''[[Audit]]''' tab - contains summary information required for Mass and Energy balance. See [[Model Examples]] for enthalpy calculation Examples.<br />
<br />
=== {{{TPS}}}Pond tab page ===<br />
<br />
{{TCEPond Tab Page|TCE ={{{TPS}}}}}<br />
<br />
=== Outlets tab page ===<br />
<br />
{{Pond Outlets Tab}}<br />
<br />
=== Results tab page ===<br />
<br />
{{Pond Results Tab}}<br />
<br />
=== TCE tab page ===<br />
<br />
{{TCE - no OpMode Tab Page | TCE ={{{TPS}}} | UnitOp=Pond| IncludeVLE=Yes|IncludeCFE=Yes|IncludeIons=Yes|IncludeHeatLoss=No}}<br />
<br />
=== CFE tab page ===<br />
<br />
{{TPS CFE Tab Page|TPS={{{TPS}}}}}<br />
<br />
=== Bypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS={{{TPS}}}|139only=Yes}}<br />
<br />
=== RxnBypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS={{{TPS}}}|RxnBypass=Yes}}<br />
<br />
=== {{{TPS}}}Results tab page ===<br />
<br />
{{TCE Results Content Tab|TCE={{{TPS}}}}}<br />
<br />
=== Input tab page ===<br />
<br />
{{TCE Input Output Diff Content Tabs|Type=Input|TCE={{{TPS}}}}}<br />
<br />
=== Output tab page ===<br />
<br />
{{TCE Input Output Diff Content Tabs|Type=Output|TCE={{{TPS}}}}}<br />
<br />
=== Diff tab page ===<br />
This tab is only visible if ''ShowRxnDiff'' is ticked. The displayed results are the difference between input and output streams.<br />
<br />
{{TCE Input Output Diff Content Tabs|Type=Diff|TCE={{{TPS}}}}}<br />
<br />
=== ElemBal tab page ===<br />
<br />
{{TPS ElemBal Tab|TPS={{{TPS}}}|139only=Yes|UnitOp=Pond}}<br />
<br />
=== PhDeport tab page ===<br />
<br />
{{TPS PhDeport Tab|TPS={{{TPS}}}|139only=Yes|UnitOp=Pond}}<br />
<br />
=== IPhDeport tab page ===<br />
<br />
{{TPS IPhDeport Tab|TPS={{{TPS}}}|139only=Yes|UnitOp=Pond}}<br />
<br />
== Preset tab page ==<br />
<br />
The Preset page contains a ''Copy to Clipboard'' button which copies the current temperature, pressure and composition of the Preset to the clipboard for pasting into external programs such as Excel.<br />
<br />
This page is used to set the required composition of the Pond when it is Preset. This is identical in functionality to the [[Define Species (DSp) Section|DSp]] page used in Feeders.<br />
<br />
== Adding this Model to a Project ==<br />
<br />
{{TPS Add Model|TPS ={{{TPS}}}|UnitOp=Pond (Dynamic)|Group=Energy Transfer}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Template:TCE_Pond&diff=78455Template:TCE Pond2024-02-16T14:07:53Z<p>Kevin.Heppner: /* TCE tab page */</p>
<hr />
<div>[[Category: {{{TPS}}}]] [[Category:Models]]<br />
{{Navigation | [[Models]] |[[Models#Thermodynamic Calculation Engines|TCE Models]]| [[{{{TPS}}} Overview|{{{TPS}}}]]}}<br />
{{{{{TPS}}} Header Tabs| currentpage = 11}}<br />
<br />
'''Related Links:''' [[{{{TPS}}}_Overview#{{{TPS}}}_SysCAD_Project_Workflow|{{{TPS}}} SysCAD Project Workflow]]<br />
----<br />
Released as a BETA version in {{Available139|{{{AvailableBuildNo}}}||y}}.<br />
{{TOC}}<br />
== General Description ==<br />
The {{{TPS}}} Pond model is used in the Dynamic mode to emulate an Evaporation Pond. The user has the option to divide the pond into two layers, a bed where most of the solids settle and a clarified liquor layer for liquids, or consider the pond as a single layer. In any case, the concentration of the pore liquid in the bed layer and the concentration of the supernatant pond liquid is always equal and in equilibrium with the solids.<br />
<br />
The {{{TPS}}} Pond model allows the user to 'call' the {{{TPS}}} solver to determine the state of a pond contents.<br />
<br />
'''Notes'''<br />
<br />
#The user MUST have added and configured a [[{{{TPS}}} Model Configuration]] unit in the SysCAD project before this unit can function.<br />
{{#ifeq:{{{TPS}}}|PHREEQC|<br />
#Installation of {{{TPS}}} is not required to use the {{{TPS}}} functionality in SysCAD. If the user wishes to install {{{TPS}}}, please see [{{{Webpage}}} {{{Webpage}}}] for more information.<br />
|<br />
#Installation of {{{TPS}}} is required to use the {{{TPS}}} functionality in SysCAD. If the user wishes to install {{{TPS}}}, please see [{{{Webpage}}} {{{Webpage}}}] for more information.<br />
}}<br />
== Inputs and Outputs ==<br />
{| border="1" cellpadding="5" cellspacing="0" <br />
|- <br />
| valign="top" rowspan="2" | '''Label''' || valign="top" rowspan="2" | '''Required<br>Optional''' || valign="top" rowspan="2" | '''Input<br>Output ''' || colspan="2" | '''Number of Connections''' || valign="top" rowspan="2" | '''Description'''<br />
|- <br />
| '''Min''' || '''Max''' <br />
|-<br />
| Feed || Required || In || 1 || 10 || The feed to the Pond.<br />
|-<br />
| '''Overflow''' || '''Required''' || '''Out''' || '''1''' || '''1''' || '''Pond overflow stream.'''<br />
|-<br />
| CL_Out || Optional || Out || 0 || 1 || Outlet stream from the Clarified Liquor layer.<br />
|-<br />
| Bed_Out || Optional || Out || 0 || 1 || Outlet stream from the Bed layer.<br />
|-<br />
| Seepage || Optional || Out || 0 || 1 || Pond seepage.<br />
|-<br />
| Vent || Optional || Out || 0 || 1 || Vent Stream (Vapour Only).<br />
|}<br />
<br />
== Model Theory ==<br />
<br />
{{TPS Unit Model Theory|TPS={{{TPS}}}|UnitOp=Pond|OutputStream=aqueous solution|DBFile=database (.dat)||AllowSideCalc=No|IncludeMapEach=false}}<br />
<br />
== Workflow ==<br />
<br />
{{TPS - Workflow | TPS={{{TPS}}} | UnitOp=Pond|Unit_Op=Pond}}<br />
<br />
== Data Sections ==<br />
# '''[[#{{{TPS}}}Pond tab page|{{{TPS}}}Pond]]''' tab - The first tab contains general information relating to the unit and allows the user to configure the unit.<br />
# '''[[#Outlets tab page|Outlets]]''' tab - Optional tab, only visible if one of the optional slurry outlets are connected (CL_Out, Bed_Out or Seepage). This tab allows user to configure the various outputs from the pond as defined in the list of outputs above.<br />
# '''[[#Results tab page|Results]]''' tab - Contains results of the model including summary of content parameters.<br />
# '''[[#TCE tab page|TCE]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab allows the user to choose the corresponding [[{{{TPS}}} Model Configuration]] unit and set other TCE options.<br />
# '''[[#CFE tab page|CFE]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''UseCFE'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#Bypass tab page|Bypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#RxnBypass tab page|RxnBypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''WithBypass'' option is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[#{{{TPS}}}Results tab page|{{{TPS}}}Results]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays the key results of the calculations.<br />
# '''[[#Input tab page|Input]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays a summary of the mapped Input stream as {{{TPS}}} species.<br />
# '''[[#Output tab page|Output]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays the Output stream results including the amounts of each {{{TPS}}} species present in the final mixture.<br />
# '''[[#Diff tab page|Diff]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''ShowRxnDiff'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab displays the amounts of each species which are formed or reacted as part of the calculations.<br />
# '''[[#ElemBal tab page|ElemBal]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE''. This tab displays an elemental balance between the Input and Output streams.<br />
# '''[[#PhDeport tab page|PhDeport]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''PhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the Solid, Liquid and Gas phases.<br />
# '''[[#IPhDeport tab page|IPhDeport]]''' tab - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and the ''IPhaseElemDeportment'' option is enabled on the [[#TCE tab page|TCE]] tab page. This tab shows the movement of elements for the individual {{{TPS}}} phases.<br />
# '''[[Material Flow Section|QUnmapped]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnUnmapped]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQRxnUnmapped'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QBypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[Material Flow Section|QRxnBypass]]''' - Optional tab, only visible if '''Rxns.Option''' = ''TCE'' and ''ShowQRxnBypass'' is enabled on the [[#TCE tab page|TCE]] tab page.<br />
# '''[[RB|CRB]]''' - Optional tab, only visible if '''Rxns.Option''' = ''CRB''.<br />
# '''[[MU]]''' - Optional tab, or multiple tabs if more than 1 Makeup is selected. Only visible if one of more Makeups are enabled in the Evaluation Block on the first tab page.<br />
# '''[[Material Flow Section|QFeed]]''' - Optional tab, only visible if ''ShowQFeed'' is enabled on the first tab page. This page shows the properties of the mixed stream as the feed to the unit. If user has specified a required pressure in the unit, the mixed feed will be set to this pressure. This may cause the temperature of the mixture to change if the delta P is significantly different.<br />
# '''[[Material Content Section|Bed]]''' tab - Optional tab, only visible if ''BedLayer.Partition'' and ''ShowBed'' are enabled on the first tab page. Contains data on the material in the bed.<br />
# '''[[Material Content Section|Content]]''' tab - contains data on the material in the pond.<br />
# '''[[#Preset tab page|Preset]]''' tab - Optional tab, only visible if ''UsePreset'' option is enabled on the first tab page. Allows user to define the Preset composition.<br />
# '''[[Material Flow Section|QCL]]''' - Optional tab, only visible if the '''CL_Out''' outlet is connected and ''ShowQCL'' is enabled on the first tab page. This page shows the properties of the CL_Out stream.<br />
# '''[[Material Flow Section|QBed]]''' - Optional tab, only visible if the '''Bed_Out''' outlet is connected and ''ShowQBed'' is enabled on the first tab page. This page shows the properties of the Bed_Out stream.<br />
# '''[[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.<br />
# '''[[Links Table|Links]]''' tab, contains a summary table for all the input and output streams. <br />
# '''[[Audit]]''' tab - contains summary information required for Mass and Energy balance. See [[Model Examples]] for enthalpy calculation Examples.<br />
<br />
=== {{{TPS}}}Pond tab page ===<br />
<br />
{{TCEPond Tab Page|TCE ={{{TPS}}}}}<br />
<br />
=== Outlets tab page ===<br />
<br />
{{Pond Outlets Tab}}<br />
<br />
=== Results tab page ===<br />
<br />
{{Pond Results Tab}}<br />
<br />
=== TCE tab page ===<br />
<br />
{{TCE - OpMode Tab Page | TCE ={{{TPS}}} | UnitOp=Pond| IncludeVLE=Yes|IncludeCFE=Yes|IncludeIons=Yes|IncludeHeatLoss=No}}<br />
<br />
=== CFE tab page ===<br />
<br />
{{TPS CFE Tab Page|TPS={{{TPS}}}}}<br />
<br />
=== Bypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS={{{TPS}}}|139only=Yes}}<br />
<br />
=== RxnBypass tab page ===<br />
<br />
{{TPS Bypass Tab Page|TPS={{{TPS}}}|RxnBypass=Yes}}<br />
<br />
=== {{{TPS}}}Results tab page ===<br />
<br />
{{TCE Results Content Tab|TCE={{{TPS}}}}}<br />
<br />
=== Input tab page ===<br />
<br />
{{TCE Input Output Diff Content Tabs|Type=Input|TCE={{{TPS}}}}}<br />
<br />
=== Output tab page ===<br />
<br />
{{TCE Input Output Diff Content Tabs|Type=Output|TCE={{{TPS}}}}}<br />
<br />
=== Diff tab page ===<br />
This tab is only visible if ''ShowRxnDiff'' is ticked. The displayed results are the difference between input and output streams.<br />
<br />
{{TCE Input Output Diff Content Tabs|Type=Diff|TCE={{{TPS}}}}}<br />
<br />
=== ElemBal tab page ===<br />
<br />
{{TPS ElemBal Tab|TPS={{{TPS}}}|139only=Yes|UnitOp=Pond}}<br />
<br />
=== PhDeport tab page ===<br />
<br />
{{TPS PhDeport Tab|TPS={{{TPS}}}|139only=Yes|UnitOp=Pond}}<br />
<br />
=== IPhDeport tab page ===<br />
<br />
{{TPS IPhDeport Tab|TPS={{{TPS}}}|139only=Yes|UnitOp=Pond}}<br />
<br />
== Preset tab page ==<br />
<br />
The Preset page contains a ''Copy to Clipboard'' button which copies the current temperature, pressure and composition of the Preset to the clipboard for pasting into external programs such as Excel.<br />
<br />
This page is used to set the required composition of the Pond when it is Preset. This is identical in functionality to the [[Define Species (DSp) Section|DSp]] page used in Feeders.<br />
<br />
== Adding this Model to a Project ==<br />
<br />
{{TPS Add Model|TPS ={{{TPS}}}|UnitOp=Pond (Dynamic)|Group=Energy Transfer}}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Generate_SysCAD_Database_from_ChemApp_Model_File&diff=78428Generate SysCAD Database from ChemApp Model File2024-02-15T13:05:30Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category: ChemApp]]<br />
{{BETA}}<br />
{{Navigation | [[Models]] |[[Models#Thermodynamic Calculation Engines|TCE Models]]| [[ChemApp Overview|ChemApp]] |altname=Utility}}<br />
{{TPS Utility Header tabs|currentpage=2}}<br />
----<br />
{{TOC}}<br />
== Applicability ==<br />
<br />
This help file is applicable to [[ChemApp Overview|ChemApp]].<br />
<br />
'''NOTE:'''<br />
The utility is for adding a list of species into a new SysCAD.93.db3 file. <br />
*It will use data from existing databases (in SysCAD database format), examples of such are Default.93.db3, SysCAD.93.db3 from user projects (these can be renamed for better identification).<br />
*It will NOT extract data from ChemApp FactSage databases.<br />
*It will add species to the new database based on the .cst files selected. <br />
*If a species is not found in the existing database, it will add the species with minimum data (Long Name, Short Name, compound, definition, phase, occurrence), but will leave all the other properties blank. User will need to check and fill in data from other sources after the database is created.<br />
<br />
== General Information ==<br />
<br />
Utility file name: '''<big>SysCADChemAppUtils.exe</big>'''<br />
<br />
*This utility can be used to create a species database using data from ChemApp DAT or CST (encrypted model file) file.<br />
*The utility can be placed in any folder, but the folder must meet the following requirements:[[File:ChemAppUtility.png|frame|ChemApp Utility Folder Structure]]<br />
*#The following ChemApp dll file should be placed inside the folder (copy from the ChemApp install folder):<br />
*#* User with Full ChemApp License: The "ca_sc_e.dll" must be present in the utility folder<br />
*#* User with ChemApp Light: The "ca_vc_l.dll" must be present in the utility folder. <br />
*#* The "ca_sc_e.dll" has precedence over "ca_vc_l.dll", ChemApp Light users should rename or delete the "ca_sc_e.dll" from the utility folder. <br />
*#There must be an “'''IPhaseMap.txt'''” file in the same folder, a template will be created if one does not exist. See [[#Creating the IPhaseMap.txt|Creating the IPhaseMap.txt]]<br />
*#*User must edit this file to contain the correct mapping information before the database can be created correctly. <br />
*#There must be an existing '''SysCAD.93.db3''' file inside the folder to serve as a template (for species table layout). <br />
*#*CAUTION: this file will be stripped down to contain only water and steam, then new data will be added based on the ChemApp model species list. <br />
*#*Please use a “copy” of the actual SysCAD.93.db3 file to avoid destroying user data.<br />
*#There must be a subfolder, “'''DB3Files'''”, containing the following files: <br />
*#*May contain the '''Default.93.DB3''' file (copy from '''SysCADxxx\BaseFiles''' folder). <br />
*#*May contain user’s own database files, formatted in SysCAD DB file format. <br />
*#*Any database files stored in the DB3Files subfolder will be used to populate the SysCAD.93.DB3 file.<br />
*#*when more than one database is present, there may be multiple entries for the same species, if a species has multiple sets of data, user must choose which set of data to add to the SysCAD.93.DB3 file.<br />
*#*as an alternative to the above, user can specify a preferred database. In this case, the preferred database will be used whenever possible, with alternate databases used elsewhere and placeholder species created where no data is available. Selecting a preferred database will avoid choosing data for each case where multiple options are available.<br />
*#*The databases in this folder will be used to build a list of options presented to the user by the utility.<br />
*#There must be a subfolder, “'''Rules'''”, containing the following files: <br />
*#*Must contain a '''Liquids.txt''' file. This specifies a number of substrings which are used to identify a ChemApp phase as a liquid. For example, the supplied Liquids.txt file contains: "AQU", "LIQ", etc., each on its own line. The user can add additional substrings which will be used by the utility to identify a ChemApp phase as a liquid. <br />
*#*Must contain a '''Gases.txt''' file. This specifies a number of substrings which are used to identify a ChemApp phase as a gas. For example, the supplied Gas.txt file contains: "GAS". The user can add additional substrings which will be used by the utility to identify a ChemApp phase as a gas. <br />
*#*There is no '''Solids.txt''' file. Any phase that is not identified as a liquid or a gas, based upon the substrings defined in Liquids.txt and Gases.txt, is defined as a solid. <br />
*#There must be a subfolder, “'''CSTFiles'''”: <br />
*#*Users with Full ChemApp: must place copies of each CST file that they wish to include in the generation of the SysCAD database file. <br />
*#*Users with ChemApp Light: must place copies of each DAT file that they wish to include in the generation of the SysCAD database file. <br />
*#*There is an option to select one or all of the contained CST (DAT) files.<br />
{{Error_And_Message_Logs_Utility}}<br />
*#<b>Optional:</b> User can place a ''Replacements.txt'' file in the same folder as the executable. This is a tab-delimited file that contains replacement strings. If not found, it is simply not used.<br />
*#:<b>''Replacements.txt''</b> <br>[[File:Replacements_File.png]]<br />
*#*If the above file were used, any ChemApp species containing the string Ice would be replaced with H2O in the creation of SysCAD species.<br />
*#<b>Optional:</b> User can place a ''Config.txt'' file in the same folder as the executable. This is a formatted file that contains configuration settings. If not found, it is simply not used.<br />
{{TPS_Utility_Config|IncludePhaseMapping=true}}<br />
== How to use the utility ==<br />
<br />
The utility has two functions:<br />
# assisting with the creation of IPhaseMap.txt. This file must be completed before user can move on to the next step.<br />
# creating the SysCAD.93.db3 file. <br />
<br />
The theory behind mapping between SysCAD and ChemApp species is described in [[ChemApp_Model_Configuration#Model_Theory|ChemApp Model Configuration Model Theory]]. Please ensure you have a clear understanding of this before proceeding to use the utility to generate a SysCAD database and configuration files.<br />
<br />
=== Defining IPhaseMap.txt ===<br />
<br />
The IPhaseMap.txt file is used to map between phase names in the ChemApp model file (CST or DAT file) and individual phases within SysCAD. A phase here is a grouping of species which exist together in a homogeneous mixture. This differs from an occurrence, which can be a group of phases. For example, liquid metals may form a phase, while slags may form another phase, but together, these are part of a liquid occurrence. In addition, there may also be pure phases within ChemApp, which are phases which have only one species within them.<br />
<br />
The three mandatory columns within the IPhaseMap.txt file are described in the table below.<br />
<br />
:[[Image:IPhaseMapTable.png]]<br />
<br />
In SysCAD, pure phases may be treated as an individual phase or as part of an occurrence. In IPhaseMap.txt file, this would be represented as:<br />
*Part of individual phase (there must be a SysCAD individual phase Q, and will map to SysCAD species SiO2(Q)):<br />
*:[[Image:SiO2QMapping.png]]<br />
*Part of occurrence (this will map to SysCAD species SiO2(s)):<br />
*:[[Image:SiO2QMapping Occurrence.png]]<br />
<br />
'''NOTE:'''<br />
If user is to create a new SysCAD database file with no ChemApp phase information, then it is best to start with NO "IPhaseMap.txt" file, this will allow the utility to create a template for you. To do so, delete the IPhaseMap.txt file before starting the utility. If in doubt of the validity of the IPhaseMap.txt file, the user is encouraged to regenerate it.<br />
<br />
==== Creating IPhaseMap.txt ====<br />
<br />
The following instructions are for user with NO valid IPhaseMap.txt file. User must run the utility once to generate a valid IphaseMap.txt, then proceed with [[#Creating the database with a valid IPhaseMap.txt|Creating the database with a valid IPhaseMap.txt]] to generate the database.<br />
<br />
#Run '''SysCADChemAppUtils.exe'''<br />
#The utility will ask for selection of a preferred database. Select the corresponding preferred database, or -1 if none is preferred. If -1 is selected, the user will manually select the data for each species where more than one option exists (see later step).<br />
#Select the CST (or DAT) file for which you wish to create a database and IPhaseMap.txt file. Select -1 to create files which incorporate all of the CST (or DAT) files in the CSTFile folder.<br />
#:[[Image:ChemAppUtil1.png|ChemApp Utility - IPhaseMap]]<br />
#The Utility will create the IPhaseMap.txt file using one of TWO options: <br />
#*OPTION 1: The IPhasemap.txt file will be created with ChemApp phases only. User MUST edit the IPhasemap.txt file to manually assign corresponding SysCAD individual phase mapping and occurrence. A file "Instructions.txt" will be created with instructions on how to edit the “IPhaseMap” file. The IPhaseMap.txt edited (manually) for the cosi.dat is shown below (left image) as an example. <br />
#*OPTION 2: The IPhasemap.txt file will be created with SysCAD individual phase names according to some predefined "RULES". The user is STRONGLY recommended to review and possibly correct the resulting SysCAD individual phase mapping before continuing with database creation. Phase names are created based upon formulas and truncated for length. Occurrences (i.e. solid, liquid, or gas) is guessed for each phase by trying to find the substrings listed for liquids or gases. The IPhaseMap.txt create for the cosi.dat is shown below (right image) as an example. <br />
#: [[Image:ChemAppUtility3.png|ChemApp Utility - IPhaseMap]]<br />
#Optional columns for pure phase options:<br />
#*For pure phases, you can manually add two additional columns to control how the utility manages pure phases in the creation of the database files and configuration. The additional columns and their effect on the utility behaviour are described in the table below:<br />
#:[[Image:IPhaseMap 2OptionalCols.png]]<br />
#*If these columns are not included, the SysCAD phase name is appended to the long name by default. Consider the species SiO2(Quartz) once again. In this case, the long name of the SysCAD species would be:<br />
#:Silica.[Q] where Q is the SysCAD phase corresponding to the ChemApp phase SiO2(Quartz).<br />
#*This is the default behaviour. If the columns are added and a 0 is specified in column 4, it will now create an individual phase "Q" and create the species SiO2(Q).<br />
<br />
Once the iPhaseMap.txt has been created, please check the file before proceeding with the next step.<br />
<br />
===Creating the database with a valid IPhaseMap.txt === <br />
<br />
The following instructions are for users with a valid and checked IPhaseMap.txt.<br />
<br />
#Run '''SysCADChemAppUtils.exe'''<br />
#The utility will ask for selection of a preferred database. Select the corresponding preferred database, or -1 if none is preferred. If -1 is selected, the user will manually select the data for each species where more than one option exists (see later step).<br />
#Select the CST (or DAT) file for which you wish to create a database and IPhaseMap.txt file. Select -1 to create files which incorporate all of the CST (or DAT) files in the CSTFiles folder.<br />
#Where a suitable species does not exist in the available SysCAD database source files, a placeholder species will be created with NO thermodynamic data.<br />
#*Note that if you are loading a DAT file (i.e. where the data is not protected), the Gibb's energy function listed in the DAT file will be used to construct the corresponding Gibbs_Cp or GibbsChemAppCp function in the SysCAD database for this species. Only Gibbs_Cp and GibbsChemAppCp (equation types 1 and 4, respectively) are currently supported.<br />
#Upon completion, the utility will show a summary, confirming the database was created successfully. Press any key to close the utility.<br />
#:[[Image:ChemAppUtil2.png|ChemApp Utility - Create SysCAD.93.db3, using ChemApp Light and .DAT file]]<br />
<br />
:NOTES:<br />
:*While running the utility, if you have NOT selected a preferred database and multiple data is found for a species, you will be prompted to select one of the options. In the example below, the utility has found 2 sets of data for “C” in the available databases, we have selected data set 2 by typing in the "2". For SiO2 quartz, we have selected data set 1.<br />
:*:[[Image:ChemAppUtility4.png|ChemApp Utility - Create SysCAD.93.db3, selecting source database]]<br />
:*:If a Cp range was specified using MIN_TEMP_CP and MAX_TEMP_CP, the utility may be able to select from multiple databases based upon maximum Cp range coverage. In this case, the prompt above would not be shown.<br />
:*If the species data does not exist in the reference SysCAD databases, then a place holder species with <b> no thermodynamic or physical properties data </b> will be used. When this happens, any project using this database will log appropriate warnings on load, look out for these species when [[#Checking the Created SysCAD.93.db3|Checking the Created SysCAD.93.db3]] <br />
:*:[[Image:ChemAppUtility6.png|ChemApp Utility - Create SysCAD.93.db3, default (place holder) species used]]<br />
:*User can use <Ctrl+Z> to quit the utility at any time.<br />
<br />
=== Checking the Created SysCAD.93.db3 ===<br />
<br />
#Check the SysCAD.93.db3 file before copying it to your actual project's cfgfile folder. You can use any SQLite DB reader, such as [https://sqlitebrowser.org/ DB Browser for SQLite]. View the ''SpeciesData'' table to see the data. Species for which no data was found in the reference databases will appear as having each of the definition columns filled, but all of the property columns blank. In the example below, NaCl*2H2O is using placeholder data.<br />
#An error will occur if a SysCAD individual phase or occurrence is missing, the utility will stop once this occurs. User has to fix the IPhasemap.txt file, then run the utility again.<br />
[[Image:PlaceholderSpecies DBBrowser.png|1200px]]<br />
<br />
== Copy the files to the CfgFiles folder ==<br />
<br />
Generally speaking, user only need to use this Utility to generate the SysCAD.93.db3 file at the start of a new ChemApp project group. Once the database has been created, the '''SysCAD.93.db3''' and '''IPhaseMap.txt''' files, as well as the associated CST files used to generate them, should be copied to the ChemApp SysCAD project group\CfgFiles subfolder. For SysCAD with ChemApp flowsheets using multiple CST files, it is required to create the database using all of the CST files at the same time when using this utility.<br />
<br />
== Troubleshooting ==<br />
<br />
{| class="wikitable"<br />
|-<br />
! Error !! Description !! Possible cause / suggested solution.<br />
|-<br />
| rowspan=3|Utility Startup Errors || Missing SysCAD Template species database (SysCAD.93.db3) || The SysCAD.93.db3 file is missing from the Utility folder. This file is required as a starting point. User may copy any valid SysCAD.93.db3 file from the SysCADxxx folder here. <br />
|-<br />
| No SysCAD reference species database found in folder DB3Files || The "DB3Files" folder is missing or empty. Please check the folder name and or make sure it contains at least one SysCAD database, such as the Default.93.db3<br />
|-<br />
| No ChemApp CST files found in folder CSTFiles || The "CSTFiles" folder is missing or empty. Please check the folder name and or make sure it contains at least one ChemApp model files with extension .CST or .DAT.<br />
|-<br />
|IPhaseMap.txt not created properly || IPhaseMap.txt file must be created. || The "Rules" folder missing or not complete. Please check the folder name and make sure it contains rules for Gas and Liquid.<br />
|- <br />
|Database not created successfully || Some ChemApp phases were not assigned corresponding SysCAD individual phases || Caused by missing data in the IPhaseMap.txt, likely a result of an unchecked IPhaseMap.txt file prior to running the utility. <br />
*Please edit the IPhasemap.txt file and assign all ChemApp phases with corresponding SysCAD individual phase and occurrence.<br />
*The ChemApp Phase, SysCAD individual phase and occurrence must be separated by TABs, not spaces.<br />
*If occurrence is missing from one or more species: then the following error may appear: Error: Unidentified phase occurrence <br />
|-<br />
| Error Number: 103 || The thermodynamic data-file could not be completely entered due to a read error || This error is generated if the ChemApp Model file contain "abnormal data", please contact SysCAD support to investigate.<br />
|-<br />
| Error Number: 160 || The thermochemical system is too big (NA=XX, Max:30) for this version of ChemApp || This error is generated if ChemApp light user attempts to load in a ChemApp model file containing more than 30 ChemApp species. ChemApp full version is required if user wants to use the specified ChemApp model file.<br />
|-<br />
| Error Number: 163 || No Valid dongle found || This error is generated if no valid ChemApp license is found. If user is using ChemApp Light, please rename the "ca_sc_e.dll" file to remove it from the utility's search path.<br />
|}<br />
*</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Generate_SysCAD_database_from_PHREEQC_Database_File&diff=78427Generate SysCAD database from PHREEQC Database File2024-02-15T13:03:15Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category: PHREEQC]]<br />
{{BETA}}<br />
{{Navigation | [[Models]] |[[Models#Thermodynamic Calculation Engines|TCE Models]]| [[PHREEQC Overview|PHREEQC]] |altname=Utility}}<br />
{{TPS Utility Header tabs|currentpage=3}}<br />
----<br />
{{TOC}}<br />
== Applicability ==<br />
<br />
This help file is applicable to [[PHREEQC Overview|PHREEQC]].<br />
<br />
'''NOTE:'''<br />
The utility is for adding a list of species into a new SysCAD.93.db3 file. <br />
*It will use data from existing databases (in SysCAD database format), examples of such are Default.93.db3, SysCAD.93.db3 from user projects (these can be renamed for better identification).<br />
*It will NOT extract data from PHREEQC databases.<br />
*It will add species to the new database based on the .dat files selected. It will include species that are listed in the .dat file as well as species that "may" form given the list of ions present.<br />
*If a species is not found in the existing database, it will add the species with minimum data (Long Name, Short Name, compound, definition, phase, occurrence), but will leave all the other properties blank. User will need to check and fill in data from other sources after the database is created.<br />
<br />
== General Information ==<br />
<br />
Utility file name: '''<big>SysCADPHREEQCUtils.exe</big>'''<br />
<br />
*This utility can be used to create a species database using data from PHREEQC DAT file (database file). PHREEQC software and database files are available online for download at: https://www.usgs.gov/software/phreeqc-version-3<br />
<br />
*The utility can be placed in any folder, but the folder must meet the following requirements:[[File:PhreeqcFolderStructure.png|frame|PHREEQC Utility Folder Structure]]<br />
*#There must be an existing '''SysCAD.93.db3''' file inside the folder to serve as a template (for species table layout). <br />
*#*CAUTION: depending on user selections, this file may be stripped down to contain only water and steam, then new data will be added based on the PHREEQC model species list. Stripping of the file is optional.<br />
*#*Please use a “copy” of the actual SysCAD.93.db3 file to avoid destroying user data.<br />
*#There must be a subfolder, “'''DB3Files'''”, containing the following files: <br />
*#*May contain the '''Default.93.DB3''' file (copy from '''SysCADxxx\BaseFiles''' folder). <br />
*#*May contain user’s own database files, formatted in SysCAD DB file format. <br />
*#*Any database files stored in the DB3Files subfolder will be used to populate the SysCAD.93.DB3 file.<br />
*#*when more than one database is present, there may be multiple entries for the same species, if a species has multiple sets of data, user must choose which set of data to add to the SysCAD.93.DB3 file.<br />
*#*as an alternative to the above, user can specify a preferred database. In this case, the preferred database will be used whenever possible, with alternate databases used elsewhere and placeholder species created where no data is available. Selecting a preferred database will avoid choosing data for each case where multiple options are available.<br />
*#*The databases in this folder will be used to build a list of options presented to the user by the utility.<br />
*#There must be a subfolder, “'''DatabaseFiles'''”: <br />
*#*Users must place copies of each DAT file that they wish to include in the generation of the SysCAD database file. <br />
*#*There is an option to select one or all of the contained DAT files in the generation of the database.<br />
{{Error_And_Message_Logs_Utility}}<br />
*#''IonList.txt'', the ion list can be created by the utility, see item "Config.txt" below.<br />
*#:[[File:TPS_IonList_AqSol.png]]<br />
*#<b>Optional:</b> User can place a ''Replacements.txt'' file in the same folder as the executable. This is a tab-delimited file that contains replacement strings. If not found, it is simply not used.<br />
*#:<b>''Replacements.txt''</b> <br>[[File:TPS_Replacements_File.png]]<br />
*#*If the above file were used, any PHREEQC species containing the string Ice would be replaced with H2O in the creation of SysCAD species.<br />
*#<b>Optional:</b> User can place a ''Config.txt'' file in the same folder as the executable. This is a formatted file that contains configuration settings. If not found, it is simply not used.<br />
{{TPS_Utility_Config|IncludeIonList=true}}<br />
<br />
== How to use the utility ==<br />
<br />
The utility has two functions:<br />
# assisting with the creation of IonList.txt. <br />
# creating the SysCAD.93.db3 file. <br />
<br />
===Creating the database === <br />
<br />
#Run '''SysCADPHREEQCUtils.exe'''<br />
#The utility will ask for selection of a preferred database. Select the corresponding preferred database, or -1 if none is preferred. If -1 is selected, the user will manually select the data for each species where more than one option exists (see later step).<br />
#Select the DAT file for which you wish to create a database. Select -1 to create files which incorporate all of the DAT files in the DatabaseFiles folder.<br />
#Where a suitable species does not exist in the available SysCAD database source files, a placeholder species will be created with NO thermodynamic data.<br />
#Upon completion, the utility will show a summary, confirming the database was created successfully. Press any key to close the utility.<br />
#:[[Image:PHREEQCUtil1.png|PHREEQC Utility - Create SysCAD.93.db3]]<br />
<br />
:NOTES:<br />
:*If the species data does not exist in the reference SysCAD databases, then a place holder species with <b> no thermodynamic or physical properties data </b> will be used. When this happens, any project using this database will log appropriate warnings on load, look out for these species when [[#Checking the Created SysCAD.93.db3|Checking the Created SysCAD.93.db3]] <br />
:*:In the above screenshot, we have 62 solid species using default (placeholder) data. In other words, 62 solid species have no thermodynamic data or physical properties data, and will use SysCAD default values when used in a project.<br />
:*While running the utility, if you have NOT selected a preferred database (i.e. used -1 as selection) and multiple data is found for a species, you will be prompted to select one of the options:<br />
:*:[[Image:Select_Species_PHREEQC.png]]<br />
:*:In the above example, the utility has found 2 sets of data for “NaCl” in the available databases, we have selected data set 2 by typing in the "2".<br />
:*:If a Cp range was specified using MIN_TEMP_CP and MAX_TEMP_CP, the utility may be able to select from multiple databases based upon maximum Cp range coverage. In this case, the prompt above would not be shown.<br />
:*User can use <Ctrl+Z> to quit the utility at any time.<br />
<br />
=== Checking the Created SysCAD.93.db3 ===<br />
<br />
Check the SysCAD.93.db3 file before copying it to your actual project's cfgfile folder. You can use any SQLite DB reader, such as [https://sqlitebrowser.org/ DB Browser for SQLite]. View the ''SpeciesData'' table to see the data. Species for which no data was found in the reference databases will appear as having each of the definition columns filled, but all of the property columns blank.<br />
<br />
[[Image:PlaceholderSpecies DBBrowser.png|1200px]]<br />
<br />
In the above example, NaCl*2H2O is using placeholder data.<br />
<br />
== Copy the files to the CfgFiles folder ==<br />
<br />
Generally speaking, user only need to use this Utility to generate the SysCAD.93.db3 file at the start of a new PHREEQC project group. Once the database has been created, the '''SysCAD.93.db3''' file, as well as the associated PHREEQC database files used to generate them, should be copied to the PHREEQC SysCAD project group\CfgFiles sub-folder. For SysCAD with PHREEQC flowsheets using multiple PHREEQC database files, it is required to create the database using all of the PHREEQC database files at the same time when using this utility. <br />
<br />
== Troubleshooting ==<br />
<br />
{| class="wikitable"<br />
|-<br />
! Error !! Description !! Possible cause / suggested solution.<br />
|-<br />
| rowspan=3|Utility Startup Errors || Missing SysCAD Template species database (SysCAD.93.db3) || The SysCAD.93.db3 file is missing from the Utility folder. This file is required as a starting point. User may copy any valid SysCAD.93.db3 file from the SysCADxxx folder here. <br />
|-<br />
| No SysCAD reference species database found in folder DB3Files || The "DB3Files" folder is missing or empty. Please check the folder name and or make sure it contains at least one SysCAD database, such as the Default.93.db3<br />
|-<br />
| No Model files found in folder DatabaseFiles || The "DatabaseFiles" folder is missing or empty. Please check the folder name and or make sure it contains at least one PHREEQC database file with extension .DAT.<br />
|-<br />
|}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Generate_SysCAD_database_from_OLI_Database_File&diff=78426Generate SysCAD database from OLI Database File2024-02-15T13:02:50Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category: OLI]]<br />
{{BETA}}<br />
{{Navigation | [[Models]] |[[Models#Thermodynamic Calculation Engines|TCE Models]]| [[OLI Overview|OLI]] |altname=Utility}}<br />
{{TPS Utility Header tabs|currentpage=4}}<br />
----<br />
{{TOC}}<br />
== Applicability ==<br />
<br />
This help file is applicable to [[OLI Overview|OLI]].<br />
<br />
'''NOTE:'''<br />
The utility is for adding a list of species into a new SysCAD.93.db3 file. <br />
*It will use data from existing databases (in SysCAD database format), examples of such are Default.93.db3, SysCAD.93.db3 from user projects (these can be renamed for better identification).<br />
*It will NOT extract data from OLI databases.<br />
*It will add species to the new database based on the .dat files selected. It will include species that are listed in the .dat file as well as species that "may" form given the list of ions present.<br />
*If a species is not found in the existing database, it will add the species with minimum data (Long Name, Short Name, compound, definition, phase, occurrence), but will leave all the other properties blank. User will need to check and fill in data from other sources after the database is created.<br />
<br />
== General Information ==<br />
<br />
Utility file name: '''<big>SysCADOLIUtils.exe</big>'''<br />
<br />
*This utility can be used to create a species database using data from OLI dbs file (database file).<br />
<br />
*The utility can be placed in any folder, but the folder must meet the following requirements:[[File:OLIFolderStructure.png|frame|OLI Utility Folder Structure]]<br />
*#There must be an existing '''SysCAD.93.db3''' file inside the folder to serve as a template (for species table layout). <br />
*#*CAUTION: depending on user selections, this file may be stripped down to contain only water and steam, then new data will be added based on the OLI model species list. Stripping of the file is optional.<br />
*#*Please use a “copy” of the actual SysCAD.93.db3 file to avoid destroying user data.<br />
*#There must be a subfolder, “'''DB3Files'''”, containing the following files: <br />
*#*May contain the '''Default.93.DB3''' file (copy from '''SysCADxxx\BaseFiles''' folder). <br />
*#*May contain user’s own database files, formatted in SysCAD DB file format. <br />
*#*Any database files stored in the DB3Files subfolder will be used to populate the SysCAD.93.DB3 file.<br />
*#*when more than one database is present, there may be multiple entries for the same species, if a species has multiple sets of data, user must choose which set of data to add to the SysCAD.93.DB3 file.<br />
*#*as an alternative to the above, user can specify a preferred database. In this case, the preferred database will be used whenever possible, with alternate databases used elsewhere and placeholder species created where no data is available. Selecting a preferred database will avoid choosing data for each case where multiple options are available.<br />
*#*The databases in this folder will be used to build a list of options presented to the user by the utility.<br />
*#There must be a subfolder, “'''DatabaseFiles'''”: <br />
*#*Users must place copies of each dbs file that they wish to include in the generation of the SysCAD database file. <br />
*#*There is an option to select one or all of the contained dbs files in the generation of the database.<br />
{{Error_And_Message_Logs_Utility}}<br />
*#''IonList.txt'', the ion list can be created by the utility, see item "Config.txt" below.<br />
*#:[[File:TPS_IonList_AqSol.png]]<br />
*#<b>Optional:</b> User can place a ''Replacements.txt'' file in the same folder as the executable. This is a tab-delimited file that contains replacement strings. If not found, it is simply not used.<br />
*#:<b>''Replacements.txt''</b> <br>[[File:TPS_Replacements_File.png]]<br />
*#*If the above file were used, any OLI species containing the string Ice would be replaced with H2O in the creation of SysCAD species.<br />
*#<b>Optional:</b> User can place a ''Config.txt'' file in the same folder as the executable. This is a formatted file that contains configuration settings. If not found, it is simply not used.<br />
{{TPS_Utility_Config|IncludeIonList=true}}<br />
<br />
== How to use the utility ==<br />
<br />
The utility has two functions:<br />
# assisting with the creation of IonList.txt. <br />
# creating the SysCAD.93.db3 file. <br />
<br />
===Creating the database === <br />
<br />
#Run '''SysCADOLIUtils.exe'''<br />
#The utility will ask for selection of a preferred database (.db3). Select the corresponding preferred database, or -1 if none is preferred. If -1 is selected, the user will manually select the data for each species where more than one option exists (see later step). <br />
#Select the .dbs file for which you wish to create a database. Select -1 to create files which incorporate all of the dbs files in the DatabaseFiles folder.<br />
#Where a suitable species does not exist in the available SysCAD database source files, a placeholder species will be created with NO thermodynamic data.<br />
#Upon completion, the utility will show a summary, confirming the database was created successfully. Press any key to close the utility.<br />
#:[[Image:OLIUtil1.png|OLI Utility - Create SysCAD.93.db3]]<br />
<br />
:NOTES:<br />
:*If the species data does not exist in the reference SysCAD databases, then a place holder species with <b> no thermodynamic or physical properties data </b> will be used. When this happens, any project using this database will log appropriate warnings on load, look out for these species when [[#Checking the Created SysCAD.93.db3|Checking the Created SysCAD.93.db3]] <br />
:*:In the above screenshot, we have 1 species using default (placeholder) data. In other words, 1 species have no thermodynamic data or physical properties data, and will use SysCAD default values when used in a project.<br />
:*While running the utility, if you have NOT selected a preferred database (i.e. used -1 as selection) and multiple data is found for a species, you will be prompted to select one of the options:<br />
:*:[[Image:Select_Species_OLI.png]]<br />
:*:In the above example, the utility has found 2 sets of data for “NaCl” in the available databases, we have selected data set 2 by typing in the "2".<br />
:*:If a Cp range was specified using MIN_TEMP_CP and MAX_TEMP_CP, the utility may be able to select from multiple databases based upon maximum Cp range coverage. In this case, the prompt above would not be shown.<br />
:*User can use <Ctrl+Z> to quit the utility at any time.<br />
<br />
=== Checking the Created SysCAD.93.db3 ===<br />
<br />
Check the SysCAD.93.db3 file before copying it to your actual project's cfgfile folder. You can use any SQLite DB reader, such as [https://sqlitebrowser.org/ DB Browser for SQLite]. View the ''SpeciesData'' table to see the data. Species for which no data was found in the reference databases will appear as having each of the definition columns filled, but all of the property columns blank.<br />
<br />
[[Image:PlaceholderSpecies DBBrowser.png|1200px]]<br />
<br />
In the above example, NaCl*2H2O is using placeholder data.<br />
<br />
== Copy the files to the CfgFiles folder ==<br />
<br />
Generally speaking, user only need to use this Utility to generate the SysCAD.93.db3 file at the start of a new OLI project group. Once the database has been created, the '''SysCAD.93.db3''' file, as well as the associated OLI database files used to generate them, should be copied to the OLI SysCAD project group\CfgFiles sub-folder. For SysCAD with OLI flowsheets using multiple OLI database files, it is required to create the database using all of the OLI database files at the same time when using this utility. <br />
<br />
== Troubleshooting ==<br />
<br />
{| class="wikitable"<br />
|-<br />
! Error !! Description !! Possible cause / suggested solution.<br />
|-<br />
| rowspan=3|Utility Startup Errors || Missing SysCAD Template species database (SysCAD.93.db3) || The SysCAD.93.db3 file is missing from the Utility folder. This file is required as a starting point. User may copy any valid SysCAD.93.db3 file from the SysCADxxx folder here. <br />
|-<br />
| No SysCAD reference species database found in folder DB3Files || The "DB3Files" folder is missing or empty. Please check the folder name and or make sure it contains at least one SysCAD database, such as the Default.93.db3<br />
|-<br />
| No Model files found in folder DatabaseFiles || The "DatabaseFiles" folder is missing or empty. Please check the folder name and or make sure it contains at least one OLI database file with extension .DAT.<br />
|-<br />
|}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Generate_SysCAD_database_from_AQSol_Configuration_File&diff=78425Generate SysCAD database from AQSol Configuration File2024-02-15T13:02:21Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category: AQSol]]<br />
{{BETA}}<br />
{{Navigation | [[Models]] |[[Models#Thermodynamic Calculation Engines|TCE Models]]| [[AQSol Overview|AQSol]]|altname=Utility}}<br />
{{TPS Utility Header tabs|currentpage=1}}<br />
----<br />
{{TOC}}<br />
== Applicability ==<br />
<br />
This help file is applicable to [[AQSol Overview|AQSol]].<br />
<br />
'''NOTE:'''<br />
The utility is for adding a list of species into a new SysCAD.93.db3 file. <br />
*It will use data from existing databases (in SysCAD database format), examples of such are Default.93.db3, SysCAD.93.db3 from user projects (these can be renamed for better identification).<br />
*It will NOT extract data from AQSol databases.<br />
*It will add species to the new database based on the .dll files selected. It will include species that "may" form given the list of ions present.<br />
*If a species is not found in the existing database, it will add the species with minimum data (Long Name, Short Name, compound, definition, phase, occurrence), but will leave all the other properties blank. User will need to check and fill in data from other sources after the database is created.<br />
<br />
== General Information ==<br />
<br />
Utility file name: '''<big>SysCADAQSolUtils.exe</big>'''<br />
<br />
*This utility can be used to create a species database using data from the AQSol dll file(s). Users must install AQSol using the standard c:\Program Files (x86)\AQSolXXX\ location for install. <br />
<br />
*The utility can be placed in any folder, but the folder must meet the following requirements:[[File:AqSolFolderStructure.png|frame|AQSol Utility Folder Structure]]<br />
*#There must be an existing '''SysCAD.93.db3''' file inside the folder to serve as a template (for species table layout). <br />
*#*CAUTION: depending on user selections, this file may be stripped down to contain only water and steam, then new data will be added based on the AQSol model species list. Stripping of the file is optional.<br />
*#*Please use a “copy” of the actual SysCAD.93.db3 file to avoid destroying user data.<br />
*#There must be a subfolder, “'''DB3Files'''”, containing the following files: <br />
*#*May contain the '''Default.93.DB3''' file (copy from '''SysCADxxx\BaseFiles''' folder). <br />
*#*May contain user’s own database files, formatted in SysCAD DB file format. <br />
*#*Any database files stored in the DB3Files subfolder will be used to populate the SysCAD.93.DB3 file.<br />
*#*when more than one database is present, there may be multiple entries for the same species, if a species has multiple sets of data, user must choose which set of data to add to the SysCAD.93.DB3 file.<br />
*#*as an alternative to the above, user can specify a preferred database. In this case, the preferred database will be used whenever possible, with alternate databases used elsewhere and placeholder species created where no data is available. Selecting a preferred database will avoid choosing data for each case where multiple options are available.<br />
*#*The databases in this folder will be used to build a list of options presented to the user by the utility.<br />
*#There must be at least one version of AQSol installed: <br />
*#*Users must install AQSol using the standard c:\Program Files (x86)\AQSolXXX\ location for install.<br />
*#*There is an option to select one or all of the installed versions of AQSol in the generation of the database.<br />
{{Error_And_Message_Logs_Utility}}<br />
*#''IonList.txt'', the ion list can be created by the utility, see item "Config.txt" below.<br />
*#:[[File:TPS_IonList_AqSol.png]]<br />
*#<b>Optional:</b> User can place a ''Replacements.txt'' file in the same folder as the executable. This is a tab-delimited file that contains replacement strings. If not found, it is simply not used.<br />
*#:<b>''Replacements.txt''</b> <br>[[File:TPS_Replacements_File.png]]<br />
*#*If the above file were used, any AQSol species containing the string Ice would be replaced with H2O in the creation of SysCAD species.<br />
*#<b>Optional:</b> User can place a ''Config.txt'' file in the same folder as the executable. This is a formatted file that contains configuration settings. If not found, it is simply not used.<br />
{{TPS_Utility_Config|IncludeIonList=true|IncludeParentFolder=true}}<br />
<br />
== How to use the utility ==<br />
<br />
The utility has two functions:<br />
# assisting with the creation of IonList.txt. <br />
<!--# assisting with the creation of IPhaseMap.txt. This file must be completed before user can move on to the next step.--><br />
# creating the SysCAD.93.db3 file. <br />
<br />
===Creating the database === <br />
<br />
#Run '''SysCADAQSolUtils.exe''' <br />
#The utility will ask for selection of a preferred database. Select the corresponding preferred database, or -1 if none is preferred. If -1 is selected, the user will manually select the data for each species where more than one option exists (see later step).<br />
#Select the dll file for which you wish to create a database. Select -1 to create files which incorporate all of the dll files in the AQSol installation folder.<br />
#Where a suitable species does not exist in the available SysCAD database source files, a placeholder species will be created with NO thermodynamic data.<br />
#Upon completion, the utility will show a summary, confirming the database was created successfully. Press any key to close the utility.<br />
#:[[Image:AQSolUtil1.png|AQSol Utility - Create SysCAD.93.db3]]<br />
<br />
:NOTES:<br />
:*If the species data does not exist in the reference SysCAD databases, then a place holder species with <b> no thermodynamic or physical properties data </b> will be used. When this happens, any project using this database will log appropriate warnings on load, look out for these species when [[#Checking the Created SysCAD.93.db3|Checking the Created SysCAD.93.db3]] <br />
:*:In the above screenshot, we have 11 species using default (placeholder) data. In other words, 11 solid species have no thermodynamic data or physical properties data, and will use SysCAD default values when used in a project.<br />
:*While running the utility, if you have NOT selected a preferred database (i.e. used -1 as selection) and multiple data is found for a species, you will be prompted to select one of the options:<br />
:*:[[Image:Select_Species_PHREEQC-AQSol.png]]<br />
:*:In the above example, the utility has found 2 sets of data for “NaCl” in the available databases, we have selected data set 2 by typing in the "2". <br />
:*:If a Cp range was specified using MIN_TEMP_CP and MAX_TEMP_CP, the utility may be able to select from multiple databases based upon maximum Cp range coverage. In this case, the prompt above would not be shown.<br />
:*User can use <Ctrl+Z> to quit the utility at any time.<br />
<br />
=== Checking the Created SysCAD.93.db3 ===<br />
<br />
Check the SysCAD.93.db3 file before copying it to your actual project's cfgfile folder. You can use any SQLite DB reader, such as [https://sqlitebrowser.org/ DB Browser for SQLite]. View the ''SpeciesData'' table to see the data. Species for which no data was found in the reference databases will appear as having each of the definition columns filled, but all of the property columns blank.<br />
<br />
[[Image:PlaceholderSpecies DBBrowser.png|1200px]]<br />
<br />
In the above example, NaCl*2H2O is using placeholder data.<br />
<br />
== Copy the files to the CfgFiles folder ==<br />
<br />
Generally speaking, user only need to use this Utility to generate the SysCAD.93.db3 file at the start of a new AQSol project group. Once the database has been created, the '''SysCAD.93.db3''' file, as well as the associated AQSol Configuration file used to generate them, should be copied to the AQSol SysCAD project group\CfgFiles sub-folder. Note that SysCAD interface does not currently support more than one AQSol configuration file.<br />
<br />
== Troubleshooting ==<br />
<br />
{| class="wikitable"<br />
|-<br />
! Error !! Description !! Possible cause / suggested solution.<br />
|-<br />
| rowspan=4|Utility Startup Errors || Missing SysCAD Template species database (SysCAD.93.db3) || The SysCAD.93.db3 file is missing from the Utility folder. This file is required as a starting point. User may copy any valid SysCAD.93.db3 file from the SysCADxxx folder here. <br />
|-<br />
| No SysCAD reference species database found in folder DB3Files || The "DB3Files" folder is missing or empty. Please check the folder name and or make sure it contains at least one SysCAD database, such as the Default.93.db3<br />
|-<br />
| No DLLs found in specified folder where AQSol DLLs are installed || Ensure that the appropriate version of AQSol is installed and ensure that AQSOL_INSTALL_PARENT_FOLDER is specified correctly in the Config.txt file.<br />
|-<br />
| Parent folder not specified for finding AQSol DLLs || Ensure that AQSOL_INSTALL_PARENT_FOLDER is specified in the Config.txt file.<br />
|-<br />
|}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Generate_SysCAD_database_from_AQSol_Configuration_File&diff=78424Generate SysCAD database from AQSol Configuration File2024-02-15T12:58:13Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category: AQSol]]<br />
{{BETA}}<br />
{{Navigation | [[Models]] |[[Models#Thermodynamic Calculation Engines|TCE Models]]| [[AQSol Overview|AQSol]]|altname=Utility}}<br />
{{TPS Utility Header tabs|currentpage=1}}<br />
----<br />
{{TOC}}<br />
== Applicability ==<br />
<br />
This help file is applicable to [[AQSol Overview|AQSol]].<br />
<br />
'''NOTE:'''<br />
The utility is for adding a list of species into a new SysCAD.93.db3 file. <br />
*It will use data from existing databases (in SysCAD database format), examples of such are Default.93.db3, SysCAD.93.db3 from user projects (these can be renamed for better identification).<br />
*It will NOT extract data from AQSol databases.<br />
*It will add species to the new database based on the .dll files selected. It will include species that "may" form given the list of ions present.<br />
*If a species is not found in the existing database, it will add the species with minimum data (Long Name, Short Name, compound, definition, phase, occurrence), but will leave all the other properties blank. User will need to check and fill in data from other sources after the database is created.<br />
<br />
== General Information ==<br />
<br />
Utility file name: '''<big>SysCADAQSolUtils.exe</big>'''<br />
<br />
*This utility can be used to create a species database using data from the AQSol dll file(s). Users must install AQSol using the standard c:\Program Files (x86)\AQSolXXX\ location for install. <br />
<br />
*The utility can be placed in any folder, but the folder must meet the following requirements:[[File:AqSolFolderStructure.png|frame|AQSol Utility Folder Structure]]<br />
*#There must be an existing '''SysCAD.93.db3''' file inside the folder to serve as a template (for species table layout). <br />
*#*CAUTION: depending on user selections, this file may be stripped down to contain only water and steam, then new data will be added based on the AQSol model species list. Stripping of the file is optional.<br />
*#*Please use a “copy” of the actual SysCAD.93.db3 file to avoid destroying user data.<br />
*#There must be a subfolder, “'''DB3Files'''”, containing the following files: <br />
*#*May contain the '''Default.93.DB3''' file (copy from '''SysCADxxx\BaseFiles''' folder). <br />
*#*May contain user’s own database files, formatted in SysCAD DB file format. <br />
*#*Any database files stored in the DB3Files subfolder will be used to populate the SysCAD.93.DB3 file.<br />
*#*when more than one database is present, there may be multiple entries for the same species, if a species has multiple sets of data, user must choose which set of data to add to the SysCAD.93.DB3 file.<br />
*#*as an alternative to the above, user can specify a preferred database. In this case, the preferred database will be used whenever possible, with alternate databases used elsewhere and placeholder species created where no data is available. Selecting a preferred database will avoid choosing data for each case where multiple options are available.<br />
*#*The databases in this folder will be used to build a list of options presented to the user by the utility.<br />
*#There must be at least one version of AQSol installed: <br />
*#*Users must install AQSol using the standard c:\Program Files (x86)\AQSolXXX\ location for install.<br />
*#*There is an option to select one or all of the installed versions of AQSol in the generation of the database.<br />
{{Error_And_Message_Logs_Utility}}<br />
*#''IonList.txt'', the ion list can be created by the utility, see item "Config.txt" below.<br />
*#:[[File:TPS_IonList_AqSol.png]]<br />
*#<b>Optional:</b> User can place a ''Replacements.txt'' file in the same folder as the executable. This is a tab-delimited file that contains replacement strings. If not found, it is simply not used.<br />
*#:<b>''Replacements.txt''</b> <br>[[File:TPS_Replacements_File.png]]<br />
*#*If the above file were used, any AQSol species containing the string Ice would be replaced with H2O in the creation of SysCAD species.<br />
*#<b>Optional:</b> User can place a ''Config.txt'' file in the same folder as the executable. This is a formatted file that contains configuration settings. If not found, it is simply not used.<br />
{{TPS_Utility_Config|IncludeIonList=true|IncludeParentFolder=true}}<br />
<br />
== How to use the utility ==<br />
<br />
The utility has two functions:<br />
# assisting with the creation of IonList.txt. <br />
<!--# assisting with the creation of IPhaseMap.txt. This file must be completed before user can move on to the next step.--><br />
# creating the SysCAD.93.db3 file. <br />
<br />
===Creating the database === <br />
<br />
#Run '''SysCADAQSolUtils.exe''' <br />
#The utility will ask for selection of a preferred database. Select the corresponding preferred database, or -1 if none is preferred. If -1 is selected, the user will manually select the data for each species where more than one option exists (see later step).<br />
#Select the dll file for which you wish to create a database. Select -1 to create files which incorporate all of the dll files in the AQSol installation folder.<br />
#Where a suitable species does not exist in the available SysCAD database source files, a placeholder species will be created with NO thermodynamic data.<br />
#Upon completion, the utility will show a summary, confirming the database was created successfully. Press any key to close the utility.<br />
#:[[Image:AQSolUtil1.png|AQSol Utility - Create SysCAD.93.db3]]<br />
<br />
:NOTES:<br />
:*If the species data does not exist in the reference SysCAD databases, then a place holder species with <b> no thermodynamic or physical properties data </b> will be used. When this happens, any project using this database will log appropriate warnings on load, look out for these species when [[#Checking the Created SysCAD.93.db3|Checking the Created SysCAD.93.db3]] <br />
:*:In the above screenshot, we have 11 species using default (placeholder) data. In other words, 11 solid species have no thermodynamic data or physical properties data, and will use SysCAD default values when used in a project.<br />
:*While running the utility, if you have NOT selected a preferred database (i.e. used -1 as selection) and multiple data is found for a species, you will be prompted to select one of the options:<br />
:*:[[Image:Select_Species_PHREEQC-AQSol.png]]<br />
:*:In the above example, the utility has found 2 sets of data for “NaCl” in the available databases, we have selected data set 2 by typing in the "2". <br />
:*User can use <Ctrl+Z> to quit the utility at any time.<br />
<br />
=== Checking the Created SysCAD.93.db3 ===<br />
<br />
Check the SysCAD.93.db3 file before copying it to your actual project's cfgfile folder. You can use any SQLite DB reader, such as [https://sqlitebrowser.org/ DB Browser for SQLite]. View the ''SpeciesData'' table to see the data. Species for which no data was found in the reference databases will appear as having each of the definition columns filled, but all of the property columns blank.<br />
<br />
[[Image:PlaceholderSpecies DBBrowser.png|1200px]]<br />
<br />
In the above example, NaCl*2H2O is using placeholder data.<br />
<br />
== Copy the files to the CfgFiles folder ==<br />
<br />
Generally speaking, user only need to use this Utility to generate the SysCAD.93.db3 file at the start of a new AQSol project group. Once the database has been created, the '''SysCAD.93.db3''' file, as well as the associated AQSol Configuration file used to generate them, should be copied to the AQSol SysCAD project group\CfgFiles sub-folder. Note that SysCAD interface does not currently support more than one AQSol configuration file.<br />
<br />
== Troubleshooting ==<br />
<br />
{| class="wikitable"<br />
|-<br />
! Error !! Description !! Possible cause / suggested solution.<br />
|-<br />
| rowspan=4|Utility Startup Errors || Missing SysCAD Template species database (SysCAD.93.db3) || The SysCAD.93.db3 file is missing from the Utility folder. This file is required as a starting point. User may copy any valid SysCAD.93.db3 file from the SysCADxxx folder here. <br />
|-<br />
| No SysCAD reference species database found in folder DB3Files || The "DB3Files" folder is missing or empty. Please check the folder name and or make sure it contains at least one SysCAD database, such as the Default.93.db3<br />
|-<br />
| No DLLs found in specified folder where AQSol DLLs are installed || Ensure that the appropriate version of AQSol is installed and ensure that AQSOL_INSTALL_PARENT_FOLDER is specified correctly in the Config.txt file.<br />
|-<br />
| Parent folder not specified for finding AQSol DLLs || Ensure that AQSOL_INSTALL_PARENT_FOLDER is specified in the Config.txt file.<br />
|-<br />
|}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Generate_SysCAD_database_from_OLI_Database_File&diff=78423Generate SysCAD database from OLI Database File2024-02-15T12:57:26Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category: OLI]]<br />
{{BETA}}<br />
{{Navigation | [[Models]] |[[Models#Thermodynamic Calculation Engines|TCE Models]]| [[OLI Overview|OLI]] |altname=Utility}}<br />
{{TPS Utility Header tabs|currentpage=4}}<br />
----<br />
{{TOC}}<br />
== Applicability ==<br />
<br />
This help file is applicable to [[OLI Overview|OLI]].<br />
<br />
'''NOTE:'''<br />
The utility is for adding a list of species into a new SysCAD.93.db3 file. <br />
*It will use data from existing databases (in SysCAD database format), examples of such are Default.93.db3, SysCAD.93.db3 from user projects (these can be renamed for better identification).<br />
*It will NOT extract data from OLI databases.<br />
*It will add species to the new database based on the .dat files selected. It will include species that are listed in the .dat file as well as species that "may" form given the list of ions present.<br />
*If a species is not found in the existing database, it will add the species with minimum data (Long Name, Short Name, compound, definition, phase, occurrence), but will leave all the other properties blank. User will need to check and fill in data from other sources after the database is created.<br />
<br />
== General Information ==<br />
<br />
Utility file name: '''<big>SysCADOLIUtils.exe</big>'''<br />
<br />
*This utility can be used to create a species database using data from OLI dbs file (database file).<br />
<br />
*The utility can be placed in any folder, but the folder must meet the following requirements:[[File:OLIFolderStructure.png|frame|OLI Utility Folder Structure]]<br />
*#There must be an existing '''SysCAD.93.db3''' file inside the folder to serve as a template (for species table layout). <br />
*#*CAUTION: depending on user selections, this file may be stripped down to contain only water and steam, then new data will be added based on the OLI model species list. Stripping of the file is optional.<br />
*#*Please use a “copy” of the actual SysCAD.93.db3 file to avoid destroying user data.<br />
*#There must be a subfolder, “'''DB3Files'''”, containing the following files: <br />
*#*May contain the '''Default.93.DB3''' file (copy from '''SysCADxxx\BaseFiles''' folder). <br />
*#*May contain user’s own database files, formatted in SysCAD DB file format. <br />
*#*Any database files stored in the DB3Files subfolder will be used to populate the SysCAD.93.DB3 file.<br />
*#*when more than one database is present, there may be multiple entries for the same species, if a species has multiple sets of data, user must choose which set of data to add to the SysCAD.93.DB3 file.<br />
*#*as an alternative to the above, user can specify a preferred database. In this case, the preferred database will be used whenever possible, with alternate databases used elsewhere and placeholder species created where no data is available. Selecting a preferred database will avoid choosing data for each case where multiple options are available.<br />
*#*The databases in this folder will be used to build a list of options presented to the user by the utility.<br />
*#There must be a subfolder, “'''DatabaseFiles'''”: <br />
*#*Users must place copies of each dbs file that they wish to include in the generation of the SysCAD database file. <br />
*#*There is an option to select one or all of the contained dbs files in the generation of the database.<br />
{{Error_And_Message_Logs_Utility}}<br />
*#''IonList.txt'', the ion list can be created by the utility, see item "Config.txt" below.<br />
*#:[[File:TPS_IonList_AqSol.png]]<br />
*#<b>Optional:</b> User can place a ''Replacements.txt'' file in the same folder as the executable. This is a tab-delimited file that contains replacement strings. If not found, it is simply not used.<br />
*#:<b>''Replacements.txt''</b> <br>[[File:TPS_Replacements_File.png]]<br />
*#*If the above file were used, any OLI species containing the string Ice would be replaced with H2O in the creation of SysCAD species.<br />
*#<b>Optional:</b> User can place a ''Config.txt'' file in the same folder as the executable. This is a formatted file that contains configuration settings. If not found, it is simply not used.<br />
{{TPS_Utility_Config|IncludeIonList=true}}<br />
<br />
== How to use the utility ==<br />
<br />
The utility has two functions:<br />
# assisting with the creation of IonList.txt. <br />
# creating the SysCAD.93.db3 file. <br />
<br />
===Creating the database === <br />
<br />
#Run '''SysCADOLIUtils.exe'''<br />
#The utility will ask for selection of a preferred database (.db3). Select the corresponding preferred database, or -1 if none is preferred. If -1 is selected, the user will manually select the data for each species where more than one option exists (see later step). <br />
#Select the .dbs file for which you wish to create a database. Select -1 to create files which incorporate all of the dbs files in the DatabaseFiles folder.<br />
#Where a suitable species does not exist in the available SysCAD database source files, a placeholder species will be created with NO thermodynamic data.<br />
#Upon completion, the utility will show a summary, confirming the database was created successfully. Press any key to close the utility.<br />
#:[[Image:OLIUtil1.png|OLI Utility - Create SysCAD.93.db3]]<br />
<br />
:NOTES:<br />
:*If the species data does not exist in the reference SysCAD databases, then a place holder species with <b> no thermodynamic or physical properties data </b> will be used. When this happens, any project using this database will log appropriate warnings on load, look out for these species when [[#Checking the Created SysCAD.93.db3|Checking the Created SysCAD.93.db3]] <br />
:*:In the above screenshot, we have 1 species using default (placeholder) data. In other words, 1 species have no thermodynamic data or physical properties data, and will use SysCAD default values when used in a project.<br />
:*While running the utility, if you have NOT selected a preferred database (i.e. used -1 as selection) and multiple data is found for a species, you will be prompted to select one of the options:<br />
:*:[[Image:Select_Species_OLI.png]]<br />
:*:In the above example, the utility has found 2 sets of data for “NaCl” in the available databases, we have selected data set 2 by typing in the "2".<br />
:*User can use <Ctrl+Z> to quit the utility at any time.<br />
<br />
=== Checking the Created SysCAD.93.db3 ===<br />
<br />
Check the SysCAD.93.db3 file before copying it to your actual project's cfgfile folder. You can use any SQLite DB reader, such as [https://sqlitebrowser.org/ DB Browser for SQLite]. View the ''SpeciesData'' table to see the data. Species for which no data was found in the reference databases will appear as having each of the definition columns filled, but all of the property columns blank.<br />
<br />
[[Image:PlaceholderSpecies DBBrowser.png|1200px]]<br />
<br />
In the above example, NaCl*2H2O is using placeholder data.<br />
<br />
== Copy the files to the CfgFiles folder ==<br />
<br />
Generally speaking, user only need to use this Utility to generate the SysCAD.93.db3 file at the start of a new OLI project group. Once the database has been created, the '''SysCAD.93.db3''' file, as well as the associated OLI database files used to generate them, should be copied to the OLI SysCAD project group\CfgFiles sub-folder. For SysCAD with OLI flowsheets using multiple OLI database files, it is required to create the database using all of the OLI database files at the same time when using this utility. <br />
<br />
== Troubleshooting ==<br />
<br />
{| class="wikitable"<br />
|-<br />
! Error !! Description !! Possible cause / suggested solution.<br />
|-<br />
| rowspan=3|Utility Startup Errors || Missing SysCAD Template species database (SysCAD.93.db3) || The SysCAD.93.db3 file is missing from the Utility folder. This file is required as a starting point. User may copy any valid SysCAD.93.db3 file from the SysCADxxx folder here. <br />
|-<br />
| No SysCAD reference species database found in folder DB3Files || The "DB3Files" folder is missing or empty. Please check the folder name and or make sure it contains at least one SysCAD database, such as the Default.93.db3<br />
|-<br />
| No Model files found in folder DatabaseFiles || The "DatabaseFiles" folder is missing or empty. Please check the folder name and or make sure it contains at least one OLI database file with extension .DAT.<br />
|-<br />
|}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=Generate_SysCAD_database_from_PHREEQC_Database_File&diff=78422Generate SysCAD database from PHREEQC Database File2024-02-15T12:53:26Z<p>Kevin.Heppner: </p>
<hr />
<div>[[Category: PHREEQC]]<br />
{{BETA}}<br />
{{Navigation | [[Models]] |[[Models#Thermodynamic Calculation Engines|TCE Models]]| [[PHREEQC Overview|PHREEQC]] |altname=Utility}}<br />
{{TPS Utility Header tabs|currentpage=3}}<br />
----<br />
{{TOC}}<br />
== Applicability ==<br />
<br />
This help file is applicable to [[PHREEQC Overview|PHREEQC]].<br />
<br />
'''NOTE:'''<br />
The utility is for adding a list of species into a new SysCAD.93.db3 file. <br />
*It will use data from existing databases (in SysCAD database format), examples of such are Default.93.db3, SysCAD.93.db3 from user projects (these can be renamed for better identification).<br />
*It will NOT extract data from PHREEQC databases.<br />
*It will add species to the new database based on the .dat files selected. It will include species that are listed in the .dat file as well as species that "may" form given the list of ions present.<br />
*If a species is not found in the existing database, it will add the species with minimum data (Long Name, Short Name, compound, definition, phase, occurrence), but will leave all the other properties blank. User will need to check and fill in data from other sources after the database is created.<br />
<br />
== General Information ==<br />
<br />
Utility file name: '''<big>SysCADPHREEQCUtils.exe</big>'''<br />
<br />
*This utility can be used to create a species database using data from PHREEQC DAT file (database file). PHREEQC software and database files are available online for download at: https://www.usgs.gov/software/phreeqc-version-3<br />
<br />
*The utility can be placed in any folder, but the folder must meet the following requirements:[[File:PhreeqcFolderStructure.png|frame|PHREEQC Utility Folder Structure]]<br />
*#There must be an existing '''SysCAD.93.db3''' file inside the folder to serve as a template (for species table layout). <br />
*#*CAUTION: depending on user selections, this file may be stripped down to contain only water and steam, then new data will be added based on the PHREEQC model species list. Stripping of the file is optional.<br />
*#*Please use a “copy” of the actual SysCAD.93.db3 file to avoid destroying user data.<br />
*#There must be a subfolder, “'''DB3Files'''”, containing the following files: <br />
*#*May contain the '''Default.93.DB3''' file (copy from '''SysCADxxx\BaseFiles''' folder). <br />
*#*May contain user’s own database files, formatted in SysCAD DB file format. <br />
*#*Any database files stored in the DB3Files subfolder will be used to populate the SysCAD.93.DB3 file.<br />
*#*when more than one database is present, there may be multiple entries for the same species, if a species has multiple sets of data, user must choose which set of data to add to the SysCAD.93.DB3 file.<br />
*#*as an alternative to the above, user can specify a preferred database. In this case, the preferred database will be used whenever possible, with alternate databases used elsewhere and placeholder species created where no data is available. Selecting a preferred database will avoid choosing data for each case where multiple options are available.<br />
*#*The databases in this folder will be used to build a list of options presented to the user by the utility.<br />
*#There must be a subfolder, “'''DatabaseFiles'''”: <br />
*#*Users must place copies of each DAT file that they wish to include in the generation of the SysCAD database file. <br />
*#*There is an option to select one or all of the contained DAT files in the generation of the database.<br />
{{Error_And_Message_Logs_Utility}}<br />
*#''IonList.txt'', the ion list can be created by the utility, see item "Config.txt" below.<br />
*#:[[File:TPS_IonList_AqSol.png]]<br />
*#<b>Optional:</b> User can place a ''Replacements.txt'' file in the same folder as the executable. This is a tab-delimited file that contains replacement strings. If not found, it is simply not used.<br />
*#:<b>''Replacements.txt''</b> <br>[[File:TPS_Replacements_File.png]]<br />
*#*If the above file were used, any PHREEQC species containing the string Ice would be replaced with H2O in the creation of SysCAD species.<br />
*#<b>Optional:</b> User can place a ''Config.txt'' file in the same folder as the executable. This is a formatted file that contains configuration settings. If not found, it is simply not used.<br />
{{TPS_Utility_Config|IncludeIonList=true}}<br />
<br />
== How to use the utility ==<br />
<br />
The utility has two functions:<br />
# assisting with the creation of IonList.txt. <br />
# creating the SysCAD.93.db3 file. <br />
<br />
===Creating the database === <br />
<br />
#Run '''SysCADPHREEQCUtils.exe'''<br />
#The utility will ask for selection of a preferred database. Select the corresponding preferred database, or -1 if none is preferred. If -1 is selected, the user will manually select the data for each species where more than one option exists (see later step).<br />
#Select the DAT file for which you wish to create a database. Select -1 to create files which incorporate all of the DAT files in the DatabaseFiles folder.<br />
#Where a suitable species does not exist in the available SysCAD database source files, a placeholder species will be created with NO thermodynamic data.<br />
#Upon completion, the utility will show a summary, confirming the database was created successfully. Press any key to close the utility.<br />
#:[[Image:PHREEQCUtil1.png|PHREEQC Utility - Create SysCAD.93.db3]]<br />
<br />
:NOTES:<br />
:*If the species data does not exist in the reference SysCAD databases, then a place holder species with <b> no thermodynamic or physical properties data </b> will be used. When this happens, any project using this database will log appropriate warnings on load, look out for these species when [[#Checking the Created SysCAD.93.db3|Checking the Created SysCAD.93.db3]] <br />
:*:In the above screenshot, we have 62 solid species using default (placeholder) data. In other words, 62 solid species have no thermodynamic data or physical properties data, and will use SysCAD default values when used in a project.<br />
:*While running the utility, if you have NOT selected a preferred database (i.e. used -1 as selection) and multiple data is found for a species, you will be prompted to select one of the options:<br />
:*:[[Image:Select_Species_PHREEQC.png]]<br />
:*:In the above example, the utility has found 2 sets of data for “NaCl” in the available databases, we have selected data set 2 by typing in the "2".<br />
:*User can use <Ctrl+Z> to quit the utility at any time.<br />
<br />
=== Checking the Created SysCAD.93.db3 ===<br />
<br />
Check the SysCAD.93.db3 file before copying it to your actual project's cfgfile folder. You can use any SQLite DB reader, such as [https://sqlitebrowser.org/ DB Browser for SQLite]. View the ''SpeciesData'' table to see the data. Species for which no data was found in the reference databases will appear as having each of the definition columns filled, but all of the property columns blank.<br />
<br />
[[Image:PlaceholderSpecies DBBrowser.png|1200px]]<br />
<br />
In the above example, NaCl*2H2O is using placeholder data.<br />
<br />
== Copy the files to the CfgFiles folder ==<br />
<br />
Generally speaking, user only need to use this Utility to generate the SysCAD.93.db3 file at the start of a new PHREEQC project group. Once the database has been created, the '''SysCAD.93.db3''' file, as well as the associated PHREEQC database files used to generate them, should be copied to the PHREEQC SysCAD project group\CfgFiles sub-folder. For SysCAD with PHREEQC flowsheets using multiple PHREEQC database files, it is required to create the database using all of the PHREEQC database files at the same time when using this utility. <br />
<br />
== Troubleshooting ==<br />
<br />
{| class="wikitable"<br />
|-<br />
! Error !! Description !! Possible cause / suggested solution.<br />
|-<br />
| rowspan=3|Utility Startup Errors || Missing SysCAD Template species database (SysCAD.93.db3) || The SysCAD.93.db3 file is missing from the Utility folder. This file is required as a starting point. User may copy any valid SysCAD.93.db3 file from the SysCADxxx folder here. <br />
|-<br />
| No SysCAD reference species database found in folder DB3Files || The "DB3Files" folder is missing or empty. Please check the folder name and or make sure it contains at least one SysCAD database, such as the Default.93.db3<br />
|-<br />
| No Model files found in folder DatabaseFiles || The "DatabaseFiles" folder is missing or empty. Please check the folder name and or make sure it contains at least one PHREEQC database file with extension .DAT.<br />
|-<br />
|}</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=PHREEQC_Overview&diff=78304PHREEQC Overview2024-02-08T22:19:25Z<p>Kevin.Heppner: /* Additional Notes */</p>
<hr />
<div>[[Category: PHREEQC]]<br />
{{Navigation | [[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{PHREEQC Header Tabs | currentpage = 1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from PHREEQC Database File]], [[Example_-_05_PHREEQC_Projects|PHREEQC Example Projects]]<br />
----<br />
{{TPS General Notes|PHREEQC }} <br />
{{TOC}}<br />
== Overview ==<br />
<br />
PHREEQC is a computer program that is designed to perform a wide variety of aqueous geochemical calculations. <br />
*It is developed and maintained by the United States Geological Survey. (refer to [https://www.usgs.gov/software/phreeqc-version-3 www.usgs.gov/software/phreeqc-version-3] for further information)<br />
*It is assumed that the user has some familiarity with the theory and use of the PHREEQC program. Installation of the PHREEQC software is not required, however, it may be useful. See [[#Additional Notes|Additional Notes]]. <br />
*This SysCAD TCE library option (in ScdPHREEQC.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons. For Build 139 from August 2022, a TCE add-on is required instead of a separate individual PHRREQC License add-on.<br />
*PHREEQC is used in a flexible way in Unit or Control models at appropriate locations in a plant model. It is not implemented as a Species Properties Model.<br />
*Selection of appropriate databases and data is the responsibility of the user. It is important to understand the limitations of databases supplied via PHREEQC download and other sources (THEREDA, THERMODDEN, etc.). A good review of selected databases has been conducted by Lu et al., 2022 [https://par.nsf.gov/servlets/purl/10321300].<br />
<br />
==Models ==<br />
<br />
PHREEQC unit models:<br />
* [[PHREEQC Model Configuration]] - Used to define and view various options for the selected PHREEQC database, including management of mapping of SysCAD species list to species list used in PHREEQC.<br />
* [[PHREEQC Direct Calc Model]] - Stand alone unit model to perform side calculations using PHREEQC for predicting aqueous chemistry equilibrium conditions and properties including pH on a user defined PHREEQC stream.<br />
* [[PHREEQC Side Calc Model]] - Stand alone unit model to perform side calculations using PHREEQC for predicting aqueous chemistry equilibrium conditions and properties including pH on a SysCAD stream in the current project.<br />
* [[PHREEQC Reactor]] - Include this model in a SysCAD stream to use PHREEQC to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
<br />
The following unit models are available in build 139 and later:<br />
* [[PHREEQC Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded PHREEQC calculations.<br />
* [[PHREEQC Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded PHREEQC calculations.<br />
* [[PHREEQC Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded PHREEQC calculations. PHREEQC can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[PHREEQC Solvent Extraction|PHREEQC Solvent Extraction (Mixer Settler)]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded PHREEQC calculations.<br />
<br />
The following unit model is available in build 139.30807 or later:<br />
* [[PHREEQC Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using PHREEQC species.<br />
<br />
Species Mapping:<br />
*Ionlist is used to breakdown the species to ions. Please see [[TPS Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
At this time, PHREEQC evaporation models are suitable for water evaporation only. This is because gases are treated as pure phases in the PHREEQC calculations. Only insoluble gases can be included in these models.<br />
<br />
== PHREEQC SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new PHREEQC SysCAD project group. <br />
<br />
If user only intend to use PHREEQC for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use PHREEQC to evaluate SysCAD streams, then follow (B).<br />
<br />
'''<big>(A)</big>''' Using PHREEQC as stand-alone thermodynamic calculation engine to perform PHREEQC equilibrium calculations.<br />
#(Only required in build138) Extract the PHREEQC add-on dlls from the bin138_xxxxx_c_ScdPHREEQC.zip into the SysCADxxx bin folder <br />
#Locate a valid PHREEQC database file and copy into the "'''database'''" subfolder of the "project group" you wish to open (or create). See image for folder layout. [[image:TPS_PHREEQC_file.png|thumb|PHREEQC folder layout]]<br />
#*Sample database files are stored in the database subfolder of the PHREEQC installation.<br />
#*Typical path is C:\Program Files\USGS\Phreeqc Interactive X.Y.Z-NNNNN\database. <br />
#[[Editing User Species Database|Edit]] the configuration to:<br />
#* select the PHREEQC models in step 1 of edit configuration file, <br />
#* in Step 2 of edit configuration file - TCEs tab, select the location of the PHREEQC database folder (point 2 of workflow) and tick all the databases you would like to use in the project. (Only required in build139)<br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[PHREEQC Model Configuration]], and configure the model:<br />
#*load in the PHREEQC Model Definition file (step 2)<br />
#Insert a [[PHREEQC Direct Calc Model]]. Use the direct calc to perform PHREEQC equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using PHREEQC to evaluate SysCAD streams or as part of the SysCAD flowsheet.<br />
#(Only required in build138) Extract the PHREEQC add-on dlls from the bin138_xxxxx_c_ScdPHREEQC.zip into the SysCADxxx bin folder <br />
#Locate a valid PHREEQC database file and copy into the "'''database'''" subfolder of the "project group" you wish to open (or create). See image above for folder layout. <br />
#*Sample database files are stored in the database subfolder of the PHREEQC installation.<br />
#*Typical path is C:\Program Files\USGS\Phreeqc Interactive X.Y.Z-NNNNN\database.<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the PHREEQC model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, PHREEQC Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the PHREEQC SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#[[Editing User Species Database|Edit]] the configuration to:<br />
#* select the PHREEQC models in of edit configuration file, <br />
#* in step 2 of edit configuration file, select the required Species from the Species Tab.<br />
#* also in Step 2 of edit configuration file - TCEs tab, select the location of the PHREEQC database folder (point 2 of workflow) and tick all the databases you would like to use in the project. (Only required in build139)<br />
#Create a SysCAD project. <br />
#Add [[PHREEQC Model Configuration]], <br />
#*load in the PHREEQC Model .dat file (this is the file we have copied over in workflow step # 2)<br />
#*complete the PHREEQC Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add PHREEQC unit models to the project where appropriate.<br />
<br />
<br />
NOTES:<br />
#item 1 of the workflow is not required for Build 139, the TCE dll files are included as part of the standard SysCAD update file.<br />
#Please also see [[TCE Configuration Options]] for how to specify the configuration options.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from PHREEQC Database File|Generate SysCAD database from PHREEQC Database File]]<br />
<br />
== Additional Notes ==<br />
#If you want to use PHREEQC with SysCAD, you don't have to install it separately. SysCAD already comes with the PHREEQC files you need and some examples of how to use them. However, if you want to learn more about PHREEQC, improve your skills with the software and access the utilities that come with it, you might want to download and install PHREEQC on your own. It's optional, but it can be helpful.<br />
# The minteq.v4.dat database cannot be used in its native form. This is because it contains reactions with the -no_check option enabled. If you attempt to load this, you will get this error. Please contact SysCAD support for a supported version of this database, or comment out the reactions in the database file which contain the -no_check option.<br />
# Documentation for the PHREEQC software package is useful for further understanding program capabilities and limitations. Links to the documentation are provided below:<br />
## [https://hydrochemistry.eu/ph3/manual2_eqns.pdf | Users Guide Version 2 (with equations)]<br />
## [https://www.usgs.gov/software/phreeqc-version-3 | Users Guide Version 3 (available on this page)]</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=PHREEQC_Overview&diff=78303PHREEQC Overview2024-02-08T22:18:48Z<p>Kevin.Heppner: /* Additional Notes */</p>
<hr />
<div>[[Category: PHREEQC]]<br />
{{Navigation | [[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{PHREEQC Header Tabs | currentpage = 1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from PHREEQC Database File]], [[Example_-_05_PHREEQC_Projects|PHREEQC Example Projects]]<br />
----<br />
{{TPS General Notes|PHREEQC }} <br />
{{TOC}}<br />
== Overview ==<br />
<br />
PHREEQC is a computer program that is designed to perform a wide variety of aqueous geochemical calculations. <br />
*It is developed and maintained by the United States Geological Survey. (refer to [https://www.usgs.gov/software/phreeqc-version-3 www.usgs.gov/software/phreeqc-version-3] for further information)<br />
*It is assumed that the user has some familiarity with the theory and use of the PHREEQC program. Installation of the PHREEQC software is not required, however, it may be useful. See [[#Additional Notes|Additional Notes]]. <br />
*This SysCAD TCE library option (in ScdPHREEQC.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons. For Build 139 from August 2022, a TCE add-on is required instead of a separate individual PHRREQC License add-on.<br />
*PHREEQC is used in a flexible way in Unit or Control models at appropriate locations in a plant model. It is not implemented as a Species Properties Model.<br />
*Selection of appropriate databases and data is the responsibility of the user. It is important to understand the limitations of databases supplied via PHREEQC download and other sources (THEREDA, THERMODDEN, etc.). A good review of selected databases has been conducted by Lu et al., 2022 [https://par.nsf.gov/servlets/purl/10321300].<br />
<br />
==Models ==<br />
<br />
PHREEQC unit models:<br />
* [[PHREEQC Model Configuration]] - Used to define and view various options for the selected PHREEQC database, including management of mapping of SysCAD species list to species list used in PHREEQC.<br />
* [[PHREEQC Direct Calc Model]] - Stand alone unit model to perform side calculations using PHREEQC for predicting aqueous chemistry equilibrium conditions and properties including pH on a user defined PHREEQC stream.<br />
* [[PHREEQC Side Calc Model]] - Stand alone unit model to perform side calculations using PHREEQC for predicting aqueous chemistry equilibrium conditions and properties including pH on a SysCAD stream in the current project.<br />
* [[PHREEQC Reactor]] - Include this model in a SysCAD stream to use PHREEQC to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
<br />
The following unit models are available in build 139 and later:<br />
* [[PHREEQC Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded PHREEQC calculations.<br />
* [[PHREEQC Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded PHREEQC calculations.<br />
* [[PHREEQC Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded PHREEQC calculations. PHREEQC can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[PHREEQC Solvent Extraction|PHREEQC Solvent Extraction (Mixer Settler)]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded PHREEQC calculations.<br />
<br />
The following unit model is available in build 139.30807 or later:<br />
* [[PHREEQC Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using PHREEQC species.<br />
<br />
Species Mapping:<br />
*Ionlist is used to breakdown the species to ions. Please see [[TPS Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
At this time, PHREEQC evaporation models are suitable for water evaporation only. This is because gases are treated as pure phases in the PHREEQC calculations. Only insoluble gases can be included in these models.<br />
<br />
== PHREEQC SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new PHREEQC SysCAD project group. <br />
<br />
If user only intend to use PHREEQC for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use PHREEQC to evaluate SysCAD streams, then follow (B).<br />
<br />
'''<big>(A)</big>''' Using PHREEQC as stand-alone thermodynamic calculation engine to perform PHREEQC equilibrium calculations.<br />
#(Only required in build138) Extract the PHREEQC add-on dlls from the bin138_xxxxx_c_ScdPHREEQC.zip into the SysCADxxx bin folder <br />
#Locate a valid PHREEQC database file and copy into the "'''database'''" subfolder of the "project group" you wish to open (or create). See image for folder layout. [[image:TPS_PHREEQC_file.png|thumb|PHREEQC folder layout]]<br />
#*Sample database files are stored in the database subfolder of the PHREEQC installation.<br />
#*Typical path is C:\Program Files\USGS\Phreeqc Interactive X.Y.Z-NNNNN\database. <br />
#[[Editing User Species Database|Edit]] the configuration to:<br />
#* select the PHREEQC models in step 1 of edit configuration file, <br />
#* in Step 2 of edit configuration file - TCEs tab, select the location of the PHREEQC database folder (point 2 of workflow) and tick all the databases you would like to use in the project. (Only required in build139)<br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[PHREEQC Model Configuration]], and configure the model:<br />
#*load in the PHREEQC Model Definition file (step 2)<br />
#Insert a [[PHREEQC Direct Calc Model]]. Use the direct calc to perform PHREEQC equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using PHREEQC to evaluate SysCAD streams or as part of the SysCAD flowsheet.<br />
#(Only required in build138) Extract the PHREEQC add-on dlls from the bin138_xxxxx_c_ScdPHREEQC.zip into the SysCADxxx bin folder <br />
#Locate a valid PHREEQC database file and copy into the "'''database'''" subfolder of the "project group" you wish to open (or create). See image above for folder layout. <br />
#*Sample database files are stored in the database subfolder of the PHREEQC installation.<br />
#*Typical path is C:\Program Files\USGS\Phreeqc Interactive X.Y.Z-NNNNN\database.<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the PHREEQC model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, PHREEQC Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the PHREEQC SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#[[Editing User Species Database|Edit]] the configuration to:<br />
#* select the PHREEQC models in of edit configuration file, <br />
#* in step 2 of edit configuration file, select the required Species from the Species Tab.<br />
#* also in Step 2 of edit configuration file - TCEs tab, select the location of the PHREEQC database folder (point 2 of workflow) and tick all the databases you would like to use in the project. (Only required in build139)<br />
#Create a SysCAD project. <br />
#Add [[PHREEQC Model Configuration]], <br />
#*load in the PHREEQC Model .dat file (this is the file we have copied over in workflow step # 2)<br />
#*complete the PHREEQC Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add PHREEQC unit models to the project where appropriate.<br />
<br />
<br />
NOTES:<br />
#item 1 of the workflow is not required for Build 139, the TCE dll files are included as part of the standard SysCAD update file.<br />
#Please also see [[TCE Configuration Options]] for how to specify the configuration options.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from PHREEQC Database File|Generate SysCAD database from PHREEQC Database File]]<br />
<br />
== Additional Notes ==<br />
#If you want to use PHREEQC with SysCAD, you don't have to install it separately. SysCAD already comes with the PHREEQC files you need and some examples of how to use them. However, if you want to learn more about PHREEQC, improve your skills with the software and access the utilities that come with it, you might want to download and install PHREEQC on your own. It's optional, but it can be helpful.<br />
# The minteq.v4.dat database cannot be used in its native form. This is because it contains reactions with the -no_check option enabled. If you attempt to load this, you will get this error. Please contact SysCAD support for a supported version of this database, or comment out the reactions in the database file which contain the -no_check option.<br />
# Documentation for the PHREEQC software package is useful for further understanding program capabilities and limitations. Links to the documentation are provided below:<br />
## [https://hydrochemistry.eu/ph3/manual2_eqns.pdf| Users Guide Version 2 (with equations)]<br />
## [https://www.usgs.gov/software/phreeqc-version-3| Users Guide Version 3 (available on this page)]</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=PHREEQC_Overview&diff=78302PHREEQC Overview2024-02-08T22:18:26Z<p>Kevin.Heppner: /* Additional Notes */</p>
<hr />
<div>[[Category: PHREEQC]]<br />
{{Navigation | [[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{PHREEQC Header Tabs | currentpage = 1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from PHREEQC Database File]], [[Example_-_05_PHREEQC_Projects|PHREEQC Example Projects]]<br />
----<br />
{{TPS General Notes|PHREEQC }} <br />
{{TOC}}<br />
== Overview ==<br />
<br />
PHREEQC is a computer program that is designed to perform a wide variety of aqueous geochemical calculations. <br />
*It is developed and maintained by the United States Geological Survey. (refer to [https://www.usgs.gov/software/phreeqc-version-3 www.usgs.gov/software/phreeqc-version-3] for further information)<br />
*It is assumed that the user has some familiarity with the theory and use of the PHREEQC program. Installation of the PHREEQC software is not required, however, it may be useful. See [[#Additional Notes|Additional Notes]]. <br />
*This SysCAD TCE library option (in ScdPHREEQC.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons. For Build 139 from August 2022, a TCE add-on is required instead of a separate individual PHRREQC License add-on.<br />
*PHREEQC is used in a flexible way in Unit or Control models at appropriate locations in a plant model. It is not implemented as a Species Properties Model.<br />
*Selection of appropriate databases and data is the responsibility of the user. It is important to understand the limitations of databases supplied via PHREEQC download and other sources (THEREDA, THERMODDEN, etc.). A good review of selected databases has been conducted by Lu et al., 2022 [https://par.nsf.gov/servlets/purl/10321300].<br />
<br />
==Models ==<br />
<br />
PHREEQC unit models:<br />
* [[PHREEQC Model Configuration]] - Used to define and view various options for the selected PHREEQC database, including management of mapping of SysCAD species list to species list used in PHREEQC.<br />
* [[PHREEQC Direct Calc Model]] - Stand alone unit model to perform side calculations using PHREEQC for predicting aqueous chemistry equilibrium conditions and properties including pH on a user defined PHREEQC stream.<br />
* [[PHREEQC Side Calc Model]] - Stand alone unit model to perform side calculations using PHREEQC for predicting aqueous chemistry equilibrium conditions and properties including pH on a SysCAD stream in the current project.<br />
* [[PHREEQC Reactor]] - Include this model in a SysCAD stream to use PHREEQC to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
<br />
The following unit models are available in build 139 and later:<br />
* [[PHREEQC Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded PHREEQC calculations.<br />
* [[PHREEQC Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded PHREEQC calculations.<br />
* [[PHREEQC Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded PHREEQC calculations. PHREEQC can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[PHREEQC Solvent Extraction|PHREEQC Solvent Extraction (Mixer Settler)]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded PHREEQC calculations.<br />
<br />
The following unit model is available in build 139.30807 or later:<br />
* [[PHREEQC Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using PHREEQC species.<br />
<br />
Species Mapping:<br />
*Ionlist is used to breakdown the species to ions. Please see [[TPS Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
At this time, PHREEQC evaporation models are suitable for water evaporation only. This is because gases are treated as pure phases in the PHREEQC calculations. Only insoluble gases can be included in these models.<br />
<br />
== PHREEQC SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new PHREEQC SysCAD project group. <br />
<br />
If user only intend to use PHREEQC for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use PHREEQC to evaluate SysCAD streams, then follow (B).<br />
<br />
'''<big>(A)</big>''' Using PHREEQC as stand-alone thermodynamic calculation engine to perform PHREEQC equilibrium calculations.<br />
#(Only required in build138) Extract the PHREEQC add-on dlls from the bin138_xxxxx_c_ScdPHREEQC.zip into the SysCADxxx bin folder <br />
#Locate a valid PHREEQC database file and copy into the "'''database'''" subfolder of the "project group" you wish to open (or create). See image for folder layout. [[image:TPS_PHREEQC_file.png|thumb|PHREEQC folder layout]]<br />
#*Sample database files are stored in the database subfolder of the PHREEQC installation.<br />
#*Typical path is C:\Program Files\USGS\Phreeqc Interactive X.Y.Z-NNNNN\database. <br />
#[[Editing User Species Database|Edit]] the configuration to:<br />
#* select the PHREEQC models in step 1 of edit configuration file, <br />
#* in Step 2 of edit configuration file - TCEs tab, select the location of the PHREEQC database folder (point 2 of workflow) and tick all the databases you would like to use in the project. (Only required in build139)<br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[PHREEQC Model Configuration]], and configure the model:<br />
#*load in the PHREEQC Model Definition file (step 2)<br />
#Insert a [[PHREEQC Direct Calc Model]]. Use the direct calc to perform PHREEQC equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using PHREEQC to evaluate SysCAD streams or as part of the SysCAD flowsheet.<br />
#(Only required in build138) Extract the PHREEQC add-on dlls from the bin138_xxxxx_c_ScdPHREEQC.zip into the SysCADxxx bin folder <br />
#Locate a valid PHREEQC database file and copy into the "'''database'''" subfolder of the "project group" you wish to open (or create). See image above for folder layout. <br />
#*Sample database files are stored in the database subfolder of the PHREEQC installation.<br />
#*Typical path is C:\Program Files\USGS\Phreeqc Interactive X.Y.Z-NNNNN\database.<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the PHREEQC model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, PHREEQC Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the PHREEQC SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#[[Editing User Species Database|Edit]] the configuration to:<br />
#* select the PHREEQC models in of edit configuration file, <br />
#* in step 2 of edit configuration file, select the required Species from the Species Tab.<br />
#* also in Step 2 of edit configuration file - TCEs tab, select the location of the PHREEQC database folder (point 2 of workflow) and tick all the databases you would like to use in the project. (Only required in build139)<br />
#Create a SysCAD project. <br />
#Add [[PHREEQC Model Configuration]], <br />
#*load in the PHREEQC Model .dat file (this is the file we have copied over in workflow step # 2)<br />
#*complete the PHREEQC Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add PHREEQC unit models to the project where appropriate.<br />
<br />
<br />
NOTES:<br />
#item 1 of the workflow is not required for Build 139, the TCE dll files are included as part of the standard SysCAD update file.<br />
#Please also see [[TCE Configuration Options]] for how to specify the configuration options.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from PHREEQC Database File|Generate SysCAD database from PHREEQC Database File]]<br />
<br />
== Additional Notes ==<br />
#If you want to use PHREEQC with SysCAD, you don't have to install it separately. SysCAD already comes with the PHREEQC files you need and some examples of how to use them. However, if you want to learn more about PHREEQC, improve your skills with the software and access the utilities that come with it, you might want to download and install PHREEQC on your own. It's optional, but it can be helpful.<br />
# The minteq.v4.dat database cannot be used in its native form. This is because it contains reactions with the -no_check option enabled. If you attempt to load this, you will get this error. Please contact SysCAD support for a supported version of this database, or comment out the reactions in the database file which contain the -no_check option.<br />
# Documentation for the PHREEQC software package is useful for further understanding program capabilities and limitations. Links to the documentation are provided below:<br />
## [https://hydrochemistry.eu/ph3/manual2_eqns.pdf| Users guide Version 2 (with equations)]<br />
## [https://www.usgs.gov/software/phreeqc-version-3| Users guide Version 3 (available on this page)]</div>Kevin.Heppnerhttps://help.syscad.net/index.php?title=PHREEQC_Overview&diff=78301PHREEQC Overview2024-02-08T22:17:32Z<p>Kevin.Heppner: /* Additional Notes */</p>
<hr />
<div>[[Category: PHREEQC]]<br />
{{Navigation | [[Models]]|[[Models#Thermodynamic Calculation Engines|TCE Models]]}}<br />
{{PHREEQC Header Tabs | currentpage = 1}}<br />
<br />
'''Related Links:''' [[TCE Functionality Overview]], [[TCE Species Mapping]], [[TCE Configuration Options]], [[Generate SysCAD database from PHREEQC Database File]], [[Example_-_05_PHREEQC_Projects|PHREEQC Example Projects]]<br />
----<br />
{{TPS General Notes|PHREEQC }} <br />
{{TOC}}<br />
== Overview ==<br />
<br />
PHREEQC is a computer program that is designed to perform a wide variety of aqueous geochemical calculations. <br />
*It is developed and maintained by the United States Geological Survey. (refer to [https://www.usgs.gov/software/phreeqc-version-3 www.usgs.gov/software/phreeqc-version-3] for further information)<br />
*It is assumed that the user has some familiarity with the theory and use of the PHREEQC program. Installation of the PHREEQC software is not required, however, it may be useful. See [[#Additional Notes|Additional Notes]]. <br />
*This SysCAD TCE library option (in ScdPHREEQC.DLL) requires the SysCAD "Energy Balance", "Integration Libraries" (formerly "SMDK Runtime") and "TCE" add-ons. For Build 139 from August 2022, a TCE add-on is required instead of a separate individual PHRREQC License add-on.<br />
*PHREEQC is used in a flexible way in Unit or Control models at appropriate locations in a plant model. It is not implemented as a Species Properties Model.<br />
*Selection of appropriate databases and data is the responsibility of the user. It is important to understand the limitations of databases supplied via PHREEQC download and other sources (THEREDA, THERMODDEN, etc.). A good review of selected databases has been conducted by Lu et al., 2022 [https://par.nsf.gov/servlets/purl/10321300].<br />
<br />
==Models ==<br />
<br />
PHREEQC unit models:<br />
* [[PHREEQC Model Configuration]] - Used to define and view various options for the selected PHREEQC database, including management of mapping of SysCAD species list to species list used in PHREEQC.<br />
* [[PHREEQC Direct Calc Model]] - Stand alone unit model to perform side calculations using PHREEQC for predicting aqueous chemistry equilibrium conditions and properties including pH on a user defined PHREEQC stream.<br />
* [[PHREEQC Side Calc Model]] - Stand alone unit model to perform side calculations using PHREEQC for predicting aqueous chemistry equilibrium conditions and properties including pH on a SysCAD stream in the current project.<br />
* [[PHREEQC Reactor]] - Include this model in a SysCAD stream to use PHREEQC to calculate predicted outlet conditions. Functionality is similar to SysCAD [[Reaction Block (RB)|Reaction Block]] and [[Free Energy Minimisation (FEM)|FEM]] where for a given feed reactions occur with optional heat exchange. The model can be configured in a number of ways for different purposes.<br />
<br />
The following unit models are available in build 139 and later:<br />
* [[PHREEQC Evaporator]] - Include this model in a SysCAD flowsheet to model an evaporator using embedded PHREEQC calculations.<br />
* [[PHREEQC Flash Tank]] - Include this model in a SysCAD flowsheet to model a flash tank using embedded PHREEQC calculations.<br />
* [[PHREEQC Reverse Osmosis Unit]] - Include this model in a SysCAD flowsheet to model reverse osmosis using embedded PHREEQC calculations. PHREEQC can be used to calculate maximum permeate recovery (to incipient solids formation) and other operating modes.<br />
* [[PHREEQC Solvent Extraction|PHREEQC Solvent Extraction (Mixer Settler)]] - Include this model in a SysCAD flowsheet to model solvent extraction using embedded PHREEQC calculations.<br />
<br />
The following unit model is available in build 139.30807 or later:<br />
* [[PHREEQC Feeder Model]] - Include this model in a SysCAD flowsheet to specify a feed using PHREEQC species.<br />
<br />
Species Mapping:<br />
*Ionlist is used to breakdown the species to ions. Please see [[TPS Species Mapping|Species Mapping]] for more information on this topic.<br />
<br />
At this time, PHREEQC evaporation models are suitable for water evaporation only. This is because gases are treated as pure phases in the PHREEQC calculations. Only insoluble gases can be included in these models.<br />
<br />
== PHREEQC SysCAD Project Workflow ==<br />
<br />
The list below are some recommended steps in creating a new PHREEQC SysCAD project group. <br />
<br />
If user only intend to use PHREEQC for standalone equilibrium calculations, thus not linking it to existing SysCAD stream or species database, then follow the (A). If user wishes to use PHREEQC to evaluate SysCAD streams, then follow (B).<br />
<br />
'''<big>(A)</big>''' Using PHREEQC as stand-alone thermodynamic calculation engine to perform PHREEQC equilibrium calculations.<br />
#(Only required in build138) Extract the PHREEQC add-on dlls from the bin138_xxxxx_c_ScdPHREEQC.zip into the SysCADxxx bin folder <br />
#Locate a valid PHREEQC database file and copy into the "'''database'''" subfolder of the "project group" you wish to open (or create). See image for folder layout. [[image:TPS_PHREEQC_file.png|thumb|PHREEQC folder layout]]<br />
#*Sample database files are stored in the database subfolder of the PHREEQC installation.<br />
#*Typical path is C:\Program Files\USGS\Phreeqc Interactive X.Y.Z-NNNNN\database. <br />
#[[Editing User Species Database|Edit]] the configuration to:<br />
#* select the PHREEQC models in step 1 of edit configuration file, <br />
#* in Step 2 of edit configuration file - TCEs tab, select the location of the PHREEQC database folder (point 2 of workflow) and tick all the databases you would like to use in the project. (Only required in build139)<br />
#Create or open a SysCAD project using the cfg file you have just edited.<br />
#Insert a [[PHREEQC Model Configuration]], and configure the model:<br />
#*load in the PHREEQC Model Definition file (step 2)<br />
#Insert a [[PHREEQC Direct Calc Model]]. Use the direct calc to perform PHREEQC equilibrium calculations.<br />
<br />
'''<big>(B)</big>''' Using PHREEQC to evaluate SysCAD streams or as part of the SysCAD flowsheet.<br />
#(Only required in build138) Extract the PHREEQC add-on dlls from the bin138_xxxxx_c_ScdPHREEQC.zip into the SysCADxxx bin folder <br />
#Locate a valid PHREEQC database file and copy into the "'''database'''" subfolder of the "project group" you wish to open (or create). See image above for folder layout. <br />
#*Sample database files are stored in the database subfolder of the PHREEQC installation.<br />
#*Typical path is C:\Program Files\USGS\Phreeqc Interactive X.Y.Z-NNNNN\database.<br />
#Create a SysCAD.93.db3 file, the SysCAD database must contain the same number of individual phases as the PHREEQC model file. <br />
#*A [[#Utility|Utility]] is available to assist user with the creation of SysCAD.93.db3 file. <br />
#*The database is created using existing SysCAD data, PHREEQC Model data is not transferred to the SysCAD database. <br />
#*Once a SysCAD.93.db3 file has been create, copy this database and the IonList.txt into the PHREEQC SysCAD project \CfgFiles subfolder<br />
#Check and [[Editing User Species Database|edit]] the SysCAD.93.db3 file inside the CfgFiles subfolder and correct any missing data.<br />
#[[Editing User Species Database|Edit]] the configuration to:<br />
#* select the PHREEQC models in of edit configuration file, <br />
#* in step 2 of edit configuration file, select the required Species from the Species Tab.<br />
#* also in Step 2 of edit configuration file - TCEs tab, select the location of the PHREEQC database folder (point 2 of workflow) and tick all the databases you would like to use in the project. (Only required in build139)<br />
#Create a SysCAD project. <br />
#Add [[PHREEQC Model Configuration]], <br />
#*load in the PHREEQC Model .dat file (this is the file we have copied over in workflow step # 2)<br />
#*complete the PHREEQC Species to SysCAD Species Mapping. <br />
#*Edit SysCAD.93.db3 and configuration file if species are missing.<br />
#Once species mapping is satisfactory, add PHREEQC unit models to the project where appropriate.<br />
<br />
<br />
NOTES:<br />
#item 1 of the workflow is not required for Build 139, the TCE dll files are included as part of the standard SysCAD update file.<br />
#Please also see [[TCE Configuration Options]] for how to specify the configuration options.<br />
<br />
== Utility ==<br />
<br />
[[Generate SysCAD database from PHREEQC Database File|Generate SysCAD database from PHREEQC Database File]]<br />
<br />
== Additional Notes ==<br />
#If you want to use PHREEQC with SysCAD, you don't have to install it separately. SysCAD already comes with the PHREEQC files you need and some examples of how to use them. However, if you want to learn more about PHREEQC, improve your skills with the software and access the utilities that come with it, you might want to download and install PHREEQC on your own. It's optional, but it can be helpful.<br />
# The minteq.v4.dat database cannot be used in its native form. This is because it contains reactions with the -no_check option enabled. If you attempt to load this, you will get this error. Please contact SysCAD support for a supported version of this database, or comment out the reactions in the database file which contain the -no_check option.<br />
# Documentation for the PHREEQC software package is useful for further understanding program capabilities and limitations. Links to the documentation are provided below:<br />
## [https://hydrochemistry.eu/ph3/manual2_eqns.pdf| Users guide with equations]<br />
## [https://www.usgs.gov/software/phreeqc-version-3| Users guide along with software download]</div>Kevin.Heppner