Sigmafine Balance - Required Attributes
The Sigmafine Balance Analysis Rule requires that elements have Attributes configured to have specific Attribute properties including, value type and unit of measure. Input and Output Attributes are listed in these sections:
- Sigmafine Balance Analysis – Input Quantity Attributes
- Sigmafine Balance Analysis – Output Quantity Attributes
- Sigmafine Balance Analysis – Heat Exchanger Output Attributes
With the Sigmafine Balance Analysis Rule, the basis of the analysis is configurable to any available UOM class. For setting the defaults for Attribute names and other requirements, see \ the Sigmafine Balance Table topic under Server & Client. The Element Attribute is part of the analysis if the following selection criteria are met:
- The Attribute has the appropriate UOM class.
- The Element is created from a template with the appropriate Element category.
- The Attribute has the appropriate Attribute category of SF_AnalysisInput or SF_AnalysisOutput.
- The Attribute is of the appropriate Value type.
Element Attributes that are listed with multiple templates must have common naming across the named templates.
Sigmafine Balance Analysis – Input Quantity Attributes
Analysis Configuration - Input Attribute Requirements
| Configuration | Attribute Unit Class | Parameter Value Type | Element Category | Attribute Category | Default Template Name(s) | Default Attribute Name |
|---|---|---|---|---|---|---|
| Measurement | \<configurable>1 | Double | SF_TankSF_MassVolumeMeterSF_Transfer | SF_AnalysisInputANDSF_CaseInputData 2 | SF_GaugedTankTemplateSF_VolumeTankTemplateSF_LiquidMeterTemplateSF_GasMeterTemplateSF_SolidMeterTemplateSF_TransferTemplate | MeasuredMass |
| Measurement Tolerance | Must match Measurement UOM | Double | \<Same as above> | \<Same as above> | \<Same as above> | MassTolerance |
| Self-Calculating Flag | None | Boolean | SF_Tank | SF_AnalysisInput | SF_GaugedTankTemplateSF_VolumeTankTemplate | SelfCalculatingFlag |
| 1 See Using the SF_SigmafineBalance Table for more information about setting the Attribute UOM Class.2 For an Attribute to be saved in the Case input data set, the Attribute must belong to the SF_CaseInputData category. You can decrease the size of the stored data set by removing this Attribute category. |
Sigmafine Balance Analysis – Output Quantity Attributes
Analysis Configuration - Output Attribute Requirements
| Configuration | Attribute Unit Class | Parameter Value Type | Element Category | Attribute Category | Default Template Name(s) | Default Attribute Name |
|---|---|---|---|---|---|---|
| Reconciled Status | \<dimensionless> | String | SF_TankSF_MassVolumeMeterSF_TransferSF_Flow | SF_AnalysisOutputANDSF_CaseResults1 | SF_GaugedTankTemplateSF_VolumeTankTemplateSF_FlowTemplateSF_TransferTemplateSF_LiquidMeterTemplateSF_GasMeterTemplate | InferredStatus |
| Reconciled Measurement | Must match Measurement UOM | Double | SF_TankSF_TransferSF_Flow | \<Same as above> | SF_GaugedTankTemplateSF_VolumeTankTemplateSF_FlowTemplateSF_TransferTemplate | ReconciledMass |
| Reconciled Tolerance | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | |
| Solvability | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassSolvability |
| Influence | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | |
| Reconciled Adjustment | Must match Measurement UOM | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassCorrection |
| Test 1 | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassTest1 |
| Test 2 | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassTest2 |
| Initial Imbalance | Must match Measurement UOM | Double | SF_TankSF_NodeSF_ProcessSF_Manifold | \<Same as above> | SF_GaugedTankTemplateSF_VolumeTankTemplateSF_NodeTemplateSF_ProcessTemplateSF_ManifoldTemplate | ReconciledMassImbalance |
| Variance | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassVariance |
| Test 3 | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassTest3 |
| Test 4 | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassTest4 |
| Reconciled Residual | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledResidual |
| 1 For an Attribute to be saved in the Case output data set, the Attribute must belong to the SF_CaseResults category. You can decrease the size of the stored data set by removing this Attribute category. |
Sigmafine Balance Analysis – Heat Exchanger Output Attributes
When heat exchangers are included in a model, they have additional requirements as noted in the table below.
Analysis Configuration - Heat Exchanger Output Attribute Requirements
| Side | Configuration Parameter | Attribute Unit Class | Parameter Value Type | Element Category | Attribute Category | Default Template Name(s) | Default Attribute Name |
|---|---|---|---|---|---|---|---|
| Shell Side | Initial Imbalance | Must match Measurement UOM | Double | SF_HeatExchanger | SF_AnalysisOutputANDSF_CaseResults1 | SF_HeatExchangerTemplate | ReconciledMassShellImbalance |
| Variance | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassShellVariance | |
| Test 3 | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassShellTest3 | |
| Test 4 | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassShellTest4 | |
| Reconciled Residual | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassShellResidual | |
| Tube Side | Initial Imbalance | Must match Measurement UOM | Double | SF_HeatExchanger | \<Same as above> | SF_HeatExchangerTemplate | ReconciledMassShellImbalance |
| Variance | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassShellVariance | |
| Test 3 | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassShellTest3 | |
| Test 4 | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassShellTest4 | |
| Reconciled Residual | \<dimensionless> | Double | \<Same as above> | \<Same as above> | \<Same as above> | ReconciledMassShellResidual | |
| 1 For an Attribute to be saved in the Case output data set, the Attribute must belong to the SF_CaseResults category. You can decrease the size of the stored data set by removing this Attribute category. |
Note: The Element template for the heat exchangers (default name is SF_HeatExchangerTemplate) requires the following four ports to be defined. The port names must remain as shown in the table.
Analysis Configuration - Output Attribute Requirements
| Name | Description | Port Type | Maximum Connections | Connection Type | Default Port | Allowed Element Template |
|---|---|---|---|---|---|---|
| Shell In | Input Port | Input | 0 | Flow, Transfer | False | \<All> |
| Shell Out | Output Port | Output | 0 | Flow, Transfer | False | \<All> |
| Tube In | Input Port | Input | 0 | Flow, Transfer | False | \<All> |
| Tube Out | Output Port | Output | 0 | Flow, Transfer | False | \<All> |