View source for Feeder-Cross Page Connector

[[Category:Models]]
{{Navigation|[[Models]]|[[Models#General Models|General Models]]}}

'''Related Links:''' [[Size Distribution Definition]], [[Models#Qualities_Models|Qualities Models]]

----
{{TOC}}
== General Description ==

This unit can function in one of three ways:
# A '''Source''' of material:
#* In this case the user usually sets up the Required Flow from the unit, the Temperature and Pressure AND the species composition, on the [[Common_Content_Section#DSp_Section|Define Species - DSp page]].
#* The Default species composition in a Feeder is 100% water.  Therefore, if the user does NOT change the species composition, the Feeder will deliver water to the project.
# A '''Sink''' for material.
# A '''Cross Page Connector''', in which case it would be connected to another Feeder / Cross Page unit, typically on another flowsheet page.
#* You may navigate to the connected Feeder by double clicking with the left mouse button on the Feeder.
#* In addition, if the Feeder is not connected, but has the '''[[#Composition Fetch|Composition Fetch (CF)]]''' enabled, then double clicking with the left mouse button on the Feeder will take you to the CF source (often a pipe).
#* The image below shows how to connect Feeders.

'''Connections'''

[[Image:FeederConnectedRev2.png]]

#If two units are connected as cross page connectors, as shown in the left hand image above:
#* ''ROM_TO_LEACH_PLANT'' (operation mode Sink) is connected to ''ORE_FEED'' (operation mode Source)
#* All the feeder information defined in ''ORE_FEED'' is greyed out and will be ignored.
#* The down stream link from ''ORE_FEED'' will contain exactly the same information as the up stream link of ''ROM_TO_LEACH_PLANT''.
#* Any information in the ''ORE_FEED'' unit will be maintained and not lost.
# If the cross page connection is disabled, as shown in the right hand image above:
#* There is '''no''' connection between the ''ORE_FEED'' and the ''ROM_TO_LEACH_PLANT'' units.
#* The input fields in ''ORE_FEED'' are white and the user may insert any value, which will be used by the unit.

'''Notes:'''
# The model requires either a single inlet or a single outlet, depending upon its intended use.
# A Sink has no input fields - the user may not set anything in this unit - it accepts whatever is delivered by the upstream link.
# The user may not type any Feed data into a Source until it has been connected to a downstream link.
# A Cross Page Connection can only be established between two Feeder/XPG units.

== Diagram ==

[[Image:FeederXpg.png]]

The lines show the stream connections.

== Inputs and Outputs ==

{|   border="1" cellpadding="5" cellspacing="0" 
|-
| valign="top" rowspan="2" | '''Label ''' || valign="top" rowspan="2" | '''Required /<br>Optional''' || valign="top" rowspan="2" | '''Input /<br> Output''' || colspan="2" | '''Number of connections''' ||'''Description'''
|-
|'''Min''' ||'''Max''' ||&nbsp;
|-
| Snk || Required || Input || 1 || 1 || OR &nbsp;
|-
| Src || Required || Output || 1 || 1 || &nbsp;
|-
|}

== Model Theory ==

Used as a material source or sink; OR as a connector between two feeders (usually on separate graphics pages).

== Data Sections ==

The feeder access window may consist of a number of sections. This number may increase or decrease, based on user configuration and / or number of species. Some of these variables are only relevant in the case of a source. When the unit is connected to another cross page connector, the input variables are not used.

# '''[[#Feeder-Cross Page Connector|FeederSink]]''' - this is the first Tab.  The user accesses this tab to configure the basic manner in which the Feeder works, or to connect to a another Feeder.
# '''[[#Batch Feed|Batch Feed]]''' - this section is available on the first Tab in Dynamic projects.  This allows users to set the Feeder to deliver a fixed amount of flow.
# '''[[VLE]]''' - Optional tab that is visible if Vapour Liquid Equilibrium is enabled on the first tab. Only visible for selected [[#Feeder Operation Selection|Feeder Operation]] modes. 
# '''[[Phase Change (PC)|PC]]''' - Optional tab that is visible if that is visible if [[#Feeder Operation Selection|Feeder Operation]] = "General" and EB.Solubility.On and/or EB.PhaseChange@T.On is enabled on the first tab.
# '''[[MU]]''' - Optional tab, or tabs if there is more than one Makeup, that is visible if [[#Feeder Operation Selection|Feeder Operation]] = "General" and Makeups > 0.
# '''[[#Content Tab Page|Content]]''' - This tab is only visible if 'ShowContent' is ticked. Contains data on the material from the Feeder and may be spread across one or two Tabs, depending on the project and the selected views.  This Tab is not visible if the unit is a Sink.
# '''[[#WQ Tab Page|WQ]]''' - Optional tab, this tab is only visible if ''WaterQualities'' in the [[Plant Model - Views|Plant Model - Views tab page]] is ticked.  
# '''[[#DSp Tab Page|DSp]]''' - this tab allows the user to define the species ('''D'''efine '''Sp'''ecies) in the material from the Feeder. This may be spread across one or two Tabs, depending on the number of species in the project. This Tab is not visible if the unit is a Sink.  NOTE also that depending on the '''[[#Feeder Operation Selection|Feeder Operation]]''' selection, the DSp page may display the Full list or a "Pre-filtered" list of species.
# '''[[#DLockup Tab Page|DLockup]]''' - Optional tab that is visible if Qualities - "Lockup.Action = Create". Please see [[LockUp]] for more information.
# '''[[#DTrack Tab Page|DTrack]]''' - Optional tab that is visible if Qualities - "MatTrack.Action = Create". Please see [[Material Tracking]] for more information.
# '''[[#DSz Tab Page|DSz]]''' - Optional tab that is visible if Qualities - "SzDist.Action = Create". This allows the user to define the Size Distribution(s) for the solids in the unit. Please see [[Size Distribution (PSD)]] for more information. The methods of defining the Size Distribution can be found in [[Size Distribution Definition]].
# '''[[#DSSA Tab Page|DSSA]]''' - Optional tab that is visible if Qualities - "SzSSA.Action = Create". Please see [[Specific Surface Area (SSA)]] for more information.
#{{ShowQout|Feed|combined feed|139only=no}}
#* This is before any [[Evaluation Blocks|Evaluation Block]] sub-models are evaluated.
#{{ShowQout|Prod|product|139only=no}}
#* This is after any [[Evaluation Blocks|Evaluation Block]] sub-models are evaluated.
# '''[[Common Data Sections#Common Data on Info Tab Page|Info]]''' tab - contains general settings for the unit and allows the user to include documentation about the unit and create Hyperlinks to external documents.
# '''[[Links Table|Links]]''' tab, contains a summary table for all the input and output streams. 
# '''[[Audit]]''' tab - contains summary information required for Mass and Energy balance. See [[Model Examples]] for enthalpy calculation Examples.

===Feeder-Cross Page Connector===
'''Unit Type: FeederSink''' - The first tab page in the access window will have this name.

The Data section of the cross page connector changes depending on the Operation Mode.  Please click on the relevant mode to see the different settings.
{|   border="1" cellpadding="5" cellspacing="0" align="center"
|    Width=150|'''Tag (Long/Short)''' || Width=100|'''Input / Calc / Options''' || '''Description'''
|-
{{Common Data on First Tab Page|ModelType=Feeder}}
|-
|  colspan="3" font style="background: #ebebeb"    |

==== Feeder Operation Selection ====
|-
|Rowspan=13|Operation ||General|| This operation allows user full control for setting all available feeder options.  [[#Composition Fetch|Composition Fetch]], [[#EB.28Feed_Processing.29...|sub-models]] and full species list are available in the DSp tab.
|-
||Solids||This operation mode will apply a solids filter to the DSp tab, all species in other phases are forced to zero.  This operation mode does not allow composition Fetch nor sub-models.  VLEquilibrium is not available as it does not apply to solids.
|-
||Liquids||This operation mode will apply a liquids filter to the DSp tab, all species in other phases are forced to zero.  This operation mode does not allow composition Fetch nor sub-models. [[#Temperature & Pressure Requirements|VLEquilibrium]] selection is limited to Saturated or subcooled liquid.
|-
||Vapours||This operation mode will apply a vapours filter to the DSp tab, all species in other phases are forced to zero.  This operation mode does not allow composition Fetch nor sub-models. [[#Temperature & Pressure Requirements|VLEquilibrium]] selection is limited to Saturated or Superheated vapour mixtures.   NOTE: for mixed phases please use the General Operation mode.
|-
||Slurry||This operation mode will apply a solids & liquids filter to the DSp tab, all species in other phases are forced to zero.  This operation mode does not allow composition Fetch nor sub-models. [[#Temperature & Pressure Requirements|VLEquilibrium]] selection is limited to Saturated or subcooled liquid.
|-
||Water||This operation mode will apply a water filter to the DSp tab, the only species shown is Water.  This operation mode does not allow composition Fetch nor sub-models. [[#Temperature & Pressure Requirements|VLEquilibrium]] selection is limited to Saturated or subcooled liquid.  NOTE: for non saturated conditions please use the General Operation mode.
|-
||Steam||This operation mode will apply a Steam filter to the DSp tab, the only species shown is Steam.  This operation mode does not allow composition Fetch nor sub-models. [[#Temperature & Pressure Requirements|VLEquilibrium]] selection is limited to Saturated or Superheated pure steam.  NOTE: for steam mixed with other vapours use the Vapours or General Operation mode.
|-
||PlantModel Air ||This operation will fetch the Global air specification from [[Plant Model - Environment]] Tab, Air Composition section into the DSp Tab.  In this mode, only the flowrate can be adjusted.
|-
||PlantModel DryAir ||This operation will fetch the Global dry air specification from [[Plant Model - Environment]] Tab, DryAir Composition section into the DSp Tab.  In this mode, only the flowrate can be adjusted.
|-
||Stream Fetch||This operation will allow user to fetch the stream T, P, and composition information from another stream.  User must specify the source stream, e.g.: P_104.Qo OR ROM_STOCKPILE.QFeed.  In this mode, only the flowrate can be adjusted. If flow should also be fetched, please tick the ''FetchFlow'' tickbox in the ''Required Mass/Volume Flow'' section.
|-
||Content Fetch||This is available for dynamic simulation only. This operation will allow user to fetch the T, P and composition information from another content (such as tank).  User must specify the source, e.g.: Tank1.Content.  In this mode, the flowrate can be adjusted.  
|-
||MakeupSrc Fetch||This operation will allow user to fetch the stream information from a Makeup Source. In this mode, only the flowrate can be adjusted. A DirectLink pipe is not created between the feeder and the flow used is NOT reflected in the Makeup source total. The purpose of this operation mode is for the feeder to be a true source of material and to use a Makeup source as a common Composition, T and P template definition.
|-
||Link to MakeupSrc||This operation will allow user to draw the flow from a Makeup Source, the DirectLink is automatically created similar to a Makeup block. In this mode, only the flowrate can be adjusted. The advantage of this operation mode is that the Makeup source is the source of the material, a DirectLink stream is created and the flow used is reflected in the Makeup source total.  Click [[#3._Set_Feeder_to_Demand_mode.2C_while_using_material_from_Makeup_Source|here]] to see an example.
|-
||Source || Input || 
Visible with the '''Stream Fetch''' operation.  User specified the source stream, e.g.: P_104.Qo OR ROM_STOCKPILE.QFeed <br>
Visible with the '''Content Fetch''' operation.  User specified the source content, e.g.: Tank1.Content.  (This is for dynamic mode only)
|-
||MakeupSrc || DropList || Visible with the '''MakeupSrc Fetch''' operation.  User selects the available makeup source unit from the list. <br> '''NOTE:''' If setting the makeup source via a controller or Excel, use the tag name of the makeup source. This is a string variable and cannot be set by integer index.
|-
|  colspan="3" font style="background: #ebebeb"    |SrcLink...  (This group is only visible with '''Link to MakeupSrc''' operation mode)
|-
||MakeupSrc || DropList || Visible with the '''Link to MakeupSrc''' operation.  User selects the available makeup source unit from the list. <br> '''NOTE:''' If setting the makeup source via a controller or Excel, use the tag name of the makeup source. This is a string variable and cannot be set by integer index.
|-
||DirectLink || Feedback|| Lists the name of the direct link (auto added by SysCAD).  This auto link can be renamed, the graphics for this autolink can also be adjusted using either 'change symbol' or 'redraw link'.
|-
||Connect||Feedback|| Returns the status of the makeup connection with the makeup source.  If the makeup source tag is invalid or empty, an error will be given.
|-
|  colspan="3" font style="background: #ebebeb"    |

==== Flow Requirements ====
|-
|rowspan="4" valign="top"| Mode || MassFlow (Qm) || Default. The user may set the Mass flow from the feeder.
|-
|| VolumeFlow (Qv) || The user may set the Volume flow from the feeder.
|-
|| NVolumeFlow (NQv) || The user may set the Normalised Volume flow from the feeder.
|-
|| Const Pressure || The user may set the Pressure at the feeder.  This option is only available in Dynamic Transfer mode.
|-
|rowspan="4" valign="top"| FlowBasis <br>Only available for<br> [[#Feeder Operation Selection|Operation - General Mode]]. <br> (See [[#Example using the Different FlowBasis Options|Example]] <br>in the Hints and <br>comments section) || All || The flow specified will be the flow of '''All''' phases from the Source, i.e. if Flow Required = 10t/h, then a total of 10t/h will flow out of the Source.
|-
|| Solids || The flow specified will be the flow of the '''Solid''' phase from the Source, i.e. if Flow Required = 10t/h, then 10t/h of Solids will flow out of the Source.  If the user has specified a composition of 90% solids and 10% liquids, then the Total Flow = 10t/h Solids + 1.11t/h Liquids = 11.11t/h. 
|-
|| Liquids || The flow specified will be the flow of the '''Liquid''' phase from the Source, i.e. if Flow Required = 10t/h, then 10t/h of Liquids will flow out of the Source.  If the user has specified a composition of 50% liquids and 50% solids, then the Total Flow = 10t/h Liquids + 10t/h Solids = 20t/h.
|-
|| Vapour || The flow specified will be the flow of the '''Vapour''' phase from the Source, i.e. if Flow Required = 10t/h, then 10t/h of Vapours will flow out of the Source.  If the user has specified a composition of 20% vapours, 70% liquids and 10% solids, then the Total Flow = 10t/h Vapours, 35t/h Liquids + 5t/h Solids = 50t/h.
|-
|  colspan="3" font style="background: #ebebeb" |
The ''SpModel.Reqd'' field is only shown if more than one Species Model is available in the project (e.g. Standard and Bayer3).
|-
| rowspan="3" | SpModel.Reqd || Inherit || Upstream configuration will be used.
|-
| Standard || All the variables are calculated using the Mass Weighted Mean of the species.
|-
| ''Species Model'' || Use an alternative species model, such as 'Bayer3' or 'Potash'. 
|-
| rowspan="2" | SpModel.Used || font style="background: #ebebeb" | Standard|| The Standard species model is being used.
|-
| font style="background: #ebebeb" | ''Species Model'' || An alternative species model is being used. 
|-
| SpModelType || font style="background: #ebebeb" | Display || This field displays the Species Model type used in the unit.
|-
| Calculator || TickBox || Only visible if Species Model used is Bayer3 or Potash.  Please see [[Alumina_3_Bayer_Species_Model#Bayer_Liquor_Calculator|Bayer Liquor Calculator]] or [[Potash_Species_Model#Potash _Liquor_Calculator|Potash Liquor Calculator]]
|-
| Demand.On || TickBox || If this is enabled then the feeder will feed in the required mass as demanded by the connected stream. See [[Demand]].<br>  If this is not enabled, then the feeder adds the amount of material as specified by the user.
|-
| Demand.Max || Input || The maximum flow allowed from the Feeder in [[Demand]] mode.  This field is only visible if Demand.On is enabled.
|-
| colspan="3" font style="background: #ebebeb" | When demand.On is in use, the Required Flow (see next group of tags) will become the Demand Minimum (mass/volume) flow.  The variable will have text "(Min)" displayed as a reminder.
|-
|  colspan="3" font style="background: #ebebeb" |

====Required (Mass or Volume) Flow ====  
This field is not available if the user selects ''Const Pressure'' in Dynamic Transfer mode.
|-
| FetchFlow || Tickbox || Visible when [[#Feeder Operation Selection|Operation]] = "Stream Fetch".  This allows the feeder to fetch Flow rate from the source unit. 
|-
| MassFlowReqd / QmReqd   || Input || Visible with ''MassFlow (Qm)'' Mode. The mass flow required from the feeder. '''Note:''' This will become the minimum flow allowed if Demand.On is enabled.
|-
| VolFlowReqd / QvReqd   || Input || Visible with ''VolumeFlow (Qv)'' Mode. The volumetric flow required from the feeder. '''Note''': This is minimum flow allowed if Demand.On is enabled.
|-
| NVolFlowReqd / NQvReqd  || Input || Visible with ''NVolumeFlow (NQv)'' Mode. The normalised volumetric flow required from the feeder. '''Note''': This is minimum flow allowed if Demand.On is enabled.
|-
|    colspan="3" font style="background: #ebebeb"   |

==== Temperature & Pressure Requirements ====
NOTE: The VLE options are only valid for components with VLE information.  When one of the VLE options is chosen, the VLE tab will be visible.  <span style="color: red">'''Some VLE conditions are inherently unachievable: for example you can never have a saturated vapour if there are nonvolatile ''liquid'' components present'''.</span> If you try to set an [[Vapour_Liquid_Equilibrium_%28VLE%29#Further_Notes|unachievable condition]] you will get an error. <br>
Below is a full list and is for the '''[[#Feeder Operation Selection|Operation - General Mode]]''' only.  For other operation modes, VLEquilibrium is either NOT available or only a subset is available.
{{VLEquilibrium Data Section}}
|-
|    colspan="3" font style="background: #ebebeb"   |

==== Qualities ====
|-
|    colspan="3" font style="background: #ebebeb"   |Stream qualities such as "Lockup", "MatTrack - material tracking", "SzSSA - Size using average specific surface area" and "SzDIst - Size distribution" maybe created / removed here.  The visibility of this section will depend on user selection and '''Operation''' mode selection.  
*For example, SSA is normally related to solid species, so it will not be visible for Liquid or gas operation modes.
{{QualitiesCommonSection}}
|-
|    colspan="3" font style="background: #ebebeb"   |

==== Cross Page Connection ====
No connection can be made in a Sink unit - the user '''MUST''' connect two cross-page connectors via the Source unit (Feed to the flowsheet).
|-
| ConnectionBlocked || Tick Box || Marks the unit is a material input or material output and unavailable for cross page connection. <br>Selecting the tickbox on the '''Sink''' unit will remove the unit from the "available to connect (ConnectTo)" list.  For example, if the Sink is the '''Product''', user may tick this box to avoid accidentally selecting this from the ConnectTo droplist.<br>Selecting the tickbox on the '''Feeder''' will break any cross page connections already in place.  
|-
| ConnectionOn || Tick Box || This is used to enable the configured cross page connection.  This may only be accessed on a Source, it cannot be changed on a Sink unit.
|-
| ConnectTo || Input / List || The required '''Tag Name''' of the connecting Sink unit.  The drop-down list will contain the tags of all un-connected Sinks in the project.  The user may also type in the Tag of the required Sink. <br> 
'''NOTE:''' If setting the connection via a controller or Excel, a string variable is expected, so use the tag name of the connecting sink. 
*When using a PGM, the SetTag function syntax is [Str "TagName.ConnectTo"] = "connected sink tag name".   
*For example: [Str "Oxidising_Leach_Solution.ConnectTo"] = "To_CuCementation"  (recommend adding this to the Prestart subroutine)
|-
| ConnectedTo || font style="background: #ebebeb" | Display || If ConnectionOn is enabled AND ConnectionBlocked is not selected AND a valid Sink Tag is entered in the ConnectTo field, then the connected Sink tag is displayed in this field.  
*You may find the connected Feeder by double left clicking on this unit.  -  NOTE that this jump to connected unit feature can be switched off by clearing the [[General Options Mouse|Mouse]] settings for '''Find Connected & Access'''.
*If this field is blank, then the Source is NOT connected. 
* If the ConnectionBlocked is on, then a message will appear, for a feeder, the message will read: "(Connection Blocked Locally)", for a sink, the message will read: (Connection Blocked by 'connected tag')
|-
| Connected || font style="background: #ebebeb" | Display || Displays the status of the cross page connection - either Yes or '-'.
|-
|  colspan="3" font style="background: #ebebeb"    |

==== Composition Fetch ====
*This section is for the '''[[#Feeder Operation Selection|Operation - General Mode]]''' only.  For other operation modes, Composition Fetch is either NOT available or available in a simplified form.
*When using Composition Fetch (CF) the options selected (e.g. under CF.What) should not conflict with other settings in the feeder. For example if the VLE is enabled it would be setting composition, T and/or P therefore CF.What must not try fetch any of these. For example, if the Bayer Feed Calculator is configured it will set the composition, therefore CF.What cannot fetch the composition.  <span style="color: red">When there is any form of Composition Fetch conflict, SysCAD will give an error message and the Composition Fetch will be ignored.</span> <br>
|-
|rowspan="3" valign="top"|CF.When||Off||No information will be transferred automatically.  The user may still manually transfer data from the source by pressing the CF.Fetch button.
|-
| OnceOff||This mode allows a once off automatic information transfer of information at the next project step (if the project is solving) or when project solve/run is started (if the project is stopped).  Once the data has been transferred, it will revert back to the off mode.
|-
| Continuous||This mode allows continuous automatic information transfer while the project is solving. This is similar to a cross page connector in terms of material flow but the solver will treat the unit operations separately.  Therefore, for large projects with difficult to solve recycle streams, this is a great way of breaking up the solver network to improve solve speed.
|-
|rowspan="16" valign="top"|CF.What||Nothing||No information will be fetched.
|-
| T ||Temperature information from the CF.Source unit (specified by the user) will be used.
|-
| P || Pressure information from the CF.Source unit (specified by the user) will be used.
|-
| T, P||Temperature and Pressure information from the CF.Source unit (specified by the user) will be used.
|-
| Comp||Component make up information from the CF.Source unit (specified by the user) will be used.
|-
| T, Comp||Temperature and Component make up information from the CF.Source unit (specified by the user) will be used.
|-
| P, Comp||Pressure and Component make up information from the CF.Source unit (specified by the user) will be used.
|-
| T, P, Comp||Temperature, Pressure and Component make up information from the CF.Source unit (specified by the user) will be used.
|-
| Flow||Flowrate information from the CF.Source unit (specified by the user) will be used.
|-
| T, Flow||Temperature and Flowrate information from the CF.Source unit (specified by the user) will be used.
|-
| P, Flow||Pressure and Flowrate information from the CF.Source unit (specified by the user) will be used.
|-
| T, P, Flow||Temperature, Pressure and Flowrate information from the CF.Source unit (specified by the user) will be used.
|-
| Comp, Flow||Components make up and Flowrate information from the CF.Source unit (specified by the user) will be used.
|-
| T, Comp, Flow||Temperature, Components make up and Flowrate information from the CF.Source unit (specified by the user) will be used.
|-
| P, Comp, Flow||Pressure, Component make up and Flowrate information from the CF.Source unit (specified by the user) will be used.
|-
| T, P, Comp, Flow||Temperature, Pressure, Component make up and Flowrate information from the CF.Source unit (specified by the user) will be used.
|-
|rowspan="8" valign="top"|CF.What.Phase||colspan="2" font style="background: #ebebeb"|Only available in Build 139 or later. Only shown if the ''CF.What'' option selected includes '''Comp''' and/or '''Flow'''.
|-
|All || The fetch will be based on ALL of the phases in the stream.
|-
|Solids || The fetch will only be based on the solid phase in the stream.
|-
|Liquids || The fetch will only be based on the liquid phase in the stream.
|-
|Vapours || The fetch will only be based on the vapour phase in the stream.
|-
|Solids & Liquids || The fetch will only be based on the solid and liquid phases in the stream.
|-
|Solids & Vapours || The fetch will only be based on the solid and vapour phases in the stream.
|-
|Liquids & Vapours || The fetch will only be based on the liquid and vapour phases in the stream.
|-
|  CF.What.Quality || TickBox || Only shown if the ''CF.What'' option selected includes '''Comp'''. Different tick boxes will be visible, depending on the options enabled in the project. Possible options include: LockUp, Size data and so on.  See [[Models#Qualities Models|Qualities Models]] for more information.<br>The project in the example shown below has Size Distribution enabled, and therefore the user may also fetch the size data from the stream in the composition fetch:
[[Image:CF_qualities.png]]
|-
|CF.Ratio || Input || Only shown if the ''CF.What'' option selected includes '''Flow'''. This allows the user to set a ratio of the feeder flow to the source flow.  So, for example, if the ratio = 1 (default value, and most commonly used setting) then the flow from the feeder will be equal to the flow in the source.  If the ratio is set to 2, then the feeder flow will be twice that from the source.
|-
| CF.Source || Input || 
{|
|The default is (Self.flows). This option will work if the following sequence of events has taken place. 1) The feeder is connected to another unit via the cross page connector method; 2) the flowsheet has been solved with the connection on. If the above are true, then the feeder will temporarily carry solved flow information. The user can then elect to copy an image of this data and set them as the feeder information by fetching the self flows data.
If the user wants to get information from other unit operations, then the format is:<br>[Unit Operation Tag Name].[Tab Page Name]<br>
*Examples: XPG_001.QProd, P813.Qo, TNK_001.QFeed, <br> 
*To set a string variable to this field from the PGM file, e.g.: [Str "Plant_Feed.CF.Source"] = "P813.Qo"
|
[[File:CopyTabName.png]]
|}
|-
|  CF.WarnOnZeroSrc||TickBox||If this is enabled then the user will receive a warning if the flow in the source is zero (or if the surge content is zero in a dynamic project)
|-
|  CF.WarnOnCoExist||TickBox||
|-
|CF.Fetch || Button || The required information is fetched from the CF.Source unit operation and used to set the current feeder configuration.
|-
|   colspan="3" font style="background: #ebebeb"    |

==== EB(Feed Processing)... ====

NOTE: This section is only visible for the '''[[#Feeder Operation Selection|Operation - General Mode]]''' only. For other operation modes, EB sub models are either NOT available or available in a simplified form (e.g. Makeup). 
{{EB Evaluation Data Section | Makeups = Yes }}
|-
|  colspan="3" font style="background: #ebebeb" |

==== Results: Flow Conditions ====
|-
| State  || font style="background: #ebebeb" | Display || Displays the state of the unit. Options are: Feeder, Sink, Feeder-Connected, Sink-Connected.   
|-
| MassFlow / Qm  || font style="background: #ebebeb" | Display || The mass flow into or out of the unit.
|-
| VolFlow / Qv   || font style="background: #ebebeb" | Display || The volume flow into or out of the unit.
|-
| NVolFlow / NQv || font style="background: #ebebeb" | Display || The normalised volume flow into or out of the unit.
|-
| Temperature / T|| font style="background: #ebebeb" | Display || The Temperature of the material flowing into or out of the unit.
|-
| Density / Rho  || font style="background: #ebebeb" | Display|| The density of the material flowing into or out of the unit.
|-
| NDensity / NRho|| font style="background: #ebebeb" | Display|| The normalised density of the material flowing into or out of the unit.
|-
| Pressure / P   || font style="background: #ebebeb" | Display || The pressure of the unit.
|-
|  colspan="3" font style="background: #ebebeb" |
==== Options ====
|-
| PasteData || Button || Allows the user to paste data copied from a stream (using the 'CopyToClipboard' button).  The stream may be in the  current SysCAD project, or another project.<br> See [[FAQ - Modelling related questions#How do I copy Stream data to a Feeder?|How do I copy Stream data to a Feeder?]]
|-
| ShowContent || Tickbox || Allows the user to view the Content tab of the Feeder.
|-
{{ShowQout DataSection|Feed|combined feed|139only=no}}<br>This is the flow from the Feeder unit, either via the Cross Page Connection or as set by the user, but prior to any Makeups.
|-
{{ShowQout DataSection|Prod|product|139only=no}}<br>  This is the actual flow from the Feeder unit, including any Makeups.
|}

=== Batch Feed ===

This functionality allows the user to allow the Feeder to deliver a discrete batch to the project.  This section is only available in ''Dynamic'' mode.

{|   border="1" cellpadding="5" cellspacing="0" align="center"
|    Width=150|'''Tag (Long/Short)''' || Width=100|'''Input / Calc''' || '''Description'''
|-
| 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 delivered by the Feeder at the rate specified in Qm.Capacity or Qv.Capacity.<br> When this value is set the amount of material will be added to the amount of material already in 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 be delivered by the Feeder.  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 Feeder. <br>However, the user may set this value and hence override the calculated Batch amount at any stage.<br> If the users sets this as Undefined (or '*') this is equivalent to any infinite Batch and therefore the flow from the Feeder will not be restricted.
|-
| M.BatchTotal || font style="background: #ebebeb" | Display || The Total Mass that has been added to the Batch using the BatchAddition field. Note this will exclude any Preset Batch amount or any manual changes to the BatchRemaining field.
|-
| 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 delivered by the Feeder at the rate specified in Qm.Capacity or Qv.Capacity.<br> When this value is set the amount of material will be added to the amount of material already in 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 be delivered by the Feeder.  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 Feeder. <br>However, the user may set this value and hence override the calculated Batch amount at any stage.<br> If the users sets this as Undefined (or '*') this is equivalent to any infinite Batch and therefore the flow from the Feeder will not be restricted.
|-
| V.BatchTotal || font style="background: #ebebeb" | Display || The Total Volume that has been added to the Batch using the BatchAddition field. Note this will exclude any Preset Batch amount or any manual changes to the BatchRemaining field.
|-
| 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 from the Feeder 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 from the Feeder, i.e. The Batch will prevent the Feeder from discharging any material.
|-
| BatchClearOnEmpty || Tickbox || {{Available139|32925}} If selected, this clears (i.e. sets to 0) the Batch amount with the Empty Action.
|-
| BatchUsePreset || Tickbox || This enables the use 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|Preset]] for more information.
|}

=== Content Tab Page ===
{{Feeder and Source Content Data Section | Feeder=Yes |UnitOp=Feeder}}

=== DSp Tab Page ===

* This Tab will contain a list of all of the species that are specified in the Project configuration file.  If a species exists in more than one phase, it will be shown in each phase, e.g. H<sub>2</sub>O(l) and H<sub>2</sub>O(g).
* If this Tab is not configured, the default value will be 100% water.  Therefore, if a project contains only water, the cause may be that the Feeder species requirements have not been configured.
* The manner in which you can specify the relative amount of the species depends on which '''View''' and '''SpBasis''' you have selected. The options, and their consequences, are described in the tables below.
{{ DSp Data Section}}

'''''Notes'''''
# The fields can either be calculated (e.g. sum of all species in the phase) or specified. The phase total will be the sum of individual species specified.
# If the Phase flows are adjusted, SysCAD will adjust all the individual species flow to meet the specified total phase flow.
# Similarly, if the Phase fraction is adjusted, the individual species fractions on a phase basis will be preserved.
# Only adjust either the total phase flow or the individual species flow at any one time to avoid over specifying.

=== DLockup Tab Page ===

{{DLockup Data Section}}

Please see [[LockUp#Creating Lockup in a Stream|Lockup - Creating Lockup]] for more information.

=== DTrack Tab Page ===

{{DTrack Data Section}}

Please see [[Material Tracking#DTrack Data Sections|Material Tracking - DTrack Data Sections]] for an explanation of the fields.

=== DSz Tab Page ===

{{Dsz Tab Page Data Section}}

Please see [[Size Distribution Definition]] for more information on the methods and constants used.

=== DSSA Tab Page ===

{{DSSA Data Sections}}

Please see [[Specific_Surface_Area_(SSA)#Creating SSA in a Stream|DSSA Data Sections]] for more information.

== Hints and Comments ==
# The configuration options for the feeder will be based on [[#Feeder Operation Selection - Operation|Operation]] mode selected. 
#*CF and EB groups are only visible for the General Operation mode.  
#*VLE options will be shortened or not visible for selected modes. 
#*The DSp tab species list will also be shortened for selected modes.
#The '''Link to MakeupSrc''' and '''Demand.on''' can be used at the same time, allowing the use of both Makeup and Demand in the same unit.
# The default Mode of the Feeder is ''MassFlow (Qm)''. The ''Const Pressure'' is only visible in dynamic simulations. The valid modes for Steady State are ''MassFlow (Qm)'', ''VolumeFlow (Qv)'' or ''NVolumeFlow (NQv)''
# The default for FlowBasis is 'All'. See below for an example of the use of the other FlowBasis options.
# Depending on the method selected in the VLE list box, the feeder composition may automatically be adjusted. Example if VLE saturated_liq is selected and the user sets the species mass fraction to 100% H<sub>2</sub>O(g), the unit may change this to 100% H<sub>2</sub>O(l). Please always double check the component make up when changing VLE methods.
# If you are using a Feeder in '''Demand''' Mode, the number in the QmReqd, or QvReqd, box will '''NOT''' indicate the amount of material flowing from the feeder, but the minimum flow.
# If you have elected to enter Species composition flows on an individual basis on the DSP page, (e.g. using the '''Mass Flow''' view), then you will not be allowed to enter flowrates in the QmReqd (Mass flow required) field. This is because the total mass flow will be calculated from the individual Species flows entered. If the total mass flowrate input is necessary, simply switch back to the '''Mass Fraction''' view after individual flow data input.
# The feeder unit operation can be used to connect flow information between graphics pages. There are two easy ways of connecting flow information:
#* Through the [[#Cross Page Connection|Cross Page Connection]]. If this is successful, the two unit operations will be connected as though there is a physical connection. Thus, when SysCAD is building the solution, these two unit operations will be included in the same solve network.
#* Through [[#Composition Fetch|Composition Fetch]]. In this case, an IMAGE of the flow information from the source unit operation is copied onto the current Feeder/Cross Page unit operation. The user can customise the frequency and amount of information fetched.<br>NOTE: When using composition fetch, the unit operations stay separated from each other. Thus, there is no permanent connections being made even when the frequency is set to continuous. Therefore, when SysCAD is building the solution, the two unit operations can belong to two separate solve networks. The user can use this method to break up a recycle stream if the solution is difficult to obtain in a closed loop.
# If a project is opened using the ''Open with alternate Configuration'' command, Feeders '''MAY''' lose their species compositions IF the new configuration file does not contain all of the species in the original configuration.
# If [[#Composition Fetch|Composition Fetch]] is set to 'Continuous', and depending on the CF.What selection, there may be a conflict with other settings. For example the VLE selection may be configured to set the temperature and you have selected temperature under composition fetch, then there is a conflict. Only one of these conflicting configurations should be configured. When there is a conflict, the CF is ignored.
# To set up feeder information when flowsheets are being solved separately using Activate/Deactive flowsheet option: Use the CF Fetch - Self Flows option.

== Examples ==

=== 1. Simple Composition Fetch from Stream or Contents===
{|
|[[File:Feeder-StreamFetch.png|Feeder-StreamFetch Mode with user specified flow]]
|
*Set '''[[#Feeder Operation Selection|Feeder Operation Selection - Operation ]] = Stream Fetch''' mode, 
*To set up '''Source''', use UnitTagName.Qo for pipes (e.g. P_001.Qo) or UnitTagName.QFeed for tanks (e.g. TNK_001.QFeed)
*The "Stream Fetch" mode allows a '''full copy''' of the '''properties''', including T, P, Composition, Particle Size Distribution Data and so on.
*If the user wishes to copy the '''flow''' as well, then select the '''FetchFlow''' tickbox in the Required Mass Flow section.  This will allow an exact copy of the source unit, with all properties and flow.
*In this simple fetch mode, data is copied continuously and user can choose only "full properties" or "full properties and Flow".  
*Variables being "fetched" will show comment "Stream Fetch" to the right of the value field. "DSp" tab variables will be greyed out.
*If the user wishes to fetch partial data only, then use the General operation mode to get the Full Composition Fetch feature, as shown in the next example.
|}

=== 2. Using Full Composition Fetch  ===

*Set '''[[#Feeder Operation Selection|Feeder Operation Selection - Operation ]] = General''' mode, allowing full functionality of the composition fetch.
*In the full composition mode, user has the flexibility to fetch only partial data, as well as control when the fetch will occur.

The diagram below shows a feeder (Pb_Concentrate) that has been connected to a sink (Lead_Concentrate). While the connection was still intact, SysCAD was solved, thus the Cross Page Connector carries an image of the flow condition, see ''Results: Flow Conditions'' section, the calculated information for ''Qm, Qv, T'' etc.

Use '''Composition Fetch''' to keep the pre-solved intermediate information as the feeder configuration information, this transfers Qm to QmReqd, T to T_Reqd etc.

If the user sets the frequency of the fetch to '''Continuous''', then whenever values change, the feeder configuration will be updated.  Therefore, if the Cross-page connection is disabled, (either manually or through the deactivate flowsheet option), the feeder will always contain the previous solved information.

NOTE: Composition Fetch assumes flow is "'''ALL'''" basis, so please make sure the '''FlowBasis''' (Under "Flow Requirements" section) is not set to single phase only (e.g.: "Solids").  

:[[Image:CompositionFetch.png]]

=== 3. Feeder in Demand mode & using Makeup Source ===

The new '''Link to MakeupSrc''' operation mode will allow user to set up the feeder to use both '''Demand''' and '''Makeup'''.  In previous versions of SysCAD, user cannot use these two features together.

For example, consider the following Process Water distribution,
*[[Image:Button Small 1.png]]Feeder Configuration
#Operation = "'''Link to MakeupSrc'''", this means the flow will come from the Makeup source, user do not have to set up any flow information as the T, P and composition of the specified makeup source will be used.
#A direct link is automatically added to show the makeup.
#The makeup source is set as "ProcessWater_Source"
#The feeder is also set with "'''Demand.On'''" ticked, this means the total flow will come from downstream demand, in this case, the Process Water distribution demand.
*[[Image:Button Small 2.png]]Each distribution pipe have been set up with a demand flow, as shown in the demand table.
*When solved, the total water demand will be added as a "'''ProcessWater_Source'''" user, the flow is shown in the makeup source summary table, in our case, XPG_001 = 22 t/h.
:[[File:LinkToMakeupSrc.png]]

=== 4. Using Different Flow Basis Options ===

The user configures the following species make-up in the feeder:

{|
|
:{|   border="1" cellpadding="5" cellspacing="0" 
| H<sub>2</sub>O(l)               || Width=50|40%
|-  
| H<sub>2</sub>SO<sub>4</sub>(aq) || 8%
|-
| SiO<sub>2</sub>(s)              || 30%
|-
| CaSO<sub>4</sub>(s)             || 20%
|-
| H<sub>2</sub>O(g)               || 1%
|-
| H<sub>2</sub>SO<sub>4</sub>(g)  || 1%
|-
|}

|This gives

|Valign=top|

:{|    border="1" cellpadding="5" cellspacing="0" 
|-
|	'''Total '''	||  Width=50|100%	                        
|-									
|	'''% Solids '''	||  48%	
|-									
|	'''% Liquid '''	||  50% 	
|-									
|	'''% Vapour'''	||  2% 	
|-
|}

|}

The table below demonstrates how Flow Basis works.
* Set Required Mass Flow (QmReqd) = 10t/h
* Then setting '''FlowBasis''' to Solids will mean 10 t/h of solids is required, liquid and vapour flow will be calculated based on the phase mass fraction.
* The results of using all different flow basis are shown below, the blue numbers are calculated values.

:{|    border="1" cellpadding="5" cellspacing="0" 
|-
!                            || Colspan=4| Flow Basis
|-
!   Flow Rate           || Width=50|All               ||  Width=50|Solids            ||  Width=50|Liquid           ||  Width=50|Vapour
|-
|	'''Total '''	(t/h)  ||  '''10'''	                        ||	<font color="blue">20</font>	||	<font color="blue">20.83</font>	||	<font color="blue">500</font>
|-									
|	'''Solids '''	(t/h)  ||	<font color="blue">5</font>	||  '''10'''                            ||	<font color="blue">10.42</font>	||	<font color="blue">250</font>
|-									
|	'''Liquid '''	(t/h)  ||	<font color="blue">4.8</font>	||	<font color="blue">9.6</font>	||    '''10'''	                        ||	<font color="blue">240</font>
|-									
|	'''Vapour'''	(t/h)  ||	<font color="blue">0.2</font>	||	<font color="blue">0.4</font>	||	<font color="blue">0.41</font>	||   '''10'''
|-
|}

=== 5. Setting Feeder using Aqueous Concentration ===

The feeder can only be specified in one of the following ways: "Mass/Mole flow of individual species", OR "Mass/Mole fraction of individual species + Total flow".  

If user wants to specify the feeder with aqueous concentration values, then they have to work out the "equivalent" mass fraction of the species (on the DSp tab) that gives the correct concentration (on the Sp tab)

For example, we want to set a feeder with 20 g/L of KCl(aq) and 50 g/L of NaCl(aq).  
#We can set these values on the "DSp" tab: 1 kg/h of water, 20 g/h of KCl(aq) and 50 g/h of NaCl(aq).  After we have entered these values and pressed the OK button, we can go to the Sp tab and look at the "Conc" (or Conc25) column to check the actual concentration values.  These will be out as the density will no longer be 1000 g/L.
#:[[Image:FeederConc1.png]]
#We can then manually adjust the mass flow on the "DSp" tab until the concentration on the "Sp" page is correct.  
#:[[Image:FeederConc2.png]]
#Once we have the correct concentration, then we can use the mass fraction to set the feeder: 
#:[[Image:FeederConc3.png]]

Alternatively, user can work out the mass fractions externally using MS Excel or using a PGM to calculate and set the required values.  
*An example PGM file can be found here: [[Aqueous Feed Concentration Calculator]]

NOTE: for users with the Alumina or Potash Add-on, the aqueous calculator is part of the species model.  User can select those to define the aqueous solution directly.
*[[Alumina_3_Bayer_Species_Model#Bayer_Liquor_Calculator|Bayer Liquor Calculator]] 
*[[Potash_Species_Model#Potash _Liquor_Calculator|Potash Liquor Calculator]]

== Adding this Model to a Project ==

<!-- {{{DllName}}}  {{{DllSubGroup}}}: {{{UnitOp}}}  {{{Group}}} -->
{{Adding Model to a Project | DllName=Basic1 | DllSubGroup=Process | UnitOp=Feeder/Sink/CrossPage | Group=General}}