View source for Noise Controller

[[Category:Models|Noise]] [[Category:Dynamic|Noise]] [[Category: Control|Noise]]
{{Navigation|[[Models]]|[[Models#Control 2 Models|Control 2 Models]]|altname=Noise Controller}}
{{Control2 Models Header table| currentpage=3 }}
'''Related Links:''' [[Noise Class]]
----
{{TOC}}
== General Description ==

*The Noise Controller unit operation is used to simulate process noise. It can be used to add disturbance to feeders, pipe outlet capacity, and other writeable variables.
*Standalone unit - no Pipe connections.
*Dynamic simulation only.

=== Diagram ===

:[[Image:Noise.jpg]]

The diagram shows the default drawing of the Noise control unit.

== Inputs and Outputs ==

There are no connections to this unit.

== Model Theory ==

{{Random Number Generator Probability Density Functions}}

== Data Sections ==
The default sections and variable names are described in detail in the following tables. The default Noise Controller access window consists of 2 sections. This number may increase or decrease, based on user configuration.

=== Summary of Data Sections ===

# '''[[#NoiseCon|NoiseCon]]''' tab - Contains a summary of all of the individual Noise Controls contained in the unit. 
# '''[[#NC1:_Individual_Noise_Controller_Data_Fields |NC Tabs ]]''' tab - This page contains all of the information for each individual Noise Controls, starting at 1 for the first Noise Controls. 
# '''[[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.

===NoiseCon ===
'''Unit Type: NoiseCon''' - The first tab page in the access window will have this name.
{| 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"  |'''''Requirements'''''
|-
| On || Tick Box || The Overall Noise Control unit will be enabled or disabled using this box.  This means that all of the independent Noise controllers in the unit will be disabled.
|-
|  colspan="3" font style="background: #ebebeb"  | The following message and field is visible when upgrading the project with existing noise controllers from SysCAD 9.2 (or earlier) to SysCAD 9.3.  <br> ''Change numbering to start from 1 instead of 0.'' <br> ''NB this affects Tags.''
|-
|ChangeNumbering || Button || Update Numbering to Start from 1 instead of 0.  Only visible if the noise controller was added in SysCAD 9.2 or earlier version.  NB: this may affect external tag references such as reports, please adjust the external references appropriately if updating the controller numbering.
|-
|  valign="top"  | Count ||  valign="top"  | Input || The number of independent Noise controllers required. This may be any number from 1 upwards. The user may also change this number at any time. The unit will always add new noise controllers after existing ones.<br> User may delete individual Noise using the 'Delete Me' button under the individual noise controller blocks.
|-
| Rowspan="3"|FreqMethod || Each Step|| The noise controller output value will be set every step. 
|-
| Steps Period || The frequency of setting the noise controller output value is based on steps.
|-
| Time Period || The frequency of setting the noise controller output value is based on simulated time period.
|-
| StepsPeriod || Input || Only visible only if '''FreqMethod''' is set to ''Steps Period''. The number of steps which must pass before the noise controller output value is set.
|-
| StepsOffSet || Input || Only visible only if '''FreqMethod''' is set to ''Steps Period''. Number of steps delay before the first noise controller output value is set.
|-
| StepsPassed || font style="background: #ebebeb" | Display || Only visible only if '''FreqMethod''' is set to ''Steps Period''. The number of steps that have passed since the last output value set.
|-
| TimePeriod || Input || Only visible only if '''FreqMethod''' is set to ''Time Period''. The amount of simulated time must pass before the noise controller output value is set.
|-
| TimeOffSet || Input || Only visible only if '''FreqMethod''' is set to ''Time Period''. Simulated time delay before the first noise controller output value is set.
|-
| TimePassed || font style="background: #ebebeb" | Display || Only visible only if '''FreqMethod''' is set to ''Time Period''. The amount of simulated time that has passed since the last output value set.
|-
| SetAtStartUp || Tick Box || With this option selected, the noise controller output value will be set during Startup step. 
|-
| SetTagAlways || Tick Box || Only visible only if '''FreqMethod''' is set to ''Steps Period'' or ''Time Period''.  With this option selected, the noise controller output value will be set every step.
|-
|  colspan="3" font style="background: #ebebeb"  |'''''Options'''''
|-
| ShowCnv || Tick Box || With this option selected, SysCAD will display engineering units for the Output tag.  '''Note''' that these will only be displayed after SysCAD has completed at least one step.
|-
| ShowOnePerPage|| Tick Box || With this option selected, SysCAD will display each noise block per tab page.  If not selected, each page displays four Noise Controllers.
|-
| Check Tags ||  font style="background: #ebebeb" | Button || SysCAD will perform a check on the validity of the tags and functions used in the noise controllers.
|-
|  colspan="3" font style="background: #ebebeb" | '''''Summary''''' <br>shows a summary table with the following values for each individual noise controller in the unit.
|-
| NC || font style="background: #ebebeb" | Display || The Noise Controller number
|-
| valign="top" rowspan="4"|Action || On || The random number generator is on and the controller will be setting the output tag at the specified frequency.
|-
| Off || The random number generator is off and the controller will NOT be setting the output tag.
|-
| Manual (User) || The random number generator is off but the controller will be setting the output tag to the User value ('''ManualOutput''') at the specified frequency.
|-
| Manual (Mean) || The random number generator is off but the controller will be setting the output tag to the mean value at the specified frequency.
|-
| Output || font style="background: #ebebeb" | Display || The output value for the individual Noise Controller.
|-
| DevFrac || font style="background: #ebebeb" | Display || The deviation fraction, when compared with mean value; for each individual Noise Controller.
|-
| OutputUnitTag || font style="background: #ebebeb" | Display || The output tag for each individual Noise Controller.
|}

=== NC1: Individual Noise Controller Data Fields ===

Noise Controller is displayed on the NCx pages. 
*If "ShowOnePerPage" is NOT selected, then each page displays four Noise Controllers.  
*If "ShowOnePerPage" is selected, then each page displays one Noise Controller.  

{| border="1" cellpadding="5" cellspacing="0" 
|-
|'''Tag (Long/Short)'''||Width=100|'''Input / Calc'''||'''Description/Calculated Variables / Options'''
|-
|   colspan="3" font style="background: #ebebeb"  |'''[NC number]'''
|-
| valign="top" rowspan="4"|Action || On || The random number generator is on and the controller will be setting the output tag at the specified frequency.
|-
| Off || The random number generator is off and the controller will NOT be setting the output tag.
|-
| Manual (User) || The random number generator is off but the controller will be setting the output tag to the User value ('''ManualOutput''') at the specified frequency.
|-
| Manual (Mean) || The random number generator is off but the controller will be setting the output tag to the mean value at the specified frequency.
|-
| Name || Input || The user may give the Noise Controller a name that describes the control, such ''Feed_Variation''.
|-
| Index||font style="background: #ebebeb"| Display || Controller Index. Useful for sorting the controller in reports
|-
| valign="top" rowspan="14" | Type||Gaussian || Distribution method as described in the [[#Model Theory|Model Theory]] above.  68.27% of the numbers generated will be between (Mean - StdDev) and (Mean + StdDev).
|-
|Flat|| Distribution method as described in the [[#Model Theory|Model Theory]] above.
|-
|Poisson || Distribution method as described in the [[#Model Theory|Model Theory]] above.
|-
|Gamma || Distribution method as described in the [[#Model Theory|Model Theory]] above.
|-
|Weibull || Distribution method as described in the [[#Model Theory|Model Theory]] above.
|-
|Bernoulli || Distribution method as described in the [[#Model Theory|Model Theory]] above.
|-
|Binomial || Distribution method as described in the [[#Model Theory|Model Theory]] above.
|-
|Geometric || Distribution method as described in the [[#Model Theory|Model Theory]] above.
|-
|Exponential || Distribution method as described in the [[#Model Theory|Model Theory]] above.
|-
|ExtremeValue || Distribution method as described in the [[#Model Theory|Model Theory]] above.
|-
|LogNormal || Distribution method as described in the [[#Model Theory|Model Theory]] above.
|-
|Cauchy || Distribution method as described in the [[#Model Theory|Model Theory]] above.
|-
|Fisher_F || Distribution method as described in the [[#Model Theory|Model Theory]] above.
|-
|Student_t || Distribution method as described in the [[#Model Theory|Model Theory]] above.
|-
| ManualOutput|| Value || Only visible when '''Action''' is set to ''Manual (User)''.  The output tag will be set to this value instead of a randomly generated number. 
|-
| rowspan=3|StdDevInput || colspan="2" font style="background: #ebebeb"| Only visible if '''Type''' = ''Gaussian'' or ''Flat''
|-
| Value || The user specifies the Standard Deviation value.
|-
| Fraction || The user specifies the Standard Deviation as a fraction of the Mean value.
|-
| valign="top"|Mean|| Input || Only visible if '''Type''' = ''Gaussian'', ''Flat'', ''Poisson'' or ''Exponential''. The mean value around which the random number must be generated.
|-
| valign="top"| StdDev || Input/Calc || Only visible if '''Type''' = ''Gaussian''. The standard deviation around the mean value.
|-
| valign="top"| StdDevFrac || Input/Calc || Only visible if '''Type''' = ''Gaussian''. The standard deviation expressed as a fraction of the mean value.
|-
| valign="top"| MaxDev || Input/Calc || Only visible if '''Type''' = ''Flat''. The maximum deviation around the mean value.
|-
| valign="top"| MaxDevFrac || Input/Calc || Only visible if '''Type''' = ''Flat''. The maximum deviation expressed as a fraction of the mean value.
|-
| Alpha || Input || Only visible if '''Type''' = ''Gamma'', ''Weibull'', ''ExtremeValue'' or ''Cauchy''. The alpha parameter as described in the [[#Model Theory|Model Theory]] above.
|-
| Beta || Input || Only visible if '''Type''' = ''Gamma'', ''Weibull'', ''ExtremeValue'' or ''Cauchy''. The beta parameter as described in the [[#Model Theory|Model Theory]] above.
|-
| n || Input || Only visible if '''Type''' = ''Binomial'', ''Fisher_F'' or ''Student_t''. The '''n''' parameter as described in the [[#Model Theory|Model Theory]] above.
|-
| p || Input || Only visible if '''Type''' = ''Bernoulli'', ''Binomial'' or ''Geometric''. The probability (of success) parameter as described in the [[#Model Theory|Model Theory]] above.
|-
| m || Input || Only visible if '''Type''' = ''LogNormal'' or ''Fisher_F''. The '''m''' parameter as described in the [[#Model Theory|Model Theory]] above.
|-
| s || Input || Only visible if '''Type''' = ''LogNormal''. The '''s''' parameter as described in the [[#Model Theory|Model Theory]] above.
|-
| OutputTag || Input ||This is the Tag that will be set. This tag must be copied from the relevant unit.  For example: Plant_Feed.QmReqd (t/h), Feed_Water.T_Reqd (C) or P_001.Qm_Capacity (kg/h).<br>'''Note 1:''' Only input data fields (i.e. white) can be used here.<br> '''Note 2:''' This field is optional.
|-
| OutputUnitTag ||  font style="background: #ebebeb"|Display ||The Unit Operation Tag. For example: If the Output Tag is ''Plant_Feed.QmReqd (t/h)'', then the OutputUnitTag is ''Plant_Feed''.
|-
| OutputValue / Output|| font style="background: #ebebeb"| Calc ||The output value.
|-
| Dev|| font style="background: #ebebeb"| Calc ||The deviation value: (output - mean).
|-
| DevFrac|| font style="background: #ebebeb"| Calc ||The deviation fraction: (output - mean)/mean.
|-
| Delete || Button || This allows the user to Delete the current individual noise controller.  Please note that there is no 'Undo'!
|-
| MoveUp || Button || This allows the user to increase the Priority of the current individual noise controller. For example, if the current noise controller is number 3, the user can change it to 2 or 1 by clicking on this button once or twice.
|-
| MoveDown || Button || This allows the user to decrease the Priority of the current individual noise controller. For example, if there are 3 noise controller in the unit and the current noise controller is number 1, the user can change it to 2 or 3 by clicking on this button once or twice.
|}

== Adding this Model to a Project ==

{{Adding Model to a Project | DllName=ControlDyn| DllSubGroup=Control 2 | UnitOp=Noise | Group=General }}

== Example Project ==
* [[Dynamic Plant Example Project]]
* [[Tailings Dam Example Project]]