Solver Setting - Scenario

From SysCAD Documentation
Jump to navigation Jump to search

Navigation: User Guide ➔ Menu Commands ➔ View ➔ Solver Settings ➔ Scenario

FS_Solver ProBal Convergence GlobalTear Tears TearTags Tolerances Analysis
Dynamic Integration Network Scenario SS Monitor

Tag (Long/Short)

Input / Calc

Description

Scenario...
Specification
Type 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.
Steps User specifies the required number of steps and and SysCAD will stop the simulation when the step count is reached.
SteadyState For this type of scenario, user must first set up some checking criteria on the Solver Setting - SS Monitor Tab, the user defined criteria will be used to stop the scenario when the conditions are met.
DurationReqd.Fmt Input Only 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 DurationReqd field is adjusted accordingly.
DurationReqd Input Only 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 DurationReqd.Fmt field is adjusted accordingly.
StopTimeReqd.Fmt Input Only 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 StopTimeReqd field is adjusted accordingly.
StopTimeReqd Input Only 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 StopTimeReqd.Fmt field is adjusted accordingly.
StepCountReqd Input Only visible with Type set to Steps. The required number of steps to run before stopping.
StopTime.Fmt Display Displays the StopTime in a time format.
StopTime Display Displays the StopTime.
ScnTime.Fmt Display Displays the current scenario time in a time format.
ScnTime Display Displays the current scenario time.
ScnTimeEnd.Fmt Display Displays the Scenario Ending time in a time format.
ScnTimeEnd Display Displays the Scenario Ending time
Solver Start Behaviour
IfManualScn Display Only visible when Type is set to Manual.
  • ReStart - If the simulation is manually stopped before scenario is completed, it will display the Busy status. Restart allows the scenario run to begin afresh when the Run command is executed again.
The following two fields are visible when Type is set to Duration, StopTime, Steps or SteadyState.
IfScnBusy Display
  • ReStart - If the simulation is manually stopped before scenario is completed, it will display the Busy status. Restart allows the scenario run to begin afresh when the Run command is executed again.
IfScnComplete Ignore If the simulation scenario has been completed, SysCAD will ignore the run command. NB If the scenario has completed and you try to restart SysCAD it will report "Scenario Complete - Restart Ignored" in the message window. To restart SysCAD, you must go to the Cmds tab and press the "Restart Scenario" button.
ReStart SysCAD will restart the scenario.
Start...
Startup Options
SetTime Tickbox Selecting this option will set the Start time specified in the following fields.
StartAt.Fmt Input 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. NOTE: use "StartAt" (next tag, maybe hidden) to set the start time from pgm or csv files.
StartAt Input 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. NOTE: use this tag to set the start time from pgm or csv files. See also Useful PGM code for Dynamic Projects.
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. Note that if this is enabled, it will override whatever setting the Clear parameter has been set to in the sac file.
InActiveNodes Ignore Ignores all inactive models. (All inactive models will retain all the contents and conditions, care must be taken when analysing the results, should flag these model as inactive in the report, or not report them)
Empty Empties all inactive models.
Preset Presets all inactive models according to their preset image. Make sure preset data have been defined.
Startup Reset Actions (These may also be set from Project - Dynamic Setup - Start Options or FS_Solver page of the Solver Access window)
Process Tickbox This will empty all pipes and flow values when the run begins.
Control Tickbox This will reset all controllers back to 'Base' state, i.e. the same state as when the controller is first inserted into the project. This is mainly relevant for PID controllers.
Statistics TickBox Selecting this will Reset the Statistical blocks when scenario is started.
EventsProfiles TickBox This will reset all Event and Profiles back to start time.
Empty Tickbox This Empties all containers with surge, e.g. Tanks.
Preset Tickbox This resets all tanks that have the 'Preset.On' button ticked and have Preset data.
End...
Completion Options
Action Stop SysCAD will be stopped when scenario is completed.
Idle SysCAD will be placed in idle state when scenario is completed.
Results
State Display Displays the state of the scenario run:
  • 0 - Off
  • 1 - Start
  • 2 - Busy
  • 3 - Complete
  • 4 - Ignore
Reset Reset Scenario Button Resets the scenario
Elapsed Time & Progress
Progress Display Displays the simulation progress as a percentage of completion.
Elapsed.Time Display Displays the current elapsed time.
Elapsed.EstToGo Display Displays the estimated time till completion of the scenario.
Elapsed.Steps Display Displays the current elapsed simulation steps taken.