1. Manuals
  2. Brands
  3. Spirit Manuals
  4. Handhelds
  5. flow-x
  6. Function reference

Spirit flow-x Function Reference

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
Function Reference
Certified flow calculations
Flow and batch calculations
Worksheet functions

Advertisement

Table of Contents
loading

Summary of Contents for Spirit flow-x

  • Page 1 Function Reference Certified flow calculations Flow and batch calculations Worksheet functions...
  • Page 2 The information contained in this document is the property of Spirit IT B.V., and may not be reproduced (wholly or in part) used or disclosed without the prior consent of Spirit IT B.V. and then on condition only that this notice is included in any reproduction or disclosure. The copyright and the foregoing restriction on copying, use and disclosure extent to all media in which this information may be embodied including magnetic storage.

  • Page 3: Table Of Contents

    Document Control ---------------------------------------------------------------------------------- 1-7 Revision Coding -------------------------------------------------------------------------------------------- 1-7 Revision History -------------------------------------------------------------------------------------------- 1-7 Chapter 2 - Introduction ------------------------------------------------------------------------------------------ 2-9 Flow-X Function Library ---------------------------------------------------------------------------------- 2-9 API Petroleum Measurement Tables ----------------------------------------------------------------- 2-9 History--------------------------------------------------------------------------------------------------------------------- 2-9 Volume correction for pressure ----------------------------------------------------------------------------------- 2-10 NGL and LPG tables -------------------------------------------------------------------------------------------------- 2-10...
  • Page 4 Flow-X─ Function Reference fxAPI_RD60F_NGL_LPG ------------------------------------------------------------------------------- 4-120 fxAPI_Table5_1952 ------------------------------------------------------------------------------------ 4-125 fxAPI_Table5_1980 ------------------------------------------------------------------------------------ 4-126 fxAPI_Table5_2004 ------------------------------------------------------------------------------------ 4-128 fxAPI_Table6_1952 ------------------------------------------------------------------------------------ 4-130 fxAPI_Table6_1980 ------------------------------------------------------------------------------------ 4-131 fxAPI_Table6_2004 ------------------------------------------------------------------------------------ 4-133 fxAPI_Table23_1952 ----------------------------------------------------------------------------------- 4-135 fxAPI_Table23_1980 ----------------------------------------------------------------------------------- 4-136 fxAPI_Table23_2004 ----------------------------------------------------------------------------------- 4-138 fxAPI_Table23E ----------------------------------------------------------------------------------------- 4-140 fxAPI_Table24_1952 ----------------------------------------------------------------------------------- 4-141 fxAPI_Table24_1980 ----------------------------------------------------------------------------------- 4-142...
  • Page 5 ---------------------------------------------------------------------------------------------------- 4-297 fxTotalizerDelta ----------------------------------------------------------------------------------------- 4-298 fxTotalizerRate ------------------------------------------------------------------------------------------ 4-300 fxUGC_C -------------------------------------------------------------------------------------------------- 4-302 fxUGC_M ------------------------------------------------------------------------------------------------- 4-304 fxWatchUpdate ----------------------------------------------------------------------------------------- 4-306 fxVCone_C ----------------------------------------------------------------------------------------------- 4-307 fxVCone_M ---------------------------------------------------------------------------------------------- 4-311 Chapter 5 - Flow-X IO Functions ----------------------------------------------------------------------------- 5-315 fxAnalogInput ------------------------------------------------------------------------------------------- 5-315 fxAnalogOutput ----------------------------------------------------------------------------------------- 5-316 fxSetAnalogOutput ------------------------------------------------------------------------------------- 5-316...
  • Page 6 Flow-X─ Function Reference fxDigitalInput -------------------------------------------------------------------------------------------- 5-317 fxDigitalOutput ----------------------------------------------------------------------------------------- 5-318 fxSetDigitalOutput ------------------------------------------------------------------------------------- 5-319 fxFrequencyOutput ------------------------------------------------------------------------------------ 5-319 fxSetFrequencyOutput -------------------------------------------------------------------------------- 5-320 fxDoubleChronometry -------------------------------------------------------------------------------- 5-321 fxPulseInput --------------------------------------------------------------------------------------------- 5-324 fxResetPulseInputErrors ------------------------------------------------------------------------------ 5-327 fxPulseOutput ------------------------------------------------------------------------------------------- 5-328 fxSetPulseOutput --------------------------------------------------------------------------------------- 5-329 fxPT100Input -------------------------------------------------------------------------------------------- 5-329 fxRTDInput ----------------------------------------------------------------------------------------------- 5-330 fxPT100Table -------------------------------------------------------------------------------------------- 5-330...

  • Page 7: Chapter 1 - Document Control

    Flow-X─ Function Reference Document Control - Revision Coding Chapter 1 - Document Control Revision Coding Our documents are supplied with a revision code. This code has the following format: <major revision letter>.<minor revision number>. Initially, the document has revision code A.0. When in the next release of the document minor changes were implemented, the minor revision number increases.
  • Page 8 Flow-X─ Function Reference Document Control - Revision History Revision A.3 Author : H. Rutjes Date March 2013 Updated incorrect page-header in TOC. Removed PPRV output from fxPeriodLatch(..) function. Revision A.4 Author : J.C.H.M. van Dal Date July 2014 Added extended ISO6976 function that takes all 55 components of the standard Added GERG2004 and GERG2008 functions Revision A.5...

  • Page 9: Chapter 2 - Introduction

    Excel workbook that contains one or more worksheets. Flow-X functions are configured as regular Excel functions. By using the output of one function as an input (argument) in another function a complete calculation scheme can be made. Functions can be defined on multiple sheets in order to organize the application.

  • Page 10: Volume Correction For Pressure

    Flow-X─ Function Reference 2-10 Introduction - API Petroleum Measurement Tables Number Title API Gravity Reduction to 60°F Reduction of Volume to 60°F Against API Gravity at 60°F Reduction of Observed Specific Gravity to Specific Gravity 60/60°F Reduction of Volume to 60o F Against Specific Gravity 60/60°F Reduction of Observed Density to Density at 15°C...

  • Page 11: Overview Of Hydrocarbon Liquid Conversion Standards

    Flow-X─ Function Reference 2-11 Introduction - API Petroleum Measurement Tables Overview of hydrocarbon liquid conversion standards  ASTM-IP Petroleum Measurement Tables, Historical Edition, 1952  API MPMS Chapter 11.1 - 1980* (Temperature VCFs for Generalized Crude Oils, Refined Products, and Lubricating Oils): Historical; Published in 14 separate volumes Also known as ...

  • Page 12: Overview Of The Functions

    Flow-X─ Function Reference 2-12 Introduction - API Petroleum Measurement Tables Overview of the functions The following table lists the volume conversion functions for hydrocarbon liquids as provided by the Flow-X series of flow computer. Function Temperature Pressure Input Output correction...

  • Page 13: Hydrometer Correction

    Flow-X─ Function Reference 2-13 Introduction - API Petroleum Measurement Tables API_Table24E API 11.2.4: 2007 API 11.2.2:1986 RD (60°F, Pe) RD (T, P) Table 24E GPA TP-15 API_Table53E API 11.2.4: 2007 API 11.2.2:1986 Density (T, P) Density (15°C, Pe) Table 53E...
  • Page 14 Flow-X─ Function Reference 2-14 Introduction - API Petroleum Measurement Tables Applies for: Table 5B Table 23B Table 53B Table 5B Table 53B Table 6B Table 24B Table 54B Table 6B Table 54B Table 23B Table 24B Range Relative Density Temperature...
  • Page 15 Flow-X─ Function Reference 2-15 Introduction - API Petroleum Measurement Tables API constants in US customary units For the tables in US customary units the following constants apply (both for the 1980 and the 2004 tables): Product API Table Crude oil 341.0957...
  • Page 16 Flow-X─ Function Reference 2-16 Introduction - API Petroleum Measurement Tables This page is left blank intentionally.

  • Page 17: Chapter 3 - Flow-X General Functions

    Flow-X─ Function Reference 3-17 Flow-X General functions - fx2CellSelection Chapter 3 - Flow-X General functions This chapter lists all available Flow-X functions in alphabetical order. fx2CellSelection Description The function selects between 2 input cells (e.g. differential pressure cells) based on the actual measured value and the failure status of each cell.
  • Page 18 Flow-X─ Function Reference 3-18 Flow-X General functions - fx2CellSelection Function Remark SW tag Alarm Fallback outputs Status 0: Normal 1: Input argument out of range FIOOR Selected cell 1: Cell 1 SELNR number 2: Cell 2 Selected cell 0: Normal...

  • Page 19: Fx3Cellselection

    Flow-X─ Function Reference 3-19 Flow-X General functions - fx3CellSelection fx3CellSelection Description The function selects between 3 input cells (typically differential pressure cells) based on the actual measured value and the failure status of each cell. The function can handle the following type of cell range configurations: ...
  • Page 20 Flow-X─ Function Reference 3-20 Flow-X General functions - fx3CellSelection Function Remark SW tag Alarm Fallback outputs Status 0: Normal 1: Input argument out of range FIOOR Selected cell 1: Cell 1 SELNR number 2: Cell 2 3: Cell 3 Selected cell...
  • Page 21 Flow-X─ Function Reference 3-21 Flow-X General functions - fx3CellSelection When cell C is currently selected  Select cell A when cell A value is below or equal to the switch-down percentage of its range and cell A is healthy ...

  • Page 22: Fxaga10_M

    Flow-X─ Function Reference 3-22 Flow-X General functions - fxAGA10_M fxAGA10_M The function calculates the speed of sound of a gas at the specified conditions of temperature and pressure using the formulae presented in the American Gas Association Report No 10.
  • Page 23 Flow-X─ Function Reference 3-23 Flow-X General functions - fxAGA10_M 2: Out of Range One or more inputs outside the 'Extended Range' (using the AGA10 calculation is not recommended in this case) Calculations Calculations are as documented in the standard.

  • Page 24: Fxaga10Ex_M

    Flow-X─ Function Reference 3-24 Flow-X General functions - fxAGA10ex_M fxAGA10ex_M The extended AGA 10 function provides an extensive set of gas properties at the specified conditions of temperature and pressure using the formulae presented in the American Gas Association Report No 10.
  • Page 25 Flow-X─ Function Reference 3-25 Flow-X General functions - fxAGA10ex_M Ideal relative density Real relative density Velocity of sound Compressibility base conditions Compressibility flowing conditions Supercompressibility Ideal specific kJ/kg MASSH0 enthalpy Real specific kJ/kg MASSH enthalpy Real specific kJ/kg/K MASSS entropy...
  • Page 26 Flow-X─ Function Reference 3-26 Flow-X General functions - fxAGA10ex_M calculation is not recommended in this case) Calculations Calculations are as documented in the standard.

  • Page 27: Fxaga3_C

    Flow-X─ Function Reference 3-27 Flow-X General functions - fxAGA3_C fxAGA3_C Description The function calculates the mass flow rate for Orifice pressure differential flow devices according to the AGA-3 standard for orifice meters with flange taps. Compliance  AGA Report No. 3 - Orifice Metering Measurement of fluid flow by means of pressure differential devices, 1992 ...
  • Page 28 Flow-X─ Function Reference 3-28 Flow-X General functions - fxAGA3_C Pressure 1: Upstream tapping PRESL Location Input 'Pressure' represents the pressure at the upstream pressure tapping Since the absolute pressure is usually measured at the upstream tapping this is the most common setting.
  • Page 29 Flow-X─ Function Reference 3-29 Flow-X General functions - fxAGA3_C Density This parameter specifies if and how DENSL Location the density should be corrected from downstream to upstream conditions. 1: Upstream tapping Input 'Density' represents the density at the upstream pressure tapping (...
  • Page 30 Flow-X─ Function Reference 3-30 Flow-X General functions - fxAGA3_C ratio at upstream temperature Orifice At the upstream inches ORIFUP diameter temperature Pipe diameter At the upstream inches PIPEUP temperature Upstream Pressure at upstream psia PRESUP pressure tapping (p Pressure at...
  • Page 31 Flow-X─ Function Reference 3-31 Flow-X General functions - fxAGA3_C Pressure correction  The relation between the pressure at the upstream tapping p and the pressure at the downstream tapping (p ) is as following:     units 1000 ...
  • Page 32 Flow-X─ Function Reference 3-32 Flow-X General functions - fxAGA3_C  When input 'Temperature correction' is set to 2, then an isentropic expansion based on input 'Temperature exponent' is applied:           ...

  • Page 33: Fxaga5_C

    Flow-X─ Function Reference 3-33 Flow-X General functions - fxAGA5_C fxAGA5_C The AGA 5 standard defines methods to calculate the mass and volume based calorific values at 60°F and 14.73 psia for a natural gas based on known molar fractions of the non-hydrocarbon gas components.

  • Page 34: Fxaga8_C

    Flow-X─ Function Reference 3-34 Flow-X General functions - fxAGA8_C fxAGA8_C The compressibility and density of a gas are calculated from the composition, temperature and pressure in accordance with the ‘Detail Characterization’ method outlined in the AGA-8 standard, with the input and output values in US Customary units.
  • Page 35 Flow-X─ Function Reference 3-35 Flow-X General functions - fxAGA8_C Function inputs and outputs Function Remark SW tag Range Default inputs Name Optional tag name, tag description and tag group Pressure Pressure value psia 0..40000 1.01325 Temperature Temperature value °F -250..+800...

  • Page 36: Fxaga8_M

    Flow-X─ Function Reference 3-36 Flow-X General functions - fxAGA8_M fxAGA8_M The compressibility and density of a gas are calculated from its composition, temperature and pressure in accordance with the ‘Detail Characterization’ method outlined in the AGA8 standard, with the input and output values in metric units.
  • Page 37 Flow-X─ Function Reference 3-37 Flow-X General functions - fxAGA8_M Function inputs and outputs Function Remark SW tag Range Default inputs Name Optional tag name, tag description and tag group Pressure Pressure value bar(a) 0..2800 1.01325 Temperature Temperature value °C -150..+450...

  • Page 38: Fxaga8_Gross --------------------------------------------------------------------------------------------

    Flow-X─ Function Reference 3-38 Flow-X General functions - fxAGA8_Gross fxAGA8_Gross Description This function calculates the compressibility factor in accordance with the AGA-8 Gross Characterization Method. Although the AGA-8 Gross Method is based on the Standard GERG Virial Equation Of State (SGERG) there are slight differences in the results.
  • Page 39 Flow-X─ Function Reference 3-39 Flow-X General functions - fxAGA8_Gross used, while for Method 2 inputs ‘Gross heating value’, ‘GHV reference temperature’ and ‘GHV reference pressure’ are not used. Function outputs Remark SW tag Alarm Fallback Status 0: Normal 1: Input argument out of range...

  • Page 40: Fxapi_Dens15C_1952

    Flow-X─ Function Reference 3-40 Flow-X General functions - fxAPI_Dens15C_1952 fxAPI_Dens15C_1952 Density (T, P) <--> Density (15°C, equilibrium pressure) This function converts a density value at the observed temperature and pressure to the density at 15°C and the equilibrium pressure (typically 0 barg) or vice versa.
  • Page 41 Flow-X─ Function Reference 3-41 Flow-X General functions - fxAPI_Dens15C_1952 compliance with API MPMS 12.2 par. 12.2.5.4). Conversion 1: From observed to standard CONVERS method conditions 2: From standard to observed conditions Function Remark SW tag Alarm Fallback outputs Status 0: Normal...
  • Page 42 Flow-X─ Function Reference 3-42 Flow-X General functions - fxAPI_Dens15C_1952 the calculations are performed in accordance with the rounding and truncating rules of the standard. The CPL value is calculated from the compressibility factor and the 'Observed pressure' and 'Equilibrium pressure' input values.

  • Page 43: Fxapi_Dens15C_1980

    Flow-X─ Function Reference 3-43 Flow-X General functions - fxAPI_Dens15C_1980 fxAPI_Dens15C_1980 Description Density (T, P) <--> Density (15°C, equilibrium pressure) This function converts a density value at the observed temperature and pressure to the density value at 15°C and the equilibrium pressure (typically 0 bar(g)) or vice versa.
  • Page 44 Flow-X─ Function Reference 3-44 Flow-X General functions - fxAPI_Dens15C_1980 Function Remark SW tag Range Default inputs Name Optional tag name, tag description and tag group Input density Meaning depends on the input kg/m3 0..1300 'Conversion method'. 'Conversion method' = 1...
  • Page 45 Flow-X─ Function Reference 3-45 Flow-X General functions - fxAPI_Dens15C_1980 in all cases 3: Enabled with 5 decimal places API-2540 rounding and truncating rules are applied, and, in case of conversion method 2 (standard to observed), the CTL value has 5 decimal places in all cases.
  • Page 46 Flow-X─ Function Reference 3-46 Flow-X General functions - fxAPI_Dens15C_1980 Function Remark SW tag Alarm Fallback outputs Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALCERR 3: No convergence NOCONV Output Meaning depends on the input...
  • Page 47 Flow-X─ Function Reference 3-47 Flow-X General functions - fxAPI_Dens15C_1980 First the inputs are rounded in accordance with the API2540 standard, provided that API2540 rounding is enabled. The hydrometer correction on the input density is applied, provided that this correction is enabled At the start of the iteration the density at [15 C, equilibrium pressure] is set...
  • Page 48 Flow-X─ Function Reference 3-48 Flow-X General functions - fxAPI_Dens15C_1980 The CTL value is calculated according to API-2540 Table 54 from the Alpha factor and the differential temperature (= observed temperature – 15°C If API2540 rounding is enabled, then the intermediate results are rounded or truncated as specified API-2540 Table 54.

  • Page 49: Chapter 4 - Flow-X General Functions

    Flow-X─ Function Reference 4-49 Flow-X General functions - fx2CellSelection Chapter 4 - Flow-X General functions This chapter lists all available Flow-X functions in alphabetical order. fx2CellSelection Description The function selects between 2 input cells (e.g. differential pressure cells) based on the actual measured value and the failure status of each cell.
  • Page 50 Flow-X─ Function Reference 4-50 Flow-X General functions - fx2CellSelection Function Remark SW tag Alarm Fallback outputs Status 0: Normal 1: Input argument out of range FIOOR Selected cell 1: Cell 1 SELNR number 2: Cell 2 Selected cell 0: Normal...

  • Page 51: Fx3Cellselection

    Flow-X─ Function Reference 4-51 Flow-X General functions - fx3CellSelection fx3CellSelection Description The function selects between 3 input cells (typically differential pressure cells) based on the actual measured value and the failure status of each cell. The function can handle the following type of cell range configurations: ...
  • Page 52 Flow-X─ Function Reference 4-52 Flow-X General functions - fx3CellSelection Function Remark SW tag Alarm Fallback outputs Status 0: Normal 1: Input argument out of range FIOOR Selected cell 1: Cell 1 SELNR number 2: Cell 2 3: Cell 3 Selected...
  • Page 53 Flow-X─ Function Reference 4-53 Flow-X General functions - fx3CellSelection When cell C is currently selected  Select cell A when cell A value is below or equal to the switch-down percentage of its range and cell A is healthy ...

  • Page 54: Fxaga10_M

    Flow-X─ Function Reference 4-54 Flow-X General functions - fxAGA10_M fxAGA10_M The function calculates the speed of sound of a gas at the specified conditions of temperature and pressure using the formulae presented in the American Gas Association Report No 10.
  • Page 55 Flow-X─ Function Reference 4-55 Flow-X General functions - fxAGA10_M values have higher uncertainty) 2: Out of Range One or more inputs outside the 'Extended Range' (using the AGA10 calculation is not recommended in this case) Calculations Calculations are as documented in the standard.

  • Page 56: Fxaga10Ex_M

    Flow-X─ Function Reference 4-56 Flow-X General functions - fxAGA10ex_M fxAGA10ex_M The extended AGA 10 function provides an extensive set of gas properties at the specified conditions of temperature and pressure using the formulae presented in the American Gas Association Report No 10.
  • Page 57 Flow-X─ Function Reference 4-57 Flow-X General functions - fxAGA10ex_M Ideal gas relative density Real gas relative density Velocity of sound Compressibility at base conditions Compressibility at flowing conditions Supercompressibility Ideal gas specific kJ/kg MASSH0 enthalpy Real gas specific kJ/kg MASSH...
  • Page 58 Flow-X─ Function Reference 4-58 Flow-X General functions - fxAGA10ex_M calculation is not recommended in this case) Calculations Calculations are as documented in the standard.

  • Page 59: Fxaga3_C

    Flow-X─ Function Reference 4-59 Flow-X General functions - fxAGA3_C fxAGA3_C Description The function calculates the mass flow rate for Orifice pressure differential flow devices according to the AGA-3 standard for orifice meters with flange taps. Compliance  AGA Report No. 3 - Orifice Metering Measurement of fluid flow by means of pressure differential devices, 1992 ...
  • Page 60 Flow-X─ Function Reference 4-60 Flow-X General functions - fxAGA3_C Pressure 1: Upstream tapping PRESL Location Input 'Pressure' represents the pressure at the upstream pressure tapping (p Since the absolute pressure is usually measured at the upstream tapping this is the most common setting.
  • Page 61 Flow-X─ Function Reference 4-61 Flow-X General functions - fxAGA3_C Density This parameter specifies if and how DENSL Location the density should be corrected from downstream to upstream conditions. 1: Upstream tapping Input 'Density' represents the density at the upstream pressure tapping (...
  • Page 62 Flow-X─ Function Reference 4-62 Flow-X General functions - fxAGA3_C diameter temperature Pipe diameter At the upstream inches PIPEUP temperature Upstream Pressure at upstream tapping psia PRESUP pressure Pressure at Pressure at downstream psia PRESDN downstream tapping (p tapping Recovered Fully recovered downstream...
  • Page 63 Flow-X─ Function Reference 4-63 Flow-X General functions - fxAGA3_C Pressure correction  The relation between the pressure at the upstream tapping p and the pressure at the downstream tapping (p ) is as following:     units 1000 ...
  • Page 64 Flow-X─ Function Reference 4-64 Flow-X General functions - fxAGA3_C                   When input 'Temperature correction' is set to 2, then an isentropic expansion based on input 'Temperature exponent' is applied: ...

  • Page 65: Fxaga5_C

    Flow-X─ Function Reference 4-65 Flow-X General functions - fxAGA5_C fxAGA5_C The AGA 5 standard defines methods to calculate the mass and volume based calorific values at 60°F and 14.73 psia for a natural gas based on known molar fractions of the non-hydrocarbon gas components.

  • Page 66: Fxaga8_C

    Flow-X─ Function Reference 4-66 Flow-X General functions - fxAGA8_C fxAGA8_C The compressibility and density of a gas are calculated from the composition, temperature and pressure in accordance with the ‘Detail Characterization’ method outlined in the AGA-8 standard, with the input and output values in US Customary units.
  • Page 67 Flow-X─ Function Reference 4-67 Flow-X General functions - fxAGA8_C Function inputs and outputs Function inputs Remark SW tag Range Default Name Optional tag name, tag description and tag group Pressure Pressure value psia 0..40000 1.01325 Temperature Temperature value °F -250..+800...

  • Page 68: Fxaga8_M

    Flow-X─ Function Reference 4-68 Flow-X General functions - fxAGA8_M fxAGA8_M The compressibility and density of a gas are calculated from its composition, temperature and pressure in accordance with the ‘Detail Characterization’ method outlined in the AGA8 standard, with the input and output values in metric units.
  • Page 69 Flow-X─ Function Reference 4-69 Flow-X General functions - fxAGA8_M Function inputs and outputs Function Remark SW tag Range Default inputs Name Optional tag name, tag description and tag group Pressure Pressure value bar(a) 0..2800 1.01325 Temperature Temperature value °C -150..+450...
  • Page 70 Flow-X─ Function Reference 4-70 Flow-X General functions - fxAGA8_Gross fxAGA8_Gross Description This function calculates the compressibility factor in accordance with the AGA-8 Gross Characterization Method. Although the AGA-8 Gross Method is based on the Standard GERG Virial Equation Of State (SGERG) there are slight differences in the results.
  • Page 71 Flow-X─ Function Reference 4-71 Flow-X General functions - fxAGA8_Gross Note: For Method 1 input ‘Nitrogen’ is not used, while for Method 2 inputs ‘Gross heating value’, ‘GHV reference temperature’ and ‘GHV reference pressure’ are not used. Function outputs Remark Alarm...

  • Page 72: Fxapi_Dens15C_1952

    Flow-X─ Function Reference 4-72 Flow-X General functions - fxAPI_Dens15C_1952 fxAPI_Dens15C_1952 Density (T, P) <--> Density (15°C, equilibrium pressure) This function converts a density value at the observed temperature and pressure to the density at 15°C and the equilibrium pressure (typically 0 barg) or vice versa.
  • Page 73 Flow-X─ Function Reference 4-73 Flow-X General functions - fxAPI_Dens15C_1952 Conversion 1: From observed to standard CONVERS method conditions 2: From standard to observed conditions Function outputs Remark SW tag Alarm Fallback Status 0: Normal 1: Input argument out of range...
  • Page 74 Flow-X─ Function Reference 4-74 Flow-X General functions - fxAPI_Dens15C_1952 The CPL value is calculated from the compressibility factor and the 'Observed pressure' and 'Equilibrium pressure' input values. The Density at [15C, equilibrium pressure] is calculated by dividing the Observed Density by the CTL and the new CPL value.

  • Page 75: Fxapi_Dens15C_1980

    Flow-X─ Function Reference 4-75 Flow-X General functions - fxAPI_Dens15C_1980 fxAPI_Dens15C_1980 Description Density (T, P) <--> Density (15°C, equilibrium pressure) This function converts a density value at the observed temperature and pressure to the density value at 15°C and the equilibrium pressure (typically 0 bar(g)) or vice versa.
  • Page 76 Flow-X─ Function Reference 4-76 Flow-X General functions - fxAPI_Dens15C_1980 Function Remark SW tag Range Default inputs Name Optional tag name, tag description and tag group Input density Meaning depends on the input kg/m3 0..1300 'Conversion method'. 'Conversion method' = 1...
  • Page 77 Flow-X─ Function Reference 4-77 Flow-X General functions - fxAPI_Dens15C_1980 and, in case of conversion method 2 (standard to observed), the CTL value has 5 decimal places in all cases. Note: although not strictly in accordance with the standard, this option is...
  • Page 78 Flow-X─ Function Reference 4-78 Flow-X General functions - fxAPI_Dens15C_1980 'Conversion method' = 2 Density at the observed temperature and pressure Volume correction factor for temperature. Value will be rounded according to input 'API2540 rounding'' Volume correction factor for pressure Value will be rounded according to input 'API 11.2.1M rounding''...
  • Page 79 Flow-X─ Function Reference 4-79 Flow-X General functions - fxAPI_Dens15C_1980 The Alpha factor is calculated according from the density at [15 C, equilibrium pressure] and the K0, K1 and K2 factor. If API2540 rounding is enabled, then the intermediate results are rounded or truncated as specified API-2540 Table 53.
  • Page 80 Flow-X─ Function Reference 4-80 Flow-X General functions - fxAPI_Dens15C_1980 15. The CPL value is calculated from the compressibility factor and the 'Observed pressure' and 'Equilibrium pressure' input values. 16. The density at [15C, equilibrium pressure] is calculated by multiplying the input...

  • Page 81: Fxapi_Dens15C_Ngl_Lpg

    Flow-X─ Function Reference 4-81 Flow-X General functions - fxAPI_Dens15C_NGL_LPG fxAPI_Dens15C_NGL_LPG Description Density (T, P) <--> Density (15°C, Pe) This function converts the density value at the observed temperature and pressure to the density value at 15°C and the equilibrium pressure or vice versa.
  • Page 82 Flow-X─ Function Reference 4-82 Flow-X General functions - fxAPI_Dens15C_NGL_LPG values are not rounded 1: Enabled The related values are rounded as defined in the standard Equilibrium 1: Use Input EQUIPMODE pressure The value of input mode 'Equilibrium pressure value' is used for the calculation of...
  • Page 83 Flow-X─ Function Reference 4-83 Flow-X General functions - fxAPI_Dens15C_NGL_LPG Function outputs Name Remark SW tag Alarm Fallb Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALCERR 3: No convergence NOCONV Output density Depending on the conversion...
  • Page 84 Flow-X─ Function Reference 4-84 Flow-X General functions - fxAPI_Dens15C_NGL_LPG CPL calc out of With respect to API 11.2.2M the range combination of input values is: 0: In Range 1: Out of Range CPLOOR The following range checks apply:  350 <= Density 15 °C <= 637 kg/m3 ...
  • Page 85 Flow-X─ Function Reference 4-85 Flow-X General functions - fxAPI_Dens15C_NGL_LPG Depending on the value of input 'Equilibrium pressure mode', either value of input 'Equilibrium pressure value' is used or the equilibrium pressure (vapor pressure) is calculated according to GPA TP-15. Whether the GPA TP-15 rounding and truncation rules are applied is dictated by input ‘GPA-TP15 rounding’...

  • Page 86: Fxapi_Dens20C_Ngl_Lpg

    Flow-X─ Function Reference 4-86 Flow-X General functions - fxAPI_Dens20C_NGL_LPG fxAPI_Dens20C_NGL_LPG Description Density (T, P) <--> Density (20°C, Pe) This function converts the density value at the observed temperature and pressure to the density value at 20°C and the equilibrium pressure or vice versa.
  • Page 87 Flow-X─ Function Reference 4-87 Flow-X General functions - fxAPI_Dens20C_NGL_LPG precision and the output values are not rounded 1: Enabled The related values are rounded as defined in the standard Equilibrium 1: Use Input EQUIPMODE pressure mode The value of input...
  • Page 88 Flow-X─ Function Reference 4-88 Flow-X General functions - fxAPI_Dens20C_NGL_LPG Function outputs Name Remark SW tag Alarm Fallback Status 0: Normal 1: Input argument out of FIOOR range Outputs will be set to CALC fallback values 2: Calculation error NOCONV Outputs will be set to...
  • Page 89 Flow-X─ Function Reference 4-89 Flow-X General functions - fxAPI_Dens20C_NGL_LPG density / 999.016/CPL  -46 <= T <= 93 °C  Table 23E reference fluid ranges Conversion method 1: standard -> observed  331.7 <= Input density <= 683.6 kg/m3 ...
  • Page 90 Flow-X─ Function Reference 4-90 Flow-X General functions - fxAPI_Dens20C_NGL_LPG When API 11.2.4 rounding is enabled, the input density and temperature values are rounded in accordance with the standard At the start of the iteration the density at [20 C, equilibrium pressure] is set equal to the observed density and the CPL value is set to 1.
  • Page 91 Flow-X─ Function Reference 4-91 Flow-X General functions - fxAPI_Dens20C_NGL_LPG The CTL value and the relative density at [60 F, equilibrium pressure] are calculated according to API MPMS 11.2.4 (GPA TP-27) Table 54 from the density at [20 C, equilibrium pressure] and the 'Observed temperature'.

  • Page 92: Fxapi_Gravity60F_1952

    Flow-X─ Function Reference 4-92 Flow-X General functions - fxAPI_Gravity60F_1952 fxAPI_Gravity60F_1952 °API (T, P) <--> °API (60°F, equilibrium pressure) This function calculates the API gravity value at the observed temperature and pressure to the API gravity value at 60°F and the equilibrium pressure (typically 0 psig) or vice versa.
  • Page 93 Flow-X─ Function Reference 4-93 Flow-X General functions - fxAPI_Gravity60F_1952 method conditions SION 2: From standard to observed conditions Function Remark SW tag Alarm Fallback outputs Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALC 3: No convergence...
  • Page 94 Flow-X─ Function Reference 4-94 Flow-X General functions - fxAPI_Gravity60F_1952 The CPL value is calculated from the compressibility factor and the 'Observed pressure' and 'Equilibrium pressure' input values. The API Gravity at [60F, equilibrium pressure] is calculated by dividing the Observed API Gravity by the CTL and the new CPL value.

  • Page 95: Fxapi_Gravity60F_1980

    Flow-X─ Function Reference 4-95 Flow-X General functions - fxAPI_Gravity60F_1980 fxAPI_Gravity60F_1980 °API (T, P) <--> °API (60°F, equilibrium pressure) This function calculates the API gravity value at the observed temperature and pressure to the API gravity value at 60°F and the equilibrium pressure (typically 0 psig) or vice versa.
  • Page 96 Flow-X─ Function Reference 4-96 Flow-X General functions - fxAPI_Gravity60F_1980 API-2540 0: Disabled API254 rounding The calculations are performed 0RND with full precision and the final CTL value is rounded as specified by input 'CTL decimal places' 1: Enabled for computational value...
  • Page 97 Flow-X─ Function Reference 4-97 Flow-X General functions - fxAPI_Gravity60F_1980 truncating rules are applied. The compressibility factor F is rounded to 3 decimal places as specified in the standard. Equilibrium The equilibrium pressure is psig EQUIPR 0..2000 pressure considered to be 0 psig for liquids...
  • Page 98 Flow-X─ Function Reference 4-98 Flow-X General functions - fxAPI_Gravity60F_1980 range for the calculation of CPL the combination of input values is: 0: In Range 1: Out of Range CPLOOR Calculations The calculations depend on the conversion method. Conversion method 1: from observed to standard conditions.
  • Page 99 Flow-X─ Function Reference 4-99 Flow-X General functions - fxAPI_Gravity60F_1980 consecutive density values is either 0.05 (or 0.07 for the transition area) or 0.000001, depending of API2540 rounding being enabled or not. 18. For refined products the entire iteration loop is repeated if the API gravity at [60F, equilibrium pressure] appears to be in a different product region than the...

  • Page 100: Fxapi_Mpms_11_2_1

    Flow-X─ Function Reference 4-100 Flow-X General functions - fxAPI_MPMS_11_2_1 fxAPI_MPMS_11_2_1 The API MPMS 11.2.1 standard consists of a printed table that contains compressibility factors to correct hydrocarbon volumes under pressure to the corresponding volumes at the equilibrium pressure for the metered temperature.
  • Page 101 Flow-X─ Function Reference 4-101 Flow-X General functions - Name Remark Fallback Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALERR Volume correction factor for pressure Note: to achieve compliance with API MPMS 12.2 the CPL value needs to be rounded to 4 decimal places.

  • Page 102: Fxapi_Mpms_11_2_1M

    Flow-X─ Function Reference 4-102 Flow-X General functions - fxAPI_MPMS_11_2_1M fxAPI_MPMS_11_2_1M Description The API MPMS 11.2.1M standard consists of a printed table that contains compressibility factors to correct hydrocarbon volumes under pressure to the corresponding volumes at the equilibrium pressure for the metered temperature.
  • Page 103 Flow-X─ Function Reference 4-103 Flow-X General functions - fxAPI_MPMS_11_2_1M Function outputs Name Remark Alarm Fallback Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALC Volume correction factor for pressure Note: to achieve compliance with API MPMS 12.2 the CPL value needs to be...

  • Page 104: Fxapi_Mpms_11_2_2

    Flow-X─ Function Reference 4-104 Flow-X General functions - fxAPI_MPMS_11_2_2 fxAPI_MPMS_11_2_2 The API MPMS 11.2.2 standard consists of a printed table that contains compressibility factors to correct hydrocarbon volumes under pressure to the corresponding volumes at the equilibrium pressure for the metered temperature.
  • Page 105 Flow-X─ Function Reference 4-105 Flow-X General functions - fxAPI_MPMS_11_2_2 API 11.2.2 0: Disabled APIROU rounding The calculation of the compressibility factor F and CPL is performed with full precision. 1: Enabled API-MPMS 11.2.2 rounding and truncating rules are applied. The compressibility factor F...

  • Page 106: Fxapi_Mpms_11_2_2M

    Flow-X─ Function Reference 4-106 Flow-X General functions - fxAPI_MPMS_11_2_2M fxAPI_MPMS_11_2_2M The API MPMS 11.2.2M standard consists of a printed table that contains compressibility factors to correct hydrocarbon volumes under pressure to the corresponding volumes at the equilibrium pressure for the metered temperature.
  • Page 107 Flow-X─ Function Reference 4-107 Flow-X General functions - fxAPI_MPMS_11_2_2M to input 'API 11.2.2M rounding' Compressibility factor 1/bar The output value will be either rounded or not depending input 'API 11.2.2M rounding' Calculation out With respect to the standard the of range...

  • Page 108: Fxapi_Mpms_11_3_2_1

    Flow-X─ Function Reference 4-108 Flow-X General functions - fxAPI_MPMS_11_3_2_1 fxAPI_MPMS_11_3_2_1 Description The function calculates the density of Ethylene (C2H4, also called Ethene) based on the API MPMS 11.3.2.1 Equation Of State in USC units. This API chapter is also known as API Standard 2565.

  • Page 109: Fxapi_Mpms_11_3_3_2

    Flow-X─ Function Reference 4-109 Flow-X General functions - fxAPI_MPMS_11_3_3_2 fxAPI_MPMS_11_3_3_2 The API MPMS 11.3.3.2 standard consists of a table with the density values (lbm/ft3) of propylene liquid as a function of pressure and temperature. Also part of the standard is the Calculation Procedure to obtain the table values.
  • Page 110 Flow-X─ Function Reference 4-110 Flow-X General functions - fxAPI_MPMS_11_3_3_2 density at 60 °F and the corresponding vapor pressure. Equilibrium Equilibrium pressure at the psia EQUIPRES pressure observed temperature. Also referred to as vapor pressure or saturated pressure Calculation out With respect to the standard...

  • Page 111: Fxapi_Rd60F_1980

    In 1982 API published tables 5D, 6D, 53D and 54D for lubricating oil products as part of API MPMS 11.1. Although tables 23D and 24D are not covered in an official API standard the Flow-X series of flow computer supports tables 23D and 24D as well by combining the calculation of tables 23A/B and 24A/B with the K0 and K1 constants published in the other tables for lubricating oils.
  • Page 112 Flow-X─ Function Reference 4-112 Flow-X General functions - fxAPI_RD60F_1980 6: B - Fuel Oil 7: D - Lubricating Oil API-2540 rounding 0: Disabled API2540RN The calculations are performed with full precision and the final CTL value is rounded as specified by input 'CTL...
  • Page 113 Flow-X─ Function Reference 4-113 Flow-X General functions - fxAPI_RD60F_1980 6 decimal places when input ‘API 2540 rounding’ > 0, as in accordance with table 23. Hydrometer Only applies for conversion HYDROCOR correction method ‘1: From observed to standard conditions’ 0: Disabled 1: Enabled API 11.2.1...
  • Page 114 Flow-X─ Function Reference 4-114 Flow-X General functions - fxAPI_RD60F_1980 Actual value of constant K1 used for CTL calculation Actual value of constant K2 used for CTL calculation Alpha Thermal expansion factor 1/°F ALPHA Compressibility factor Product When input 'Product' is 'B - Auto...
  • Page 115 Flow-X─ Function Reference 4-115 Flow-X General functions - fxAPI_RD60F_1980 10. The relative density at [60 F, equilibrium pressure] is calculated from the density at [60 F, equilibrium pressure] 11. Because API 11.2.1 requires the API gravity value at 60 F, the API gravity at [60 F, equilibrium pressure] is calculated from the density at [60 F, equilibrium...
  • Page 116 Flow-X─ Function Reference 4-116 Flow-X General functions - fxAPI_RD60F_1980 The compressibility factor is calculated according to API MPMS 11.2.1 from the input density and temperature'. If API 11.2.1 rounding is enabled then the input density and temperature are rounded and the calculations are performed in accordance with the rounding and truncating rules of the standard.

  • Page 117: Fxapi_Sg60F_1952

    Flow-X─ Function Reference 4-117 Flow-X General functions - fxAPI_SG60F_1952 fxAPI_SG60F_1952 Specific Gravity (T, P) <--> Specific Gravity (60°F, equilibrium pressure) This function converts a specific gravity value at the observed temperature and pressure to the specific gravity at 60°F and the equilibrium pressure (typically 0 psig) or vice versa.
  • Page 118 Flow-X─ Function Reference 4-118 Flow-X General functions - fxAPI_SG60F_1952 Conversion 1: From observed to standard CONVERSIO method conditions 2: From standard to observed conditions Function outputs Remark SW tag Alarm Fallback Status 0: Normal 1: Input argument out of range...
  • Page 119 Flow-X─ Function Reference 4-119 Flow-X General functions - fxAPI_SG60F_1952 11.2.1 rounding is enabled then the API gravity and temperature are rounded and the calculations are performed in accordance with the rounding and truncating rules of the standard. The CPL value is calculated from the compressibility factor and the 'Observed pressure' and 'Equilibrium pressure' input values.

  • Page 120: Fxapi_Rd60F_Ngl_Lpg

    Flow-X─ Function Reference 4-120 Flow-X General functions - fxAPI_RD60F_NGL_LPG fxAPI_RD60F_NGL_LPG Description Relative Density (T, P) <--> Relative Density (60°F, Pe) This function converts the relative density value at the observed temperature and pressure to the relative density value at 60°F and the equilibrium pressure or vice versa.
  • Page 121 Flow-X─ Function Reference 4-121 Flow-X General functions - fxAPI_RD60F_NGL_LPG output values are not rounded 1: Enabled The input and output values are rounded as defined in the standard Equilibrium 1: Use Input EQUIPMOD pressure The value of input 'Equilibrium mode...
  • Page 122 Flow-X─ Function Reference 4-122 Flow-X General functions - fxAPI_RD60F_NGL_LPG and the equilibrium pressure or density at the observed temperature and pressure Volume correction factor for temperature. Value will be rounded according to input 'API 11.2.4 rounding' Volume correction factor for...
  • Page 123 Flow-X─ Function Reference 4-123 Flow-X General functions - fxAPI_RD60F_NGL_LPG The following range checks apply: For lower range:  0.350 <= RD60 < 0.425  -50 to (695.51*RD60 - 155.51) °F Higher range:  0.425 <= RD60 <= 0.676  -50 to 140 °F with RD60 being the relative density at 60°F...
  • Page 124 Flow-X─ Function Reference 4-124 Flow-X General functions - fxAPI_RD60F_NGL_LPG Conversion method 2: from standard to observed conditions. The function performs straightforward calculations to determine the density at observed conditions: When API 11.2.4 rounding is enabled, the input relative density and temperature values are rounded in accordance with the standard The CTL value is calculated according to API MPMS 11.2.4 (GPA TP-27) Table 24E...

  • Page 125: Fxapi_Table5_1952

    Flow-X─ Function Reference 4-125 Flow-X General functions - fxAPI_Table5_1952 fxAPI_Table5_1952 °API (T) --> °API (60°F) This function converts an API gravity value at the observed temperature to the API gravity value at 60°F in accordance with API 1952 Table 5.

  • Page 126: Fxapi_Table5_1980

    Flow-X─ Function Reference 4-126 Flow-X General functions - fxAPI_Table5_1980 fxAPI_Table5_1980 °API (T) --> °API (60°F) This function converts an API gravity value at the observed temperature to the API gravity value at 60°F. The temperature conversion is according to API MPMS 11.1:1980 (API-2540), Tables 5A (Generalized Crude Oils) and 5B (Refined Oil Products) and API MPMS 11.1 Chapter XIII Table 5D: 1984 (Lubricating...
  • Page 127 Flow-X─ Function Reference 4-127 Flow-X General functions - fxAPI_Table5_1980 Function Remark SW tag Alarm Fallback outputs Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALCERR 3: No convergence NOCONV API at 60 °F API gravity at 60°F °API...

  • Page 128: Fxapi_Table5_2004

    Flow-X─ Function Reference 4-128 Flow-X General functions - fxAPI_Table5_2004 fxAPI_Table5_2004 Description °API (T, P) --> °API (60°F, 0 psig) This function converts an API gravity value at the observed temperature and pressure to the API gravity value at 60°F and 0 psig.
  • Page 129 Flow-X─ Function Reference 4-129 Flow-X General functions - fxAPI_Table5_2004 Function Remark Alarm Fallback outputs Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALCERR 3: No convergence within 15 iterations NOCONV API at 60 °F API gravity at 60°F and 0 psig Volume correction factor for temperature.

  • Page 130: Fxapi_Table6_1952

    Flow-X─ Function Reference 4-130 Flow-X General functions - fxAPI_Table6_1952 fxAPI_Table6_1952 °API (60°F, 0 psig) --> CTL This function calculates the volume correction factor for temperature from the API gravity value at 60°F and the observed temperature according to API 1952 Table 6.

  • Page 131: Fxapi_Table6_1980

    Flow-X─ Function Reference 4-131 Flow-X General functions - fxAPI_Table6_1980 fxAPI_Table6_1980 °API (60°F, 0 psig) --> CTL This function calculates the volume correction factor for temperature from the API gravity value at 60°F and the observed temperature. The temperature conversion is according to API-2540, Tables 6A (Generalized Crude Oils) and 6B (Refined Oil Products) and API MPMS 11.1 Chapter XIII Table 6D: 1984 (Lubricating Oils).
  • Page 132 Flow-X─ Function Reference 4-132 Flow-X General functions - fxAPI_Table6_1980 cases 3: Enabled with 5 decimal places API-2540 rounding and truncating rules are applied, while the CTL value has 5 decimal places in all cases. Note: although not strictly in accordance with the...

  • Page 133: Fxapi_Table6_2004

    Flow-X─ Function Reference 4-133 Flow-X General functions - fxAPI_Table6_2004 fxAPI_Table6_2004 Description °API (60°F, 0 psig) --> °API (T, P) This function converts an API gravity value at 60°F and 0 psig to the API gravity value at the observed temperature and pressure.
  • Page 134 Flow-X─ Function Reference 4-134 Flow-X General functions - fxAPI_Table6_2004 Volume correction factor for pressure CTPL Combined volume correction CTPL factor CTPL = CTL * CPL Actual value of constant K0 used for CTL calculation Actual value of constant K1 used...

  • Page 135: Fxapi_Table23_1952

    Flow-X─ Function Reference 4-135 Flow-X General functions - fxAPI_Table23_1952 fxAPI_Table23_1952 Specific Gravity (T) --> Specific Gravity (60°F) This function converts a specific gravity value at the observed temperature to the specific gravity at 60° according to the API 1952 Table 23.

  • Page 136: Fxapi_Table23_1980

    In 1982 API published tables 5D, 6D, 53D and 54D for lubricating oil products as part of API MPMS 11.1. Although tables 23d and 24d are not covered in an official API standard the Flow-X series of flow computer supports tables 23D and 24D as well by combining the calculation of tables 23A/B and 24A/B with the K0 and K1 constants published in the other tables for lubricating oils.
  • Page 137 Flow-X─ Function Reference 4-137 Flow-X General functions - fxAPI_Table23_1980 standard. Hydrometer 0: Disabled HYDROCO correction 1: Enabled Function Remark SW tag Alarm Fallbac outputs Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALC 3: No convergence...

  • Page 138: Fxapi_Table23_2004

    Flow-X─ Function Reference 4-138 Flow-X General functions - fxAPI_Table23_2004 fxAPI_Table23_2004 Description Relative Density (T, P) --> Relative Density (60°F, 0 psig) This function converts a relative density value at the observed temperature and pressure to the relative density value at 60°F and 0 psig.
  • Page 139 Flow-X─ Function Reference 4-139 Flow-X General functions - fxAPI_Table23_2004 Function Remark SW tag Alarm Fallback outputs Status 0: Normal 1: Input argument out of range Outputs will be set to fallback values 2: Calculation error Outputs will be set to fallback...

  • Page 140: Fxapi_Table23E

    Flow-X─ Function Reference 4-140 Flow-X General functions - fxAPI_Table23E fxAPI_Table23E Description Relative Density (T) --> Relative Density (60°F) This function converts the relative density value at the observed temperature to the corresponding relative density at 60°F. The temperature correction is according to API MPMS 11.2.4:2007 (GPA TP-25 / GPA TP-27).

  • Page 141: Fxapi_Table24_1952

    Flow-X─ Function Reference 4-141 Flow-X General functions - fxAPI_Table24_1952 fxAPI_Table24_1952 Specific Gravity (60°F) --> CTL This function returns the volume correction factor for temperature Ctl from the observed temperature and the specific gravity at 60° according to the API 1952 Table 24.

  • Page 142: Fxapi_Table24_1980

    In 1982 API published tables 5D, 6D, 53D and 54D for lubricating oil products as part of API MPMS 11.1. Although tables 23d and 24d are not covered in an official API standard the Flow-X series of flow computer supports tables 23D and 24D as well by combining the calculation of tables 23A/B and 24A/B with the K0 and K1 constants published in the other tables for lubricating oils.
  • Page 143 Flow-X─ Function Reference 4-143 Flow-X General functions - fxAPI_Table24_1980 truncating rules are applied and the table value for CTL as specified in the standard meaning that the CTL value has 4 decimal places in all cases 3: Enabled with 5 decimal places...

  • Page 144: Fxapi_Table24_2004

    Flow-X─ Function Reference 4-144 Flow-X General functions - fxAPI_Table24_2004 fxAPI_Table24_2004 Description Relative Density (60°F, 0 psig) --> Relative Density (T, P) This function converts a relative density value at 60°F and 0 psig to the relative density value at the observed temperature and pressure.
  • Page 145 Flow-X─ Function Reference 4-145 Flow-X General functions - fxAPI_Table24_2004 Function Remark SW tag Alarm Fallbac outputs Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALCER Observed Relative density at the observed relative temperature and pressure...

  • Page 146: Fxapi_Table24E

    Flow-X─ Function Reference 4-146 Flow-X General functions - fxAPI_Table24E fxAPI_Table24E Description Relative Density (60°F) --> CTL This function calculates the volume correction factor for temperature from the relative density value at 60°F and the observed temperature. The temperature correction is according to API MPMS 11.2.4:2007 (GPA TP-25 / GPA TP-27).

  • Page 147: Fxapi_Table53_1952

    Flow-X─ Function Reference 4-147 Flow-X General functions - fxAPI_Table53_1952 fxAPI_Table53_1952 Density (T) --> Density (15°C) This function converts a density value at the observed temperature to the density at 15°C according to the API 1952 Table 53. Compliance  ASTM-IP Petroleum Measurement Tables, Metric Edition, Metric Units of Measurement,...

  • Page 148: Fxapi_Table53_1980

    Flow-X─ Function Reference 4-148 Flow-X General functions - fxAPI_Table53_1980 fxAPI_Table53_1980 Density (T) --> Density (15°C) This function converts a density value at the observed temperature to the density value at 15°C. The temperature conversion is according to API-2540, Tables 53A (Generalized Crude Oils) and 53B (Refined Oil Products) and API MPMS 11.1 Chapter XIV Table 53D: 1984 (Lubricating Oils).
  • Page 149 Flow-X─ Function Reference 4-149 Flow-X General functions - fxAPI_Table53_1980 Function Remark SW tag Alarm Fallback outputs Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALCERR 3: No convergence NOCONV Density at 15 °C Density at 15°C...

  • Page 150: Fxapi_Table53_2004

    Flow-X─ Function Reference 4-150 Flow-X General functions - fxAPI_Table53_2004 fxAPI_Table53_2004 Description Density (T, P) --> Density (15°C, 0 bar(g)) This function converts a density value at the observed temperature and pressure to the density value at 15°C and 0 bar(g).
  • Page 151 Flow-X─ Function Reference 4-151 Flow-X General functions - fxAPI_Table53_2004 Function Remark SW tag Alarm Fallback outputs Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALCERR 3: No convergence NOCONV Density at Density at 15°C and 0 bar(g) DENS15 15 °C...

  • Page 152: Fxapi_Table53E

    Flow-X─ Function Reference 4-152 Flow-X General functions - fxAPI_Table53E fxAPI_Table53E Description Density (T) --> Density (15°C) This function converts the density value at the observed temperature to the corresponding density at 15°C. The temperature correction is according to API MPMS 11.2.4:2007 (GPA TP-27).

  • Page 153: Fxapi_Table54_1952

    Flow-X─ Function Reference 4-153 Flow-X General functions - fxAPI_Table54_1952 fxAPI_Table54_1952 Density (15°C) --> CTL This function determines the volume correction factor for temperature CTL from the relative density value at 15°C and the observed temperature according to the API 1952 Table 54.

  • Page 154: Fxapi_Table54_1980

    Flow-X─ Function Reference 4-154 Flow-X General functions - fxAPI_Table54_1980 fxAPI_Table54_1980 Density (15°C) --> CTL This function calculates the volume correction factor for temperature CTL from the relative density value at 15°C and the observed temperature. The temperature conversion is according to API-2540, Tables 54A (Generalized Crude Oils) and 54B (Refined Oil Products) and API MPMS 11.1 Chapter XIV Table 54D: 1984 (Lubricating Oils).
  • Page 155 Flow-X─ Function Reference 4-155 Flow-X General functions - fxAPI_Table54_1980 truncating rules are applied, while the CTL value has 5 decimal places in all cases. Note: although not strictly in accordance with the standard, this option is more commonly used than option 'Enabled for...

  • Page 156: Fxapi_Table54_2004

    Flow-X─ Function Reference 4-156 Flow-X General functions - fxAPI_Table54_2004 fxAPI_Table54_2004 Description Density (15°C, 0 bar(g)) --> Density (T, P) This function converts a density value at 15°C and 0 bar(g) to the density value at the observed temperature and pressure.
  • Page 157 Flow-X─ Function Reference 4-157 Flow-X General functions - fxAPI_Table54_2004 Function Remark SW tag Alarm Fallback outputs Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALCERR 3: No convergence Observed Density at the observed DENS density...

  • Page 158: Fxapi_Table54E

    Flow-X─ Function Reference 4-158 Flow-X General functions - fxAPI_Table54E fxAPI_Table54E Description Density (15°C) --> CTL This function calculates the volume correction factor for temperature from the relative density value at 15°C and the observed temperature. The temperature correction is according to API MPMS 11.2.4:2007 (GPA TP-27).

  • Page 159: Fxapi_Table59_2004

    Flow-X─ Function Reference 4-159 Flow-X General functions - fxAPI_Table59_2004 fxAPI_Table59_2004 Description Density (T, P) --> Density (20°C, 0 bar(g)) This function converts a density value at the observed temperature and pressure to the density value at 20°C and 0 bar(g).
  • Page 160 Flow-X─ Function Reference 4-160 Flow-X General functions - fxAPI_Table59_2004 Function Remark SW tag Alarm Fallback outputs Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALCERR 3: No convergence NOCONV Density at Density at 20°C and 0 bar(g) DENS20 20 °C...

  • Page 161: Fxapi_Table59E

    Flow-X─ Function Reference 4-161 Flow-X General functions - fxAPI_Table59E fxAPI_Table59E Description Density (T) --> Density (20°C) This function converts the density value at the observed temperature to the corresponding density at 20°C. The temperature correction is according to API MPMS 11.2.4:2007 (GPA TP-27).

  • Page 162: Fxapi_Table60_2004

    Flow-X─ Function Reference 4-162 Flow-X General functions - fxAPI_Table60_2004 fxAPI_Table60_2004 Description Density (20°C, 0 bar(g)) --> Density (T, P) This function converts a density value at 20°C and 0 bar(g) to the density value at the observed temperature and pressure.
  • Page 163 Flow-X─ Function Reference 4-163 Flow-X General functions - Function Remark SW tag Alarm Fallback outputs Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALCERR 3: No convergence Observed Density at the observed DENS density temperature and pressure Volume correction factor for temperature.

  • Page 164: Fxapi_Table60E

    Flow-X─ Function Reference 4-164 Flow-X General functions - fxAPI_Table60E fxAPI_Table60E Description Density (20°C) --> CTL This function calculates the volume correction factor for temperature from the relative density value at 20°C and the observed temperature. The temperature correction is according to API MPMS 11.2.4:2007 (GPA TP-27).

  • Page 165: Fxastm_D1550_Rd60

    Flow-X─ Function Reference 4-165 Flow-X General functions - fxASTM_D1550_RD60 fxASTM_D1550_RD60 Description This function calculates the relative density at 60ᵒF and 0 psig of Butadiene based on ASTM Designation 1550. The ASTM-D1550 standard specifies several tables. This function uses table 1, which contains values for the relative density at 60ᵒF as a function of the observed relative density and the observed...
  • Page 166 Flow-X─ Function Reference 4-166 Flow-X General functions - fxASTM_D1550_RD60 Compressibility factor 1/psi The output value will be either rounded or not depending input 'API 11.2.2 rounding' Volume correction factor for temperature. Volume correction factor for pressure Value will be rounded according to input 'API 11.2.2 rounding'...

  • Page 167: Fxastm_D1550_Ctl

    Flow-X─ Function Reference 4-167 Flow-X General functions - fxASTM_D1550_Ctl fxASTM_D1550_Ctl Description This function calculates the Ctl value (VCF) of Butadiene based on the ASTM Designation 1550. The standard specifies several tables. This function uses table 2, which contains values for the volume correction factor as a function of the relative density at 60°F and the observed temperature.

  • Page 168: Fxastm_D1555_Dens60F

    Flow-X─ Function Reference 4-168 Flow-X General functions - fxASTM_D1555_Dens60F fxASTM_D1555_Dens60F Description This function calculates the relative density at 60ᵒF and 0 psig according ASTM Designation 1555. The ASTM-D1550 standard specifies equations for the calculation of Ctl, the liquid correction factor for temperature, for several aromatic hydrocarbons and cyclohexane as a function of the observed temperature.
  • Page 169 Flow-X─ Function Reference 4-169 Flow-X General functions - fxASTM_D1555_Dens60F Equilibrium The equilibrium pressure is considered to be psig 0..2000 pressure 0 psig for liquids which have an equilibrium pressure less than atmospheric pressure (in compliance with API MPMS 12.2 par.
  • Page 170 Flow-X─ Function Reference 4-170 Flow-X General functions - fxASTM_D1555_Dens60F The new value for density at [60F, 0 psig] is calculated by dividing the observed density by the CTL and CPL values. Steps 2 through 6 are repeated until the absolute difference between two consecutive relative density values is less than the convergence limit of 1e-8.

  • Page 171: Fxastm_D1555_Ctl

    Flow-X─ Function Reference 4-171 Flow-X General functions - fxASTM_D1555_Ctl fxASTM_D1555_Ctl Description This function calculates the Ctl value from the observed temperature for several aromatic hydrocarbons and cyclohexane based on the ASTM Designation 1555 Compliance  ASTM Designation: D1555 -04, Standard Test Method for Calculation of Volume and Weight...
  • Page 172 Flow-X─ Function Reference 4-172 Flow-X General functions - fxASTM_D1555_Ctl Calculations ASTM D1555 contains both formulas and tables for the Ctl (called VCF in the standard) for the different product. Please note the formulas are the standard and not the tables. This function therefore applies...

  • Page 173: Fxbatchfwa

    Flow-X─ Function Reference 4-173 Flow-X General functions - fxBatchFWA fxBatchFWA Description The function calculates a flow-weighted average (FWA) for a batch. A batch can be any batch type of process, such as product loading, meter proving or transmitter validation. The function weights the input value with a flow increment and updates the average accordingly. The flow increment is provided by either a ‘fxTotalizerDelta’...

  • Page 174: Fxbatchhistdata

    Flow-X─ Function Reference 4-174 Flow-X General functions - fxBatchHistData fxBatchHistData Description The function retrieves historical 'batch' data from the flow computer persistent memory. A 'batch' can be any batch type of process, such as product loading, meter proving or transmitter validation.

  • Page 175: Fxbatchlatch

    Flow-X─ Function Reference 4-175 Flow-X General functions - fxBatchLatch fxBatchLatch Description The function latches a value at every batch reset. Inputs and outputs Function Remark SW tag Range Default inputs Name Name used for tag-prefix and retentive storage. Input value...

  • Page 176: Fxbatchmax

    Flow-X─ Function Reference 4-176 Flow-X General functions - fxBatchMax fxBatchMax Description The function determines the maximum for a particular input value over a batch. A batch can be any batch type of process, such as product loading, meter proving or transmitter validation.

  • Page 177: Fxbatchmin

    Flow-X─ Function Reference 4-177 Flow-X General functions - fxBatchMin fxBatchMin Description The function determines the minimum for a particular input value over a batch. A batch can be any batch type of process, such as product loading, meter proving or transmitter validation.

  • Page 178: Fxbatchtotal

    Flow-X─ Function Reference 4-178 Flow-X General functions - fxBatchTotal fxBatchTotal Description The function accumulates a flow increment into a batch total. At every batch reset the current batch total is stored into the previous value and the current value is reset to 0.

  • Page 179: Fxbatchtwa

    Flow-X─ Function Reference 4-179 Flow-X General functions - fxBatchTWA fxBatchTWA Description The function calculates a time-weighted average (TWA) for a batch. At a batch reset the current average is stored in the previous value and the current value is reset to 0.

  • Page 180: Fxbatchwatch

    Flow-X─ Function Reference 4-180 Flow-X General functions - fxBatchWatch fxBatchWatch Description The function 'remembers' that a condition has been valid during a batch. A typical example is a transmitter that was overridden with a keypad value. Inputs and outputs Function...

  • Page 181: Fxconvertunit

    Flow-X─ Function Reference 4-181 Flow-X General functions - fxConvertUnit fxConvertUnit Description This function converts a value expressed in a particular unit into the corresponding value expressed in another unit. The input and output unit must belong category, otherwise the conversion fails.

  • Page 182: Fxdeviationalarm

    Flow-X─ Function Reference 4-182 Flow-X General functions - fxDeviationAlarm fxDeviationAlarm Description The function watches the deviation, or the difference or discrepancy, between two values and generates an alarm when the deviation exceeds the specified limit. Function inputs and outputs Function inputs...

  • Page 183: Nist1045

    Flow-X─ Function Reference 4-183 Flow-X General functions - NIST1045 NIST1045 Description The function calculates the density of Ethylene (C2H4, also called Ethene) based on the NIST-1045 Equation Of State in metric units. References  R.D. McCarty and R.T. Jacobsen “An Equation of State for Fluid Ethylene”, National Bureau of Standards (NBS), US, Technical Note 1045, 1981.

  • Page 184: Fxethylene_Iupac_C

    Flow-X─ Function Reference 4-184 Flow-X General functions - fxEthylene_IUPAC_C fxEthylene_IUPAC_C Description The function calculates the compressibility factor and the density of Ethylene (C2H4, also called Ethene) based on the Equation Of State published by IUPAC and in US customary units.

  • Page 185: Fxethylene_Iupac_M

    Flow-X─ Function Reference 4-185 Flow-X General functions - fxEthylene_IUPAC_M fxEthylene_IUPAC_M Description The function calculates the compressibility factor and the density of Ethylene (C2H4, also called Ethene) based on the Equation Of State published by IUPAC and in metric units. References ...

  • Page 186: Fxgasviscosity_2004

    Flow-X─ Function Reference 4-186 Flow-X General functions - fxGasViscosity_2004 fxGasViscosity_2004 The dynamic viscosity of natural gas is calculated in accordance with a method developed at the Rostock University in Germany and published in 2004 in the ‘International Journal of the Thermophysics’.
  • Page 187 Flow-X─ Function Reference 4-187 Flow-X General functions - fxGasViscosity_2004 Input component Added to / neglected Propane Propane Water Neglected Hydrogen Sulphide Neglected Hydrogen Methane Carbon Monoxide Neglected Oxygen Nitrogen i-Butane i-Butane n-Butane n-Butane i-Pentane i-Pentane n-Pentane n-Pentane n-Hexane n-Hexane n-Heptane...

  • Page 188: Fxgeneratereport

    Flow-X─ Function Reference 4-188 Flow-X General functions - fxGenerateReport fxGenerateReport This function generates prints and stores a report. Function inputs Remark SW tag Range Default Name Report definition Must be the name of the report definition (Flow-Xpress, section Reports). Event Event to generate the report.

  • Page 189: Fxgerg2008_Gas

    GERG-2008 equation of state. The function uses an optimized routine that only applies when fluid is in the gaseous state (100% gas) and that requires limited CPU time (suitable for processing in the Flow-X flow computer). Compliance ...
  • Page 190 Flow-X─ Function Reference 4-190 Flow-X General functions - fxGERG2008_Gas Molar Density kmol/m3 MOLDENS Molar Mass kg/kmol MOLMASS Speed of Sound Isentropic Exponent Range 0: In Normal Range RANGE All inputs are within the 'Normal Range' 1: In Extended Range One or more inputs within the...

  • Page 191: Fxgerg2008_Flash

    Flow-X─ Function Reference 4-191 Flow-X General functions - fxGERG2008_Flash fxGERG2008_Flash The compressibility and density of a gas/liquid mixture are calculated from its composition, temperature and pressure in accordance with the GERG2008 standard. Compliance  Kunz, O., and W. Wagner. "The GERG-2008 wide-range equation of state for natural gases and other mixtures: An expansion of GERG-2004."...
  • Page 192 Flow-X─ Function Reference 4-192 Flow-X General functions - fxGERG2008_Flash Function Remark SW tag Alarm Fallback outputs Status 0: Normal 1: Input argument out of range FIOOR 2: Calculation error CALCERR 3: No convergence NOCONV 4: Mole fractions do not add up to COMPERR 1.0 +- 0.0001...

  • Page 193: Fxgpa_Tp15

    Flow-X─ Function Reference 4-193 Flow-X General functions - fxGPA_TP15 fxGPA_TP15 Description The GPA-TP15 standard defines a generalized correlation method to determine the vapor pressure (i.e. the equilibrium pressure) for natural gas liquids (NGL). The vapor pressure is required by the API 11.2.2 and API 11.1:2004 calculations of the CPL value for light hydrocarbon liquids that have a vapor pressure above atmospheric pressure.
  • Page 194 Flow-X─ Function Reference 4-194 Flow-X General functions - fxGPA_TP15 Function inputs Remark Range Default Name Optional tag name, tag description and tag group Relative density at 0.3 .. 0.75 60°F Observed °F -100..200 Temperature API rounding 0: Disabled Full precision (no rounding applied)

  • Page 195: Fxgpa2172_96_C

    Flow-X─ Function Reference 4-195 Flow-X General functions - fxGPA2172_96_C fxGPA2172_96_C This uses the procedure for calculating heating value, specific gravity and compressibility factor at customary (imperial) conditions from the compositional analysis of a natural gas mixture. GPA2172 describes the calculation methods to determine the compositional properties based on the individual component values and it refers to the GPA Standard 2145 (GPA2145) standard for these individual component values.
  • Page 196 Flow-X─ Function Reference 4-196 Flow-X General functions - fxGPA2172_96_C neo-Pentane Determines what to do when NEOC5_MODE mode component neo-Pentane is larger than zero 1: Add to i-Pentane 2: Add to n-Pentane 3: Neglect Function Remark SW tag Alarm Fallback outputs...
  • Page 197 Flow-X─ Function Reference 4-197 Flow-X General functions - fxGPA2172_96_C Molar Mass Ideal specific gravity ISG_SAT Ratio (Saturated) Relative Based on the RRD_SAT Density compressibility of (Saturated) saturated air Compressibility Z_SAT (Saturated) Gross Heating Btu/lbm MASGHV_SAT Value (Saturated) Net Heating Btu/ft3...

  • Page 198: Fxgpa2172_96_M

    Flow-X─ Function Reference 4-198 Flow-X General functions - fxGPA2172_96_M fxGPA2172_96_M This function uses the procedure for calculating heating value, specific gravity and compressibility factor at metric conditions from the compositional analysis of a natural gas mixture. GPA2172 describes the calculation methods to determine the compositional properties based on the individual component values and it refers to the GPA Standard 2145 (GPA2145) standard for these individual component values.
  • Page 199 Flow-X─ Function Reference 4-199 Flow-X General functions - fxGPA2172_96_M Function outputs Remark SW tag Alarm Fallback Status 0: Normal 1: Input argument out FIOOR of range CALCERR 2: Calculation error COMPERR 3: Composition error  Composition does not add up to 100% +- 0.01%...
  • Page 200 Flow-X─ Function Reference 4-200 Flow-X General functions - fxGPA2172_96_M Calculations The calculations are as documented in the GPA-2172 standard using the GPA2145 table values. However the calculations are performed at full precision, so not with intermediate rounding as shown in the examples of the standard.

  • Page 201: Fxgpa2172_09_C

    Flow-X─ Function Reference 4-201 Flow-X General functions - fxGPA2172_09_C fxGPA2172_09_C This function calculates the heating value, specific gravity and compressibility factor at customary (imperial) conditions from the compositional analysis of a natural gas mixture in accordance with GPA2172-09. This function does not support the theoretical hydrocarbon liquid content calculation that has been added to GPA-2172 2009 revision.
  • Page 202 Flow-X─ Function Reference 4-202 Flow-X General functions - fxGPA2172_09_C Function inputs Remark SW tag Range Default Name Optional tag name, tag description and tag group Composition Standard composition as mol/mol COMP 0..1 defined section 'Standard Gas Composition' Edition Refers to the base conditions...
  • Page 203 Flow-X─ Function Reference 4-203 Flow-X General functions - fxGPA2172_09_C Molar Mass lbm/lbmol ISG_DRY Ratio (Dry) Relative RRD_DRY Density (Dry) Compressibility Z_DRY (Dry) Gross Heating Btu/lbm MASGHV_DRY Value (Dry) Net Heating Btu/ft3 VOLNHV_DRY Value (Dry) Gross Heating The saturated Gross Btu/ft3...

  • Page 204: Fxgpa2172_09_M

    Flow-X─ Function Reference 4-204 Flow-X General functions - fxGPA2172_09_M fxGPA2172_09_M This function calculates the heating value, specific gravity and compressibility factor at metric (imperial) conditions from the compositional analysis of a natural gas mixture in accordance with GPA2172-09. This function does not support the theoretical hydrocarbon liquid content calculation that has been added to GPA-2172 2009 revision.
  • Page 205 Flow-X─ Function Reference 4-205 Flow-X General functions - fxGPA2172_09_M neo-Pentane Determines what to do NEOC5_MODE mode when component neo- Pentane is larger than zero 1: Add to i-Pentane 2: Add to n-Pentane 3: Neglect Function outputs Remark SW tag Alarm...
  • Page 206 Flow-X─ Function Reference 4-206 Flow-X General functions - fxGPA2172_09_M (Saturated) compressibility of saturated air Compressibility Z_SAT (Saturated) Gross Heating MJ/kg MASGHV_SAT Value (Saturated) Net Heating MJ/m3 VOLNHV_SAT Value (Saturated) Calculations The calculations are as documented in the GPA-2172 standard using the GPA2145 table values.

  • Page 207: Fxiapws_If97_C

    Flow-X─ Function Reference 4-207 Flow-X General functions - fxIAPWS_IF97_C fxIAPWS_IF97_C Description The function calculates the density and enthalpy of steam and water according to AIPWS-IF97 in US Customary units. IAPWS-IF97 defines calculations for 5 regions as shown in the picture below.
  • Page 208 Flow-X─ Function Reference 4-208 Flow-X General functions - fxIAPWS_IF97_C Function inputs Remark Range Default Name Optional tag name, tag description and tag group Temperature °F 0 .. 4000 Pressure psia 0..15000 Phase The phase (water or steam) can be calculated automatically or be set to either steam or water.
  • Page 209 Flow-X─ Function Reference 4-209 Flow-X General functions - fxIAPWS_IF97_C Calculations The calculations are in compliance with the standard. For regions 1, 2 and 5 the density can be calculated directly from the temperature in pressure. For region 3 an iterative calculation is required because the Equation Of State for this region calculates the pressure from a known temperature and density iteration.

  • Page 210: Fxiapws_If97_M

    Flow-X─ Function Reference 4-210 Flow-X General functions - fxIAPWS_IF97_M fxIAPWS_IF97_M Description The function calculates the density and enthalpy of steam and water according to AIPWS-IF97 in Metric units. IAPWS-IF97 defines calculations for 5 regions as shown in the picture below.
  • Page 211 Flow-X─ Function Reference 4-211 Flow-X General functions - fxIAPWS_IF97_M Function inputs Remark Range Default Name Optional tag name, tag description and tag group Temperature °C -50 .. 2200 Pressure bar(a) 0..1100 Phase The phase (water or steam) can be calculated automatically or be set to either steam or water.
  • Page 212 Flow-X─ Function Reference 4-212 Flow-X General functions - fxIAPWS_IF97_M Calculations The calculations are in compliance with the standard. For regions 1, 2 and 5 the density can be calculated directly from the temperature in pressure. For region 3 an iterative calculation is required because the Equation Of State for this region calculates the pressure from a known temperature and density iteration.

  • Page 213: Fxindex

    Flow-X─ Function Reference 4-213 Flow-X General functions - fxIndex fxIndex The 'fxIndex' provides the same functionality as the Excel Index function with the addition of the creation of tag names. A spreadsheet cell that contains a 'fxIndex' function obtains the tag name as defined by its 'Name' input with the tag inheriting all properties including the value and units from the referred tag.

  • Page 214: Fxinterpolationcurve

    Flow-X─ Function Reference 4-214 Flow-X General functions - fxInterpolationCurve fxInterpolationCurve This function calculates the output value from a set of reference points and the actual input value. The function can take an arbitrary number of reference points. The function is typically used for applying a calibration curve to a K factor or a meter factor (liquid) or a meter error curve (gas).
  • Page 215 Flow-X─ Function Reference 4-215 Flow-X General functions - fxInterpolationCurve Calculations         Where: Input value Interpolated value Closest input reference value that is smaller than the input value Closest input reference value that is larger than the input value...

  • Page 216: Fxiso5167_Isa1932Nozzle

    Flow-X─ Function Reference 4-216 Flow-X General functions - fxISO5167_ISA1932Nozzle fxISO5167_ISA1932Nozzle The function calculates the mass flow rate for ISA1932 Nozzle pressure differential flow devices according to the ISO-5167 standard. Compliance ISO-5167 - 1991 Measurement of fluid flow by means of pressure differential devices, 1st edition, 1991 ISO-5167 Amd.1 : 1998(E)
  • Page 217 Flow-X─ Function Reference 4-217 Flow-X General functions - fxISO5167_ISA1932Nozzle pressure at the downstream tapping Temperature 1: Upstream Location Input 'Temperature' represents the upstream temperature (t 2: Downstream Input 'Temperature represents the temperature at the downstream tapping (t 3: Recovered Input 'Temperature' represents the...
  • Page 218 Flow-X─ Function Reference 4-218 Flow-X General functions - fxISO5167_ISA1932Nozzle when the input value is set to 0, else the input value will be used. For more details refer to section 'Density correction'. Fluid The type of fluid being measured 1: Gas...

  • Page 219: Fxiso5167_Longradiusnozzle

    Flow-X─ Function Reference 4-219 Flow-X General functions - fxISO5167_LongRadiusNozzle fxISO5167_LongRadiusNozzle The function calculates the mass flow rate for Long Radius Nozzle pressure differential flow devices according to the ISO-5167 standard. Compliance ISO-5167 - 1991 Measurement of fluid flow by means of pressure differential devices, 1st edition, 1991 ISO-5167 Amd.1 : 1998(E)
  • Page 220 Flow-X─ Function Reference 4-220 Flow-X General functions - fxISO5167_LongRadiusNozzle pressure at the downstream tapping (p Temperature Location 1: Upstream Input 'Temperature' represents the upstream temperature (t 2: Downstream Input 'Temperature represents the temperature at the downstream tapping (t 3: Recovered...
  • Page 221 Flow-X─ Function Reference 4-221 Flow-X General functions - fxISO5167_LongRadiusNozzle location Where the pressure has fully recovered ( Density Exponent. This factor is used when density correction is enabled. The formula 1/ will be used when the input value is set to 0, else the input value will be used.

  • Page 222: Fxiso5167_Orifice

    Flow-X─ Function Reference 4-222 Flow-X General functions - fxISO5167_Orifice fxISO5167_Orifice The function calculates the mass flow rate for Orifice pressure differential flow devices according to the ISO-5167 standard and the ISO/TR 15377 technical report. Orifices plates with the following type of pressure tappings are supported by this function: ...
  • Page 223 Flow-X─ Function Reference 4-223 Flow-X General functions - fxISO5167_Orifice factor Orifice The reference temperature that corresponds to the °C Reference 'Orifice diameter' input value 300..100 Temperatur Configuratio The location of the pressure tappings. Several configurations are permitted by the ISO5167 standard.
  • Page 224 Flow-X─ Function Reference 4-224 Flow-X General functions - fxISO5167_Orifice Temperatur 1: Upstream e Location Input 'Temperature' represents the upstream temperature (t 2: Downstream Input 'Temperature represents the temperature at the downstream tapping (t 3: Recovered Input 'Temperature' represents the downstream temperature at a location Where...
  • Page 225 Flow-X─ Function Reference 4-225 Flow-X General functions - fxISO5167_Orifice Drain hole When input value is > 0 then an additional correction on the orifice diameter will be applied to account for the drain hole, as explained further on. Function outputs...
  • Page 226 Flow-X─ Function Reference 4-226 Flow-X General functions - fxISO5167_Orifice Where: Pressure at upstream tapping [bar(a)] Pressure at downstream tapping [bar(a)] Fully recovered downstream pressure [bar(a)] p Differential pressure [mbar] Pressure loss over the meter [bar] LOSS Temperature correction  When input 'Temperature correction' is set to 1, then an isentropic expansion based on the isentropic coefficient is applied: ...
  • Page 227 Flow-X─ Function Reference 4-227 Flow-X General functions - fxISO5167_Orifice Density correction  When input 'Density exponent' = 0, then the following isentropic corrections are applied (depending on the type of Density Correction)        ...
  • Page 228 Flow-X─ Function Reference 4-228 Flow-X General functions - fxISO5167_Orifice Where:  Upstream density [kg/m3]  Measured density from the densitometer at p and t [kg/m3] Upstream pressure [bar(a)] Pressure at the downstream tapping [bar(a)] Upstream temperature °C Temperature at downstream side Where pressure has fully °C...

  • Page 229: Fxiso5167_Venturi

    Flow-X─ Function Reference 4-229 Flow-X General functions - fxISO5167_Venturi fxISO5167_Venturi The function calculates the mass flow rate for classical Venturi tube pressure differential flow devices according to the ISO-5167 standard. Compliance ISO-5167 - 1991 Measurement of fluid flow by means of pressure differential devices, 1st edition, 1991 ISO-5167 Amd.1 : 1998(E)
  • Page 230 Flow-X─ Function Reference 4-230 Flow-X General functions - fxISO5167_Venturi standard!) When 'User-defined' is selected then the input 'Discharge coefficient' will be used in the calculations instead. Pressure Location 1: Upstream Input 'Pressure' represents the pressure at the upstream pressure tapping (p...
  • Page 231 Flow-X─ Function Reference 4-231 Flow-X General functions - fxISO5167_Venturi 1: Upstream Input 'Density' represents the density at the upstream pressure tapping ( 2: Downstream Input 'Density' represents the density at the downstream tapping ( 3: Recovered Input 'Density' represents the...
  • Page 232 Flow-X─ Function Reference 4-232 Flow-X General functions - fxISO5167_Venturi Function outputs Remark Fallback Status 0: Normal (No error condition) 1: Input argument out of range 2: No convergence Mass flow rate The calculated mass flow rate tonne/h Beta ratio Venturi to pipe diameter ratio at upstream...

  • Page 233: Fxiso5167_Venturinozzle

    Flow-X─ Function Reference 4-233 Flow-X General functions - fxISO5167_VenturiNozzle fxISO5167_VenturiNozzle The function calculates the mass flow rate for Venturi Nozzle pressure differential flow devices according to the ISO-5167 standard. Compliance ISO-5167 - 1991 Measurement of fluid flow by means of pressure differential devices, 1st edition, 1991 ISO-5167 Amd.1 : 1998(E)
  • Page 234 Flow-X─ Function Reference 4-234 Flow-X General functions - fxISO5167_VenturiNozzle fully recovered (t Since temperature measurement is usually downstream of the flow device this is the most common setting. Temperature Isentropic expansion using (1-)/ as the Correction temperature referral exponent Isentropic expansion using input 'Temperature...
  • Page 235 Flow-X─ Function Reference 4-235 Flow-X General functions - fxISO5167_VenturiNozzle Function outputs Remark Fallback Status 0: Normal (No error condition) 1: Input argument out of range 2: No convergence Mass flow rate The calculated mass flow rate tonne/h Beta ratio Venturi nozzle to pipe diameter ratio at upstream...
  • Page 236 Flow-X─ Function Reference 4-236 Flow-X General functions - fxISO5167_VenturiNozzle Temperature correction  When input ''Temperature exponent' = 0, then an isentropic expansion is applied:                ...

  • Page 237: Fxiso6976_1983_M

    Flow-X─ Function Reference 4-237 Flow-X General functions - fxISO6976_1983_M fxISO6976_1983_M ISO standard 6976 defines component properties and calculations to determine the calorific value, density and relative density for a gas composition at the specified metering and combustion reference temperatures and 1.01325 bar(a).

  • Page 238: Fxiso6976_1995_M

    Flow-X─ Function Reference 4-238 Flow-X General functions - fxISO6976_1995_M fxISO6976_1995_M ISO standard 6976 edition 1995 defines component properties and calculations to determine the calorific value, density, relative density and Wobbe index for a gas composition at the specified metering and combustion reference temperatures and 1.01325 bar(a).
  • Page 239 Flow-X─ Function Reference 4-239 Flow-X General functions - fxISO6976_1995_M Function outputs Remark Fallback Status 0: Normal 1: Input argument out of range 2: Calculation error 3: Mole fractions do not add up to 1.0 +- 0.0001 Superior calorific Real superior calorific value on volume basis at...

  • Page 240: Fxiso6976Ex_1995_M

    Flow-X─ Function Reference 4-240 Flow-X General functions - fxISO6976ex_1995_M fxISO6976ex_1995_M Extended version that takes the first 55 components as used in the standard plus an additional set of user-definable components. ISO standard 6976 edition 1995 defines component properties and calculations to determine the calorific value, density, relative density and Wobbe index for a gas composition at the specified metering and combustion reference temperatures and 1.01325 bar(a).
  • Page 241 Flow-X─ Function Reference 4-241 Flow-X General functions - fxISO6976ex_1995_M Function Remark Default inputs 29: Cyclopentane 30: Methylcyclopentane 31: Ethylcyclopentane 32: Cyclohexane 33: Methylcyclohexane 34: Ethylcyclohexane 35: Benzene 36: Toluene 37: Ethylbenzene 38: o-Xylene 39: Methanol 40: Methanethiol 41: Hydrogen 42: Water...
  • Page 242 Flow-X─ Function Reference 4-242 Flow-X General functions - fxISO6976ex_1995_M Function Remark Default inputs User-defined Array of molar masses of the additional user-definable kg/kmol molar mass components. This should be the molar mass corresponding to the current ‘Molar mass table method’.
  • Page 243 Flow-X─ Function Reference 4-243 Flow-X General functions - fxISO6976ex_1995_M Data range With respect to the ISO6976-1995 standard the combination of input values is: 0: In Range 1: Out of Range Calculations Calculations are performed in accordance with the standard with the addition of the user-definable components.

  • Page 244: Fxkeypadfallback

    Flow-X─ Function Reference 4-244 Flow-X General functions - fxKeypadFallback fxKeypadFallback This function provides a generic interface to any input signal, such as a pressure, temperature, density or flow input. It provides the option to override the 'live' value with a keypad value and to fallback to a specific value when the input value is faulty.

  • Page 245: Fxkeypadfallbackarray

    Flow-X─ Function Reference 4-245 Flow-X General functions - fxKeypadFallbackArray fxKeypadFallbackArray This function provides a generic interface to an array of input values, typically a gas composition. It provides the option to override the 'live' values with keypad values and to fallback to specific values when the set of input values is faulty.

  • Page 246: Fxlatch

    Flow-X─ Function Reference 4-246 Flow-X General functions - fxLatch fxLatch The 'fxLatch' function provides generic latching functionality. Function inputs Remark SW tag Range Default Name Tag name for the cell that contains the 'fxLatchValue' function. Latch trigger Trigger to latch the input value Input value Value to be latched.

  • Page 247: Fxlimitalarm

    Flow-X─ Function Reference 4-247 Flow-X General functions - fxLimitAlarm fxLimitAlarm Description The function applies alarm limits on any value. Function inputs and outputs Function inputs Remark SW tag Range Default Name Optional tag name Input value Must be linked to...

  • Page 248: Fxmr113

    Flow-X─ Function Reference 4-248 Flow-X General functions - fxMR113 fxMR113 Description The relative humidity, compressibility, density, speed of sound, isentropic coefficient and optionally the dynamic viscosity of a gas are calculated from its composition, absolute humidity, temperature and pressure in accordance with the GOST MR113 standard. The CPU-intensive calculation of viscosity can be optionally enabled if the (flow computer) CPU capacity allows for this.

  • Page 249: Fxname

    Flow-X─ Function Reference 4-249 Flow-X General functions - fxName Function outputs Remark Fallback Status 0: Normal 1: Input argument out of range 2: Calculation error 3: No convergence Base Compressibility At reference conditions Flow Compressibility At flowing conditions Base Density...

  • Page 250: Fxnx19_1962

    Flow-X─ Function Reference 4-250 Flow-X General functions - fxNX19_1962 fxNX19_1962 Description The AGA NX-19 standard describes a method to calculate the super-compressibility for natural gases and was developed in 1962. The 1962 standard describes a standard method for calculating the super-compressibility factor that is based on the actual pressure and temperature, the specific gravity and the mole fractions of the carbon dioxide and nitrogen.
  • Page 251 Flow-X─ Function Reference 4-251 Flow-X General functions - fxNX19_1962 Function outputs Remark Fallback Status 0: Normal 1: Input argument out of range 2: Calculation error Note: value 1 is also reported when one of the intermediate results is out of limit.

  • Page 252: Fxnx19_M

    Flow-X─ Function Reference 4-252 Flow-X General functions - fxNX19_M fxNX19_M Description The AGA NX-19 standard describes a method to calculate the super-compressibility for natural gases and was developed in 1962. The 1962 standard describes a standard method for calculating the super-compressibility factor that is based on the actual pressure and temperature, the specific gravity and the mole fractions of the carbon dioxide and nitrogen.
  • Page 253 Flow-X─ Function Reference 4-253 Flow-X General functions - fxNX19_M shall be at the applicable reference conditions of pressure and temperature. Gross heating value At the applicable reference conditions of MJ/m3 0..100 pressure and temperature Only required when the ‘PTB G9 correction’...

  • Page 254: Fxperiodfwa

    Flow-X─ Function Reference 4-254 Flow-X General functions - fxPeriodFWA fxPeriodFWA Description The function calculates a flow-weighted average (FWA) for a particular period. The function weights the input value with a flow increment and updates the average accordingly. The flow increment is provided by a ‘TotalizerDelta’ or ‘TotalizerRate’ function.

  • Page 255: Fxperiodlatch

    Flow-X─ Function Reference 4-255 Flow-X General functions - fxPeriodLatch fxPeriodLatch Description The function latches a value at the end of a repeating period of time. Inputs and outputs Function Remark Range Default inputs Name Name used for tag prefix and retentive storage.

  • Page 256: Fxperiodmax

    Flow-X─ Function Reference 4-256 Flow-X General functions - fxPeriodMax fxPeriodMax Description The function determines a maximum value over a particular period. Inputs and outputs Function inputs Remark SW tag Range Default Name Name used for tag prefix and retentive storage.

  • Page 257: Fxperiodmin

    Flow-X─ Function Reference 4-257 Flow-X General functions - fxPeriodMin fxPeriodMin Description The function determines a minimum value over a particular period. Inputs and outputs Function Remark SW tag Range Default inputs Name Name used for tag prefix and retentive storage.

  • Page 258: Fxperiodtotal

    Flow-X─ Function Reference 4-258 Flow-X General functions - fxPeriodTotal fxPeriodTotal Description The function accumulates a flow increment into a period total. At the end of the period the current total is stored into the previous value and the current value is reset to 0.
  • Page 259 Flow-X─ Function Reference 4-259 Flow-X General functions - fxPeriodTotal Function Remark SW tag Alarm Fallback outputs Current Accumulated total for the Same as input total current period ’Increment’ Previous Accumulated total for the Same as input total previous period ’Increment’...

  • Page 260: Fxperiodtwa

    Flow-X─ Function Reference 4-260 Flow-X General functions - fxPeriodTWA fxPeriodTWA Description The function calculates a time-weighted average (TWA) for a particular period. At the end of a period the current average is stored in the previous value and the current value is reset to 0.

  • Page 261: Fxperiodwatch

    Flow-X─ Function Reference 4-261 Flow-X General functions - fxPeriodWatch fxPeriodWatch Description The function 'remembers' that a condition has been valid during a period of time. A typical example is a transmitter that was overridden with a keypad value. Inputs and outputs...

  • Page 262: Fxpid

    Note: In flow measurement systems typically only PI control is applied, so the derivative action is disabled. The Flow-X PID function provides several features for enhanced PID control such as:  In cascade control there are two PID control loops arranged with one loop controlling the set point of the other loop.
  • Page 263 Flow-X─ Function Reference 4-263 Flow-X General functions - fxPID output High scale value Process / setpoint value that corresponds to 100% of the control output Reverse Selects the direct or reverse action of control 0: Forward -> Error = (PV - SP) 1: Reverse ->...
  • Page 264 Flow-X─ Function Reference 4-264 Flow-X General functions - fxPID <> 0 : Enabled Idle output % Value used for control output when the PID permissive flag is not set Cascade mode 0: Disabled <>0 : Enabled When this input is enabled while...
  • Page 265 Flow-X─ Function Reference 4-265 Flow-X General functions - fxPID Function Remark SW tag Alarm Fallback outputs Control output The actual output value as percentage of scale that shall be used for actual control. Equals the required control output including the slew rate and min/max limitations.
  • Page 266 Flow-X─ Function Reference 4-266 Flow-X General functions - fxPID Logic Symbols process value in current cycle [EU] process value in previous cycle [EU] PREV required setpoint value [EU] in-use setpoint value in current cycle [EU] in-use setpoint value in previous cycle [EU]...
  • Page 267 Flow-X─ Function Reference 4-267 Flow-X General functions - fxPID  Check if the current setpoint needs to be gradually ramped up or down to the required setpoint: If (SP - SP ) > ( Upwards SP clamp rate * Δt ) then = SP + ( Upwards SP clamp rate * Δt )
  • Page 268 Flow-X─ Function Reference 4-268 Flow-X General functions - fxPID Else If u < u then Bumpless transfer logic If bumpless transfer is enabled, then the following logic is applied. Setpoint tracking IF Manual mode = Enabled OR Tracking mode = Enabled...

  • Page 269: Fxrocalarm

    Flow-X─ Function Reference 4-269 Flow-X General functions - fxROCAlarm fxROCAlarm Description The function checks if a value does not change its value at a rate that is higher than a specific limit (‘rate of change’). Function inputs and outputs Function inputs...
  • Page 270 Flow-X─ Function Reference 4-270 Flow-X General functions - fxSarasota_C correction is enabled Constant from lbm/ft3 0..2000 calibration certificate Note: value required in lbm/ft3  s Constant from 0..1e6 calibration certificate Spool calibration 0..3e3 constant from calibration certificate s/°F Temperature Constant from TEMPCOEF -1e6..1e6...

  • Page 271: Fxsarasota_M

    Flow-X─ Function Reference 4-271 Flow-X General functions - fxSarasota_M fxSarasota_M The function calculates the density from a frequency input signal provided by a Sarasota densitometer and corrects it for temperature and pressure effects in metric units. Note: Calibration constants also need to be in metric units (°C, bar and kg/m3).
  • Page 272 Flow-X─ Function Reference 4-272 Flow-X General functions - fxSarasota_M Where: ρ The corrected density kg/m3 Obtained from the calibration certificate kg/m3  s Obtained from the calibration certificate Obtained from the calibration certificate Obtained from the calibration certificate s/bar Obtained from the calibration certificate s/°C...

  • Page 273: Fxsetonchange

    Flow-X─ Function Reference 4-273 Flow-X General functions - fxSetOnChange fxSetOnChange The 'fxSetOnChange function sets a tag or cell to a specific value whenever another value changes Function inputs Remark SW tag Range Default Module Number of the Flow-X/M module. -1 .. 8 -1 : local module 1..8 : module 1 through 8...

  • Page 274: Fxsetonevent

    Flow-X─ Function Reference 4-274 Flow-X General functions - fxSetOnEvent fxSetOnEvent The 'fxSetOnEvent' function sets a tag to a specific value whenever an event occurs. It is a generic function that is especially useful for implementing logic for controlling output signals (e.g.

  • Page 275: Fxsetindexoncondition

    Flow-X─ Function Reference 4-275 Flow-X General functions - fxSetIndexOnCondition Function Remark SW tag Alarm Fallback outputs Date and time Date and time that the most recent change has occurred fxSetIndexOnCondition The 'fxSetIndexOnCondition' function sets one tag from an array of tags to a specific value whenever a condition is true.

  • Page 276: Fxsetindexonevent

    Flow-X─ Function Reference 4-276 Flow-X General functions - fxSetIndexOnEvent fxSetIndexOnEvent The 'fxSetIndexOnEvent' function sets one tag from an array of tags to a specific value whenever an event occurs. It is a generic function that is especially useful for implementing logic for controlling output signals (e.g.

  • Page 277: Fxsgerg_C

    Flow-X─ Function Reference 4-277 Flow-X General functions - fxSGERG_C fxSGERG_C Description This function performs the SGERG calculation in USC units. The Standard (or Simplified) GERG TM5 1991 Virial Equation (SGERG or SGERG-88) has defines a method to calculate the Compressibility Factor (Z) for Natural Gases. The SGERG calculation is equivalent to the AGA8 Gross Characterisation Method, however .the results are slightly different...
  • Page 278 Flow-X─ Function Reference 4-278 Flow-X General functions - fxSGERG_C pressure 1: 60°F / 60 °F / 14.73 psia 2: 60 °F / 60 °F / 1.01592 bar Note: the calculations are based on 25°C / 0°C / 1.01325 bar(a). For the other...

  • Page 279: Fxsgerg_M

    Flow-X─ Function Reference 4-279 Flow-X General functions - fxSGERG_M fxSGERG_M Description This function performs the SGERG calculation in metric units. The Standard (or Simplified) GERG TM5 1991 Virial Equation (SGERG or SGERG-88) has defines a method to calculate the Compressibility Factor (Z) for Natural Gases. The SGERG calculation is equivalent to the AGA8 Gross Characterisation Method, however .the results are slightly different...
  • Page 280 Flow-X─ Function Reference 4-280 Flow-X General functions - fxSGERG_M 2: 0°C / 0 °C / 1.01325 bar(a) 3: 15°C / 15°C / 1.01325 bar(a) Note: the calculations are based on 25°C / 0°C / 1.01325 bar(a). For the other conditions conversion factors are...

  • Page 281: Fxsolartron_Gas_C

    Flow-X─ Function Reference 4-281 Flow-X General functions - fxSolartron_Gas_C fxSolartron_Gas_C Description The function calculates the density from a frequency input signal provided by a Solartron 7810, 7811 or 7812 gas densitometer and corrects it for temperature and velocity of sound effects in US customary units.
  • Page 282 Flow-X─ Function Reference 4-282 Flow-X General functions - fxSolartron_Gas_C G value Value will be used when VOS GVAL correction is enabled and the G value method is 'Use input G value' Specific gravity Value will be used when VOS 0..2...
  • Page 283 Flow-X─ Function Reference 4-283 Flow-X General functions - fxSolartron_Gas_C                          Where: ρ The density corrected for temperature and VOS...

  • Page 284: Fxsolartron_Gas_M

    Flow-X─ Function Reference 4-284 Flow-X General functions - fxSolartron_Gas_M fxSolartron_Gas_M Description The function calculates the density from a frequency input signal provided by a Solartron 7810, 7811 or 7812 gas densitometer and corrects it for temperature and velocity of sound effects in metric units.
  • Page 285 Flow-X─ Function Reference 4-285 Flow-X General functions - fxSolartron_Gas_M correction is enabled and the G value method is 'Use input G value' Specific gravity Value will be used when VOS 0..2 correction is enabled and the G value method is 'Use ratio of...
  • Page 286 Flow-X─ Function Reference 4-286 Flow-X General functions - fxSolartron_Gas_M                          Where: ρ The density corrected for temperature and VOS...

  • Page 287: Fxsolartron_Liquid _C

    Flow-X─ Function Reference 4-287 Flow-X General functions - fxSolartron_Liquid _C fxSolartron_Liquid _C Description The function calculates the density from a frequency input signal provided by a Solartron 7835, 7845, 7846 or 7847 liquid densitometer and corrects it for temperature, pressure and velocity of sound effects using US Customary units.
  • Page 288 Flow-X─ Function Reference 4-288 Flow-X General functions - fxSolartron_Liquid _C 'Based on Kr / Kj Constants'. Constant needs to be obtained from Solartron Used when VOS method is set to lbm/ft3 'Based on Kr / Kj Constants'. Constant needs to be obtained from...
  • Page 289 Flow-X─ Function Reference 4-289 Flow-X General functions - fxSolartron_Liquid _C                              ...

  • Page 290: Fxsolartron_Liquid_M

    Flow-X─ Function Reference 4-290 Flow-X General functions - fxSolartron_Liquid_M fxSolartron_Liquid_M The function calculates the density from a frequency input signal provided by a Solartron 7835, 7845, 7846 or 7847 liquid densitometer and corrects it for temperature, pressure and velocity of sound effects using metric units.
  • Page 291 Flow-X─ Function Reference 4-291 Flow-X General functions - fxSolartron_Liquid_M certificate K21A Constant from calibration -1e9..1e9 -4.467e-1 certificate K21B Constant from calibration -1e9..1e9 -8.633e-3 certificate Used when VOS method is set -1..+1 to 'Based on Kr / Kj Constants'. Constant needs to be obtained...
  • Page 292 Flow-X─ Function Reference 4-292 Flow-X General functions - fxSolartron_Liquid_M Where: ρ The density corrected for temperature kg/m3 Obtained from the calibration certificate Obtained from the calibration certificate The line temperature °C The reference temperature °C The pressure and temperature corrected density ρ...
  • Page 293 Flow-X─ Function Reference 4-293 Flow-X General functions - fxSolartron_Liquid_M Where: ρ The density corrected for temperature kg/m3 Constant obtained from Solartron Constant obtained from Solartron kg/m3 Calibration VOS Liquid VOS...

  • Page 294: Fxsolartron_Sg

    Flow-X─ Function Reference 4-294 Flow-X General functions - fxSolartron_SG fxSolartron_SG The function calculates the specific gravity from a frequency input signal provided by a Solartron 3096 or 3098 Specific Gravity transducer. Compliance The calculations are in accordance with documents: ...

  • Page 295: Fxstatusalarm

    Flow-X─ Function Reference 4-295 Flow-X General functions - fxStatusAlarm fxStatusAlarm The ‘fxStatusAlarm’ alarm function generates an alarm that can be triggered by a boolean condition. Function inputs Remark Range Default Name Name for the tag Condition A boolean indicating whether the...
  • Page 296 Flow-X─ Function Reference 4-296 Flow-X General functions - minimum check is applied Maximum Maximum value that is accepted when the tag is externally writable May be left empty, in which case no maximum check is applied Function outputs Remark SW tag...

  • Page 297: Fxtimer

    Flow-X─ Function Reference 4-297 Flow-X General functions - fxTimer fxTimer The 'fxTimer' function provides generic timer functionality. Function Remark SW tag Range Default inputs Name Optional tag name, tag description and tag group Start Trigger to start the timer. START...

  • Page 298: Fxtotalizerdelta

    Flow-X─ Function Reference 4-298 Flow-X General functions - fxTotalizerDelta fxTotalizerDelta Description The function accumulates a flow increment into a cumulative (eternal) total. Besides of the cumulative total the function also outputs the flow increment that represents the increase in flow quantity in the last calculation cycle. This increment value serves as an input for related batch and period flow-weighted averaging and totalization functions.
  • Page 299 Flow-X─ Function Reference 4-299 Flow-X General functions - fxTotalizerDelta calculation cycle 'Input unit' Rollover flag Flag indicating a rollover to ROALM 0: Off 1: On Note: stays 'On' for one cycle only. Reset flag Flag indicating a reset to 0.

  • Page 300: Fxtotalizerrate

    Flow-X─ Function Reference 4-300 Flow-X General functions - fxTotalizerRate fxTotalizerRate Description The function accumulates a flow rate into a cumulative (eternal) total. Besides of the cumulative total the function also outputs the flow increment that represents the increase in flow quantity in the last calculation cycle. This increment value serves as an input for related batch and period flow-weighted averaging and totalization functions.
  • Page 301 Flow-X─ Function Reference 4-301 Flow-X General functions - fxTotalizerRate Reset flag Flag indicating a reset to 0. RESET 0: Off 1: On Note: stays 'On' for one cycle only Reload Flag that indicates that at startup RLWARN warning only 2 of the 3 copies were equal and that that value is used as the initial total.

  • Page 302: Fxugc_C

    Flow-X─ Function Reference 4-302 Flow-X General functions - fxUGC_C fxUGC_C The function calculates the density from a frequency input signal provided by a UGC densitometer and corrects it for temperature and pressure effects in US customary units. Note: Calibration constants also need to be in US customary units.
  • Page 303 Flow-X─ Function Reference 4-303 Flow-X General functions - Calculations The uncorrected density ρ is calculated by         Where: ρ The uncorrected density lbm/ft Obtained from the calibration certificate Obtained from the calibration certificate Obtained from the calibration certificate s...

  • Page 304: Fxugc_M

    Flow-X─ Function Reference 4-304 Flow-X General functions - fxUGC_M fxUGC_M The function calculates the density from a frequency input signal provided by a UGC densitometer and corrects it for temperature and pressure effects in metric units. Calibration constants also need to be in metric units.
  • Page 305 Flow-X─ Function Reference 4-305 Flow-X General functions - fxUGC_M Calculations The uncorrected density ρ is calculated by         Where: ρ The uncorrected density kg/m3 Obtained from the calibration certificate Obtained from the calibration certificate Obtained from the calibration certificate s...

  • Page 306: Fxwatchupdate

    Flow-X─ Function Reference 4-306 Flow-X General functions - fxWatchUpdate fxWatchUpdate This function raises a flag whenever a value has been updated in the latest calculation cycle. It is a generic function that can be used for any purpose, e.g. to report the number of times that a gas chromatograph has sent updates of the gas composition.

  • Page 307: Fxvcone_C

    Flow-X─ Function Reference 4-307 Flow-X General functions - fxVCone_C fxVCone_C Description This function calculates the mass flow rate for a measured differential pressure over a McCrometer V- Cone meter in U.S. customary units. The calculation, as specified by the meter supplier, is essentially a modified ISO 5167 flow rate calculation.
  • Page 308 Flow-X─ Function Reference 4-308 Flow-X General functions - fxVCone_C Pressure Location 1: Upstream Input 'Pressure' represents the pressure at the upstream pressure tapping (p Since the absolute pressure is usually measured at the upstream tapping this is the most common setting.
  • Page 309 Flow-X─ Function Reference 4-309 Flow-X General functions - fxVCone_C Density This factor is used when density correction is Exponent. enabled. The formula 1/ will be used when the input value is set to 0, else the input value will be used.
  • Page 310 Flow-X─ Function Reference 4-310 Flow-X General functions - fxVCone_C Expansion Factor The McCrometer reference document states that Range for gas applications the expansion factor should not get below 0.84 0: Expansion factor is in valid range 1: Expansion factor is out of valid range Calculations The flow calculation is as specified in the McCrometer reference document.

  • Page 311: Fxvcone_M

    Flow-X─ Function Reference 4-311 Flow-X General functions - fxVCone_M fxVCone_M Description This function calculates the mass flow rate for a measured differential pressure over a McCrometer V- Cone meter in metric units. The calculation, as specified by the meter supplier, is essentially a modified ISO 5167 flow rate calculation.
  • Page 312 Flow-X─ Function Reference 4-312 Flow-X General functions - fxVCone_M then this input is not used (because the expansion factor is set to 1) Pressure Location 1: Upstream Input 'Pressure' represents the pressure at the upstream pressure tapping (p Since the absolute pressure is...
  • Page 313 Flow-X─ Function Reference 4-313 Flow-X General functions - fxVCone_M 2: Downstream Input 'Density' represents the density at the downstream tapping ( 3: Recovered Input 'Density' represents the density downstream at a location Where the pressure has fully recovered ( Density Exponent.
  • Page 314 Flow-X─ Function Reference 4-314 Flow-X General functions - fxVCone_M tapping Downstream 'Fully recovered' downstream temperature (t °C Input Temperature Temperature Upstream density Density at upstream tapping ( kg/m3 Input Density Density at kg/m3 Input Density Pressure at downstream tapping (...

  • Page 315: Chapter 5 - Flow-X Io Functions

    Chapter 5 - Flow-X IO Functions This chapter lists all available IO functions. Please refer to the pinouts for your specific model of flow computer in the installation manual provided with the Spirit Flow Suite software. fxAnalogInput Each flow module supports a maximum of 6 analog input signals. The first 2 signals can be used as either a mA/VDC input or as a RTD input.

  • Page 316: Fxanalogoutput

    Flow-X IO Functions - fxAnalogOutput fxAnalogOutput This function configures a single 4-20 mA output channel on the local Flow-X module. Use function 'fxSetAnalogOutput' to control the actual output signal. The output current is either set directly or gradually changed to the required set point based on the specified filter method.

  • Page 317: Fxdigitalinput

    Flow-X─ Function Reference 5-317 Flow-X IO Functions - fxDigitalInput fxDigitalInput The Digital Input function processes a single digital input and outputs either the actual input signal or the latched input signal. Function inputs Remark SW tag Default Name Optional tag name, tag description and tag...

  • Page 318: Fxdigitaloutput

    Flow-X─ Function Reference 5-318 Flow-X IO Functions - fxDigitalOutput fxDigitalOutput The Digital Output function configures a single digital output on the local module. Use function 'fxSetDigitalOutput' to control the actual output signal. Function inputs Remark SW tag Range Default Name...

  • Page 319: Fxsetdigitaloutput

    Flow-X─ Function Reference 5-319 Flow-X IO Functions - fxSetDigitalOutput fxSetDigitalOutput This function writes a value to a configured digital output. Function inputs Remark SW tag Range Default Name Name for output 'Signal State' Module Unused, set to -1 -1..16 Channel number One of the 16 digital i/o channels.

  • Page 320: Fxsetfrequencyoutput

    Flow-X─ Function Reference 5-320 Flow-X IO Functions - fxSetFrequencyOutput fxSetFrequencyOutput This function starts a programmed frequency on the digital pin, set by fxFrequencyOutput. In case of a dual pulse via frequency out, here the phase shift between the pins can be configured.

  • Page 321: Fxdoublechronometry

    Flow-X─ Function Reference 5-321 Flow-X IO Functions - fxDoubleChronometry fxDoubleChronometry The function provides double chronometry measurement for meter proving and calibration purposes with a resolution of 100 nanoseconds. The function monitors a (dual) pulse input signal provided by the meter under test and by one or more digital signals that represent the start and stop of the measurement.
  • Page 322 Flow-X─ Function Reference 5-322 Flow-X IO Functions - fxDoubleChronometry Function inputs and outputs Function Remark SW tag Range Default inputs Name Optional tag name, tag description and tag group Index Index number INDEX 1..4 Flow input Number of the digital input channel...
  • Page 323 Flow-X─ Function Reference 5-323 Flow-X IO Functions - fxDoubleChronometry geometrical imperfections of the primary metering device the function may be forced to accumulate a number of pulses that corresponds to a whole number of flow meter revolutions. E.g. suppose that at the stop signal...

  • Page 324: Fxpulseinput

    Flow-X─ Function Reference 5-324 Flow-X IO Functions - fxPulseInput fxPulseInput The 'fxPulseInput' function is meant for a flow meter that provides a single or a dual pulse output signal. Each flow module supports either 1 single or 1 dual pulse input.
  • Page 325 Flow-X─ Function Reference 5-325 Flow-X IO Functions - fxPulseInput larger than this value, the status becomes 'Missing Pulses Channel x' (with x either A or B) The value 0 disables the missing pulses limit check. Added pulses When the total number of added ADDLIM 0..1e99...
  • Page 326 Flow-X─ Function Reference 5-326 Flow-X IO Functions - fxPulseInput Function outputs Remark Alarm Fallb Status 0: Normal 1: Input argument out of range FIOOR 2: No A pulses (while B pulses) NOPLSA 3: No B pulses (while A pulses) NOPLSB...

  • Page 327: Fxresetpulseinputerrors

    Flow-X─ Function Reference 5-327 Flow-X IO Functions - fxResetPulseInputErrors fxResetPulseInputErrors This function resets the error pulse counters (error, added, missing and simultaneous pulses) of the pulse input of one of the modules part of the same configuration. It is required that the pulse input of the specified module is configured by function 'fxPulseInput'.
  • Page 328 Flow-X─ Function Reference 5-328 Flow-X IO Functions - fxPulseOutput fxPulseOutput This function is used to feed pulses to an electro-mechanical (E/M) counter. There are 4 pulse output units, to be selected by the index parameter. The function uses a reservoir to accumulate the pulses.

  • Page 329: Fxsetpulseoutput

    Flow-X─ Function Reference 5-329 Flow-X IO Functions - fxSetPulseOutput Calculations Every calculation cycle a number of pulses is added to the reservoir that is equal to input value 'Increment' divided by input value Significance factor. fxSetPulseOutput Adds pulses to the reservoir, to be output on the next cycle. Takes the ‘significance factor’ into account, see fxPulseOutput.

  • Page 330: Fxrtdinput

    Flow-X─ Function Reference 5-330 Flow-X IO Functions - fxRTDInput Function outputs Remark SW tag Alarm Fallback Status Status output 0: Normal 1: Input argument out of range FIOOR 2: Under range failure 3: Over range failure 4: Open circuit 5: Short circuit...
  • Page 331 Flow-X─ Function Reference 5-331 Flow-X IO Functions - fxPT100Table...

  • Page 332: Fxtimeperiodinput

    Flow-X─ Function Reference 5-332 Flow-X IO Functions - fxTimePeriodInput fxTimePeriodInput This function measures the time period between two pulses with a high resolution (100 nanoseconds) and is typically used for densitometer inputs. The measurement is performed continuously in the background and the function returns the average value since the previous calculation cycle.

  • Page 333: Chapter 6 - Reference

    Flow-X─ Function Reference 6-333 Reference - Unit Types Chapter 6 - Reference Unit Types Type Description Unit Convert Excel Multiply Conversion unit constant Accelerati meters per m/s2 xu_m_s2 second squared kilometers per km/s2 m/s2 xu_km_s2 1.0 E+03 Exact second squared...
  • Page 334 Flow-X─ Function Reference 6-334 Reference - Unit Types megacalorie Mcal 4.1868 Exact E+09 decatherm 1.05505585 Exact 262 E+09 Energy per joule per J/kg Mass kilogram kilojoule per kJ/kg J/kg 1.0 E+03 Exact kilogram megajoule per MJ/kg J/kg 1.0 E+06 Exact...
  • Page 335 Flow-X─ Function Reference 6-335 Reference - Unit Types kilo British kBtu/hr (1.0550558 Exact thermal unit per 5262 / hour 3600) E+06 million British MMBtu/ (1.0550558 Exact thermal unit per 5262 / hour 3600) E+09 kilo British kBtu/d (1.0550558 Exact thermal unit per...
  • Page 336 Flow-X─ Function Reference 6-336 Reference - Unit Types foot ) E+06 calorie per cal/sm3 J/sm3 4.1868 Exact standard cubic meter kilocalorie per kcal/sm3 J/sm3 4.1868 Exact standard cubic E+03 meter Energy per joules per J/m3(n) Normal standard cubic Volume meter...
  • Page 337 Flow-X─ Function Reference 6-337 Reference - Unit Types Kinematic square meter m2/s Viscosity per second square mm2/s m2/s 1.0 E-06 Exact millimeter per second centistokes m2/s 1.0 E-06 Exact stokes m2/s 1.0 E-04 Exact Length meter centimeter 1.0 E-02 Exact millimeter 1.0 E-03...
  • Page 338 Flow-X─ Function Reference 6-338 Reference - Unit Types tonUS) long ton (equals long ton 1.01604690 Exact 2240 lb, also 9 E+03 called tonUK) Mass per mass fraction mass/ma Mass mass %mass mass/ma 1.0 E-02 Exact percentage Mass per kilograms per...
  • Page 339 Flow-X─ Function Reference 6-339 Reference - Unit Types pound mass lbm/d kg/s (4.535924/ Exact (avoirdupois) 86400) E-01 per day kilopound mass klbm/d kg/s (4.535924/ Exact (avoirdupois) 86400) per day E+02 Mass per kilogram per kg/m3 Volume cubic meter gram per cubic...
  • Page 340 Flow-X─ Function Reference 6-340 Reference - Unit Types gram per g/cm3(n) kg/m3(n) 1.0 E-03 Exact normal cubic centimeter Mole mole A mole resembles 6.0251 x 10^23 molecules of a substance, a standard number of molecules known as Avogadro’s number. kilomole kmol 1.0 E+03...
  • Page 341 Flow-X─ Function Reference 6-341 Reference - Unit Types Power watt kilowatt 1.0 E+03 Exact megawatt 1.0 E+06 Exact gigawatt 1.0 E+09 Exact Pressure pascal (differenti kilo pascal 1.0 E+03 Exact kilogram-force kgf/m2 9.80665 Exact per square meter kilogram-force kgf/cm2 9.80665...
  • Page 342 Flow-X─ Function Reference 6-342 Reference - Unit Types convential absolute millimeter of mmH2O Pa(a) 9.80665 Exact water, convential absolute millimeter of mmH2O Pa(a) 248.84/25. Approximate water @ 60°F a @ 60°F absolute inch of mercury, inHga Pa(a) 3386.38864 Exact convential...
  • Page 343 Flow-X─ Function Reference 6-343 Reference - Unit Types gauge inch of water @ inH2Og Pa(g) 249.082 Approximate 39.2°F (4°C) @ 39.2°F gauge inch of water @ inH2Og Pa(g) 248.84 Approximate 60°F gauge @ 60°F Pressure per pascal 1/Pa inverse per kilo pascal...
  • Page 344 Flow-X─ Function Reference 6-344 Reference - Unit Types Rankine T[K] = Exact T[R]/1.8 Temperat per Kelvin inverse per degree 1/°C Exact Celsius per degree 1/°F Exact Fahrenheit per Rankine Exact Temperat degree Celsius °C/bar ure per per bar Pressure (Joule-Thomson coefficient) °F/psi...
  • Page 345 Flow-X─ Function Reference 6-345 Reference - Unit Types Standard standard cubic Volume meter kilo standard ksm3 1.0 E+03 Exact cubic meter mega standard Msm3 1.0 E+06 Exact cubic meter standard cubic 28.31685 E Exact foot kilo standard kscf 28.31685 Exact...
  • Page 346 Flow-X─ Function Reference 6-346 Reference - Unit Types cubic feet per ft3/hr m3/s 0.02831685 Exact hour /3600 cubic feet per ft3/d m3/s 0.02831685 Exact /86400 kilo cubic feet kft3/hr m3/s 28.31685/3 Exact per hour kilo cubic feet kft3/d m3/s 28.31685/8...

  • Page 347: Terminology

    Flow-X─ Function Reference 6-347 Reference - Terminology barrels per day bbl/d sm3/s 0.15898729 Exact (standard) 5/86400 Normal normal cubic m3(n)/s Volume meter per per Time second normal cubic m3(n)/hr m3(n)/s 1/3600 Exact meter per hour normal cubic m3(n)/d m3(n)/s 1/86400...

  • Page 348: Standard Composition

    Flow-X─ Function Reference 6-348 Reference - Standard composition Standard composition The Standard Composition is a standard array of mole fractional values that is used by all functions that require a (partial) compositional analysis. The following table defines the sequence of the components and also defines which function uses which component.
  • Page 349 Flow-X─ Function Reference 6-349 (This page is intentionally left blank for user notes.)
  • Page 350 Flow-X─ Function Reference 6-350 (This page is intentionally left blank for user notes.)

Table of Contents