View source for Build 138 Release Notes Full

[[Category:SysCAD Versions and Builds]]
{{Navigation|[[User Guide]]|[[SysCAD Version History]]|[[Build 138 Release Notes]]|altname=Full Release Notes}}
{{Whats New Header 138}}

'''Related Links:''' [[Upgrading Projects]], [[Revision_History_for_SysCAD_9.3#Changes_in_SysCAD_9.3_Build_138|Build 138 Revision History]]
----
{{TOC}}
= What's New and Changed =

==New Models==

'''New Unit Model:'''
*[[Solids Recovery Unit]] : The Solids Recovery Unit can be used to model a variety of solid recovery processes including flotation, magnetic separation and spirals. 
**Similar in functionality to the [[Flotation Cell]], the model requires the user to define the primary species or element that is recovered to the concentrate and middlings streams (if connected).  
**The user may then specify the recovery and grade or mass pull of the primary species/element.  
**The recoveries of secondary species may also be defined by the user. 
**Alternatively, the model can be used with [[Size Distribution (PSD)|PSD]] and the user can set the recovery to concentrate/middlings of each solid species with a size distribution in each size interval.

'''New Sub-Model:'''
*[[Discard Block (DB)|Material Discard Block]] : Similar to the [[Makeup Block (MU)|Makeup Block]], this gives the user a number of flexible controlled methods to remove material from the model to a [[Discard Sink]] without connecting and configuring a normal stream.

== Model Improvements ==

===Significant Unit Model Improvements===
*[[Feeder-Cross_Page_Connector#Feeder_Operation_Selection|Feeder]] - New Operation modes greatly simplifying the use of feeders:
**The simplified modes will remove various options that are not applicable to the selected Operation as well as reducing the species visible on the DSp tab, making it easier to input parameters including stream composition.  <br>For example, if the operating mode is *Liquids*, then Solids and Gases species will be not be displayed in the DSp tab; or if the operating mode is *Steam* then the user does not need to specify the composition it is automatically always steam.
**The new operating modes simplify data entry, reduces complexity of user options shown in the Access window and reduces possibility of incorrect data entry. The General Operation mode retains the full functionality and flexibility.
**The new Operation modes work with [[Demand]] functionality. For example using the [[Feeder-Cross_Page_Connector#Feeder_Operation_Selection|Link to MakeupSrc]] Operation mode will allow user to use makeup and demand together as described in [[Feeder-Cross_Page_Connector#3._Set_Feeder_to_Demand_mode.2C_while_using_material_from_Makeup_Source|this example]].
**Where a feeder was used with makeup block to provide the feeder can be simplified significantly with use of Operation mode [[Feeder-Cross_Page_Connector#Feeder_Operation_Selection|MakeupSrc Fetch]] or [[Feeder-Cross_Page_Connector#Feeder_Operation_Selection|Link to MakeupSrc]] with added advantage of being able to use [[Demand]] functionality.

*[[Flotation_Cell#Requirements|Flotation Cell]]  - New option to specify grade of secondary species

*[[Solvent_Extraction_Unit#General_Description|Solvent Extraction]] - New Method and options:  
**Added new [[Solvent_Extraction_Unit#Model_Theory|Isotherm2 ]]method designed to replace original Isotherm method to better handle user specified McCabe-Thiele phase equilibrium data.  See [[Solvent_Extraction_Unit#EXAMPLE_1:_Based_on_total_Cu_concentration_by_phase|example]] on how to set up the isotherm.
**Added method to allow user to selectively define which species is included in the elemental concentration count.  For example, user can select Fe2+ only, not total Fe.  See [[Solvent_Extraction_Unit#EXAMPLE_2:_Based_on_User_Defined_calculations|Example]] on how to set up and use user defined species with isotherm.
**Added environmental heat loss to the unit.
**Added option for user to [[Solvent_Extraction_Unit#Isotherm_Section|load or save the isotherm]] data.

*[[Simple_Heat_Exchanger#Calc|Simple Heat Exchanger - Other side]] - New Approach option for demand calculation.  
**The Simple Heat Exchanger now provides feedback for "Hot side", and shows the HotSide and Cold Side approach temperature calculations.  
**See [[Simple_Heat_Exchanger#Model_Configuration_Example|Example]] on how to configure the model using the new approach method.

*[[Thermocompressor#Differences_to_Build_137|Thermocompressor]] - New options:
**New option for user to specify desired Discharge Pressure instead of Entrainment Ratio.
**User can now choose to have demand calculation on either the Primary or Secondary Steam inlets. Previously was only available for Primary Steam inlet.
**Existing functionality retained but updates to methods may result in different answers (see [[#Project Upgrade And Changes that Affect Results|Project Upgrade And Changes that Affect Results]]).
**Some tag changes (see [[#Project Upgrade And Changes that Affect Results|Project Upgrade And Changes that Affect Results]]).

*[[Precipitator3_Model_Theory#Bound_Soda_implementation|Precipitator3]]  
**Corrected the [[Precipitator3_Model_Theory#Bound_Soda_implementation|bound soda calculations]] to include the missing species conversion factors for Hunter and Fixed% methods. See [[#Changes_that_may_Affect_Results|Changes that may Affect Results]] for more information.
**Corrected [[Alumina3_Precip_-_Full_PSD#Agglomeration_Cutoff|Agglomeration cut off]] for steady state.  See [[#Changes_that_may_Affect_Results|Changes that may Affect Results]] for more information.

*Alumina Bayer Properties Model enhancement
**Added Beckham Grocott method for Bayer [[Bayer3_Species_Model_Theory#Oxalate_Equilibrium|Oxalate Solubility]].
**Added McKinnon method for [[Precipitator3_Model_Theory#Oxalate_Precipitation_Calculation|Oxalate precipitation]] in the Precipitator3

===Model Enhancements:===
*[[Belt_Filter#WashLoss_Section|Belt Filter]]: Added option for user to load or save the wash loss data.  Also added [[Belt_Filter#Hints_and_Comments|example]] to estimate a wash loss curve based on Simple Filtration Wash Efficiency.
*[[Feeder-Cross_Page_Connector|Feeder]]: New option (ConnectBlocked) to exclude feeders from crosspage connection list simplifying the workflow for connecting feeders across graphics pages. At the same time marking the feeders as model material inputs or outputs.
*[[FEM]] Reactor: New display options for analysis. Improved messages and information for failed convergence. Miscellaneous solver improvements for different conditions.
*[[Flash Tank]]: Improve error reporting in the case of a [[Flash Tank]] receiving feed with a saturation pressure too high.
*[[Flash Train Control]]: This Dynamic mode controller now takes into account heat of reaction in associated shell and tube models.
*[[Precipitator3]]: Additional growth rate tuning factor. New option to include [[Alumina3_Precip_-_Full_PSD#Bound_Soda_with_Nucleation|Nucleation yield]] in bound soda calcualtions. New options for dynamic for managing changes in tank volume or contents.
*[[Makeup Block (MU)|Makeup Block]]: new selections for Solids Species, Liquid Species and Vapour Species and better ranging of inputs.
*Unit models with feed [[Makeup Block (MU)|Makeup Block]] now allow the makeup to be the only source of material to the unit.

== User interface ==
*Added new fields on '''[[Plant_Model_-_Project|PlantModel]] - Project''' tab page for data entry:
**This allows the user to enter information about the project.  It also provides placeholder for two external links, for example, user can add in the hyperlink of a document (in the DescLink field) that would help describe the project.  This could be a full web address or a full path of a file on the network or a file on the local computer.
**If a hyperlink points to a web address, then user can click on [[image:hyperlinkicon.png]] icon next to the hyperlink to open the web page.
**The hyperlink provided in the DescLink field is tied-in with new menu command '''[[View_Command_Summary|View - Project Description]]'''.
*Added new Menu Command: '''[[View_Command_Summary|View - Project Description]]'''
**This menu command will activate the hyperlink (or other document name with a full path).
**This command can also be activated from [[Graphics_Window#For_SysCAD_9.3|graphics page right click context menu]]
**For distributed SysCAD example projects, this command will open the example project description page on SysCAD Help wiki.
*Added new Menu Command: '''[[Help_Command_Summary|Help - Example Projects]]''' - This command will open the [[Example Projects]] page on SysCAD Help wiki.
*Added option to '''Include All model''' - for improved usability when selecting unit models from model library dlls:
**For '''Edit Configuration''' - [[Model_Selection]] step, added new option to always '''Include All Unit Models for selected dll'''.  This option will include all unit models in dlls which already have at least one model selected. All current (and future) unit models for a dll are then always available.  
**For '''[[Insert Graphics Commands#Insert Unit|Insert Unit]]''' and '''[[Edit Graphics Commands#Change Unit|Change Unit]]''', added "Show All" to allow display of all unit models in dlls.  This eliminates the need to close and exit SysCAD, edit the configuration file to include the required model, then re-open the project.
*Expanded [[Species Flow Section#Phase_and_View_Options|Elemental flows section]] on the '''EC''' page to include variables on an '''Individual Phase''' basis. This includes:
** Mass Flow/Fraction
** Mole Flow/Fraction
** Mass Concentration (Conc and Conc25)
** Molar Concentration (Mole Conc and Mole Conc25)
*Added new filter criteria for [[Species Filter]]
** Expanded species display filter to display species with the largest flows.
** User can filter to show a specified number of species with the largest flows or specify minimum mass fraction.
*New option to copy "partial" unit group tag, for example: P_001.Qo, Tank1.QFeed
**Right click on Access window tab page title has a new context menu to copy the tag providing a convenient way of copying and pasting tags for use in referenced models. This would be the model tag for the first tab page, and the sub-model (eq Qo) for subsequent pages.  See [[Copy_and_Paste#Copying_Access_Window_Tab_Names|Copy Access Window Tab name]] for more information.
**In Access window Ctrl+C or right click on start of a group of tags (e.g. Qo...; QFeed...) can now be used to copy the tag for the group.  See [[Copy_and_Paste#Copying_Access_Window_Tab_Names|Copy Access Window group name]] for more information.
*New Copy Full Tag for PGM, e.g.: ["P_001.Qo.Qm (t/h)"]
**[[Access_Window#Right_click_on_Access_Window_variables|Right click on an access window tag]] and select "Copy Tag for PGM" will copy the full tag with the PGM Tag Function syntax already in place.  User can use the tag directly inside the PGM file without having to add the [" "] syntax separately.
*New Mouse Action Defaults : Changed Menu command Options | General Options | Mouse Tab | [[General_Options_Mouse#Mouse|'''Default2''' Mouse Actions]]
**Double Left Click - opens the Access Window
**Right Click - pop up menu
**Shift + Left Click - Find Connected units (e.g. cross page connector)
*Improved [[Copy_and_Paste_Graphics_Commands#Paste|copy & paste]] for nested and referenced tags
*[[Tear]] simplification. The previous separate Tb_Flange (Tear Block) and Flange (SubClass Tear) associated with a recycle tear have been combined into a single [[Tear]] model. 
**So there is now a single Access window with all information related to individual Tears in the flowsheet. 
**The Flange associated with the stream tear still exists but is now part of the Tear object. 
**The new single Tear object is is now directly associated with the tear symbol on the graphics and reporting of tear variables during convergence. The corresponding table of [[Solver_Setting_-_TearTags|TearTags in Solver Settings]] has been simplified.
*Add new variables '''FullDateAndTime''' and '''FullDate''' to '''View|PlantModel[[Plant_Model_-_System#General|System]]''' Tab.  For excel reports, these tags will export the correct date to match regional date formats.

==New Add-Ons==

The following new add-ons all relate to flexible integration in SysCAD plant models of third-party software performing detailed equilibrium and thermodynamic property calculations. The direct integration of these specialist software programs in SysCAD provide a significant range of new and detailed applications in the SysCAD flowsheet simulator for a range of pyromet, hydromet and aqueous chemistry systems. These are currently in BETA. Please contact us for demonstrations or further information.
 
===[[PHREEQC Add-On]]===

See [[PHREEQC Add-On]] (currently in BETA) for a description of this new add-on. PHREEQC is a computer program that is designed to perform a wide variety of aqueous geochemical calculations. It is developed and maintained by the United States Geological Survey [https://www.usgs.gov/software/phreeqc-version-3/ www.usgs.gov/software/phreeqc]. 
PHREEQC unit models:
* [[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.
* [[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.
* [[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.
* [[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.

===[[ChemApp Add-On]]===

See [[ChemApp Add-On]] (currently in BETA) for a description of this new add-on. ChemApp is a computer program for thermodynamic phase equilibrium calculation primarily in pyrometallurgy using ChemApp and FactSage. It permits the calculation of complex, multicomponent, multiphase chemical equilibria and their associated extensive property balances. '''ChemApp''' [https://gtt-technologies.de/software/chemapp|ChemApp] is developed and maintained by GTT-Technologies [https://gtt-technologies.de]. '''FactSage''' [http://www.factsage.com/] is by CRCT ThermFact Inc [http://www.crct.polymtl.ca/index.html] and GTT-Technologies [https://gtt-technologies.de].
ChemApp unit models:
* ChemApp Model Configuration - Used to define and view various options for the selected ChemApp FactSage database, including management of mapping of SysCAD species list to species list used in ChemApp.
* ChemApp Direct Calc Model - Stand alone unit model to perform side calculations using ChemApp for predicting chemistry equilibrium conditions and properties on a user defined ChemApp stream.
* ChemApp Side Calc Model - Stand alone unit model to perform side calculations using ChamApp for predicting chemistry equilibrium conditions and properties including on a SysCAD stream in the current project.
* ChemApp Reactor - Include this model in a SysCAD stream to use ChemApp 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. The model can be configured in a number of ways for different purposes.

===[[AQSol Add-On]]===

See [[AQSol Add-On]] (currently in BETA) for a description of this new add-on. The AQSol program can be used for general phase equilibrium calculations for aqueous solutions. It is developed and maintained by Aqueous Solutions ApS, Søborg, Denmark [http://www.phasediagram.dk www.phasediagram.dk].
AQSol unit models:
* AQSol Model Configuration - Used to define and view various options for the selected AQSol database, including management of mapping of SysCAD species list to species list used in AQSol.
* AQSol Direct Calc Model - Stand alone unit model to perform side calculations using AQSol for predicting aqueous chemistry equilibrium conditions and properties on a user defined AQSol stream.
* AQSol Side Calc Model - Stand alone unit model to perform side calculations using AQSol for predicting aqueous chemistry equilibrium conditions and properties on a SysCAD stream in the current project.
* AQSol Reactor - Include this model in a SysCAD stream to use AQSol 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.

== Other Improvements ==

*Increased limit on number of Individual Phases allowed from 32 to 250.
*New Specific Heat equation [[Species_Table_-_Specific_Heat_(Cp)#NASA_Glenn_Coefficients_Equation|NASAGlenn_Cp equation]] available for species database properties.
*Additional tests and warnings during project load for inconsistent Entropy data for species based on user specified S25 and Cp equation.
*Option in the [[General Configuration | Edit Configuration step 2]] to perform entropy data check on project load.
*Additional columns in the [[SDB_-_Thermo1|$SDB -Thermo1]] and [[SDB_-_Thermo2|$SDB -Thermo2]] tabs for H25 and S25 values. Warnings will be given for species with missing H25 and S25 data.
*Added Gibbs Free Energy to stream display under Entropy section.
*Added Gibbs Free Energy function to the predefined PGM - [[Species Database Class]].
*Added new functions (SetIdentity, Invert, CopyInvert, Determinant, solve and copysolve) to the predefined PGM - [[Matrix Class]] and improved [[Matrix_Class#Watch|Watch]].
*Implemented support for larger numbers of species with [[PSD]] in projects.
*[[Potash Properties Utility]] utility updated with 64 bit version now available.

== Tutorial & Examples ==

* Updated Tutorial documentation.  Please see '''[[Tutorial]]''' in the Help documentation.
* [[Example Projects]] distributed with SysCAD have been updated, including some new Example projects.

=="Under the Hood" Changes==

*Reduced memory use for projects allowing even larger projects with more species.
*Moved [[Belt Filter]], [[Solvent Extraction Unit]] and [[Washer]] from Separ1.dll to Separation.dll.
*Compiled with Microsoft C++ 2017 making use of new features available in C++ and the standard library.
*Significantly enhanced SMDK (SysCAD Model Developers Kit). Expanded list of helper classes and new methods for existing classes.
*Various general and solver speed improvements.

==Changes that may Affect Results==
{{Changes that may Affect Results 137 to 138}}

==Project Upgrade and Tag Changes==
{{SysCAD Tag Changes 137 to 138}}