FLOCALC.
net User Manual
FLOCALC.net
User Manual
Rev Issue date Description Prep App
1.0 14/06/13 Issued MH MH
Kelton Engineering Ltd
The Mackenzie Building
168 Skene Street
Aberdeen
AB10 1PE
SCOTLAND
Tel. +44 1224 630000
Fax. +44 1224 630004
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 1
FLOCALC.net
User Manual
1 INTRODUCTION ....................................................................................................................................... 3
1.1 FLOCALC ................................................................................................................................................ 3
1.2 FLOXL ..................................................................................................................................................... 3
2 FLOCALC.NET INSTALLATION ................................................................................................................... 3
2.1 INSTALLATION............................................................................................................................................ 3
3 GETTING STARTED ................................................................................................................................... 4
3.1 RUNNING FLOCALC .................................................................................................................................. 4
3.2 THE FLOCALC WORKSPACE ........................................................................................................................ 4
4 CALCULATIONS ........................................................................................................................................ 6
4.1 OPENING A CALCULATION FROM THE LIBRARY .................................................................................................. 6
4.2 RUNNING CALCULATIONS ............................................................................................................................ 7
4.3 SAVING CALCULATIONS ............................................................................................................................. 11
4.4 OPENING CALCULATIONS ........................................................................................................................... 12
4.5 CALCULATION TEMPLATES.......................................................................................................................... 12
4.6 CREATING A CALCULATION FROM A TEMPLATE................................................................................................ 12
4.7 OPENING CALCULATIONS SAVED IN FLOCALC V2 .......................................................................................... 13
5 CALCULATION WORKBOOKS.................................................................................................................. 13
5.1 GENERAL ................................................................................................................................................ 13
5.2 CREATING A NEW WORKBOOK..................................................................................................................... 14
5.3 ADDING CALCULATIONS FROM THE LIBRARY ................................................................................................... 14
5.4 ADDING CALCULATIONS FROM A TEMPLATE ................................................................................................... 14
5.5 ADDING SAVED CALCULATIONS.................................................................................................................... 14
5.6 USING WORKBOOKS ................................................................................................................................. 15
5.7 SETTING CALCULATION OPTIONS ................................................................................................................. 15
5.8 INPUTS ................................................................................................................................................... 16
6 FLOCALC ON-LINE .................................................................................................................................. 18
6.1 ENABLING OPC ....................................................................................................................................... 18
6.2 SET UP OPC INPUTS ................................................................................................................................. 18
6.3 READING FROM OPC ................................................................................................................................ 19
6.4 WRITING TO OPC .................................................................................................................................... 19
7 FLOXL .................................................................................................................................................... 21
7.1 ADDING A FLOXL FUNCTION ...................................................................................................................... 21
7.2 CONFIGURE CALCULATION ......................................................................................................................... 22
7.3 THE EXCEL FUNCTION ............................................................................................................................... 25
7.4 MULTIPLE OUTPUTS ................................................................................................................................. 26
7.5 LINKING CALCULATIONS............................................................................................................................. 27
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 2
FLOCALC.net
User Manual
1 Introduction
1.1 FLOCALC
FLOCALC is the KELTON calculation package designed for flow measurement engineers and
technicians. FLOCALC.net is the fourth generation of this application redesigned to work
with current operating systems.
1.2 FloXL
FloXL enables FLOCALC calculations to be run as functions within Microsoft Excel 2010
workbooks.
2 Flocalc.net Installation
2.1 Installation
FLOCALC is delivered with an installation manual to guide you through the process of
installing the application and accessing your licenced calculations. The most recent copy of
the installation manual is available from Kelton Engineering on request.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 3
FLOCALC.net
User Manual
3 Getting Started
3.1 Running FLOCALC
FLOCALC, like any other windows applications can be started from the windows start menu;
this is located under the Kelton Engineering Ltd. group. Alternatively a shortcut to the
application is installed on the desktop.
If FLOCALC is installed as part of an FM²P system It can be run from the FLOCALC icon main
FM²P Window.
3.2 The FLOCALC Workspace
FLOCALC will open to show the main window from which all elements of the application can
be accessed.
This window contains three toolbars and will switch between toolbar automatically as you
use the application.
3.2.1 The Home toolbar
The Home toolbar is the first toolbar you will see when you open the application.
This contains buttons for creating and saving workbooks and calculations along with
common features such as viewing the help files and the unit converter utility.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 4
FLOCALC.net
User Manual
3.2.2 The Workbook toolbar
The Workbook toolbar is visible when working in a workbook and contains buttons to run
common commands associated with manipulating workbooks.
3.2.3 The Calculation toolbar
The Calculation toolbar is visible when working in a calculation and contains buttons to run
common commands required.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 5
FLOCALC.net
User Manual
4 Calculations
4.1 Opening a calculation from the library
FLOCALC accesses the KELTON Common Calculation Library (KCCL), a library of calculations
which is continually updated as new standards and calculations are added.
To select a new calculation click on the Calculation from Library button on the Home toolbar.
Within KCCL Calculations are referenced by a number preceded by a C. This is the base
calculation number which is used by KELTON for managing the calculation. Within FLOCALC
there is also a reference number proceeded by an F, which is the FLOCALC calculation
reference number.
Clicking the Calculation, ‘F’ ref or Title headings will sort the calculation by the heading
clicked.
There are a number of options available to help find and select the required calculation.
4.1.1 Group
Calculations are grouped according to the standards they are referenced to; selecting a
standard group in the left-hand pane will filter the list of calculations to show only those
belonging to the standard group.
The All group shows all calculations except the Legacy calculations.
4.1.2 Show Legacy Group
Check this option to display Legacy calculations. Legacy calculations are those which are
included in the calculation library to maintain compatibility with calculations created in
previous versions of the application. Most Legacy calculations will have been updated with a
new version which may have more options or different calculation methods.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 6
FLOCALC.net
User Manual
4.1.3 Show Locked Calculations
The list of calculations will only display those which are included in your licence. Should you
wish to see other calculations which are available, check the Show Locked Calculations
check-box.
4.1.4 Opening a calculation
To open a selected calculation, either double-click the calculation in the list or select by
clicking the entry and then clicking the OK button.
4.2 Running Calculations
All FLOCALC calculations follow a similar Structure and contain the following components.
4.2.1 General
The General tab contains header information which can be added to the calculation. This is
particularly useful if a record of the calculation is to be saved or sent to another user.
Information can be entered into a number of predefined fields such as Site, Tag and Client.
Other information on this tab is; the date the calculation was last modified, The KCCL
reference and the date the calculation was last modified in KCCL.
4.2.2 Options
Many of the calculations contain Options which control how the calculation is performed
and the parameters used.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 7
FLOCALC.net
User Manual
In this example the user is provided with options for calculating standard density or density.
Choosing the Commodity group and setting the reference temperature. In some
calculations choosing an option may introduce further options.
4.2.3 Inputs
Inputs for the calculation are entered under the inputs tab.
The selection of inputs for a calculation may change depending upon the options which are
selected. In this example Standard Density is shown as an input because the option to solve
for Density from standard density was selected; had the option to solve for Standard density
from density been selected the input would have been Density.
The engineering unit for each input can be selected by clicking on the unit and picking from
the drop-down list.
4.2.4 Intermediates
Intermediate results from a calculation are displayed in the intermediates tab. This feature
is useful when investigating calculation errors or discrepancies.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 8
FLOCALC.net
User Manual
By default the intermediate results are shown to the full precision but can be rounded or
truncated by clicking on the ‘P’ (precision) button, selecting whether to round or truncate
and then selecting the number of decimal places.
To round all items in a group to the same precision, click on the 'P' in the group heading. If
you would like to round individual values to different levels of precision click on the value to
round and then click the ‘P’ to the right of the value.
4.2.5 Outputs
Outputs are displayed in the same way as the intermediates. Both resolution and
engineering units can be selected for intermediates and outputs.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 9
FLOCALC.net
User Manual
4.2.6 Report
The results of a calculation can be presented in the format of a report.
4.2.7 Report Options
When generating a report you can select which options to display by unchecking
corresponding to each tab
The report toolbar contains buttons for navigating between pages of the report, printing and
exporting to file.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 10
FLOCALC.net
User Manual
4.2.8 Warnings
Some calculations include logic to display warning messages when certain conditions occur;
these are displayed in a warning tab which is otherwise hidden.
4.3 Saving Calculations
To save a calculation, click the save button on the Home or the Calculation toolbar.
If the calculation has not been saved this will take you to the standard Save As dialog which
will let you save the file in any location with the FLOCALC calculation extension (*.fcx)
The save button will be greyed out if you open a saved calculation but will become active
once the calculation has been changed or information added.
An asterisk at the start of the calculation title indicates that the calculation has been
changed or edited since it was last saved.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 11
FLOCALC.net
User Manual
4.4 Opening Calculations
To open a calculation which has previously been saved either click on the Open button on
the Home toolbar or the Open button which is always displayed in the Quick Access Toolbar.
This is at the top left corner of the application window.
4.5 Calculation Templates
If you are to repeat calculations with the same units or options it may be advantageous to
use calculation templates.
To create a template open a calculation and then set the required options and units you
would like saved.
Click on the Save As button and choose to save as a Calculation Template (*.ftx)
The advantage of using a template as opposed to saving and editing a calculation file is that
a template will create a new calculation each time it is used whilst leaving the template itself
intact.
4.6 Creating a calculation from a template
To create a calculation based on a preconfigured template click the Calculation from
Template button on the Home menu bar
You will notice that the calculation will have an asterisk next to the title indicting that it can
be saved.
Clicking the save button will prompt you to save the calculation as a new calculation file thus
leaving the template intact.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 12
FLOCALC.net
User Manual
4.7 Opening calculations saved in FLOCALC V2
Click the import button on Home toolbar to import a calculation created in previous versions
of FLOCALC. These will have the extensions:
FLOCALC Workbook (*.fcw)
FLOCALC Calculation (*.fcc)
FLOCALC Template (*.fct)
5 Calculation Workbooks
5.1 General
A FLOCALC calculation workbook is a collection of FLOCALC calculations which are saved as a
single file.
The purpose of a workbook is to keep related calculations together and to enable passing
data from one calculation to another or to share inputs.
If you have Microsoft Excel a more convenient method of passing data from one calculation
to another may be to use FloXL the Microsoft Excel interface which is included with
FLOCALC.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 13
FLOCALC.net
User Manual
5.2 Creating a new workbook
To create a FLOCALC calculation workbook click on the Workbook button on the Home
toolbar or the New Workbook button on the Workbook toolbar.
When the new workbook is created the Workbook button will be selected.
Header information can be entered into the Workbook as shown above.
5.3 Adding calculations from the library
To add a new calculation from the library, click the Add from Library button on the
Workbook toolbar. This will open the same calculation selection window as described in
Section 4.1
5.4 Adding calculations from a template
To add a new calculation based on a template (see Section 0) click the Add from Template
button on the Workbook toolbar.
5.5 Adding saved calculations
If you wish to import a calculation which has previously been created and saved, open the
calculation as shown in Section 4.1.4
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 14
FLOCALC.net
User Manual
5.6 Using Workbooks
Once a workbook has been created and calculations have been added they will appear in a
list:
Calculations in the workbook can be opened and used in the same way as stand-alone
calculations. Alternatively the tabs at the top of the window can be used for setting options,
entering inputs and viewing results from any calculation.
In this example we are going to create a workbook to calculate the mass and energy flow
rate through an orifice meter. The flow rate is calculated in accordance with ISO 5167, the
density is calculated using AGA 8 and the calorific value is calculated using ISO 6976.
When adding calculations to a workbook the order is significant; calculations can only use
values from other calculations if they appear before them in the list.
5.7 Setting Calculation Options
The options tab will let you expand each calculation in the workbook and set the options.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 15
FLOCALC.net
User Manual
5.8 Inputs
The Inputs from for each calculation are grouped and can be expanded by clicking on the
arrow to enter the values and select the engineering units.
On the first calculation in the list the only option available for inputs is User Entered but on
subsiquent calculations the inputs may be taken from previous calculations in the list.
In this example the input composition for F003 ISO 6976 is taken to be the same as the input
composition for AGA 8; this will save entering the composition twice.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 16
FLOCALC.net
User Manual
The outputs from F014 –AGA 8 and F003 ISO 6976 are fed into F027 – ISO 5167. This
example shows the input for the line density required to calculate Flow being linked to the
density calculated by AGA 8.
Intermediate and output values are displayed for each calculation:
Once the links have been set up in a workbook it is recommended that the workbook be
saved as a template so that similar calculations can be performed without having to go
through the process of setting up links again.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 17
FLOCALC.net
User Manual
6 FLOCALC On-line
If FLOCALC is licenced as part of an FM²P.net system which included K-LINK it is possible to
perform a calculation using valued which are read electronically from an OPC Tags and write
calculated values back to OPC tags. To use this functionality FLOCALC must be launched
from within FM²P.
6.1 Enabling OPC
To enable OPC for a calculation check the OPC Enabled check-box:
6.2 Set up OPC inputs
By default the inputs will be user entered; by clicking on the box which displays the text User
Entered you can browse to OPC sources which have been set up in K-Link.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 18
FLOCALC.net
User Manual
6.3 Reading from OPC
To read values from the OPC tags click the Set OPC Inputs button on the Calculation toolbar.
This will read the value from the OPC tag once; if the values on the OPC tags change the
FLOCALC calculation will not be updated unless the Set OPC inputs button is clicked again.
6.4 Writing to OPC
Calculated outputs and Intermediates can be written to OPC tags by linking to the OPC tag
(in the same way as the inputs were linked and then clicking on the Set OPC Outputs button
on the Calculation toolbar.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 19
FLOCALC.net
User Manual
In this example the fast-loop pressure and temperature were read from OPC tags along with
the measured density. Values for the Cpl, Ctl and standard density were calculated by
FLOCALC and written back to the appropriate OPC tags.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 20
FLOCALC.net
User Manual
7 FloXL
FloXL makes FLOCALC calculations available as functions when using Microsoft Excel 2010.
This feature is run from within Excel and there is no requirement to run FLOCALC to use
FloXL.
7.1 Adding a FloXL Function
In this example we would like to add a function to calculate standard density from the
measured density, pressure and temperature using the 2004 API density referral calculation.
To Add a FloXL function click on the Add Formula button on the Kelton toolbar; this will open
a window which will let you select the appropriate calculation. As with FLOCALC the
calculations are grouped for easy selection.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 21
FLOCALC.net
User Manual
7.2 Configure Calculation
The FloXL calculation will open in a window similar to that when using a FLOCALC
calculation.
7.2.1 Options
Calculation options are set under the options tab; in this case we would like to calculate the
standard density of crude oil using a standard temperature of 15 °C.
7.2.2 Inputs
When setting up the inputs the units must match those used in the spreadsheet otherwise
the calculation will not return the correct result.
There are a number of ways in which the input can be referenced to a cell in Excel.
Click and Select
To use this method, first click on the cell within Excel you would like to link and then
click the button next to the parameter where you would like to use the value.
This method works best when you are manipulate the windows on your screen to
display the Excel workbook and the FloXL calculation window side by side.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 22
FLOCALC.net
User Manual
Alternatively you can switch between windows by clicking on the Excel button on
the taskbar at the bottom of the screen.
Type the cell reference
The cell reference can be typed in place of the input value. Once the cell reference is
entered it will be referenced to the Worksheet which is currently selected.
As with any other Excel functions absolute and relative cell references can be used
by preceding the Row numbers and Column letters with a $.
Named cells
If you are familiar with the use of named cells within Excel this method works well
with FloXL – Simply type the name of the cell in place of the cell reference.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 23
FLOCALC.net
User Manual
7.2.3 Results
Intermediates and outputs all appear in the results tab.
The method of linking results to Excel is the same as when setting up inputs
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 24
FLOCALC.net
User Manual
7.3 The Excel Function
Once you have configured the FloXL Function and clicked OK the Excel function will be
entered in the cell which is referenced in the Results tab.
To edit the function, click the edit formula button on the Kelton toolbar as FloXL functions
use too many arguments to use the fx button in the formula bar.
Functions will behave in the same way as a standard Excel function and can be copied,
moved, dragged and dropped. This example has been shows the density which would result
from changing the temperature of the oil:
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 25
FLOCALC.net
User Manual
7.4 Multiple Outputs
A FloXL calculation may calculate a number of different parameters. In the example where
we calculated standard density from measured density we also had the option of calculating
Cpl and Ctl.
Selecting multiple results will result in multiple Excel functions being created.
It should be noted that the functions created are independent of each other and once
created editing one function will not change the configuration of any function created at the
same time.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 26
FLOCALC.net
User Manual
7.5 Linking Calculations
Using FloXL is particularly useful when linking calculations.
In this example a workbook has been set up to calculate energy flow rate using ISO 5167
with the CV coming from ISO 6976 and the Density from AGA 8 etc.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 27
FLOCALC.net
User Manual
The calculation of calorific value, density, isentropic exponent and dynamic viscosity are all
linked to the same input composition therefore changing a single parameter will filter
through to the output.
\\kelton.local\DFS\Projects\T\58\00\3.03 Technical Work Notes\Manuals\FLOCALC User Manual R1.docx 28
