Template:Pond Outlet Inputs
Requirements ({{{Desc}}})
{{{Name}}}...
ConnectedPipe Display The tag of the connected pipe for the {{{Desc}}}.
Order Display The order used for determining outlet flows.
Filter None All liquid and solid material will be able to exit via the connected pipe.
Block-Solids Solids will be not be allowed to exit via the connected pipe.
Block-Liquids Liquids will be not be allowed to exit via the connected pipe.
Composition Allows the user to specify the solid, liquid and vapour fractions.
Individual Phase Allows the user to specify an individual phase to draw from the pond.
Composition.SolidFrac / Sf Input Only visible if Filter = Composition. The required solid fraction of the stream.
Composition.LiquidFrac / Lf Input Only visible if Filter = Composition. The required liquid fraction of the stream.
Composition.VapourFrac / Vf Input Only visible if Filter = Composition. The required vapour fraction of the stream.
IPhase / IPh Input Only visible if Filter = Individual Phase. The required individual phase of the stream.
|font style="background: #ebebeb" colspan="3" | {{{Tag}}}...
|-
|font style="background: #ebebeb" colspan="3" | Outlet XXX
|-
|font style="background: #ebebeb" colspan="3" | These Output connection tags are also available on the Pipe access window. Any changes made here will be updated on the pipe access window and vice-versa.
|-
| valign="top" rowspan="3" | CapacityControl || Off || The maximum mass flow through the outlet will be set to unlimited amount (uncontrolled).
|-
|| ByMassFlow || The user can specify the maximum mass flow through the outlet.
|-
|| ByVolumeFlow || The user can specify the maximum volumetric flow through the outlet.
|-
| Qm.ReqdCapacity / Qm.Capacity || Input || Visible with the ByMassFlow method. The required pipe Capacity in mass flow.
|-
| Qm.MinCapacity / Qm.MinCap || Input || Visible with the ByMassFlow method. The minimum user specified flow capacity by mass.
|-
| Qm.MaxCapacity / Qm.MaxCap || Input || Visible with the ByMassFlow method. The maximum user specified flow capacity by mass. Enter * for unlimited flow.
|-
| Qv.ReqdCapacity / Qv.Capacity || Input || Visible with the ByVolumeFlow method. The required pipe Capacity in volumetric flow.
|-
| Qv.MinCapacity / Qv.MinCap || Input || Visible with the ByVolumeFlow method. The minimum user specified flow capacity by volume.
|-
| Qv.MaxCapacity / Qv.MaxCap || Input || Visible with the ByVolumeFlow method. The maximum user specified flow capacity by volume. Enter * for unlimited flow.
|-
| MeasRho || font style="background: #ebebeb" | Display || The stream density used when converting between mass and volume flows.
|-
| valign="top" rowspan="2" | OverCapacity || Spill || If more material enters the pipe then the Maximum Capacity value, then the excess material will be 'spilled' and sent to the Spills area.
|-
|| Accept || If more material enters the pipe then the Maximum Capacity value, then the pipe must accept the excess material.
|-
| rowspan="3" valign="top" | BatchMethod || None || The Batch functionality is not enabled.
|-
|| Total Mass || The Batch functionality is enabled and the required batch size is defined in terms of Mass flow. Further fields will become visible if this option is selected allowing the user to set the required batch mass.
|-
|| Total Volume || The Batch functionality is enabled and the required batch size is defined in terms of Volume flow. Further fields will become visible if this option is selected allowing the user to set the required batch volume.
|-
| colspan="3" font style="background: #ebebeb" | The following fields will be visible if Total Mass is selected as the Batch method.
|-
| valign="top" | M.BatchAddition || Input || The Mass of the required Batch. This amount of material will be allowed to flow out of the pipe at the rate specified in Qm.Capacity or Qv.Capacity.
When this value is set the amount of material will be added to the amount of material already in M.BatchRemaining (the field below), and then this field will revert to 0.
|-
| valign="top" | M.BatchRemaining || Calc / Input || The Mass of material currently in a Batch, i.e. the amount of material in a Batch that still has to flow through the pipe. Normally this value is initialised at the start of a run and then it is calculated by SysCAD from the amount required in M.BatchAddition and the amount already delivered by the batch.
However, the user may set this value and hence override the calculated Batch amount at any stage.
If the users sets this as Undefined (or '*') this is equivalent to any infinite Batch and therefore the flow through the pipe will not be restricted.
|-
| M.BatchTotal || font style="background: #ebebeb" | Display || The Total Mass that has flowed through the pipe using the Batch addition method.
|-
| colspan="3" font style="background: #ebebeb"| The following fields will be visible if Total Volume is selected as the Batch method.
|-
| valign="top" | V.BatchAddition || Input || The Volume of the required Batch. This amount of material will be allowed to flow out of the pipe at the rate specified in Qm.Capacity or Qv.Capacity.
When this value is set the amount of material will be added to the amount of material already in V.BatchRemaining (the field below), and then this field will revert to 0.
|-
| valign="top" | V.BatchRemaining || Calc / Input || The Volume of material currently in a Batch, i.e. the amount of material in a Batch that still has to flow through the pipe. Normally this value is initialised at the start of a run and then it is calculated by SysCAD from the amount required in V.BatchAddition and the amount already delivered by the batch.
However, the user may set this value and hence override the calculated Batch amount at any stage.
If the users sets this as Undefined (or '*') this is equivalent to any infinite Batch and therefore the flow through the pipe will not be restricted.
|-
| V.BatchTotal || font style="background: #ebebeb" | Display || The Total Volume that has flowed through the pipe using the Batch addition method.
|-
| colspan="3" font style="background: #ebebeb" | The following fields will be visible if Total Mass or Total Volume is selected as the Batch method.
|-
| rowspan = "4" valign="top" | BatchState || font style="background: #ebebeb" | None || No Batch mode has been set.
|-
| font style="background: #ebebeb" | Inactive || A Batch method has been selected, but the Batch is undefined.
|-
| font style="background: #ebebeb" | Busy || A Batch method has been selected, there is material remaining in the Batch, and hence there is flow in the pipe due to the Batch.
|-
| font style="background: #ebebeb" | Stop Flow|| A Batch method has been selected, there is NO material remaining in the Batch, and hence there is no flow in the pipe, i.e. the Batch will prevent any flow in the pipe.
|-
| BatchClearOnEmpty|| Tickbox || If enabled, any remaining batch amount will be cleared on Empty action command.
|-
| BatchUsePreset || Tickbox || This enables the use of Preset for the Batch amount.
|-
| M or V.BatchUsePreset || Input|| The Mass or Volume of the Batch when the model is Preset. Refer to Actions Commands - Preset for more information.