Spirit flow-x Parts list manual

Function Reference
Certified flow calculations
Flow and batch calculations
Worksheet functions

Product
Flow-X Function Reference
Reference number
01-0110-1
Revision
A.6
Date
April 2015
Authors
J.C.H.M. van Dal
Disclaimer
Spirit IT has taken care in the preparation of this book, but makes no expressed or implied warranty of
any kind and assumes no responsibility for errors or omissions. No liability is assumed for incidental or
consequential damages in connection with or arising out of the issue of the information or programs
contained herein.
Special note
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.
Printed in the Netherlands.
Copyright© 2008-2015 Spirit IT B.V., Eindhoven, the Netherlands. All rights reserved.
®Flow-X is a registered trademark of Spirit Holding B.V.
®Microsoft Windows is a registered trademark of Microsoft Corporation.
®Microsoft Excel is a registered trademark of Microsoft Corporation.
Visit Spirit on the Web: http://www.spiritIT.com
Spirit Innovative Technologies
Prof. dr. Dorgelolaan 20
5613 AM Eindhoven
The Netherlands

Flow-X─ Function Reference
1-3
Table of contents
Chapter 1 - 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
Overview of hydrocarbon liquid conversion standards ------------------------------------------------------ 2-11
Overview of the functions ------------------------------------------------------------------------------------------ 2-12
Hydrometer Correction ---------------------------------------------------------------------------------------------- 2-13
API-2540 Boundaries ------------------------------------------------------------------------------------------------ 2-13
Chapter 3 - Flow-X General functions-------------------------------------------------------------------------3-17
fx2CellSelection------------------------------------------------------------------------------------------ 3-17
fx3CellSelection------------------------------------------------------------------------------------------ 3-19
fxAGA10_M ---------------------------------------------------------------------------------------------- 3-22
fxAGA10ex_M ------------------------------------------------------------------------------------------- 3-24
fxAGA3_C-------------------------------------------------------------------------------------------------- 3-27
fxAGA5_C-------------------------------------------------------------------------------------------------- 3-33
fxAGA8_C-------------------------------------------------------------------------------------------------- 3-34
fxAGA8_M ------------------------------------------------------------------------------------------------ 3-36
fxAGA8_Gross-------------------------------------------------------------------------------------------- 3-38
fxAPI_Dens15C_1952----------------------------------------------------------------------------------- 3-40
fxAPI_Dens15C_1980----------------------------------------------------------------------------------- 3-43
Chapter 4 - Flow-X General functions-------------------------------------------------------------------------4-49
fx2CellSelection------------------------------------------------------------------------------------------ 4-49
fx3CellSelection------------------------------------------------------------------------------------------ 4-51
fxAGA10_M ---------------------------------------------------------------------------------------------- 4-54
fxAGA10ex_M ------------------------------------------------------------------------------------------- 4-56
fxAGA3_C-------------------------------------------------------------------------------------------------- 4-59
fxAGA5_C-------------------------------------------------------------------------------------------------- 4-65
fxAGA8_C-------------------------------------------------------------------------------------------------- 4-66
fxAGA8_M ------------------------------------------------------------------------------------------------ 4-68
fxAGA8_Gross-------------------------------------------------------------------------------------------- 4-70
fxAPI_Dens15C_1952----------------------------------------------------------------------------------- 4-72
fxAPI_Dens15C_1980----------------------------------------------------------------------------------- 4-75
fxAPI_Dens15C_NGL_LPG ----------------------------------------------------------------------------- 4-81
fxAPI_Dens20C_NGL_LPG ----------------------------------------------------------------------------- 4-86
fxAPI_Gravity60F_1952 -------------------------------------------------------------------------------- 4-92
fxAPI_Gravity60F_1980 -------------------------------------------------------------------------------- 4-95
fxAPI_MPMS_11_2_1 ---------------------------------------------------------------------------------4-100
fxAPI_MPMS_11_2_1M-------------------------------------------------------------------------------4-102
fxAPI_MPMS_11_2_2 ---------------------------------------------------------------------------------4-104
fxAPI_MPMS_11_2_2M-------------------------------------------------------------------------------4-106
fxAPI_MPMS_11_3_2_1 ------------------------------------------------------------------------------4-108
fxAPI_MPMS_11_3_3_2 ------------------------------------------------------------------------------4-109
fxAPI_RD60F_1980-------------------------------------------------------------------------------------4-111
fxAPI_SG60F_1952-------------------------------------------------------------------------------------4-117

1-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
fxAPI_Table24_2004----------------------------------------------------------------------------------- 4-144
fxAPI_Table24E -----------------------------------------------------------------------------------------4-146
fxAPI_Table53_1952----------------------------------------------------------------------------------- 4-147
fxAPI_Table53_1980----------------------------------------------------------------------------------- 4-148
fxAPI_Table53_2004----------------------------------------------------------------------------------- 4-150
fxAPI_Table53E -----------------------------------------------------------------------------------------4-152
fxAPI_Table54_1952----------------------------------------------------------------------------------- 4-153
fxAPI_Table54_1980----------------------------------------------------------------------------------- 4-154
fxAPI_Table54_2004----------------------------------------------------------------------------------- 4-156
fxAPI_Table54E -----------------------------------------------------------------------------------------4-158
fxAPI_Table59_2004----------------------------------------------------------------------------------- 4-159
fxAPI_Table59E -----------------------------------------------------------------------------------------4-161
fxAPI_Table60_2004----------------------------------------------------------------------------------- 4-162
fxAPI_Table60E -----------------------------------------------------------------------------------------4-164
fxASTM_D1550_RD60---------------------------------------------------------------------------------4-165
fxASTM_D1550_Ctl ------------------------------------------------------------------------------------4-167
fxASTM_D1555_Dens60F-----------------------------------------------------------------------------4-168
fxASTM_D1555_Ctl ------------------------------------------------------------------------------------4-171
fxBatchFWA----------------------------------------------------------------------------------------------4-173
fxBatchHistData-----------------------------------------------------------------------------------------4-174
fxBatchLatch---------------------------------------------------------------------------------------------4-175
fxBatchMax ----------------------------------------------------------------------------------------------4-176
fxBatchMin----------------------------------------------------------------------------------------------- 4-177
fxBatchTotal ---------------------------------------------------------------------------------------------4-178
fxBatchTWA ---------------------------------------------------------------------------------------------4-179
fxBatchWatch -------------------------------------------------------------------------------------------4-180
fxConvertUnit -------------------------------------------------------------------------------------------4-181
fxDeviationAlarm---------------------------------------------------------------------------------------4-182
NIST1045 -------------------------------------------------------------------------------------------------4-183
fxEthylene_IUPAC_C----------------------------------------------------------------------------------- 4-184
fxEthylene_IUPAC_M----------------------------------------------------------------------------------4-185
fxGasViscosity_2004-----------------------------------------------------------------------------------4-186
fxGenerateReport --------------------------------------------------------------------------------------4-188
fxGERG2008_Gas---------------------------------------------------------------------------------------4-189
fxGERG2008_Flash -------------------------------------------------------------------------------------4-191
fxGPA_TP15----------------------------------------------------------------------------------------------4-193
fxGPA2172_96_C ---------------------------------------------------------------------------------------4-195
fxGPA2172_96_M-------------------------------------------------------------------------------------- 4-198
fxGPA2172_09_C ---------------------------------------------------------------------------------------4-201
fxGPA2172_09_M-------------------------------------------------------------------------------------- 4-204
fxIAPWS_IF97_C ----------------------------------------------------------------------------------------4-207
fxIAPWS_IF97_M ---------------------------------------------------------------------------------------4-210
fxIndex ----------------------------------------------------------------------------------------------------4-213

Flow-X─ Function Reference
1-5
fxInterpolationCurve ----------------------------------------------------------------------------------4-214
fxISO5167_ISA1932Nozzle ---------------------------------------------------------------------------4-216
fxISO5167_LongRadiusNozzle -----------------------------------------------------------------------4-219
fxISO5167_Orifice --------------------------------------------------------------------------------------4-222
fxISO5167_Venturi -------------------------------------------------------------------------------------4-229
fxISO5167_VenturiNozzle ----------------------------------------------------------------------------4-233
fxISO6976_1983_M------------------------------------------------------------------------------------4-237
fxISO6976_1995_M------------------------------------------------------------------------------------4-238
fxISO6976ex_1995_M---------------------------------------------------------------------------------4-240
fxKeypadFallback ---------------------------------------------------------------------------------------4-244
fxKeypadFallbackArray --------------------------------------------------------------------------------4-245
fxLatch ----------------------------------------------------------------------------------------------------4-246
fxLimitAlarm ---------------------------------------------------------------------------------------------4-247
fxMR113--------------------------------------------------------------------------------------------------4-248
fxName ---------------------------------------------------------------------------------------------------4-249
fxNX19_1962 --------------------------------------------------------------------------------------------4-250
fxNX19_M------------------------------------------------------------------------------------------------4-252
fxPeriodFWA---------------------------------------------------------------------------------------------4-254
fxPeriodLatch--------------------------------------------------------------------------------------------4-255
fxPeriodMax ---------------------------------------------------------------------------------------------4-256
fxPeriodMin----------------------------------------------------------------------------------------------4-257
fxPeriodTotal --------------------------------------------------------------------------------------------4-258
fxPeriodTWA --------------------------------------------------------------------------------------------4-260
fxPeriodWatch ------------------------------------------------------------------------------------------4-261
fxPID-------------------------------------------------------------------------------------------------------4-262
fxROCAlarm----------------------------------------------------------------------------------------------4-269
fxSarasota_C---------------------------------------------------------------------------------------------4-269
fxSarasota_M--------------------------------------------------------------------------------------------4-271
fxSetOnChange -----------------------------------------------------------------------------------------4-273
fxSetOnCondition---------------------------------------------------------------------------------------4-273
fxSetOnEvent--------------------------------------------------------------------------------------------4-274
fxSetIndexOnChange ----------------------------------------------------------------------------------4-274
fxSetIndexOnCondition -------------------------------------------------------------------------------4-275
fxSetIndexOnEvent-------------------------------------------------------------------------------------4-276
fxSGERG_C -----------------------------------------------------------------------------------------------4-277
fxSGERG_M ----------------------------------------------------------------------------------------------4-279
fxSolartron_Gas_C -------------------------------------------------------------------------------------4-281
fxSolartron_Gas_M ------------------------------------------------------------------------------------4-284
fxSolartron_Liquid _C----------------------------------------------------------------------------------4-287
fxSolartron_Liquid_M ---------------------------------------------------------------------------------4-290
fxSolartron_SG ------------------------------------------------------------------------------------------4-294
fxStatusAlarm -------------------------------------------------------------------------------------------4-295
fxTag-------------------------------------------------------------------------------------------------------4-295
fxTimer----------------------------------------------------------------------------------------------------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

1-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
fxTimePeriodInput -------------------------------------------------------------------------------------5-332
Chapter 6 - Reference -------------------------------------------------------------------------------------------6-333
Unit Types------------------------------------------------------------------------------------------------ 6-333
Terminology ---------------------------------------------------------------------------------------------6-347
Standard composition---------------------------------------------------------------------------------6-348

Flow-X─ Function Reference
1-7
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. When major changes have been implemented, the major revision number increments.
Example document:
A.0 First revision
A.1 Second revision with minor changes implemented
A.2 Third revision, with other minor changes
B.0 Fourth revision, with (a) major change(s).
The revision coding will be modified for each new release of a document.
All software packages and software modules or components will be provided with a version number.
This number consists of three parts: A release number, a major revision number and a minor revision
number separated by decimal points. A release number identifies the generation number of the
software, the major number refers to the main functionality of the program, seen from the user's point
of view, while the minor revision number identify a new software version.
Example program:
1.01.001 Initial release
1.01.002 Minor change
1.02.001 Major change
2.01.001 Family change
Revision History
Revision A.0
Author : J.C.H.M. van Dal
Date : April 2009
Initial, release
Revision A.1
Author : J.C.H.M. van Dal
Date : June 2010
Added IUPAC Ethylene and IAWS-IF97 functions
Revision A.2
Author : I. Fiers
Date : Aug 2012
Updated and corrected IO functions, moved to separate chapter.

1-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
Author : J.C.H.M. van Dal
Date : February 2015
Minor editorial changes
Revision A.6
Author : J.C.H.M. van Dal
Date : April 2015
Added new natural gas viscosity calculation
Added C11 –C21 components to the extended ISO6976 functions
Added “Quarter circle” and “Conical entrance” orifice calculations
Revision A.7
Author : J.C.H.M. van Dal
Date : September 2015
Added GSSSD method MR 113-03 function

Flow-X─ Function Reference
2-9
Introduction - Flow-X Function Library
Chapter 2 - Introduction
This document describes the spreadsheet functions for the Flow-X series of flow computers. It also
provides background information on related standards and calculation methods used in the industry for
quality and quantity measurement of hydrocarbon and other type of fluids.
The document serves as a reference manual for application engineers who have in-depth knowledge of
the configuration software used for programming the Flow-X products.
Flow-X Function Library
The Flow-X series of flow computer uses Microsoft Excel as its configuration environment. Each Flow-X
application consists of a single 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.
API Petroleum Measurement Tables
History
The first version of the API Petroleum Measurement Tables was published in 1952. In those days
measurement readings were taken manually and the tables were used to convert the observed density
or gravity at the observed temperature to the value at the reference temperature. So the table values
were the actual standard.
The 1952 Tables consists of 58 tables containing all kind of correction and conversion factors used in
the measurement of hydrocarbon liquids. Each table deals with a particular conversion of units,
correction of density, or correction of volume. The 1952 tables that have to do with the conversion of
density and volume are: 5, 6, 23, 24, 53 and 54.
Table 5, 6, 23 and 24 convert density or volume to or from to a reference temperature of 60°F, while
tables 53 and 54 refer to 15°C.
In 1980 a complete new set of tables was published together with computer routines to allow
electronic devices to automatically calculate the volume conversion factors and API gravity / (relative)
density at the reference temperature. Back then most electronic devices were not capable of
performing double-precision floating point calculations, so the standard prescribed all kind of rounding
and truncating rules to make sure that the calculations would always provide the same result. For the
1980 version the calculation procedures are the standard rather than the table values.
In the 1980 version, which is also referred to as API-2540, the tables are divided into 3 product groups
and a letter designation was used to distinguish between the sub-tables. "A" was used for crude oil, "B"
for refined products and "C" for special applications. The 1980 tables, however, did not cover the LPGs
and NGLs density ranges and the 1952 Tables were left valid for these products. Furthermore, the
lubricating oil tables (designated as "D") were not complete at the time of the printing in 1980 and
were released two years later. As opposed to the A, B and C tables no implementation procedures were
defined for the D tables.
In 1988 the Institute of Petroleum released its Paper No. 3 with tables 59 and 60 that are based on a
reference temperature of 20°C.
This resulted in the following Petroleum Measurement Tables dealing with the conversion of volume
and density to and from a reference temperature.

2-10
Flow-X─ Function Reference
Introduction - API Petroleum Measurement Tables
Number
Title
5
API Gravity Reduction to 60°F
6
Reduction of Volume to 60°F Against API Gravity at 60°F
23
Reduction of Observed Specific Gravity to Specific Gravity 60/60°F
24
Reduction of Volume to 60o F Against Specific Gravity 60/60°F
53
Reduction of Observed Density to Density at 15°C
54
Reduction of Volume to 15°C Against Density at 15°C
59
Reduction of Observed Density to Density at 20°C
60
Reduction of Volume to 20°C Against Density at 20°C
In 2004 the API MPMS 11.1 1980 tables were superseded by a new set of tables primarily for the
following reasons:
API 11.1:2004 includes the correction for both temperature and pressure in one and the
same algorithm
Taken into account the progress in electronics (and for other reasons) the complex
truncating and rounding rules were abandoned. Instead the calculation procedures use
double-precision floating point math. The input and output values are still rounded in order
to obtain consistent results.
The convergence methods for the correction of observed density to base density have been
improved.
On-line density measurement by densitometers became common practice, requiring the
pressure and temperature correction to be incorporated in one ands the same procedure
The tables are extended in both temperature and density to cover lower temperatures and
higher densities.
The previous standard used a significant digit format which resulted in 4 or 5 decimal places
depending on whether the observed temperature was above or below the reference
temperature. The new standard prescribes 5 decimal places if or both cases.
The IP paper No. 3 tables were added to accommodate conversion to 20°C.
Tables for lubricating oils including the implementation procedures are now part of the standard.
Volume correction for pressure
The API MPMS 11.1:1980 Tables only cover the correction for temperature. The correction for pressure
was published in API MPMS standards 11.2.1 and 11.2.2.
The correction for pressure is to the atmospheric pressure or, for products within the lower density
range, to the equilibrium vapor pressure.
To calculate the equilibrium vapor pressure an Addendum was added to API MPMS 11.2.2. This
addendum is also known as GPA TP-15 (1988). In September 2007 the addendum was replaced by a
new API standard 11.2.5 and at the same time GPA TP-15 (1988) was updated with a new 2007
revision.
NGL and LPG tables
For NGL and LPG products volume correction tables 24E and 23E (at 60 °F) were published in GPA TP-25
(1988), so the letter 'E" was used to distinguish the tables from the related API MPMS A, B, C and D
tables.
GPA TP-25 has been superseded by GPA TP-27 / API MPMS 11.2.4 (2007), which includes tables 53E,
54E, 59E and 60E to convert to 15°C and 20°C as well. All text from TP-25 is included without technical
change, so TP-25 is still viable for conversion to and from 60 °F.