View Commands in 9.1
From SysCAD Documentation
Navigation: User Guide -> Menu Commands -> View Commands
This section shows the View Commands in SysCAD 9.1. Refer to View Commands in 9.2 for SysCAD 9.2.
Contents |
Explorer
The Explorer window is very useful for carrying out a number of tasks:
- To toggle between flowsheets and trend windows within a project.
- To search for models in a project, as it contains a list of all models in a project sorted by Class (model type).
- It contains a search facility to enable users to search for a specific tag, similar to the Find Tag command.
- Users may copy a list of the units in the project, or in a flowsheet, to another application. They may copy all units or selected types of units, such as Pipes which makes it useful when setting up Excel reports.
- To Activate or De-activate flowsheets.
Please see Explorer Window for more details on the above functionality.
Project
Command Path View, Project
Please see the Project Window section for details on this dialogue box.
Message
Command Path View, Messages
This will open the Message Window.
Quick View
Command Path View, Quick View
The Quick View list is used to quickly access some unit model information from the Graphics Window. Each unit type has its own Quick View list. Some models may have default lists configured already. However, the user can customise these lists as described below. When the Quick View command is activated, it opens the Tag Lists dialog box.
To build a customised Quick View list, open the Access Window for the unit of interest. Select the variable(s) you want to add to the Quick View list using the left mouse button, then right click on the variable, choose Send to Quick View (F6). The selected variables will be added to the tag list window. While the Tag lists dialog box is opened, you may continue to add variables to the list. Keeping in mind that the model type selected matches the model opened (Access Window). When a variable has been added to the Quick View list, a small blue dot will appear to the left of the variable name in the Access Window.
Please NOTE that you may specify the maximum number of the quick view entries (global option, same for all unit operation types) by entering a value in the Max Value Length box. The default is 20.
Once variables are added to the Tag lists window, you may modify it in a number of ways. Left click on the variable's label name to select it, once selected, you may:
- Move it up or down the list to position the variables in the right order using the Move Up and Move Down buttons.
- Remove the variable from the list using the Remove button.
- Right click on the label to change the conversion units and formats of the number.
- Left click on the label to rename it.
When finished, close the Quick View List to save it.
When a Quick View list is configured, the user may view it from the graphics window. See Left Mouse Click On Graphics Symbol.
If the Save in Cfg option is checked, the Quick View information will be saved to a file called SCD_RTL.ini in the project group\cfgfiles folder. This way, the Quick View configurations can be shared between projects.
Plant Model
Command Path View, Plant Model
Right clicking on the Graphics Window background can also access this.
Opens the Plant Model Access Window.
FlwSolve Tab Page
| Tag / Symbol | Input / Calc | Description/Calculated Variables / Options |
| Common First Data Section | ||
| Commands | ||
| State | FeedBack | Current SysCAD solve state. |
| StateDes | FeedBack | Current SysCAD solve state Description. |
| Cmd.Start | Button | This is the same as menu option "Actions - Run State", pressing this button starts the SysCAD simulation. This button is here so that user can make use of the command from external packages, such as calling SysCAD Start (solve) from Excel or other Operator Interface. To get the command Right Click on the variable name and select Copy FullTag. |
| Cmd.Idle | Button | This is the same as menu option "Actions - Idle State", pressing this button pauses the SysCAD simulation. This button is here so that user can make use of the command from external packages, such as calling pausing SysCAD (solve) from Excel or other Operator Interface. To get the command Right Click on the variable name and select Copy FullTag. |
| Cmd.Stop | Button | This is the same as menu option "Actions - Stop State", pressing this button Stops the SysCAD simulation. This button is here so that user can make use of the command from external packages, such as calling SysCAD to Stop solving from Excel or other Operator Interface. To get the command Right Click on the variable name and select Copy FullTag. |
| SetStateAll | List | The options are: 1)ZeroFlows; 2)Empty; 3)Preset; 4)SteadyState; 5)PBInit; 6)DynStatsRunInit; 7)EmtySpillTargets. The explanations for these options can be found in the following fields. |
| Cmd.ZeroFlows | Button | This is used mainly in Dynamic simulations, it is the same as menu option "Actions - Zero All Flows", pressing this button empties all the streams (pipes) in the SysCAD simulation. User can use this command in PGM, Event file or from Excel. |
| Cmd.Empty | Button | This is used mainly in Dynamic simulations, it is the same as menu option "Actions - Empty All", pressing this button empties all the containers (eg. tanks, or anything that contains volume) in the SysCAD simulation. User can use this command in PGM, Event file or from Excel. |
| Cmd.Preset | Button | This is used mainly in Dynamic simulations, it is the same as menu option "Actions - Preset All ", pressing this button Presets all the containers (eg. tanks) in the SysCAD simulation. User can use this command in PGM, Event file or from Excel. |
| Cmd.SteadyState | Button | This is used mainly in Dynamic simulations, it is the same as menu option "Actions - Run to SteadyState". User can use this command in PGM, Event file or from Excel. |
| Cmd.PBInit | Button | It is the same option as given in the ProBal Setup - Options - Initialise. This option re-initialises the SysCAD solution and is used to clear previous BAD solutions from incorrect feed or unrealistic model configuration. Pressing this button will often force a fresh restart on the solved solution. User can use this command in PGM, Event file or from Excel. |
| Cmd.DynStatsRunInit | Button | This is used mainly in Dynamic simulations, it is the same option as given in the Dynamic Setup - options - Reset Statistics, pressing this button empties all the statistical information collected in the SysCAD simulation. User can use this command in PGM, Event file or from Excel. |
| Cmd.EmptySpillTargets | Button | This is used mainly in Dynamic simulations, it is the same option as given in the Dynamic Setup - options - Empty Spills, pressing this button empties all the spill information collected in the SysCAD simulation. User can use this command in PGM, Event file or from Excel. |
| Dyn.Time | FeedBack | Dynamic Simulation Time |
| Dyn.dTime | FeedBack | Dynamic Simulation delta time |
| Dyn.dTimeMax | Input | Dynamic Simulation Maximum delta time |
| Dyn.dTimeMin | Input | Dynamic Simulation Minimum delta time |
| Balance & Closure | ||
| TestMassTolerance | Input | |
| ClosureTests | List | Options are: 1) Off; 2) On; 3) On - Messages: any closure errors will be displayed in the messages portion of the message window. 3) On - Conditions: any closure errors will be displayed in the Conditions portion of the message window. The Closure Test Conditions are found in Menu Command View - Probal Configuration. |
| SpillReporting | List | This is for dynamic mode only. It is used for setting behaviour when a material spill occurs. |
| AuditLevel | List | This can be used to enable a full or partial display of mass and/or energy balance fields in all models. This is shown on the Audit tab page of every model and link. The solver must be started before the Audit tags and values are shown. |
| Options | ||
| StopOnError | This allows SysCAD to be stopped when serious errors are present; to eliminate time used on solving a project that is not correctly configured. The options are Yes or No. | |
| PGM_ExecuteTimeout | If the execution of the logic in a controller takes a long time, this is the time after which execution is terminated. It is designed to prevent logic that causes an endless loop from freezing SysCAD. If a timeout error occurs you should review the PGM logic. | |
| RandomSeedAtStart | ||
| MultiProcessing | ||
| NoOfProcessors | FeedBack | This shows the number of Processors available in the computing hardware. |
| NoOfSolveThreads | FeedBack | SysCAD is a multi-tasking (or multi-threaded) application. |
| NoOfSolveThreadsRqd | This tag allows control of Multiprocessor's: The options are: 0 : Use the NonThreaded Solver 1,2... : Use the Threaded Solver with N sets of worker threads -1 : Use NonThreaded Solver if 1 processor or 'M' sets of worker threads, where M is the number of processors if M>1 | |
| Direct IO Links | ||
| Default.Area | Input | The default Area Model to which any newly inserted models will belong to by default. This can be changed by the user for each individual model. |
| Default.MakeupSrc | Input | The default Makeup Source. Any newly inserted makeup blocks will have this as their source by default. This can be changed by the user for each individual Makeup Block (MU). |
| Default.BleedSnk | Input | The default bleed sink. Not currently implemented. |
| DIO.ConnectSpills | List | 1) None - No direct IO connection for spills/vents; 2) All - direct IO connection for spills/vents |
| DIO.ConnectLeaks | List | 1) None - No direct IO connection for Leaks; 2) All - direct IO connection for Leaks |
| DIO.ConnectAudit | List | 1) None - ; 2) All - |
Species tab page
| Species Database NOTE: these values can only be changed via the Edit Configuration command prior to loading of project. | ||
| NormT | Feedback information - Normal Temperature specified in the configuration file. Used when calculating normalised volume flow and normalised density, for example for display on stream pages. | |
| NormP | Feedback information - Normal Pressure specified in the configuration file.. Used when calculating normalised volume flow and normalised density. | |
| StdT | Feedback information - Standard Temperature. In SysCAD 9.2 this is 25C. In SysCAD 9.1 this could be specified by the user in the configuration file. | |
| StdP | Feedback information - Standard Pressure. In SysCAD 9.2 this is 101.325kPa. In SysCAD 9.1 this could be specified by the user in the configuration file. | |
| EnthalpyStrategy | This allows the user to choose the method used for heat balancing. The two available methods are: 1) Best_Temperature and 2) Conserve_Heat | |
| H2OProperties | This allows the user to choose the Steam/Water calculation method. The default if IF97H2O, which uses the industrial standard IAPWS-IF97. | |
| FunctionSurfaces | The steam/water properties are built into surface functions during the initial iteration. SysCAD then fetches steam/water properties from these functions (with linear interpolation between known points). The result is the solution is Faster but losses accuracy. | |
| SmoothSurfaces | Forces smooth surface functions. This is no longer used. | |
| SurfaceElements | ||
| IncludeSpcCnvs | ||
| ShowSpcRangeErrors | This option adds warning message to the unit operation if temperature range is outside of what is specified in the species database. For Example: if temperature NaCl(aq) in the species data base is only from 25C to 100C, but the operating temperature is 200, then it is marked temperature out of range. | |
| ShowSpcXRangeErrors | This option adds warning messages to the unit operation if temperature range is outside of what is specified in the Temperature Extension fields. To access this, go to Edit - Project Configuration - Species Tab page, an extended temperature range can be sets for any selected compound. Note that any opened projects must be closed first before the edit configuration command can become accessible. | |
| Environment... | ||
| Elevation | Elevation above sea level, used to calculate the atmospheric pressure. | |
| T / AmbientTemp: | The Ambient Temperature. The ambient temperature is used by some models, eg Environmental Heat Exchanger - loss to Ambient | |
| P / AirPressure: | The atmospheric pressure calculated by the elevation. | |
| AirDensity | The Density of Air at the specified elevation. Reference for Air Pressure and Air Density calculation: Perry's Chemical Engineers Handbook, 7th Edition, TABLE 2-236 Thermodynamic Properties of the International Standard Atmosphere. | |
| WindSpeed | ||
| WindDirection | ||
| RelHumidity | The relative humidity. | |
| Environment.Air... | ||
| State | Feedback information to show if gaseous components are present in the project. | |
| species 1 | If a gaseous species is present in the project, it will be available here to define the environmental air composition. This is only required for dynamic simulation project. | |
SetTagList Tab Page
| Tag / Symbol | Input / Calc | Description/Calculated Variables / Options |
| Tag List to set before initialisation | ||
| (this works the same as the Set Tag List Model except that the tags are set at the very start of the initialisation process. This can be used to set tags which need to be set prior to other logic which occurs during initialisation. Some examples are page activations, controllers on/off and variables which are referenced in the calculations/logic which is part of an "If (OnInitialise)" block in a PGM) | ||
| SetTagList... | ||
|
On |
Tick Box |
Enables or disables the SetTagList Block. |
|
Status |
Feed back |
The status of the SetTagList with a brief summary of the file. |
|
Folder |
Feed back |
The full path of the Set Tag List file. |
|
File |
Input |
The file name of the Set Tag List. Note: this file must be created first. File can be txt or csv format. |
|
| ||
|
Edit |
Button |
Allow the user to edit the file. |
|
Browse |
Button |
Use this button to Browse for the file. |
| LogTagSets | List | None -- SysCAD will not log the tag sets. |
| Messages -- SysCAD will log the tag sets in the Messages window only. | ||
| EventLog -- SysCAD will log the tag sets in the Event Log only. | ||
| Messages and EventLog -- SysCAD will log the tag sets in both the Messages window and the Event Log. | ||
|
| ||
|
SetTags |
Button |
Use this button to Set the Tags into SysCAD. |
|
| ||
|
ColumnToSet |
Input |
This specifies which column of values will be used when the tag list is set. Default value is 1 which corresponds to the first column of values. |
System tab page
| System... | ||
| Executable Build... | ||
| VersionOnly | Feedback information | Displays the current version. |
| Version | Feedback information | Displays the current version with Build Date. |
| majorBuildNo | Feedback information | Displays the current major build number. |
| BuildNo | Feedback information | Displays the current minor build number. |
| BuildDate | Feedback information | Displays the build date. |
| Project... | ||
| ProjectName | Feedback information | Displays the Project name only. |
| ProjectFolder | Feedback information | Displays the Project folder path. |
| PrjFile | Feedback information | Displays the project file path. |
| Cfgfile | Feedback information | Displays the Cfgfiles path. |
| DateAndTime | Feedback information | Current Time and Date. |
| Time1970 | Feedback information | Time in seconds with starting time being 1/1/1970. |
HINT: These fields can be useful information to include in a SysCAD report.
Pages Tab Page
The Pages tab page gives a list of graphics pages associated with the project. It is built dynamically after a project load. The main purpose of this is to allow user to activate/deactivate a graphics page externally through the use of macros.
Statistics tab page
The Statistics tab page gives information on the solve time and speed.
| Steps | Displays the number of simulation steps executed. |
| Iterations | Displays the number of simulation iterations executed. |
| BadIterations | Displays the number of bad iterations the simulation has encountered. |
| SimulationTime | Displays the simulation Time. |
| SimulationTimeDesc | Displays the simulation time as a text string, that is, in terms of number of days and Hour:Minutes:Seconds:milliseconds. |
| StartingTime | Displays the time at start. |
| SolveTime | Displays the current solve time. |
| SolveTimeDesc | Displays the solve time as a text string, that is, in terms of Hour:Minutes:Seconds:milliseconds. |
| StepTm | Displays the simulation step time. |
| StepTmMoveAvg | Displays the simulation step time moving average. |
| StepTmAvg | Displays the average step size time. |
| RunSpd | Displays the Run speed. |
| RunSpdMoveAvg | Displays the run speed moving average. |
| RunSpdAvg | Displays the average run speed. |
| ProcessorUse | Displays the processor usage. |
| ProcessorUseMoveAvg | Displays the moving average of processor usage. |
| ProcessorUseAvg | Displays the average processor usage. |
| MoveAvgPoints | The user specified number of points used in calculating the moving average. |
| Memory.PageFaultCount | |
| Memory.PeakWorkingSetSize | |
| Memory.Used | |
| Memory.QuotaPeakPagedPoolUsage | |
| Memory.QuotaPagedPoolUsage | |
| Memory.QuotaPeakNonPagedPoolUsage | |
| Memory.QuotaNonPagedPoolUsage | |
| Memory.PagefileUsage | |
| Memory.PeakPagefileUsage | |
| Memory.Load | |
| Memory.TotalPhys | |
| Memory.AvailPhys | |
| Memory.TotalPageFile | |
| Memory.AvailPageFile | |
| Memory.TotalVirtual | |
| Memory.AvailVirtual | |
| Unknowns | |
| BadError | Displays the number of Bad errors the simulation has encountered. |
| BadLimit | |
| WorstErr | Displays the worst error in the current simulation. |
| Nets | |
| SubNets | |
| Nodes | |
| FxdLnks | |
| LoneLnks | |
| NetLnks | |
| Exec.StartTm | |
| Exec.QueryTm | |
| Exec.BuildTm | |
| Exec.ExecTm | |
| Exec.ExecDoneTm | |
| Exec.ReadTm | |
| Exec.WriteTm | |
| Exec.StopTm | |
| Net.TotalExecTicks | |
| Net.Measure | |
| Net.Converge | |
| Net.Solve | |
| Net.LoadSurge | |
| Net.CalcIndices | |
| Net.MtxBuild | |
| Net.MtxSolve | |
| Net.MtxExtract | |
| Net.ChkJoins | |
| Net.EvalJoinQ | |
| Net.EvalJoinP | |
| Net.SolveFxdFlwQ | |
| Net.SolveFxdFlwP | |
| Net.FixTopology | |
| Net.OverHead | |
| Net.TotalDerivative | |
| CtrlOverHead | |
| PowerRequired | |
| Slv.Electrics | |
| Slv.CtrlActions | |
| Slv.CtrlStrategy | |
| Slv.ConfigJoins | |
| Slv.NetworkSolve | |
| Slv.ModelSolve | |
| Slv.Discrete | |
| Slv.Balance | |
| Slv.ChangeTrace | |
| Slv.Total | |
Globals tab page
| SQSzDist1.VarSlct These variables all relate to the PSD, or size distribution, data. Please see Size Distribution (PSD) for more information. | ||
| Variable Selection | ||
| FracPass | Tick Box | Allow the user to select the fractional percent passing for display on the SZ tab. |
| MassFlow | Tick Box | Allow the user to select the mass flow for display on the SZ tab. |
| CountFracPass | Tick Box | Allow the user to select the particle count for fractional percent passing for display on the SZ tab. |
| CountFlow | Tick Box | Allow the user to select the particle count flow for display on the SZ tab. |
| Count | Tick Box | Allow the user to select the particle count for display on the SZ tab. |
| SpecCount | Tick Box | Allow the user to select the specie count for display on the SZ tab. |
| Cumulative | Tick Box | Allow the user to select the cumulative percent passing for display on the SZ tab. |
ProBal Configuration
Command Path View, ProBal Configuration
Right clicking on the Graphics Window background can also access this.
This opens the $PB Access Window. The PB tab page lists some of the configuration options as per the ProBal Setup command.
The $PB.Closure... section allows the user to set closure test conditions. The closure tests can be turn on/off via the View - Plant Model command. Error messages may be displayed if the following conditions are not met.
| Tolerance Defaults | |
| EPS_Rel | |
| EPS_Abs | |
| Convergence Defaults | |
| MaxIters | |
| CnvgdIters | |
| Method | |
| Damping | |
| DampingGrowth | |
| DampingDecay | |
| WegsteinDelay | |
| WegsteinBound | |
| WegsteinClamp | |
| MassSmoothing | |
| ResultsValid | |
| LowQmFacOther | |
| Closure... | |
| MsAbs | Maximum allowable Absolute Mass flow imbalance in models. |
| MsRel | Maximum allowable Relative Mass flow imbalance in models. |
| HtAbs | Maximum allowable Absolute Heat flow imbalance in models. |
| HtRel | Maximum allowable Relative Heat flow imbalance in models. |
| HtRel2Mdl | |
Dynamic Configuration
Command Path View, Dynamic Configuration
Right clicking on the Graphics Window background can also access this.
This Opens the $DYN Access Window. The Dyn tab page lists the configuration options as per the Dynamic Setup command.
Some extra fields not covered by the Dynamic Setup dialogs are listed here. Note: this list is not complete.
FS_Dyn Tab Page
| Executive | ||
| Time.Fmt | FeedBack | |
| Time | FeedBack | |
| StepSize.Fmt | ||
| StepSize | ||
| StepCount | FeedBack | Displays the number of steps the simulation has taken. |
| RealTimeOn | Tickbox | |
| RealTimeMultiplier | ||
| TimeRec... | ||
| mSecs | FeedBack | Displays the current time - "Milliseconds" segment |
| Secs | FeedBack | Displays the current time - "Seconds" segment |
| Mins | FeedBack | Displays the current time - "Minutes" segment |
| Hours | FeedBack | Displays the current time - "Hours" segment |
| Days | FeedBack | Displays the current time - "Days" segment |
| DateRec... | ||
| Day | FeedBack | Displays the current simulation date - "Day" Segment. For example, if the current date is 28-05-2007, it will display 28 here. |
| Month | FeedBack | Displays the current simulation date - "Month" Segment. For example, if the current date is 28-05-2007, it will display 5 here. |
| Year | FeedBack | Displays the current simulation date - "Year" Segment. For example, if the current date is 28-05-2007, it will display 2007 here. |
| DayOfWeek | FeedBack | Displays the current date as in Day of the week. For example, if the current date is 28-05-2007, which is a Monday, it will display 2 here. |
| DayOfWeekDesc | FeedBack | Displays the current date as in Day of the week. For example, if the current date is 28-05-2007, it will display Monday here. |
| DayOfYear | FeedBack | Displays the current simulation's date as number of days in the year. |
| MonthDesc | FeedBack | Displays the current date in terms of month. For example, if the current date is 28-05-2007, it will display May here. |
| DaysInMonth | FeedBack | Displays the number of days in the current month. For example, if the current date is 28-05-2007, it will display 31 here. |
| DaysInYear | FeedBack | Displays the number of days in the current Year. For example, if the current date is 28-05-2007, 365. |
Scenario Tab Page
| Specification | ||
| Type | List | Manual - User manually press the Stop button to end the dynamic simulation run. |
| Duration - User specifies a duration and SysCAD will stop the simulation when the duration period is reached. | ||
| StopTime- User specifies a Stop time and SysCAD will stop the simulation when the time counter has been reached. | ||
| Step - User specifies the required number of steps and and SysCAD will stop the simulation when the step count is reached. | ||
| SteadyState | ||
| DurationRqd.Fmt | Input/FeedBack | Visible with Type set to Duration. User can set the duration in a time format: Day:Hour:Minute:Seconds. For example: duration of 2 days and 1 hour can be set as: 2:01:00:00. Note that if this field is changed, after pressing the OK button the DurationRqd field is adjusted accordingly. |
| DurationRqd | Input/FeedBack | Visible with Type set to Duration. User can set the duration in terms of a time engineering unit. For example: duration of 2 days and 1 hour can be set as: 2.04 d OR 49 h. Note that if this field is changed, after pressing the OK button the DurationRqd.Fmt field is adjusted accordingly. |
| StopTimeRqd.Fmt | Input/FeedBack | Visible with Type set to StopTime. User can set the stop time in a time format: Day:Hour:Minute:Seconds. This works in conjunction with the Start Time, which can be found under Scenario.Start. For Example, if StopTimeRqd.Fmt is set at 0:00:20:00, and StartAt.Fmt is set at 0:00:10:00 with SetTime Ticked, the simulation will only run for 10 minutes and it will stop. Note that if this field is changed, after pressing the OK button the StopTimeRqd field is adjusted accordingly. |
| StopTimeRqd | Input/FeedBack | Visible with Type set to StopTime. User can set the stop time in terms of a time engineering unit. This works in conjunction with the Start Time, which can be found under Scenario.Start. For Example, if StopTimeRqd is set at 1200s, and StartAt is set at 600s with SetTime Ticked, the simulation will only run for 600s and it will stop. Note that if this field is changed, after pressing the OK button the StopTimeRqd.Fmt field is adjusted accordingly. |
| StepCountRqd | Input | Visible with Type set to Steps. |
| ScnState | FeedBack | Displays the state of the scenario run. |
| StopTime.Fmt | FeedBack | Displays the StopTime in a time format. |
| StopTime | FeedBack | Displays the StopTime. |
| ScnTime.Fmt | FeedBack | Displays the current simulation time in a time format. |
| ScnTime | FeedBack | Displays the current scenario time. |
| ScnTimeEnd.Fmt | FeedBack | Displays the Scenario Ending time in a time format. |
| ScnTimeEnd | FeedBack | Displays the Scenario Ending time |
| Start Action | ||
| IfScnBusy | List | Continue - If the simulation is manually stopped before scenario is completed, it will display the Busy status. Selecting Continue here will allow the simulation to continue with the scenario when Start Run command is executed again. |
| Restart - If the simulation is manually stopped before scenario is completed, it will display the Busy status. Selecting Restart here will allow the scenario run to begin afresh when Start Run command is executed again. | ||
| IfScnComplete | List | Ignore - If the simulation scenario has been completed, SysCAD will ignore the run command. |
| Restart - SysCAD will restart the scenario. | ||
| Elapsed Time & Progress | ||
| Progress | FeedBack | Displays the simulation progress as a percentage of completion. |
| Elapsed.Time | FeedBack | Displays the current elapsed time. |
| Elapsed.EstToGo | FeedBack | Displays the estimated time till completion of the scenario. |
| Elapsed.EstTotal | FeedBack | Displays the estimated total time required to complete the scenario run. |
| Elapsed.Steps | FeedBack | Displays the current elapsed simulation steps taken. |
| Scenario.Start... | ||
| SetTime | Tickbox | Selecting this option will set the Start time specified in the following fields. |
| StartAt.Fmt | Input/Feedback | Allows the user to set a starting time in the format of Day:hour:Minute:seconds. This field will be used to determine the scenario run time if the StopTime Type has been selected. Note that if this field is changed, after pressing the OK button the StartAt field is adjusted accordingly. |
| StartAt | Input/Feedback | Allows the user to set a starting time. This field will be used to determine the scenario run time if the StopTime Type has been selected. Note that if this field is changed, after pressing the OK button the StartAt.Fmt field is adjusted accordingly. |
| RestartHistorian | TickBox | Selecting this will Restart the Historian when scenario is started. |
| SetHistorianTagList | TickBox | Selecting this will Set the Historian Tag List if used when scenario is started. |
| RestartArchive | TickBox | Selecting this will Restart the Archiver if used when scenario is started. |
| EmptySpills | TickBox | Selecting this will Empty all Spills when scenario is started. |
| Empty | TickBox | Selecting this will Empty all tanks (or any other unit operation with volume) when scenario is started. |
| RestartProfiles | TickBox | Selecting this will Restart any Profiles if used when scenario is started. |
| ResetStats | TickBox | Selecting this will Reset the Statistical blocks when scenario is started. |
| Scenario.Start... | ||
| Scenario.End.Action | List | Stop - SysCAD will be stopped when scenario is completed. |
| Idle - SysCAD will be placed in idle position when scenario is completed. | ||
Cmd Tab Pag
| Scenario | ||
| Reset Scenario | Button | This button resets the Scenario Run. User can use this command in PGM, Event file or from Excel. |
| SetTime | Button | |
| RestartHistorian | Button | This button resets the Historian data. User can use this command in PGM, Event file or from Excel. |
| ZeroFlows | Button | This button Zeros all flows in the streams. User can use this command in PGM, Event file or from Excel. |
| Empty | Button | This button Empties all containers (Eg, Tanks). User can use this command in PGM, Event file or from Excel. |
| Preset | Button | This button resets all tanks with pre-set data. User can use this command in PGM, Event file or from Excel. |
| SteadyState | Button | |
| DynStatsRunInit | Button | This button resets all statistical collection data. User can use this command in PGM, Event file or from Excel. |
| EmptySpillTargets | Button | This button empties all the spill area and spill summation data. User can use this command in PGM, Event file or from Excel. |
Integration Tab Page
| Method | FeedBack | Displays the simulation method used. |
| TimeIncCtrl | FeedBack | Displays the step size control, fixed or variable. |
| IterationsPerStep | Input | Number of iterations per step |
| TimeInc | ||
| TimeIncMax | ||
| TimeIncMin | ||
| DerivEstInc | ||
| SettleTime | ||
| CtrlEval | ||
| Mag_Eps_Abs | ||
| Mag_Eps_Rel | ||
| Int_Safety | ||
| GrowLimit | ||
| Grow | ||
| OKShrinkLimit | ||
| OKShrink | ||
| BADShrink | ||
| Steps | FeedBack | Displays the total number of simulation steps |
| GoodIters | FeedBack | Displays the number of good iterations |
| BadIters | FeedBack | Displays the number of bad iterations |
| Iters4Step | FeedBack | Displays the number of iteration per step |
| WorstMagInt0 | FeedBack | Displays the worst error |
| WorstMagInt1 ... 9 | FeedBack | Displays the next 8 worst errors |
NetWork Tab Page
| Link Convergence | ||
| Lnk_Eps_Abs | ||
| Lnk_Eps_Rel | ||
| Network Convergence | ||
| Net_DeRating | ||
| Net_MaxResRatio | ||
| NetCnvCount | ||
| Net_ResRunAvgStart | ||
| Net_ResRunAvgCount | ||
| UDFCnvCount | ||
| FastConverge | ||
| Flow Calculations | ||
| NetFlow.Vapour | ||
| NetFlow.Liquid | ||
| Velocity Limits | ||
| ShowVelLimitAs | List | Options are: 1) Off; 2) Note; 3) Warning; 4) Error |
| VelLimitSL | Input | Allows user to set an upper limit for slurry velocity. Messages may be displayed based on the ShowVelLimitAs method selected. See the above field. |
| VelLimitV | Input | Allows user to set an upper limit for vapour velocity. Messages may be displayed based on the ShowVelLimitAs method selected. See the above field. |
| Mass Flow Differences | ||
| ShowQmDiffAs | ||
| QmMatchAbs | ||
| QmMatchRel | ||
| Options | ||
| DefaultArea | ||
| Momentum | ||
| KFactMult | ||
Tears Tab Page
| Tolerance Defaults | ||
| Tear.EPS_Rel | Input | User specified relative tolerance for tear streams. |
| Tear.EPS_Abs | Input | User specified absolute tolerance for tear streams. |
| Convergence Defaults | ||
| Tear.MaxIters | ||
| Tear.Method | ||
| Tear.Damping | ||
| Tear.DampingGrowth | ||
| Tear.DampingDecay | ||
| Tear.WegsteinDelay | ||
| Tear.WegsteinBound | ||
| Tear.WegsteinClamp | ||
SS_Monitor Tab Page
| Tag/Symbol | Input/Calc | Description |
|---|---|---|
| SS.Test | List | Off - do not do any tests |
| Network - The Network option implies that steadystate will be tested for by looking at the conditions in the network the Pressure and Flowrate at all inlets and outlets are tested for change | ||
| SS.StopCount | Input | The number of continuous iterations that the network must be steady before SysCAD will stop. |
| SS.MaxIters | Input | The solver will stop after MaxIters – regardless. |
| SS.Iteration | Output | The number of iterations todate. |
| SS.Steady | Output | The number of consecutive iterations that the ‘Steady State’ criteria have been satisfied. |
| SS.MaxChange | Output | The largest change during the last iteration. |
| SS.MaxChangeTag | Output | An indicator showing where the largest change during the last iteration took place. |
| SS.P.Abs | Input | Absolute tolerance on P change |
| SS.P.Rel | Input | Relative tolerance on P change |
| SS.QM.Abs | Input | Absolute tolerance on MassFlow change |
| SS.QM.Rel | Input | Relative tolerance on MassFlow change |
Options
| Tag/Symbol | Input/Calc | Description |
|---|---|---|
| HistorianTagList... | ||
| Folder | Feedback | The path of the Historian Tag List |
| File | Input | User can specify all the Historian Tags on a List (Text file) and load it into SysCAD here. |
| Edit | Button | User can edit the Historian Tags List |
| Browse | Button | User can browse for the Historian Tag List |
| Set_... | Button | Adds the tags to the SysCAD Historian. |
NOTE: The first line in the Historian Tag list is ignored, user can place heading or comments there. The tags to be loaded starts from Line 2 of the file.
Example Historian Tag List file (Numbers shown are line numbers):
- Example Historian Tag List
- MULTI_STORE.TotalMass (t)
- MULTI_STORE.Summary.[0].Mass (t)
- MULTI_STORE.Summary.[1].Mass (t)
- MULTI_STORE.Summary.[2].Mass (t)
- P100.Qm (t/h)
- P101.Qm (t/h)
- P102.Qm (t/h)
Controls
Command Path View, Controls
Right clicking on the Graphics Window background can also access this.
THIS PAGE IS USED TO AUTO-TUNE CONTROLLERS IN THE PROJECT, WHILE THIS STILL WORKS, IT IS BEING SUPERSEDED BY Trend Window (with PID Controllers).
This opens the $Ctrl Access Window. This access window can be used to Auto-Tune controllers in the project. To do so, the user must first tick the option in the Tuning Tab page.
The Controls Tab page lists all the controllers used in the project. Only one Controller may be tuned at any one time. The controller in view is selected from the list on the bottom half of the page. In the example shown below, the Plant.WaterMakeup controller is selected (marked by a tick in the V [View] column). To Auto-Tune this controller, the user should then tick the box under the T [Tune] column. When the controller is under the Auto-Tune mode, SysCAD holds all other controllers steady and performs the tuning routine. When the controller is tuned, it overwrites the user specified Gain and Proportional Band values with the optimum values derived from the tuning exercise.
The user may then repeat the exercise to tune other controllers in the project.
Note: As with any real life operating plants, some controllers may need more fine tuning depending on the interaction with other controllers. In most cases, it is best to hand tune some of the more sensitive controllers first to get the plant under control and use the auto tune for optimisation.
Power Supplies
Command Path View, Power Supplies
Right clicking on the Graphics Window background can also access this.
This is used to turn the supplied power on/off, mainly used in conjunction with electrical group of models. NOTE: user should leave these power options switched on as some unit operations do require the power to be connected to function.
User can add in new types of power supply by change the number field and filling in the information when the new fields are created. Alternatively, the existing source can be edited.
Once the power supply is created on this page, it is available for selection in some unit operations. Examples of such are valves, pumps, crushers and so on.
To be completed.
Plant Area
This is a project wide Area Model. All individual area models belong to the Plant Area. The Plant Area is the default Area to which new units and links belong.
Species Data
Command Path View, Species Data
Right clicking on the Graphics Window background can also access this.
This opens the $SDB Access Window. An example of the species property access window is as follows:
The above display of the species properties is the SysCAD interpretation of the data loaded for the project. This serves both as a check for the property data and useful data for the SysCAD users while solving the project.
The above Species Property Data is given for temperature 0°C and Pressure 101.31 kPa. These temperature and pressure can be changed to obtain species properties at different conditions. Users can choose to display the data in either mass or mole basis. This is done via the Mass Basis check box, it toggles between the two options.
Users can also choose to use the Hi or Low Fidelity (accuracy) steam/water model to predict the properties. This is done via the HiFidelity check box.
Right clicking on any property value in the above data table will bring up a pop up menu with the following options:
- Conversion: The engineering units for the column can be changed where applicable.
- Format: The format for the column can be changed.
- Copy Full Tag: When the data is presented as a matrix, the conventional Copy and Paste method would not copy the tag properly. To copy the full tag for use in the trend window or other referenced files such as excel or pgm, use this copy full tag command. The format is:
$SDB.compound(phase).ColumnHeading(@ Temp & Pressure) (units)
To paste the tag, use <Ctrl + V> as normal.
- Copy Value/Copy: When the data is presented as a matrix, the conventional Copy and Paste method would not copy the tag properly. To copy the tag value for use in the referenced files such as excel or pgm, use this copy value command.
- Paste: As the variables are all calculated or for display only. Values cannot be pasted onto the table.
Tolerances
Command Path View, Tolerances
Right clicking on the Graphics Window background can also access this.
The $Tol Access Window lists all tolerance values used in various solve routines. These include both System routines and model-based routines. An example is shown below. The user can change values in this window to help speed up convergence. See Tolerance Testing for an explanation of how SysCAD uses these tolerances.
Tear Blocks
Command Path View, Tear Blocks
Right clicking on the Graphics Window background can also access this.
Related Topics: Convergence Methods, Tolerance Testing.
The $Tears Access Window lists all the tear blocks information for the project. It may contain a number of pages depending of the project. If there is no tear block present in the active project, only the Tears tab page will be displayed. If Tear blocks are present in the project, then all tear blocks will be listed as shown in the example below.
Convergence Defaults / Tolerance Defaults: This is the global solver method selected for the project; this is being set in Project - ProBal Setup. Some damping factors can be set for selected methods, for more information on the factors and methods, please refer to Damping Factors for a glimpse of the C++ code used. Please note that the user need not change any of this information for the project to solve. However, for the keen and experienced modeller, some factors and tolerances can be adjusted to speed up the solve routines.
Tear Tag: This is the name of the tear block.
Method: The method for individual tear blocks can be changed. Options are: Direct Substitution, Adaptive Direct Substitution and Wegstein Acceleration.
Damping Rqd: The damping factor for the tear block if it is damped as a group. Symbol * mean the factor will be determined and changed by SysCAD, whereas a number will hard wire the damping factor to a set value.
Grp: This means all variables in the tear block will be damped as a group or individually.
Tolerance Strategy: Options are: Priority, Maximum or Minimum.
Abs / Rel: Each tear block can have its own tolerance factors.
Viewing icon: To the left hand side of the Tear Tag, there is a column of magnifying glass icons. This is the active tear block selection button. When a tear block is selected, detailed tear block variables information will be displayed in the Damping and Tolerance Tab page. From these pages, the user is allowed to change damping/tolerance factors to the individual variables if required.
Find Graphics icon: The two columns of binoculars will find the Unit operation and the tear stream respectively for the tear block on the graphics window.
Change Stats
Command Path View, Change Stats
Right clicking on the Graphics Window background can also access this.
This access window displays statistical information on change of values during Solve or Run. To start collecting the information, the collect tick box must be selected and solve/run started.
In the Errs tab page, the largest error encountered will be listed, while the chngs and Osc tab pages will list variables that have the most changes and the worst oscillations respectively.
As with all access windows, the changes will not update unless the refresh button is pressed. Also, the collection of the statistical data will add to the memory usage; if the project is big, the user can experience a much slower solve speed. Therefore, only use this feature if debugging is required. Once debugging is done, un-tick the collect option to switch off this feature.
Evaluation Order
Command Path View, Evaluation Order
Right clicking on the Graphics Window background can also access this.
This will open the order Evaluation Window. This window contains fairly useful information, eg, it shows how the solver network is built, the relationship between the units, the tears streams, the project input and output units and some PID controllers information.
As this window displays how the project is solved information will only be gathered when the solver has been activated. If you have opened this window before solve, press the Refresh button to update the display.
To illustrate how to use this window, an example of a very simple project (Tutorial project DigestF3.spf) and its Order of Evaluation Windows are shown below. Note that as the complexity of the project grows, so does the relationship between units, which can become very large.
The options for the evaluation order window are:
The number of columns displayed depend on the options selected above, they may include:
- Seq - Sequence number
- Inputs - This is the input stream to the node / unit operation.
- Node - The unit operation
- Outputs - This is the output streams from the node / unit operation.
- Mv - This is the measured value, only applies to the control values. NOTE: these will be in SI units.
- Qm, T, P, (Solids fraction), (Liquid fraction) or dQm, dT, dP etc columns will appear based on selection of IO list box.
A number of features to look out for are:
- If the Process option is selected, it will display all the process flow dependencies, including the control information.
- If Option Control is selected, it will display all the General Controllers and PID controllers showing their dependent streams.
- Units are grouped into little networks to indicate their dependency. Each group is shown in the order the units are evaluated. .
- The plant model input and output streams are indicated by
.
- The tear streams are indicated by
.
- Control streams are indicated by
.
Runtime Statistics
Command Path View, Runtime Statistics
This command will open the Runtime Statistics Window. User can make use of the data displayed in the window for project debugging purposes.











