View source for Plant Model - FlwSolve

[[Category:Project Configuration]]
{{Navigation|[[User Guide]]|[[View Command Summary|View]]|[[Plant Model]]|altname=FlwSolve}}
{{Plant Model Tab Pages |currentpage=1}}
----

== Introduction ==

This tab page on the Plant Model Access Window has a number of parameters that the user may either set or read regarding the SysCAD Solver.

{|   border="1" cellpadding="5" cellspacing="0" 
|    '''Tag (Long/Short)''' || Width=100|'''Input / Calc''' || '''Description/Calculated Variables / Options'''
{{Common Data on First Tab Page}}
<!--
|-
|  colspan="3" font style="background: #ebebeb"    |

== Spills & Vents ==
(spills and venting are only relevant in dynamic mode)
|-
| valign="top" rowspan="4" |Spill.Report|| Off || Spill messages are off
|-
| On-Messages || Any spills will be reported in the messages portion of the message window.
|-
| On-Conditions || Any spills will be reported in the conditions portion of the message window.
|-
| On-Both || Any spills will be reported in the both the messages and conditions portions of the message window.
|- 
| valign="top" rowspan="4" |Vent.Report|| Off ||Venting messages are off
|-
| On-Messages || Any venting will be reported in the messages portion of the message window
|-
| On-Conditions || Any venting will be reported in the conditions portion of the message window
|-
| On-Both || Any venting will be reported in the both the messages and conditions portions of the message window
|- 
| valign="top" rowspan="7" |Spill.Action||  Ignore || No action will occur if a spill occurs
|-
|  Idle-Units || If a spill occurs from a unit, then the model will pause (goto Idle mode)
|-
|  Idle-Links || If a spill occurs from a link, then the model will pause (goto Idle mode)
|-
|  Idle-Both || If a spill occurs from either a unit or a link, then the model will pause (goto Idle mode)
|- 
|  Stop-Units || If a spill occurs from a unit, then the model will stop
|-
|  Stop-Links || If a spill occurs from a link, then the model will stop
|-
|  Stop-Both || If a spill occurs from either a unit or a link, then the model will stop
|- 
| valign="top" rowspan="7" |Vent.Action || Ignore || No action will occur if venting occurs
|-
|  Idle-Units || If venting occurs from a unit, then the model will pause (goto Idle mode)
|-
|  Idle-Links || If venting occurs from a link, then the model will pause (goto Idle mode)
|-
|  Idle-Both || If venting occurs from either a unit or a link, then the model will pause (goto Idle mode)
|- 
|  Stop-Units || If venting occurs from a unit, then the model will stop
|-
|  Stop-Links || If venting occurs from a link, then the model will stop
|-
|  Stop-Both || If venting occurs from either a unit or a link, then the model will stop
|- 
|  Spill.Threshold || Input || The mass flow threshold for defining a spill
|-
|  Vent.Threshold || Input || The mass flow threshold for defining venting
-->
|-
|  colspan="3" font style="background: #ebebeb"    |

== Evaluation Order ==
|-
|TraceChanges || Tickbox ||
|-
|  colspan="3" font style="background: #ebebeb"    |
== MultiStep Settings ==
|-
|MultiStep.StepCount || Input || Defines the number of steps/iterations to be run when using the [[Actions_Command_Summary|MultiStep]] command or [[Image:MultiStepbutton.png]] button.
|-
|  colspan="3" font style="background: #ebebeb"    |

== Demand Configuration ==
Please see [[Demand]] for more information on this functionality.
|-
|BlockInTears || Tickbox ||This will block demand logic through all tear streams in a project.
|-
|ShowDemandAvail || Tickbox ||If this is enabled then the user will be able to view the mass available from a source in Demand mode both up and down stream in all pipes in the project.
|-
|DemandThresholdQm || Input || {{Available139}} The minimum mass flow below which Demand required is not transferred.
|-
|DemandWarningTol.SigDigits || Input || The number of significant digits for the demand warning for relative tolerance (-log(DemandWarningTol.Rel)). This will adjust the tag below.
|-
|DemandWarningTol.Rel || Input ||The relative tolerance used when testing to display condition warnings when a required demand flow is not being met.
|-
|DemandWarningTol.Abs || Input || The absolute tolerance used when testing to display condition warnings when a required demand flow is not being met.
|-
|  colspan="3" font style="background: #ebebeb"    |

== Options ==
|-
|  PGM_ExecuteTimeout || Input || 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 || Input || Seed value used for Random number generator models such as [[Controller -- Noise|Noise Controller]] model. For the same seed value, a repeatable set of random numbers will be generated. For a different seed, a different set of random numbers will be generated. Use * to get a random set of values on every run.
|-
|  colspan="3" font style="background: #ebebeb"    |

== Developer Testing Options ==
These options are designed for users of SMDK and Developer License where extra tests are performed on stream mixtures to test data sanity (e.g. test for negative masses of species). In normal use these options should be off so that SysCAD solver does not perform the extra unnecessary checks. The purpose is to help test that SMDK models are performing sensibly.
|-
| rowspan="3" |SanityChecks|| Off || Testing of streams for bad data is not performed.
|-
|  Messages || Any errors or reported to message window.
|-
|  Stop || Any errors or reported to message window, and the solver is stopped at the end of that iteration.
|-
|  Enthalpy.ForceTotalP || Tickbox|| 
|-
| Colspan="3" font style="background: #ebebeb"|''Option to allow the user to disable tear advance''
|-
|Hold.TearAdvance || Tickbox|| sets tears with fixed current values, so to eliminate effects from tears. 
|-
| Colspan="3" font style="background: #ebebeb"|''Options to allow the user to disable control & similar actions''
|-
|Hold.ControlActions || Tickbox|| Ticking this will disable all control actions, useful for debugging the project, to eliminate effects from controllers (e.g. PID controllers). 
|-
|Hold.DiscreteActions|| Tickbox|| Ticking this will disable all discrete actions, useful for debugging the project, to eliminate effects from discrete actions.
|-
|Hold.MPsActions|| Tickbox|| Ticking this will disable all MP files, useful for debugging the project, to eliminate effects from model procedures.
|-
|Hold.TagIOActions|| Tickbox|| 
|}