General Statistics

From SysCAD Documentation
Jump to navigation Jump to search

Navigation: Models ➔ Statistical Models ➔ General Statistics

Flow Statistics General Statistics

Introduction

This model is for Dynamic simulation only.

  • The General Statistics unit operation can be used to collect statistical information of a selected variable, when copying the variable tag, please use "Copy Full Tag".
For example:
  1. species or elemental flowrate of material flowing through a pipe. - P_021.Qo.QM.Ca[OH]2(s) (t/h)
  2. species or elemental concentration flowing through a pipe or inside the a tank. - P_012.Qo.Cnc.CaSO4(aq) (g/L)
  3. level of a tank - PROCESS_WATER_TANK.Lvl (%)
  4. other properties such as T, P, density etc - P_008.Qo.T (C)
  • For total mass flow, volumetric flow or total phase mass flow variables, use the Flow Statistics model.
  • The General Statistics can be reset at Startup by selecting the Statistics tick box on the SysCAD Commands View | Solver Settings - Scenario Tab.

NOTE: User can also use the built in Statistics block in a Tank to collect Level information.

Data Sections

The default sections and variable names are described in detail in the following tables. The default General Statistics access window consists of 3 sections. This number may increase or decrease, based on user configuration.

Summary of Data Sections

  1. GeneralStats tab - Contains general information relating to the unit as well as a summary table of each individual statistical blocks.
  2. S1 tab - The General Statistics blocks will be displayed here.
  3. Info tab - Contains general settings for the unit and allows the user to include documentation about the unit and create Hyperlinks to external documents.

General Statistics Page

Unit Type: GeneralStats - The first tab page in the access window will have this name.

Tag (Long/Short) Input / Calc 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 Tick box Enable or disable all of the independent General Stats Blocks.
The following message and field is visible when upgrading the project with existing General Stat Blocks from SysCAD 9.2 (or earlier) to SysCAD 9.3.
Change numbering to start from 1 instead of 0.
ChangeNumbering Button Update Numbering to Start from 1 instead of 0. Only visible if the General Stat Blocks was added in SysCAD 9.2 or earlier version.
NB: this may affect external tag references such as reports, PGM, please adjust the external references appropriately if updating the numbering.
Count Input The number of independent Statistics blocks required. This may be any number from 1 upwards.
Actions
ResetAll Button Resets all the data collected in the model.
Options
ShowCnv Tick Box With this option selected, SysCAD will display engineering units for the Output tag. Note that these will only be displayed after SysCAD has completed at least one iteration.
ShowOnePerPage Tick Box With this option selected, SysCAD will display each Statistic block per tab page. If not selected, each page displays four Statistic blocks.
CheckTags Button SysCAD will perform a check on the validity of the tags used.
 
Summary This shows a summary table with the following values for each individual Stats block in the unit.
Sx Display The General Stats block number
Time Display The elapsed time.
Total Display The accumulative total value. Note: this is only meaningful for some variables.
Average / Avg Display The average stats over total time (including zero value time).
MeasTag Display The measured Stats tag.
TimeZero Display The total time where the unit has no value.
OnAverage / OnAvg Display The average Stats over time where unit is on (excluding zero value time).

S1: Individual Statistic Data Fields

Statistic is displayed on the Sx pages.

  • If "ShowOnePerPage" is NOT selected, then each page displays four Statistic blocks.
  • If "ShowOnePerPage" is selected, then each page displays one Statistic block.
Tag (Long/Short) Input / Calc Description/Calculated Variables / Options
Each independent Statistics block has the following layout. If there is not enough space to display all blocks on the tab page, a second tab page will be created.
[Statistics Block number]
Name Input Optional description of the statistics block.
Index Display Only available in Build 137 or later. Statistic block index. Useful for sorting in reports
MeasTag Input This is the variable where statistics information will be collected. For Example:
  1. species or elemental flowrate of material flowing through a pipe. - P_021.Qo.QM.Ca[OH]2(s) (t/h)
  2. species or elemental concentration flowing through a pipe or inside the a tank. - P_012.Qo.Cnc.CaSO4(aq) (g/L)
  3. level of a tank - PROCESS_WATER_TANK.Lvl (%)
  4. other properties such as T, P, density etc - P_002.To (C)
ResetStats Button Resets the Statistics information.
Time Calc Time elapsed.
Meas Calc The current measured value.
Total Calc The accumulative total value.
Total = previous total + (dT * measured value), where the measure value is in units specified in the StatTag.
Note: this is only meaningful for some variables.
Average / Avg Calc The average value over total time. Average = total / time.

Note: Tick the "ShowCnv" option on the "GeneralStats" tab to see the engineering units used.

TimeZero Calc The total time where the unit has zero-value.
TimeInvalid Calc The total time where the unit has a value which is not a number (NAN) (shown as '*').
OnAverage / OnAvg Calc The average value over total Time (excluding zero value time).
Min Calc The Minimum value collected over time.
Max Calc The Maximum value collected over time.
Delete Button This allows the user to Delete the current individual Control block. Please note that there is no 'Undo'!
MoveUp Button This allows the user to increase the Priority of the current individual Control block. For example, if the current Control block is number 3, the user can change it to 2 or 1 by clicking on this button once or twice.
MoveDown Button This allows the user to decrease the Priority of the current individual Control block. For example, if there are 3 Control blocks in the unit and the current Control block is number 1, the user can change it to 2 or 3 by clicking on this button once or twice.

Adding this Model to a Project

Insert into Configuration file

Sort either by DLL or Group.

  DLL:
ControlDyn.dll
Units/Links Statistics: General
or Group:
General
Units/Links Statistics: General

See Model Selection for more information on adding models to the configuration file.


Insert into Project

  Insert Unit Statistics General

See Insert Unit for general information on inserting units.