Release Notes
xStream Version 4 Release Notes
Critical
-
Modified batch runs to report errors when an unhandled exception occurs. Batch runs may now continue if the unhandled exception occurred while loading or running the model file.
-
Fixed an error where Parametric Study would clear the user-defined value after the run rather than restoring it as expected.
Important
-
Improved functionality of warning icons on unit drop-down lists when units in the model file are excluded by personal user preference settings.
-
Fixed an issue where an inactive unit warning icon could display on the Graph Controls and shift the interface, making some graph options inaccessible with no scroll bar.
-
Fixed an issue in the Pipe Materials Library edit form where the Delete and Rename buttons were inoperable.
-
Fixed an issue where View->Show Object Status would always be disabled in the Toolbar.
-
Fixed an issue where creating a Design Alert from Output could throw an exception for some object types.
-
Fixed an issue where splitting a pipe at intermediate elevations caused it, and any subsequently created pipes and branches, to not be initially visible in Layers.
-
Fixed an issue where selecting junctions from Workspace selections in the Global Morph window would throw an exception.
-
Fixed a case where output would be incorrectly cleared after clicking Cancel on the confirmation pop-up, triggered by moving pipes or junctions on the workspace.
-
Improved selection logic so that selections from Model Data grids are used when launching Global Edit from Model Data tab, rather than Workspace selections.
-
Fixed issues with parameters of dynamic unit type in the internal API. The outward effect of this error was that the Parametric Study would not always correctly set or reset parameters with a dynamic unit type. The change also indirectly fixed pipe parameters not being correctly reset to their original values by the Parametric study.
-
Resolved conversion error popup in xStream when selecting “Graph Results” from Solution Progress window.
-
Fixed a calculation error for Difference Exit force sets using the option for "Point Force Ambient Pressure = Use Atmospheric Pressure from Environmental Properties". It could incorrectly use zero absolute pressure instead of the proper value and units from the Environmental Properties (1 atm by default).
Minor
-
Fixed an issue where Event Messages by Junction were not listed in junction order.
Changes that may affect engineering conclusions
-
Fixed an issue where User-Specified Valve Equivalent Loss values would be unused and overwritten in the simulation.
-
Fixed an issue in which choked branches would appear to cycle between choked and not choked.
Important non-engineering changes
-
The Specify Properties button was missing on the Pipe Material Library window.
-
Improved performance related to clearing Output once Output no longer exists - some Output clearing actions were happening repetitively when they only needed to happen once per clearage.
-
Fixed issue with Split Pipe feature not correctly connecting pipes to new junction.
-
Fixed an issue that would check out a duplicate Chempak Data license seat if the Chempak Viewer was launched while Chempak fluids were already in-use in the main application.
-
The first row of the transient data table for junctions is no longer cleared when switching to event based transients.
-
Fixed a case where the Force Set Problems window would incorrectly appear for force sets containing a branching flow path.
Miscellaneous changes
-
Some language localizations files had blank Workspace Layers abbreviation translations, resulting in Workspace labels with no corresponding abbreviation for the parameter value. Standard English abbreviations were added to the files for any parameters that had blanks in this field.
-
Fixed an issue when creating a Design Alert from output cells would cause system error.
Changes that may affect engineering conclusions
-
Fixed bug where valve opening transients dependent on K factors would cause artificial transients in xStream.
-
Fixed bug where xStream didn't correctly determine junctions to be restriction choking during the transient run, ending the run early.
-
Fixed issue with estimating sonic velocity for sectioning with real gases.
-
Fixed a bug where reverse flow restriction choked junctions in steady state output would compute results in the user-specified upstream (flow-direction downstream) pipe incorrectly, and warn of sonic choking at an incorrect junction.
-
Fixed a case where the Force Set Problems window would incorrectly appear for force sets containing a branching flow path.
-
Fixed a bug where some xStream simulations intended to end the simulation on an event would not do so, and would run to the full simulation time.
Important non-engineering changes
-
Fixed an issue where a Bend/Elbow's R/D value could be improperly imported from a PCF file in languages where a comma is used as the decimal mark.
-
Added more options to help load results faster when a very large number of Events are generated during runs.
-
Unit conversion for custom start time for force file exporting now functions properly.
-
Fixed an issue where the eLicense code entry window could appear during a license error even if a valid Registration file was present.
Miscellaneous changes
-
Removed an erroneous Detailed Tee orientation evaluation in xStream since the Detailed Tee feature is not available in xStream.
-
Added display of library file path in the Edit Junctions section of Library Manager and allowed right click to copy the path to clipboard.
-
Added 'Workspace' and 'Special' buttons to Global Junction Morph panel.
-
Fixed a case when creating Design Alerts would clear output Warning messages.
-
Implemented shift click on row and column headers within output data.
-
Updated loading new libraries with older models.
-
Updated Workflow to display when memory constraint reached.
-
Scenario Manager tree structure will now preserve scenario order when cloning scenarios with children and when adding scenarios within Batch Run.
Changes that may affect engineering conclusions
-
Fixed two issues with force sets. One is an issue where force sets with branching paths were not being calculated. The other was an issue where Analysis Setup would fail to open when the model contained point forces.
-
Fixed issue where Hydraulic Diameter in Model Data did not match Hydraulic Diameter in Output.
Important non-engineering changes
-
Updated eLicense DLL to address issues with hard drive serial checks and occasional hanging of application on close.
-
Updated "About" window to include additional licensing information.
-
Removed hard requirement for existence of license file for applications to open.
-
Fixed an issue where the registration file was unable to be copied from other/old locations in some cases.
-
Fixed issue where models with force differences were taking too long to run.
-
Fixed visual validation issue with Compressor Flow/Pressure and Compression Ratio.
-
Fixed issue when exporting tanks to EPA.
-
Fixed an issue where 'Show Time Label' setting would be ignored when copying an image of an animated graph. Additionally, the label location in the image is no longer fixed and will match the location that it was placed prior to taking the image.
-
Added user option to prevent automatic snap to grid when isometric pipe drawing mode is activated.
-
Auto-rotating area changes and check valves will now automatically adjust icons to align with the flow direction and size changes at these junctions.
-
Added missing descriptions for advanced parameters and removed Disable Enthalpy Match Logic option.
-
Fixed issue with junction icons being reset after auto rotation.
Miscellaneous changes
-
Fixed sizing for notes and status text boxes in Assigned Pressure form.
-
Improved image cropping when Copying Graph Image while showing raw data in Graph Results.
-
Improved visual mirroring of Magnification tool.
-
Fixed an issue where a Color Map defined with the "Show Value on Workspace Label" option could format the value incorrectly in the object's label.
xStream Version 3 Release Notes
|
Notes: For documentation on previous versions of xStream, see Previous Version Documentation in the Documentation Portal. For instructions on installing the latest version of xStream, see Software Installation for Current Versions in the Documentation Portal. |
Changes that may affect engineering conclusions
-
Fixed a problem when using standard or normal mass flow rate units for an Assigned Flow junction, where the first run of a scenario may not have the correct STP conditions set. The second run and reopening the scenario after a successful run would have the correct flow values.
-
Fixed issue where Hydraulic Diameter in Model Data did not match Hydraulic Diameter in Output.
-
Fixed an issue where a Bend/Elbow's R/D value could be improperly imported from a PCF file in languages where a comma is used as the decimal mark.
-
Unit conversion for custom start time for force file exporting now functions properly.
-
Fixed a case where creating Design Alerts would clear output Warning messages.
Important non-engineering changes
-
Fixed issue with Split Pipe feature not correctly connecting pipes to new junction.
-
Fixed a problem where a system error message was saved to the model file if it contained a CRLF character which caused the model to error when loading.
Miscellaneous changes
-
Corrected text to show that Miter bends have an angle limitation of 0-90 degrees.
-
Fixed a case where Pipe data would not copy Heat Transfer data to non-Heat Transfer pipe.
Changes that may affect engineering conclusions
-
Fixed issue where frequency graphs and API-618 and API-674 checks were reporting or using the regular amplitude instead of the peak-to-peak amplitude (double the amplitude).
-
Fixed a problem where a spray in a section of piping that is closed by another junction (like a valve) would not propagate the ambient pressure into the closed pipes which would give "No Solution" and lead to a error about a Stagnate Region.
-
Fixed an issue with units in API 618 Pulsation Summary text when using metric units.
-
Changed the K factor calculation for junctions that use a Cd (like an Orifice) or Cv (like a Valve) when the flow is reversed though the junction. This will bring the flow and losses more inline with the same junction with flow in the positive direction.
-
Fixed a problem with reporting Sonic Area and Mach Number Restriction if the flow is reversed through a junction like a valve.
-
There were a number of issues exporting the Transient Max/Min table to Excel that were fixed. One of them related to incorrect unit conversions for Superheat Temperature in the Detailed Max/Min tables when exported to Excel.
-
Fixed issue where Valve Reynolds Number and xT Valve Summary parameters were not reporting correctly for control valves.
-
Fixed an issue where a Color Map defined with the "Show Value on Workspace Label" option could format the value incorrectly in the object's label.
Important non-engineering changes
-
Fixed an issue that caused Minimum Transient Pipe Parameters in Layers to not be read in from the model file.
-
Fixed an error that caused the Paste command to be disabled in contexts where it should have been enabled.
-
Fixed issue when exporting file without raw pump data to EPA file.
-
Fixed an error with Multi-Profile plots with a Common Pipe where the offset to align the plots was not being added.
-
Fixed issue when changing pipe label color in User Options.
-
Removed "Troubleshooting" buttons.
-
Improved Global Pipe Edit Roughness application when destination pipe has no material set.
-
The Forces button on the Output Control window was not displaying. The Forces report in the Output Window was still displaying, but could not be customized as the button was hidden.
-
Fixed issue with grid formatting when exporting force files.
-
Graph Results: Fixed Default line style being set to Dash instead of Solid when clicked.
-
Graph Results: Improved Multi-Scenario Profile Animation visualization and clarity when Scenario Simulation Durations do not match.
-
Fixed issue where double-clicking Annotations in Layers Setup would not load that Annotation's properties.
-
Added user option to prevent automatic snap to grid when isometric pipe drawing mode is activated.
-
Made it so that deleting a scenario will remove that scenario from saved Graph List Items.
-
Fixed issue with printing output in landscape format.
-
Fixed issue when renaming fluid groups.
-
Auto-rotating area changes and check valves will now automatically adjust icons to align with the flow direction and size changes at these junctions.
-
Added missing descriptions for advanced parameters and removed Disable Enthalpy Match Logic option.
-
Fixed issue with junction icons being reset after auto rotation.
Miscellaneous changes
-
Fixed an issue where "Compressor/Fan Summary Parameters" in Workspace Layers was displaying as "Pump Summary Parameters"
-
Added ellipsis to Join Pipes/Junctions menu command.
-
Use of Common Junction Global Edit could fail upon initializing the common junction.
Changes that may affect engineering conclusions
-
Fixed an issue with the optional sonic CdA for venturis, screens, and valves that prevented sonic choking and prevented loading saved valve sonic CdA values.
-
Fixed several issues with exporting Transient Max/Min tables to Excel.
-
Fixed an issue that caused Pump Vs. System Efficiency curve values to plot at the Minimum Speed rather than the Speed defined in the Pump Curve Configuration Form, when that Minimum Speed curve was included in the plot.
-
Fixed a minor issue where changing a pipe or junction's Name or Number would not immediately reflect on the Workspace until another display-altering action was taken.
Important non-engineering changes
-
Zooming Workspace with Mouse Wheel no longer requires Left-Clicking Workspace first immediately after Panning with the Middle Mouse Button.
-
Fixed an issue where the Auto Save feature could start saving in the middle of a run, causing Output to be unavailable once the simulation completes.
-
Increased the speed of reading an imported CSV force set file by a factor of 3 to 4.
-
Fixed an issue where PCF models with objects that have very large (in the billions or larger) X, Y, or Z coordinate values could cause an arithmetic overflow exception during import.
-
Fixed an issue where using the Merge feature would cause merged objects to be invisible on all Layers initially, and could not be made visible on the All Objects Layer.
-
Fixed an issue where deleting the highest number junction would cause the next junction dragged onto the Workspace to duplicate Layer styling from that deleted junction.
-
Fixed an issue where Line type Annotations were being drawn in an incorrect location if the current Workspace view was not at the very top-left of the diagram.
-
Fixed issues with printing large models.
-
Movements to the Annotation Line will now be captured in Undo.
-
Added the capability to resize the background image in individual scenarios.
Miscellaneous changes
-
Graph Results: removed the colored border when Copying Graph as Image.
-
Fixed a visual error that caused Annotation Selection Handles to remain after a new model was loaded while Annotation was selected.
-
Fixed an issue that could cause incorrect screenshot bounds for animated graphs when using the Copy Graph Data button.
-
Model Data Junction grid scroll position no longer resets after opening Junction Property Window by double-clicking the grid.
-
Improved Workspace Search function user experience.
-
Select Shortest Paths will now ask to try the opposite direction if the first ordered junction pair fails to find a path in the given flow direction.
-
Fixed a minor bug where Scenario Comparison grid would be re-evaluated on closing the Scenario Comparison Tool, if the Difference Visibility Mode had been changed since entering the tool.
-
Added logic to prompt model save for more actions involving annotation edits.
-
Fixed issue with missing images in xStream Transient Solver Initialization tab of Output Control.
-
Removed AFT Notifications links from Startup Form and Help Menu. Notifications are now automatically dispatched to license holder.
Changes that may affect engineering conclusions
-
For very low flows or pressure drops, the Cv/xT calculation could have a large relative error. Added the ability to tighten the tolerance for Cv/xT calculations to Advanced Parameters to account for this rare occurrence.
Important non-engineering changes
-
Fixed issue when closing Print Preview.
-
Valves with a loss model of Resistance Curve caused the transient solver to halt - this has been corrected. Additionally, it was possible to select Exit Valve in combination with Resistance Curve, which is not supported - this selection is no longer possible.
-
Fixed error when using "Load All User Defaults" in User Options.
-
Fixed an issue with automatic conversions when selecting units for valve equivalent lengths.
-
Fixed issues with printing large models.
-
Fixed a problem where a user created fluid without vapor pressure would repeatedly ask to be updated.
-
Fixed a problem where when the advanced option to bypass the AFT Arrow Steady solver was selected and the model was run in Steady-State mode, the solver would not run and there would be an error displaying the output.
-
Added the capability to resize the background image in individual scenarios.
-
Fixed an issue where hitting the Escape key after drawing a pipe in multi-pipe drawing mode over a rectangular Annotation would cause that Annotation to be removed.
-
Fixed issue with unexpected errors when using workspace search bar.
-
Fixed an issue where copy-pasting multiple Annotations could include previous Workspace locations in the Paste Preview incorrectly.
-
Fixed issue where closed graph icons would display incorrect colors in graph list.
Miscellaneous changes
-
Model files which had been saved with at least one annotation, in which at least one of those annotations that had been previously saved was later deleted, after which the model was saved again, and model reopened would cause an error for each of the deleted annotations while reading the model file.
-
Fixed an issue that caused the 'Show Full Scenario Path' checkbox in Graph Results legend formatting not to take effect when the graph had not yet been added as a Graph List Item.
-
Updated text in license expiration message.
-
Fixed a graph scaling issue with Not a Number results (such as infinite K factor for zero loss).
-
Fixed issue where Library Manager form would collapse upon closing the Edit Cost Library form.
-
Added parameters to Excel Import Workbook.
-
Fixed issue where graph formatting flyout would close when resizing the application.
Changes that affect engineering conclusions
-
Fixed an issue where ASME Steam, Chempak, or REFPROP fluids would not appropriately use "High Accuracy" Gamma. This generally has negligible impact, but in some cases - especially near a fluid's critical point or at extreme supercritical conditions - results could be substantially affected, and/or the transient results could be unstable/unrealistic.
-
Fixed a problem displaying Standard or Normal unit types in the Heat Exchanger, Valve and Tank summary tables. These could be using an incorrect STP density if there are multiple fluids used.
Other changes
-
Fixed an issue where splitting a ZLC pipe would cause an elevation of NaN to be calculated for the new junction. This could cause an overflow exception when manipulating workspace objects later on.
-
Fixed issue where "Other" Export Type in the Excel Export Manager displayed incorrect estimates for cells occupied. Fixed issue where "Library Sources" did not display the correct information.
-
Fixed an issue that caused Plot Formatting to load incorrectly for Multi-Scenario Graph List Items.
-
Added transient events for Tank Gas Mass and Tank Temperature.
-
Fixed an problem that would cause Annotation Text Alignment properties to not be retained when reloading Graph List Items.
-
Revised scaling in Fluid Library preview graphs.
-
Correct fluid list is now displayed when closing the edit fluids tab.
-
List headers now resize to fit the header even when there are no items in its column
-
Expanded the Pipe Material Library to include Specific Heat and Modulus of Elasticity.
-
Added bends as object type in xStream Import Workbook.
-
Added a check for valid geometries when importing fittings. User can no longer import fittings with geometries that are invalid for their respective category.
-
Fixed issue with focusing when user clicked into and out of filter text box in the Output Control form.
Changes that affect results
-
Fixed an issue where, for some model configurations, a finite tank set to Calculate From Steady-state would cause convergence failure.
-
Fixed a problem where the maximum and minimum forces were not reset between runs. This would result in these values being used from one scenario to the next and could give erroneously high forces for a given scenario.
Changes that affect interface
-
Limited the number of multi-scenario output to 250 scenarios to avoid file and display errors.
-
Improved visualization of Design Alerts when graphed in Profile plots.
-
Fixed an issue where pipes would not show in the Overview Map at close zoom levels.
-
Updated Printer Page Layout and Print Area Preview on the Workspace to have more clear behavior and options.
-
Added the capability to start a valve at 0% open when using the Characteristic data.
-
Fixed the time remaining estimate not being reasonable when starting from a checkpoint.
-
Fixed an issue that caused Undo to not operate correctly for Annotations.
-
Made it so that deleting a scenario will remove that scenario from saved Graph List Items.
-
Fixed an issue where resizing an annotation could sometimes cause a System.Collections.Generic.KeyNotFoundException.
-
Fixed an issue where changing the "Background Picture Scaling" value in User Options -> Workspace -> Other was not properly scaling the background image.
Other changes
-
Fixed a problem where the Valve Source was being reset to User Specified when the model or scenario was loaded.
Changes that affect results
-
Fixed an issue where User Library fluids would not report a warning if they dropped below their defined minimum temperature during a Run.
Changes that affect interface
-
Limited the number of multi-scenario output to 250 scenarios to avoid file and display errors.
-
Added junction numbers to the Edit->Select Shortest Path menu labels for clarity.
-
Fixed an issue where valves using the Resistance Curve loss model were improperly checking transient data when accepting changes in the Valve Properties window.
-
Removed liquid-type units from the Volumetric Flow Rate unit family.
-
Fixed being unable to cancel Batch Runs.
Other changes
-
Fixed an issue that caused just the first graph in stacked graph configurations to be saved to a file by using the File->Save Graph As... dialog.
Changes that affect results
-
Fixed issue where control valves set to Fully Open - Never Control in stagnant regions were not transferring the pressure from one stagnant pipe to the other.
-
Fixed issue where some loss information was inadvertently cleared (set to zero) when loading an xStream 2 model. Affected losses were: (1) General Component K Factor, (2) Heat Exchanger K Factor, (3) Screen K Factor, (4) Venturi K Factor, (5) Venturi Cd.
-
Fixed issue where the Xt reported for a control valve with a Cv and Xt vs Open Percent table was always the full open Xt.
-
Fixed Transient Solver Initialization > Advanced Settings values being of unreasonable magnitude when unit system was set to Metric Only.
-
Fixed issue where an internal transient solver failure could cause another error that crashed the application. Now, these types of errors will fail to converge as expected and delete the output without additional failures.
-
Fixed issue that was preventing Local Iteration error messages from showing as Warning messages for Steady State runs.
Changes that affect interface
-
Fixed issue where User Default font settings in Global Layer Settings were not being saved or loaded properly in languages where a comma is used as the decimal mark.
-
Added more robust error handling for file manipulation errors commonly encountered in Library Browser.
-
Fixed issue that caused recorded animations to not prompt for a save location.
-
Made error reporting improvements in Graph Results Multi-Scenario graphs.
-
Fixed issue with copy+pasting Annotations with lines shown not displaying properly in the Paste Preview or after pasting.
-
Added import of junction image sizes and pipe thickness to Workspace Layers Import.
-
Improved performance when a large number of objects are deleted from the workspace or bulk modified in Analysis Setup.
-
Fixed issue where valves using the "From Characteristic" Loss Source with Open Percentage transients would force the first transient data point to be 100% open.
-
Fixed issue that caused Layer Label Control Parameter Lists to load incorrectly while using certain language translation files.
-
Fixed issue with EPAnet export that caused models with Exit Relief Valves to fail the export.
-
Fixed issue that caused Select Working Fluid in the Startup Form to fail when a Chempak fluid was selected.
-
Fixed issue during a batch run where the results would not be saved to a text file when this option was selected.
-
The frame on the Pipe Properties window, Optional tab, for the number of parallel pipes was being hidden by other controls. Moved the frame so it can be seen.
-
Fixed a problem where the valve K factor or resistance curves would not be retained when the model/scenario was reloaded.
-
Profile Plot titles will now display the first and last pipe numbers of the selected path, rather than the lowest and highest overall pipe numbers.
-
Fixed a problem when morphing a Valve into a Relief Valve where the Loss Type would be in and unknown state.
Other changes
-
Fixed a problem causing the Warning and Design Alerts to not be exported when using the Preformatted option.
-
Updates the descriptor for Stainless Steel Tubing, 1-3/4 from 14 BWG to 16 BWG to match wall thickness value. This would not change the engineering data but may cause some pipes to become undefined if models are using this.
-
Fixed an issue where changing Scenarios while the Recovery File or Auto-Save was running could cause corruption of some model/object data
-
Removed the prompt to convert older models and make a backup. This caused the output files to be renamed to .out.bak_X3 which caused the model to not report any valid output.