Stream Analyser

From Met Dynamics
Revision as of 14:49, 17 September 2026 by Maintenance script (talk | contribs) (Migrate protected Model Theory content)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Description

The Stream Analyser is a SysCAD Control model used to analyse existing material streams and report Composition by Size, Recovery, and Circulating Load results.

The Stream Analyser does not require material stream connections. Instead, each calculation references existing material streams elsewhere in the flowsheet by stream tag. The selected streams are read for calculation purposes only and are not modified by the model.

Model theory

Nuvola apps important blue.svg.png This content is available to registered users. Please log in to view.

Composition by Size

Recovery

Circulating Load

SysCAD

The sections and variable names used in the SysCAD interface are described in detail in the following tables.

MD_StreamAnalyser page

The first tab page in the access window will have this name.

Tag (Long/Short) Input / Display Description/Calculated Variables/Options
Tag Display This name tag may be modified with the change tag option.
Condition Display OK if no errors/warnings, otherwise lists errors/warnings.
ConditionCount Display The current number of errors/warnings. If condition is OK, returns 0.
GeneralDescription / GenDesc Display This is an automatically generated description for the unit. If the user has entered text in the 'EqpDesc' field on the Info tab (see below), this will be displayed here.

If this field is blank, then SysCAD will display the unit class ID.

Requirements
On CheckBox Enables the Stream Analyser. If this box is not checked, all calculation pages display an Off Status and no results are calculated.
CalcCount Input Number of calculation pages. A value from 0 to 16 may be specified. Pages are named Calc1 to Calc16.

Calc1 to Calc16 pages

One calculation page is displayed for each page selected with CalcCount. Each page is configured independently. The fields and result structures displayed depend on the selected Type.

Status messages containing the abbreviation PSD reproduce the wording displayed by SysCAD; in these messages, PSD means particle size distribution. Numbered Status messages below use representative source-field numbers; SysCAD displays the numbers of the fields that caused the message.

Tag (Long/Short) Input / Display Description/Calculated Variables/Options
Calculation
On CheckBox Enables the calculation. The Stream Analyser On field must also be checked.
Name Input Optional user-defined name displayed in the Summary table.
Type Composition by Size Displays composition, distribution by size, and stream contribution results for one selected stream.
Recovery Calculates recovery from one or more Feed streams to one or more Concentrate streams.
Circulating Load Calculates the ratio of one Circulating stream to one Reference stream.
StreamTag Input Only visible when Composition by Size is selected. Tag of the stream to be analysed.
FeedTag1, FeedTag2, ... Input
  • Only visible when Recovery is selected.
  • Tags of the streams included in the combined Feed source group.
  • At least one FeedTag is required. Additional fields appear progressively, up to FeedTag32.
ConcentrateTag1, ConcentrateTag2, ... Input
  • Only visible when Recovery is selected.
  • Tags of the streams included in the combined Concentrate source group.
  • At least one ConcentrateTag is required. Additional fields appear progressively, up to ConcentrateTag32.
ReferenceTag Input Only visible when Circulating Load is selected. Tag of the Reference stream used as the denominator of the circulating-load ratio.
CirculatingTag Input Only visible when Circulating Load is selected. Tag of the Circulating stream used as the numerator of the circulating-load ratio.
CalcWhen OnDemand
  • Uses current stream values.
  • Composition by Size values are calculated when requested.
  • Recovery and Circulating Load result tables are refreshed during a Solve.
OnStop Calculates once when a Solve stops.
Manual Calculates only when the Calculate button is pressed.
Calculate Button Only visible when Manual is selected. Calculates results using the current source stream values when both the Stream Analyser and the calculation page are enabled.
Status Off The Stream Analyser or calculation page is disabled. Check both On fields to enable the calculation.
OK The source configuration is valid and the current results are available, or can be calculated on demand. No corrective action is required.
Solve to Calculate The OnDemand Recovery or Circulating Load results have not yet been refreshed. Solve the project.
Solve and Stop to Calculate The calculation uses OnStop timing and has not yet been calculated. Solve the project and then stop the solver.
Press Calculate The calculation uses Manual timing and has not yet been calculated. Press the Calculate button.
StreamTag Required No StreamTag is entered for a Composition by Size calculation. Enter a source stream tag.
ReferenceTag Required No ReferenceTag is entered for a Circulating Load calculation. Enter the Reference stream tag.
CirculatingTag Required No CirculatingTag is entered for a Circulating Load calculation. Enter the Circulating stream tag.
Enter at least one FeedTag No Feed stream is selected for a Recovery calculation. Enter at least one FeedTag.
Enter at least one ConcentrateTag No Concentrate stream is selected for a Recovery calculation. Enter at least one ConcentrateTag.
StreamTag: Enter valid stream tag The StreamTag does not resolve to a valid SysCAD stream. Correct or replace the tag.
ReferenceTag: Enter valid stream tag The ReferenceTag does not resolve to a valid SysCAD stream. Correct or replace the tag.
CirculatingTag: Enter valid stream tag The CirculatingTag does not resolve to a valid SysCAD stream. Correct or replace the tag.
FeedTag2: Enter valid stream tag The numbered FeedTag does not resolve to a valid SysCAD stream. Correct or replace the tag.
ConcentrateTag1: Enter valid stream tag The numbered ConcentrateTag does not resolve to a valid SysCAD stream. Correct or replace the tag.
StreamTag: Select valid PSD stream The selected stream does not contain a valid particle size distribution. Select a stream with valid particle size distribution data.
ReferenceTag: Select valid PSD stream The selected Reference stream does not contain a valid particle size distribution. Select a stream with valid particle size distribution data.
CirculatingTag: Select valid PSD stream The selected Circulating stream does not contain a valid particle size distribution. Select a stream with valid particle size distribution data.
FeedTag2: Select valid PSD stream The numbered Feed stream does not contain a valid particle size distribution. Select a stream with valid particle size distribution data.
ConcentrateTag1: Select valid PSD stream The numbered Concentrate stream does not contain a valid particle size distribution. Select a stream with valid particle size distribution data.
FeedTag2 duplicates FeedTag1 The same stream is entered more than once in the Feed source group. Remove or replace one duplicate tag.
ConcentrateTag2 duplicates ConcentrateTag1 The same stream is entered more than once in the Concentrate source group. Remove or replace one duplicate tag.
ConcentrateTag1 also used as FeedTag1 The same stream is used in both Recovery source groups. Select distinct Feed and Concentrate streams.
FeedTag2: PSD must match FeedTag1 The numbered Feed stream uses a different particle size distribution from the first valid Feed stream. Select a stream with the same particle size distribution definition.
ConcentrateTag1: PSD must match FeedTag1 The numbered Concentrate stream uses a different particle size distribution from the first valid Feed stream. Select a stream with the same particle size distribution definition.
CirculatingTag: PSD must match ReferenceTag The Circulating and Reference streams use different particle size distributions. Select streams with the same particle size distribution definition.
Check source tags: Concentrate exceeds Feed The combined Concentrate mass exceeds the combined Feed mass for at least one solid species and size interval. Correct the source selection or the upstream mass balance.
Composition Size Calculation Unavailable The Composition by Size result table is not configured for the particle size distribution of the current source. Stop the project, confirm the StreamTag, and reselect the source or calculation Type.
Recovery Calculation Unavailable The Recovery result table is not configured for the particle size distribution of the current source. Stop the project, confirm all source tags use the same particle size distribution, and reselect a source or the calculation Type.
Circulating Load Calculation Unavailable The Circulating Load result table is not configured for the particle size distribution of the current source. Stop the project, confirm both source tags use the same particle size distribution, and reselect a source or the calculation Type.
Composition Size Calculation Failed The Composition by Size results could not be completed. Check the source stream values and particle size distribution configuration, then reconfigure and recalculate. Report the issue if it persists with valid source data.
Recovery Calculation Failed The Recovery results could not be completed. Check the source stream values and particle size distribution configuration, then reconfigure and recalculate. Report the issue if it persists with valid source data.
Circulating Load Calculation Failed The Circulating Load results could not be completed. Check the source stream values and particle size distribution configuration, then reconfigure and recalculate. Report the issue if it persists with valid source data.
Distribution
Name Display Shows the name of the SysCAD Size Distribution (PSD) quality associated with the feed stream.
IntervalCount Display Shows the number of size intervals in the SysCAD Size Distribution (PSD) quality associated with the feed stream.
SpWithPSDCount Display Shows the number of species in the feed stream assigned with the SysCAD Size Distribution (PSD) quality.
CSz
Property Composition Displays the mass fraction of each species, component, element, or individual phase within each size interval. The All row displays the overall composition over all size intervals.
Distribution by Size Displays the fraction of each constituent's total mass that occurs in each size interval. The All column displays the distribution by size of all solids with a particle size distribution property in the selected stream.
Stream Contribution Displays each constituent and size interval mass as a fraction of the total mass of all solids with a particle size distribution property in the selected stream.
Comp
Size Display Size of each interval in the mesh series.
All (All column) Display Total composition of all solids with a particle size distribution property in each size interval. The result is 100% when the interval contains solids with a particle size distribution property and 0 when it does not.
Comp Display Mass fraction of each solid species with a particle size distribution property within each size interval.
All (All row, All column) Display Total composition of all solids with a particle size distribution property over all size intervals. The result is 100% when the selected stream contains solids with a particle size distribution property and 0 when it does not.
All (All row, per species) Display Overall mass fraction of each solid species with a particle size distribution property in the selected stream for all size intervals.
CmpComp
Components
ButtonHideComponents.png
ButtonShowComponents.png
Hides or shows the component composition table.
Size Display Size of each interval in the mesh series.
All (All column) Display Total composition of all solids with a particle size distribution property in each size interval. The result is 100% when the interval contains solids with a particle size distribution property and 0 when it does not.
CmpComp Display Mass fraction of each displayed solid component within each size interval.
All (All row, All column) Display Total composition of all solids with a particle size distribution property over all size intervals.
All (All row, per component) Display Overall mass fraction of each displayed solid component in the selected stream over all size intervals.
EleComp
Elements
ButtonHideElements.png
ButtonShowElements.png
Hides or shows the element composition table.
Size Display Size of each interval in the mesh series.
All (All column) Display Total composition of all solids with a particle size distribution property in each size interval. The result is 100% when the interval contains solids with a particle size distribution property and 0 when it does not.
EleComp Display Mass fraction of each displayed element within each size interval.
All (All row, All column) Display Total composition of all solids with a particle size distribution property over all size intervals.
All (All row, per element) Display Overall mass fraction of each displayed element in the selected stream over all size intervals.
IPhComp
IPhases
ButtonHideIPhases.png
ButtonShowIPhases.png
Hides or shows the individual phase composition table.
Size Display Size of each interval in the mesh series.
All (All column) Display Total composition of all solids with a particle size distribution property in each size interval. The result is 100% when the interval contains solids with a particle size distribution property and 0 when it does not.
IPhComp Display Mass fraction of each displayed individual phase within each size interval.
All (All row, All column) Display Total composition of all solids with a particle size distribution property over all size intervals.
All (All row, per individual phase) Display Overall mass fraction of each displayed individual phase in the selected stream over all size intervals.
Dist
Size Display Size of each interval in the mesh series.
All (All column) Display Fraction of the total mass of all solids with a particle size distribution property in the selected stream that occurs in each size interval.
Dist Display Fraction of the total mass of each solid species with a particle size distribution property that occurs in each size interval.
All (All row, All column) Display Total distribution by size of all solids with a particle size distribution property. The result is 100% when the selected stream contains solids with a particle size distribution property and 0 when it does not.
All (All row, per species) Display Total distribution by size of each solid species with a particle size distribution property. The result is 100% when that species is present and 0 when it is not.
CmpDist
Components
ButtonHideComponents.png
ButtonShowComponents.png
Hides or shows the component distribution-by-size table.
Size Display Size of each interval in the mesh series.
All (All column) Display Fraction of the total mass of all solids with a particle size distribution property in the selected stream that occurs in each size interval.
CmpDist Display Fraction of each displayed solid component's total mass that occurs in each size interval.
All (All row, All column) Display Total distribution by size of all solids with a particle size distribution property.
All (All row, per component) Display Total distribution by size of each displayed solid component. The result is 100% when that component is present and 0 when it is not.
EleDist
Elements
ButtonHideElements.png
ButtonShowElements.png
Hides or shows the element distribution-by-size table.
Size Display Size of each interval in the mesh series.
All (All column) Display Fraction of the total mass of all solids with a particle size distribution property in the selected stream that occurs in each size interval.
EleDist Display Fraction of each displayed element's total mass that occurs in each size interval.
All (All row, All column) Display Total distribution by size of all solids with a particle size distribution property.
All (All row, per element) Display Total distribution by size of each displayed element. The result is 100% when that element is present and 0 when it is not.
IPhDist
IPhases
ButtonHideIPhases.png
ButtonShowIPhases.png
Hides or shows the individual phase distribution-by-size table.
Size Display Size of each interval in the mesh series.
All (All column) Display Fraction of the total mass of all solids with a particle size distribution property in the selected stream that occurs in each size interval.
IPhDist Display Fraction of each displayed individual phase's total mass that occurs in each size interval.
All (All row, All column) Display Total distribution by size of all solids with a particle size distribution property.
All (All row, per individual phase) Display Total distribution by size of each displayed individual phase. The result is 100% when that individual phase is present and 0 when it is not.
Contr
Size Display Size of each interval in the mesh series.
All (All column) Display Fraction of the total mass of all solids with a particle size distribution property in the selected stream that occurs in each size interval.
Contr Display Stream Contribution of each solid species with a particle size distribution property and size interval to the total mass of all solids with a particle size distribution property in the selected stream.
All (All row, All column) Display Total stream contribution of all solids with a particle size distribution property. The result is 100% when the selected stream contains solids with a particle size distribution property and 0 when it does not.
All (All row, per species) Display Overall stream contribution of each solid species with a particle size distribution property for all size intervals.
CmpContr
Components
ButtonHideComponents.png
ButtonShowComponents.png
Hides or shows the component stream contribution table.
Size Display Size of each interval in the mesh series.
All (All column) Display Fraction of the total mass of all solids with a particle size distribution property in the selected stream that occurs in each size interval.
CmpContr Display Stream Contribution of each displayed solid component and size interval to the total mass of all solids with a particle size distribution property in the selected stream.
All (All row, All column) Display Total stream contribution of all solids with a particle size distribution property.
All (All row, per component) Display Overall stream contribution of each displayed solid component for all size intervals.
EleContr
Elements
ButtonHideElements.png
ButtonShowElements.png
Hides or shows the element stream contribution table.
Size Display Size of each interval in the mesh series.
All (All column) Display Fraction of the total mass of all solids with a particle size distribution property in the selected stream that occurs in each size interval.
EleContr Display Stream Contribution of each displayed element and size interval to the total mass of all solids with a particle size distribution property in the selected stream.
All (All row, All column) Display Total stream contribution of all solids with a particle size distribution property.
All (All row, per element) Display Overall stream contribution of each displayed element for all size intervals.
IPhContr
IPhases
ButtonHideIPhases.png
ButtonShowIPhases.png
Hides or shows the individual phase stream contribution table.
Size Display Size of each interval in the mesh series.
All (All column) Display Fraction of the total mass of all solids with a particle size distribution property in the selected stream that occurs in each size interval.
IPhContr Display Stream Contribution of each displayed individual phase and size interval to the total mass of all solids with a particle size distribution property in the selected stream.
All (All row, All column) Display Total stream contribution of all solids with a particle size distribution property.
All (All row, per individual phase) Display Overall stream contribution of each displayed individual phase for all size intervals.
Distribution
Name Display Shows the name of the SysCAD Size Distribution (PSD) quality associated with the feed stream.
IntervalCount Display Shows the number of size intervals in the SysCAD Size Distribution (PSD) quality associated with the feed stream.
SpWithPSDCount Display Shows the number of species in the feed stream assigned with the SysCAD Size Distribution (PSD) quality.
Recovery
Density Display Density of each solid species with a particle size distribution property.
Size Display Size of each interval in the mesh series.
MeanSize Display Geometric mean size of each interval in the mesh series.
All (All column) Display
  • Calculated recovery of all solids with a particle size distribution property for each size interval.
  • The result is the total mass in the combined Concentrate streams divided by the total mass in the combined Feed streams for the interval.
Recovery Display Calculated recovery of each solid species with a particle size distribution property for each size interval.
All (All row, All column) Display Overall recovery of all solids with a particle size distribution property for all size intervals.
All (All row, per species) Display Overall recovery of each solid species with a particle size distribution property for all size intervals.
CmpRecovery
Components
ButtonHideComponents.png
ButtonShowComponents.png
Hides or shows the component recovery table.
Size Display Size of each interval in the mesh series.
MeanSize Display Geometric mean size of each interval in the mesh series.
All (All column) Display Calculated recovery of all solid components represented in the table for each size interval.
CmpRecovery Display Calculated recovery of each displayed solid component for each size interval.
All (All row, All column) Display Overall recovery of all solid components represented in the table for all size intervals.
All (All row, per component) Display Overall recovery of each displayed solid component over all size intervals.
EleRecovery
Elements
ButtonHideElements.png
ButtonShowElements.png
Hides or shows the element recovery table.
Size Display Size of each interval in the mesh series.
MeanSize Display Geometric mean size of each interval in the mesh series.
All (All column) Display Calculated recovery of all elements represented in the table for each size interval.
EleRecovery Display Calculated recovery of each displayed element for each size interval.
All (All row, All column) Display Overall recovery of all elements represented in the table over all size intervals.
All (All row, per element) Display Overall recovery of each displayed element over all size intervals.
IPhRecovery
IPhases
ButtonHideIPhases.png
ButtonShowIPhases.png
Hides or shows the individual phase recovery table.
Size Display Size of each interval in the mesh series.
MeanSize Display Geometric mean size of each interval in the mesh series.
All (All column) Display Calculated recovery of all individual phases represented in the table for each size interval.
IPhRecovery Display Calculated recovery of each displayed individual phase for each size interval.
All (All row, All column) Display Overall recovery of all individual phases represented in the table for all size intervals.
All (All row, per individual phase) Display Overall recovery of each displayed individual phase over all size intervals.
Distribution
Name Display Shows the name of the SysCAD Size Distribution (PSD) quality associated with the feed stream.
IntervalCount Display Shows the number of size intervals in the SysCAD Size Distribution (PSD) quality associated with the feed stream.
SpWithPSDCount Display Shows the number of species in the feed stream assigned with the SysCAD Size Distribution (PSD) quality.
CircLoadRatio
Density Display Density of each solid species with a particle size distribution property.
Size Display Size of each interval in the mesh series.
MeanSize Display Geometric mean size of each interval in the mesh series.
All (All column) Display
  • Calculated circulating load of all solids with a particle size distribution property for each size interval.
  • The result is the total mass in the Circulating stream divided by the total mass in the Reference stream for the interval.
CircLoadRatio Display Calculated circulating load of each solid species with a particle size distribution property for each size interval.
All (All row, All column) Display Overall circulating load of all solids with a particle size distribution property for all size intervals.
All (All row, per species) Display Overall circulating load of each solid species with a particle size distribution property for all size intervals.
CmpCircLoadRatio
Components
ButtonHideComponents.png
ButtonShowComponents.png
Hides or shows the component circulating load table.
Size Display Size of each interval in the mesh series.
MeanSize Display Geometric mean size of each interval in the mesh series.
All (All column) Display Calculated circulating load of all solid components represented in the table for each size interval.
CmpCircLoadRatio Display Calculated circulating load of each displayed solid component for each size interval.
All (All row, All column) Display Overall circulating load of all solid components represented in the table for all size intervals.
All (All row, per component) Display Overall circulating load of each displayed solid component over all size intervals.
EleCircLoadRatio
Elements
ButtonHideElements.png
ButtonShowElements.png
Hides or shows the element circulating load table.
Size Display Size of each interval in the mesh series.
MeanSize Display Geometric mean size of each interval in the mesh series.
All (All column) Display Calculated circulating load of all elements represented in the table for each size interval.
EleCircLoadRatio Display Calculated circulating load of each displayed element for each size interval.
All (All row, All column) Display Overall circulating load of all elements represented in the table over all size intervals.
All (All row, per element) Display Overall circulating load of each displayed element over all size intervals.
IPhCircLoadRatio
IPhases
ButtonHideIPhases.png
ButtonShowIPhases.png
Hides or shows the individual phase circulating load table.
Size Display Size of each interval in the mesh series.
MeanSize Display Geometric mean size of each interval in the mesh series.
All (All column) Display Calculated circulating load of all individual phases represented in the table for each size interval.
IPhCircLoadRatio Display Calculated circulating load of each displayed individual phase for each size interval.
All (All row, All column) Display Overall circulating load of all individual phases represented in the table for all size intervals.
All (All row, per individual phase) Display Overall circulating load of each displayed individual phase over all size intervals.

About page

This page is provides product and licensing information about the Met Dynamics Models SysCAD Add-On.

Tag (Long/Short) Input / Display Description/Calculated Variables/Options
About
HelpLink ButtonLicensingHelp.png Opens a link to the Installation and Licensing page using the system default web browser. Note: Internet access is required.
Information ButtonCopyToClipboard.png Copies Product and License information to the Windows clipboard.
Product
Name Display Met Dynamics software product name
Version Display Met Dynamics software product version number.
BuildDate Display Build date and time of the Met Dynamics Models SysCAD Add-On.
License
File ButtonBrowse.png This is used to locate a Met Dynamics software license file.
Location Display Type of Met Dynamics software license or file name and path of license file.
SiteCode Display Unique machine identifier for license authorisation.
ReqdAuth Display Authorisation level required, MD-SysCAD Full or MD-SysCAD Runtime.
Status Display License status, LICENSE_OK indicates a valid license, other messages report licensing errors.
IssuedTo Display Only visible if Met Dynamics license file is used. Name of organisation/seat the license is authorised to.
ExpiryDate Display Only visible if Met Dynamics license file is used. License expiry date.
DaysLeft Display Only visible if Met Dynamics license file is used. Days left before the license expires.

Additional notes

  • The model supports up to 16 calculation pages.
  • A Recovery calculation supports up to 32 Feed streams and 32 Concentrate streams. Additional source fields appear progressively as tags are entered.
  • Each Composition by Size table displays up to 48 constituent columns, in addition to the Size and All columns. The All results include all solid species with a particle size distribution property, including species not shown when the display limit is reached.
  • Only solid species with a particle size distribution property are included. Liquids and solid species without a particle size distribution property are excluded.
  • All streams used by a Recovery or Circulating Load calculation must use the same particle size distribution definition.
  • Clearing a Recovery source field compacts the remaining source tags toward the first field.
  • The Components, Elements, and IPhases show/hide controls apply globally to equivalent result grids.
  • Results calculated using OnStop or Manual remain available until a source tag, Type, or CalcWhen changes, or the results are recalculated.