Modicon Starling Associates Gas Flow Loadable Function ... · Modicon Starling Associates Gas Flow Loadable Function Block ... express written permission of the ... format as a standard

ModiconStarling Associates Gas Flow Loadable Function Block User Guide890 USE 137 00 Version 2.0

ModiconStarling Associates

Gas Flow Loadable Function BlockUser Guide

890 USE 137 00 Version 2.0

May, 1999

Schneider Electric Inc.One High Street

North Andover, MA 01845

Preface890 USE 137 00 iii

Preface

The data and illustrations found in this book are not binding. We reservethe right to modify our products in line with our policy of continuousproduct development. The information in this document is subject tochange without notice and should not be construed as a commitment byStarling Associates, Inc.

Starling Associates assumes no responsibility for any errors that mayappear in this document. If you have any suggestions for improvementsor amendments or have found errors in this publication, please notify usby using the form on the last page of this publication.

No part of this document may be reproduced in any form or by anymeans, electronic or mechanical, including photocopying, withoutexpress written permission of the Publisher, Schneider Electric.

Caution: All pertinent state, regional, and local safetyregulations must be observed when installing and using thisproduct. For reasons of safety and to assure compliance withdocumented system data, repairs to components should beperformed only by the manufacturer.

MODSOFT is a registered trademark of SchneiderElectric Inc.

The following are trademarks of Schneider Electric Inc.:

Modbus Modbus PlusModicon 984

DIGITAL and DEC are registered trademarks of Digital EquipmentCorporation.

IBM and IBM AT are registered trademarks of InternationalBusiness Machines Corporation.

Microsoft and MS-DOS are registered trademarks of MicrosoftCorporation.

Meter Manager is a registered trademarks of Starling Associates,Corporation.

iv Preface 890 USE 137 00

Windows 3.1 and Windows 95 are registered trademarks of MicrosoftCorporation.

Copyright 1999, Starling Associates, Inc.Printed in U.S.A.

Contents890 USE 137 00 v

Contents

Chapter 1Introduction 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.1 PLC Loadable Functions 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.2 Gas Flow Specific Functionality 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.2.1 Implementation 4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.2.2 Restrictions 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.2.3 Compatible Software and Hardware 5. . . . . . . . . . . . . . . . . . .1.2.4 Reference Documents 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.3 Software Installation using Modsoft 2.5 or Higher 8. . . . . . . . . . . . . . . . . .1.3.1 DX Zoom Screens: Loading DXFDT.SYS 8. . . . . . . . . . . . . . . .1.3.2 DX Zoom Screens: Loading Gxxx.ZMM 8. . . . . . . . . . . . . . . . .1.3.3 Loading Gxxx20x8.HLP 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.3.4 Loadable Installation 8. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.4 Software Installation using Concept 2.1 or Higher 15. . . . . . . . . . . . . . . . . .1.4.1 Loadable Installation 15. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.5 Hardware Enabler Installation 18. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.5.1 For Compact PLCs 18. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1.5.2 For Micro 110 CPU 612 04 PLC 20. . . . . . . . . . . . . . . . . . . . . . .

1.6 Customer Service 21. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 2GD92 AGA#3&8 1992 Detail Method Gas Flow Function Block 23.

2.1 Gas Flow Function Block 24. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.1.1 Characteristics 24. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.1.2 Representation 24. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.1.3 GD92 Configuration Table 26. . . . . . . . . . . . . . . . . . . . . . . . . . . .

2.2 DX Zoom Screens (Modsoft Only) 31. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2.3 Gas Flow Configuration Table 38. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2.3.1 Gas Flow Configuration Input Table 38. . . . . . . . . . . . . . . . . . .2.3.2 Gas Flow Configuration Output Table 50. . . . . . . . . . . . . . . . . .2.3.3 Gas Flow Configuration Optional Output Table 57. . . . . . . . .

2.4 Possible Configuration Example for the Gas Flow Block 59. . . . . . . . . . . . .2.4.1 Example with US Units 59. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

890 USE 137 00Contentsvi

Chapter 3GM92 AGA#3&8 1992 Detail Method Gas Flow Function Block 67.

3.1 Gas Flow Function Block 68. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.1.1 Characteristics 68. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.1.2 Representation 69. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.1.3 GM92 Configuration Table 70. . . . . . . . . . . . . . . . . . . . . . . . . . . .

3.2 DX Zoom Screens (Modsoft Only) 75. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3.3 Gas Flow Configuration Table 83. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

3.3.1 Gas Flow Configuration Input Table 83. . . . . . . . . . . . . . . . . . .3.3.2 Gas Flow Configuration Output Table 94. . . . . . . . . . . . . . . . . .3.3.3 Gas Flow Configuration Optional Output Table 101. . . . . . . . .

3.4 Possible Configuration Example for the Gas Flow Block 103. . . . . . . . . . . . .3.4.1 Example with Metric Units 103. . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 4G392 AGA#3 1992 Gas Flow Function Block 111. . . . . . . . . . . . . . . . . .

4.1 Gas Flow Function Block 112. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.1.1 Characteristics 112. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.1.2 Representation 112. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.1.3 G392 Configuration Table 114. . . . . . . . . . . . . . . . . . . . . . . . . . . .

4.2 DX Zoom Screens (Modsoft Only) 118. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.3 Gas Flow Configuration Table 126. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4.3.1 Gas Flow Configuration Table (Inputs) 126. . . . . . . . . . . . . . . . .4.3.2 Gas Flow Output Table 138. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4.3.3 Gas Flow Output Table (Optional Outputs) 144. . . . . . . . . . . . .


Contents890 USE 137 00 vii

Chapter 5GG92 AGA#3 1992 Gross Method Flow Function Block 153. . . . . . . .

5.1 Gas Flow Function Block 154. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5.1.1 Characteristics 154. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5.1.2 Representation 155. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5.1.3 GG92 Configuration Table 156. . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.2 DX Zoom Screens (Modsoft Only) 161. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5.2.1 Gross Method 1 DX Zoom Screens 162. . . . . . . . . . . . . . . . . . . . .5.2.2 Gross Method 2 DX Zoom Screens 169. . . . . . . . . . . . . . . . . . . . .

5.3 Gas Flow Configuration Table 176. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5.3.1 Gas Flow Configuration Input Table 176. . . . . . . . . . . . . . . . . . .5.3.2 Gas Flow Configuration Output Table 189. . . . . . . . . . . . . . . . . .5.3.3 Gas Flow Configuration Optional Output Table 196. . . . . . . . .


Chapter 6GFNX AGA#3 ’85 & NX19 ’68 Flow Function Block 207. . . . . . . . . . . .

6.1 Gas Flow Function Block 208. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6.1.1 Characteristics 208. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6.1.2 Representation 209. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6.1.3 GFNX Configuration Table 210. . . . . . . . . . . . . . . . . . . . . . . . . . .

6.2 DX Zoom Screens (Modsoft Only) 215. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6.2.1 Gross Method 1 (10) DX Zoom Screens 216. . . . . . . . . . . . . . . . .6.2.2 Detail Method 1 (11) (Gas Analysis) DX Zoom Screens 222. . .6.2.3 Gross Method 2 (12) DX Zoom Screens 228. . . . . . . . . . . . . . . . .6.2.4 Gross Method 3 (13) DX Zoom Screens 234. . . . . . . . . . . . . . . . .

6.3 Gas Flow Configuration Table 241. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6.3.1 Gas Flow Configuration Input Table 241. . . . . . . . . . . . . . . . . . .6.3.2 Gas Flow Configuration Output Table 253. . . . . . . . . . . . . . . . . .6.3.3 Gas Flow Configuration Optional Output Table 259. . . . . . . . .


890 USE 137 00Contentsviii

Appendix AAPI 21.1 Audit Trail 267. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

A.1 API 21.1 Audit Trail Overview 268. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A.2 API21.1 Audit Trail Configuration Table 269. . . . . . . . . . . . . . . . . . . . . . . . . .

A.2.1 Inputs 269. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A.2.2 Outputs 270. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A.2.3 API21.1 Audit Trail Detailed Descriptions 270. . . . . . . . . . . . . .A.2.4 API21.1 Audit Trail Configuration Output Table 272. . . . . . . .

A.3 API21.1 Audit Trail Area 274. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A.3.1 Configuration Table Data 274. . . . . . . . . . . . . . . . . . . . . . . . . . . . .A.3.2 Daily Transaction Log Data 274. . . . . . . . . . . . . . . . . . . . . . . . . . .A.3.3 Hourly Transaction Log Data 275. . . . . . . . . . . . . . . . . . . . . . . . .A.3.4 Event Log Data 276. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A.3.5 Configuration Change Log Data 279. . . . . . . . . . . . . . . . . . . . . . .

Appendix BUtility Functions 285. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B.1 GET_LOGS.EXE 286. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B.1.1 Parameters and Switches 286. . . . . . . . . . . . . . . . . . . . . . . . . . . . .B.1.2 Output Files 289. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

B.2 SET_SIZE.EXE 300. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B.2.1 Format and Switches 300. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Appendix CTechnical References 303. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

C.1 Performance of Gas Blocks 304. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C.2 End User Part Numbers 305. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C.3 Formula Nomenclature 307. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C.4 Conversion Factors 308. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C.5 Possible Application Examples for PLCs 309. . . . . . . . . . . . . . . . . . . . . . . . . . .C.6 Technical Expertise in Gas Measurement 316. . . . . . . . . . . . . . . . . . . . . . . . . .

Index 317. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Introduction890 USE 137 00 1

Chapter 1Introduction

V PLC Loadable Functions

V Gas Flow Specific Functionality

V Software Installation

V Enabler Key Installation

V Customer Service

Introduction 890 USE 137 002

1.1 PLC Loadable Functions

The PLC has the ability to have Loadable Function Blocks added to itsconfiguration. These Loadable Functions are application specificcallable subroutine sets that are loaded and allow you to set the Opcodethrough Modsoft or Concept panel software and then ”configure” theminto the larger control program.

The executable software code is programmed into the application in theformat as a standard three node ladder logic function block. The basiclogic subroutine structure of a loadable is shown in Figure 1.

Process Memory References

Define Length

StartOp Code

INPUTS OUTPUTS

Figure 1 Loadable Code Logic Flow

These functions can be added to existing control logic in a fieldenvironment and offer a software solution to specific applicationproblems.


1.2 Gas Flow Specific Functionality

The Gas Flow Loadable Function Block allows you to run AGA 3 andAGA 8 equations and meet the audit trail requirements of API 21.1using your Modicon PLC. The computed flow rates agree within 1 ppmof the published AGA standards. You may pick basic flow equations orpreferred supercompressibility factor (Z factor) options. The followingfive Gas Flow Functions are available for your selection: GD92, GM92,G392, GG92 and GFNX. Refer to Section C.1 for the detail performancevalues of each gas flow function block.

Gas FlowBlocks

Features of Blocks PLC Memory SizeRequired

Standards

Available with a 130 HEK 301 01, AGA Full Enabler.

GD92 Detail method*single pass

8K AGA 3 ’92 &AGA 8 ’92

GM92 Detail method* eightpasses

16K** AGA 3 ’92 &AGA 8 ’92

G392 Eight passes 8K AGA 3 ’92

GG92 Gross method eightpasses (both of two)

16K** AGA 3 ’92 &AGA 8 ’92

GFNX Eight Passes 16K** AGA 3 ’85 &NX19

Available with a 130 HEK 301 02, AGA Lite Enabler.

GD92 Detail method*single pass

8K AGA 3 ’92 &AGA 8 ’92

G392 Eight passes 8K AGA 3 ’92

*Supports the detailed characterization method, that uses a detail knowledge of thegas composition making it more accurate than the gross characterization method.The gross method uses an aggregate knowledge of the gas composition given by theheating value and/or relative density and diluent content.

**The 110 CPU 612 04 DOES support these gas flow blocks even though its an 8KPLC. This is because of its execution buffer design.


1.2.1 Implementation

The Gas Flow Loadable Function Block Disk (Part Number 309 ULD455 00) contains the following files:

Gas Flow Disk Files

File OpCode

Max. UserLogic SIze*

Number ofPasses

Function LoadedOnto

GD92.EXE 1f Hex 5.2K 1 singlepass

Uses AGA3 ’92 (FlangeTaps Only), AGA8 ’92(Detail Method)

PLC

GM92.EXE 1f Hex 8.7K 8 passes Uses AGA3 ’92 (FlangeTaps Only), AGA8 ’92(Detail Method), andAPI 21.1

PLC

G392.EXE 1f Hex 6.0K 8 passes Uses AGA3 ’92, andAPI 21.1

PLC

GFNX.EXE 1f Hex 6.9K 8 passes Uses AGA3 ’85, NX19,and API 21.1

PLC

GG92.EXE 1f Hex 7.7K 8 passes Uses AGA3 ’92 (FlangeTaps Only), AGA8 ’92(Gross Method), andAPI 21.1

PLC

LSUP.EXE ff Hex 1.7K LoadableSupportUtility

Used to run the gasflow loadable Gxxx.EXEfiles

PLC

DXFDT.SYS

\MS_25

N/A N/A Modsoft DXZoomsource files

Used to update Modsoft2.5 and lower versionfiles in order to accessthe Gas Flow Blocksusing the Zoom fea-tures

PC

Gxxx.ZMM

\MS_26

N/A N/A Modsoft DXZoomsource files

Used to update Modsoft2.6 or higher versionfiles in order to accessthe Gas Flow Blocksusing the Zoom fea-tures

PC

GET_LOGS.EXE N/A N/A DOS utility Used to retrieveAPI21.1 informationfrom the protectedmemory area of thePLC into your PC.

PC

SET_SIZE.EXE N/A N/A DOS utility Used to reconfigure theheap size of Gxxx.EXE.

PC

Gxxx20x8.HLP N/A N/A Modsofthelp sourcefiles

Used to update Modsoftfiles in order to accessthe help informationabout the Gas FlowBlocks

PC


MBP0.ADR N/A N/A DOS textfile

Used to setup ModbusPlus routing addressesfor PLCs when usingthe GET_LOGS.EXEutility.

PC

README.TXT N/A N/A Readme file Provides important userinformartion.

PC

*May vary based upon the PLC model and user configuration.

1.2.2 Restrictions

The Gas Flow loadables run for 48 hours when the hardware enabler isnever present in the backplane, and 60 seconds when the hardwareenabler is present and is then removed. The Gas Flow Enabler (130HEK 301 01/02) MUST be installed or the Gas Flow Loadable will notfunction continually.

The loadables do NOT operate on Modicon Micro models 110 CPU 512xx, 110 CPU 612 00, 110 CPU 612 03, and Compact models A984 120,A984 13X, or 0984 PLCs.

1.2.3 Compatible Software and Hardware

V Modsoft Version 2.4 or Version 2.5 (Part Number SW-MSxD-9SA).Refer to Section 1.3.1 for details.

V Modsoft Version 2.6 or higher (Part Number SW-MSxD-9SA). Re-fer to Section 1.3.2 for details.

V Concept Version 2.1 or higher (Part Number(s) 372 SPU 472 01V2x, 372 SPU 474 01 V2x, or 372 SPU 479 01 V2x). Refer to Sec-tion 1.4 for details.

V Gas Flow Loadable Function Blocks (Part Number 309 ULD 45500)

V Gas Flow Enabler (Part Number 130 HEK 301 01 for AGA Full or130 HEK 301 02 for AGA Lite).

V Compact PLC models: PC A984 141, and PC A984 145 (with load-able firmware executive). These Models do NOT support GM92,GG92 or GFNX Gas Flow Blocks.

V Compact PLC models: PC E984 241, PC E984 245, (with 1.02 firm-ware executive or higher). These Models do NOT support GM92,GG92 or GFNX Gas Flow Blocks.


V Compact PLC models: PC E984 251, and PC E984 255 (with 1.02

executive or higher).

V Compact PLC models: PC E984 258, PC E984 265, PC E984 275,and PC E984 285 (with 1.05 executive or higher). To use the load-able on these PLC models, you must use either Meter Manager

from Starling Associates, Inc., or use RDE of Concept 2.1 or higher.

V Micro PLC models: 110 CPU 612 04* (with 1.00 executive or high-er). *You must use Modsoft Version 2.5 or higher to operate withthe 110 CPU 612 04 PLC. Gas Flow loadables do NOT supportA120 I/O expansion backplane configurations with this PLC modeldirectly. You MUST use I/O in conjunction with a child Micro.

Note: The GM92, GG92 and GFNX blocks require a 16K total usermemory PLC model. Therefore, they do NOT support the followingmodels: PC A984 141, PC A984 145, PC E984 241, and PC E984 245.However, the 110 CPU 612 04 PLC DOES support these blocks eventhough its an 8K PLC because of its execution buffer design.

1.2.3.1 Optional Software

V Meter Manager (offered by Starling Associates, Inc.)

Meter Manager is used to define configuration variables used within theGas Flow Blocks already loaded into your PLC. Meter Manager usesModbus, as well as, Mofbus Plus communication protocol.

Meter Manager comes with default configuration parameters in US andMetric (SI) unit systems for easy setup.

Meter Manager is a 16 bit application that is fully compatible withsystems running either Windows 3.1, or Windows 95. Meter Managerrequires 8.5MB of disk space.

Meter Manager is part of the Modicon Modconnect Partners Program,and is available through Starling Associates, Inc. To order MeterManager, (offered by Starling Associates, Inc.) refer to Appendix C,Section C.6.


1.2.4 Reference Documents

V Modicon 984-A120 Compact Programmable Controllers User Guide(890 USE 108 00)

V Modicon 512/612 Micro PLC Hardware User Manual(890 USE 145 00)

V Modicon Micro Controllers Ladder Logic Manual(890 USE 146 00)

V Modicon Modsoft Programmer Software User Guide(890 USE 115 00)

V Modicon Concept User Manual (840 USE 461 00)

V Modicon Ladder Logic Block Library User Guide(840 USE 101 00)


1.3 Software Installation using Modsoft 2.5 orHigher

Before installing the Gas Flow Loadable you must copy two files fromthe Gas Flow Loadable Function Block Disk (309 ULD 455 00) asdescribed below.

1.3.1 DX Zoom Screens: Loading DXFDT.SYS

Caution: Only load DXFDT.SYS when using Modsoft 2.4 or 2.5for DX Zoom screens. This file is in the \MS_25 sub-directory.

Step 1 Copy the DXFDT.SYS file to the Modsoft/runtime directory. TheDXFDT.SYS file replaces the existing DXFDT.SYS file.

1.3.2 DX Zoom Screens: Loading Gxxx.ZMM

Only load Gxxx.ZMM when using Modsoft 2.6 or higher for DX zoomscreens. This file is in the \MS_26 sub-directory.

Step 1 Copy the Gxxx.ZMM files to the directory which the program files re-side. This file MUST be in the same directory as the program files forthe program using Gas Loadable, or the DX zoom screens will not beavailable.

1.3.3 Loading Gxxx20x8.HLP

Step 1 Copy the Gxxx20x8.HLP files to the Modsoft/programs directory.

1.3.4 Loadable Installation

This information assumes the use of Modsoft Panel software that youhave used to configure a controller and now are about to add a Gas FlowLoadable.

When the loadable is transferred to the panel, Modsoft convertsGxxx.EXE to a DX file named Gxxx20x8.EXE.

The next few figures are examples of the screens you see as you transferthe Gas Loadable from the disk to the 984 controller.


Step 1 Insert the Gas Flow Loadable Function Block Disk (Part Number 309ULD 455 00) into disk drive A:

Step 2 Go to the Offline (F2) selection on the Main Menu.

Step 3 Select either Select Program or New Program from the menu. Use thedefault path and communication parameters then hit return.

Step 4 From the Segment Status Display Screen select Configuration (F5)from the menu.

Step 5 From the Configuration Overview Screen, select Overview (F3) fromthe menu. Select PLC Type then model number and hit return. Also,select your Ranges.

Step 6 From the Overview (F3) menu, select Specials then move your cursordown to the Time of Day Clock area and type in a desired 4X registerrange that holds the time data used by the Gas Flow Blocks. Also, se-lect any other specials you desire.

Note: Remember, the DXFDT.SYS, Gxxx.ZMM, MBP0.ADRGxxx20x8.HLP, LSUP.EXE, GET_LOGS.EXE, SET_SIZE.EXE andGxxx.EXE files are present on the disk(s). The LSUP.EXE loadable isused to interface .EXE loadables with the PLC operating system.

1.3.4.1 Loading LSUP.EXE

Caution: The LSUP.EXE file MUST be loaded FIRST in theloadable list. If not, the Gas Flow Block function will notoperate properly. All three inputs and outputs turn on in thissituation. Therefore, if you already have LSUP.EXE loaded,you need not load it again. Refer to Figure 2.

Step 1 From the Configuration Overview Screen, select Loadable (F7) thenDir (F3) then Load (F1). A prompt appears asking for the filename.Type A:\ LSUP.EXE and then hit return.

Note: NSUP.EXE does NOT support the Gas Flow Blocks.


Figure 2 Loadable Screen (Sample Screen)

Step 2 System message appears telling you that you can now access this load-able. Hit Escape to remove the system message.

Step 3 Hit Shift ? or enter to display all available loadables. The LSUP.EXELoadable should now appears in this list.

Step 4 Place your cursor onto LSUP.EXE and press enter. This displays therevision, size, and opcode of the LSUP Loadable. Its Opcode is (ffHex). Ensure that this Opcode does not conflict with any other Op-codes that may be in use. If so, select a new Opcode from the availablelist. Hit Escape to return to configuration screen.

Step 5 Hit Escape twice to return the Configuration Overview Screen.

1.3.4.2 Loading Gxxx.EXE

Caution: The LSUP.EXE file MUST be loaded FIRST in theloadable list. If not, the Gas Flow Block function will notoperate properly. All three inputs and outputs turn on in thissituation. Therefore, if you already have LSUP.EXE loaded,you need not load it again.


Step 1 From the Configuration Overview Screen, select Loadable (F7) thenDir (F3) then Load (F1). A prompt appears asking for the filename.Type A:\ Gxxx.EXE and then hit return. Refer to Figure 3.


Step 2 System message appears telling you that you can now access this load-able. Move cursor below the name of the previous loadable to an openspot.

Step 3 Hit Shift ? or enter to display all available loadables. The Gxxx.EXELoadable should now appears in this list. Refer to Figure 4.


Figure 4 List of Available Loadables (Sample Screen)

Step 4 Place your cursor onto Gxxx.EXE and press enter. This displays the re-vision, size, and opcode of the Gas Flow Loadable. Ensure each load-able has its own individual opcode. Ensure that the Opcode does notconflict with any other Opcodes that may be in use. The Opcodeshown on the screen may vary. Refer to Figure 5. To change the Op-code go to the DX Loadable Configuration screen. Place your cursor onthe Name of the Gas Flow Block you want to change. Pick Edit (F4)then Opcode (F3). A list of Opcodes appears. Select the new Opcodeand hit return.


Figure 5 Installed Loadables (Sample Screen)

Step 5 Press Escape three times.

Step 6 The Segment Status Display appears. Select a segment, a network andpress enter.

Step 7 Select Elements (F3) from menu.

Step 8 Select Loadable (F5) from menu to access the Gas Flow Loadable.


Step 9 Pick your Gas Flow Loadable and hit return.

Your Gas Flow Block is now loaded. Continue to program your PLC asyou normally would. When loading your program with the specific GasFlow Block, make certain to set the hardware clock. Refer to theModicon Modsoft Programmer Software User Guide (890 USE 115 00) orthe Modicon Concept User Manual (840 USE 461 00) based on the panelsoftware you are using.

See: Each Gas Flow Block has a different set of DX Zoom screens.Therefore, refer to the applicable chapter for those screens and steps.


1.4 Software Installation using Concept 2.1 orHigher

Warning! Concept 2.1 or higher may be used to load the Gasblocks. However, Concept does NOT provide help or DX zoomscreens for configuration. When using Concept panel softwarewe recommend you use Meter Manager for your configurationneeds.

Warning! The Gas Flow Blocks can only be used in 984LL.

1.4.1 Loadable Installation

This information assumes the use of Concept Panel software that youhave used to configure a controller and now are about to add a Gas FlowLoadable.

When the loadable is transferred to the panel, Concept convertsGxxx.EXE to a DX file named Gxxx20x.EXE.

The next few figures are examples of the screens when you transfer theGas Loadable from the disk to the 984 controller. When you haveconcluded the transfer to the panel, the DX will be downloaded to thecontroller when you download the configuration.

Step 1 Insert the Gas Flow Loadable Function Block Disk (Part Number 309ULD 455 00) into disk drive A:

Step 2 Go to the File selection on the Main Menu.

Step 3 Select either Open... or New Project from the menu.

Step 4 From the main menu select Project then select Configurator.

Step 5 From the PLC Configuration Screen, double click the mouse on Type:.The PLC Selection Screen appears. Click on the down arrow just belowPLC Family. The families appear. Select TSX Compact under CPU/Executive. Select PC-E984-2xx, then click OK.

Step 6 From the Main Menu, select Configure then Specials... then Time ofDay Clock. Also, select any other specials you desire. Click OK.


Note: Remember, the DXFDT.SYS, Gxxx.ZMM, MBP0.ADR,Gxxx20x8.HLP, LSUP.EXE, GET_LOGS.EXE, SET_SIZE.EXE andGxxx.EXE files are present on the disk(s). However, when usingConcept you ONLY load LSUP.EXE, and Gxxx.EXE. The LSUP.EXEloadable is used to interface .EXE loadables with the PLC operatingsystem.

1.4.1.1 Loading LSUP.EXE

Step 1 From the Main Menu, select Configure, then Loadable then Unpackthen Drives:. Select the A: drive. LSUP.EXE appears under the FileName: area. Select it and click OK.

Caution: The LSUP.EXE file MUST be loaded FIRST in theloadable list. If not, the Gas Flow Block function will notoperate properly. All three inputs and outputs turn on in thissituation. Therefore, if you already have LSUP.EXE loaded,you need not load it again.

Note: NSUP.EXE does NOT support the Gas Flow Blocks.

Step 2 LSUP Vxxx appears in the Available area. Click on LSUP Vxxx thenclick on Install. LSUP Vxxx now appears in the Installed area. ClickOK. Its Opcode is (ff Hex). Ensure that this Opcode does not conflictwith any other Opcodes that may be in use. If so, select a new Opcodefrom the available list by clicking Edit. Refer to Figure 6.



1.4.1.2 Loading Gxxx.EXE

Step 1 From the Main Menu, select Configure, then Loadable then Unpackthen Drives:. Select the A: drive. Gxxx.EXE appears under the FileName: area. Select it and click OK.

Step 2 Gxxx Vxxx appears in the Available area. Click on Gxxx Vxxx thenclick on Install. Gxxx Vxxx now appears in the Installed area. ClickOK. Its Opcode is (1f Hex). Ensure that this Opcode does not conflictwith any other Opcodes that may be in use. If so, select a new Opcodefrom the available list by clicking Edit. Refer to Figure 7.


Step 3 From the Main Menu select File then New Section then 984LL thenunder Section Name type in your applicable name and then click OK.

Step 4 From the Main Menu select Objects then Instruction by Name thentype Gxxx into the dialog box that appears then click OK.

Note: Remember, Concept does NOT provide help or DX Zoomscreens for configuration.


1.5 Hardware Enabler Installation

Note: The Gas Flow Enabler (130 HEK 301 01 for AGA Full or 130HEK 301 02 for AGA Lite) MUST be installed before the Gas FlowLoadable Function Block (309 ULD 455 00) will continue to operateafter 48 hours. The Gas Flow Enabler may be installed on CompactPLCs, or Micro 110 CPU 612 04 PLC.

130 HEK 301 0x Specifications

5V Tolerance +/-- 5%

5V Current Con-sumption

5mA Maximum @ 20µF CapacitiveLoad

Inrush Current 250mA

Operating Tem-perature

0 ... 70°C

Storage Tempera-ture

--40 ... 85°C

Humidity 5 ... 95% RH (non--condensing)

Vibration 10 ... 57Hz @ 0.075 mmDA57 ... 150Hz @ 1g

Shock 30G peak, 11mS, half sine--wave

Agency Approvals(Currently Pend-ing)

UL 508; CSA 22.2 No.142, FMClass I, Div 2; and European Direc-tive on EMC 89/336/EEC Standards

Note: The Gas Flow Enabler should never be hot swapped.

1.5.1 For Compact PLCs

Locate the Gas Flow Enabler (1.64 in x1.18 in x .42 in PCB with 30 pins)(Part Number 130 HEK 301 0x) and place it into the PAB Bus ExtensionConnector on the Backplane (Part Number AS HDTA 20X) for CompactPLCs. When more than one backplane exists the Gas Flow Enable mustbe placed in the last backplane. The Gas Flow Enabler may only beinserted in one manner. Refer to Figure 8.

Note: All I/O slots may still be used with a Gas Flow Enablerinstalled in an AS HDTA 200, or AS HDTA 201 backplane.


Note: Do not use the Gas Flow Enabler on a two slot backplane (PartNumber AS HDTA 202).

30 Pin A120I/O ExpansionReceptacle

Gas Flow Enabler(130 HEK 301 01/02)

Figure 8 130 HEK 301 01/02 Gas Flow Enabler Placement

Caution: Both the AS WBXT 201 and AS WBXT 202 cables arenot supported. You MUST use the AS WBXT 203 cable for A120I/O expansion.

(Rack 1)

(Rack 3)(Rack 2)

DTA 200

DTA 201

BXT 203

DTA 201

Figure 9 A Stacked Configuration Example with a Compact PLC and the BXT 203Cable

Note: A maximum of three racks (one primary and two secondary)may be used with the AS WBXT 203 cable.


1.5.2 For Micro 110 CPU 612 04 PLC

When using a 110 CPU 612 04 without additional A120 backplanes,insert the Gas Flow Enabler (1.64 in x1.18 in x .42 in PCB with 30pins)(Part Number 130 HEK 301 0x) into the 30 pin A120 expansionreceptacle on the side of the PLC. The Gas Flow Enabler is inserted inonly one manner. Refer to Figure 10.

Caution: Gas Flow Loadables do NOT support A120 I/Oexpansion backplane configurations with the 110 CPU 612 04PLC model directly. You MUST use I/O in conjunction with achild Micro.

30 pin A120 expansionreceptacle

Gas Flow Enabler(130 HEK 301 0x)

comm 1 (RJ45) port

comm 2 (RJ45) port

I/O exp link (RJ11) port

Figure 10 130 HEK 301 01/02 Gas Flow Enabler Placement

MICRO 612--04PARENT

CHILD

MICRO 612--03

AS-HDTA-201

A120I/O MODULES

Figure 11 A120 I/O Configuration with a 110 CPU 612 04 and a Micro Child


1.6 Customer Service

Schneider Electric telephone numbers are as follows:

V To call us from anywhere in North America except from within thestate of Massachusetts: 1 (800) 468 5342

V To call us from within Massachusetts or from outside North Ameri-ca: 1 (978) 975 5001

V To fax us: 1 (978) 975 9301

Customer Service When calling the Schneider Electric telephonenumber, ask for service from the list below.

When calling the 800 number, you will get a recording asking you toenter a one digit code for the type of service you want (listed below).However, this only works with a ”touch tone” phone. If using a dialphone, hang on and the operator will intercept after a short pause.

The service categories and extra digit code responses for push-buttonphones are:

1 Technical support2 Service order administration3 Modfax4 Training/course registration inquiries5 General information other than above.

Note: MODFAX: For available hardware data sheets, applicationnotes, and software information. Recommended catalogue MC-FAX-DIR which is the master of all available catalogues (only twelve pages)lists all catalogues available on the MODFAX system.

Note: BBS (Schneider Electric’s Customer Service Bulletin Board):For Modsoft updates, conversion utilities, hardware and software help,field service bulletins, Modbus and Modbus Plus help, software revisionlevels, FLASH EXEC updates for Modicon equipment, and more. Pa-rameters are up to 14.4k baud, no parity, 8 data, 1 stop, phone 1 (978)975 9779.

Note: Schneider Electric web page (www.modicon.com) provides userdocumentation, file updates, access to MODFAX, and other onlineservices.

GD92 AGA#3&8 1992 Detail Method Gas Flow Function Block890 USE 137 00 23

Chapter 2GD92 AGA#3&8 1992 DetailMethod Gas Flow FunctionBlock

Note: GD92 does NOT support the API21.1 audit trail feature.

V Gas Flow Function Block

V DX Zoom Screens

V Gas Flow Configuration Table

V Possible Configuration Example for the Gas Flow Block

GD92 AGA#3&8 1992 Detail Method Gas Flow Function Block 890 USE 137 0024

2.1 Gas Flow Function Block

2.1.1 Characteristics

2.1.1.1 Size

Three nodes high

2.1.1.2 PLC Compatibility

V Compact PLCs: PC A984 141, and PC A984 145 (with no loadableexecutive firmware).

V Compact PLCs: PC E984 241, PC E984 245, PC E984 251, and PCE984 255 (with 1.02 executive firmware or higher).

V Compact PLCs: PC E984 258, PC E984 265, PC E984 275, and PCE984 285 (with 1.05 executive firmware or higher). To use theloadable on these PLC models, you must use either Meter Managerfrom Starling Associates, Inc., or use the RDE of Concept 2.1 orhigher.

V Micro PLCs: 110 CPU 612 04 (with 1.00 executive firmware orhigher). Gas Flow loadables do NOT support A120 I/O expansionbackplane configurations with this PLC model directly. You MUSTuse I/O in conjunction with a child Micro.

2.1.1.3 Opcode

1f hex for GD92.EXE file.

2.1.2 Representation

2.1.2.1 Block Structure

Start operation Operation is active#0001

4xxxx

GD92System or ProgramError#0003

User defined Error

System or ProgramWarning

User defined Warning


InputsGD92 Gas Flow Block has three control inputs. The input to the topnode starts the calculation of the gas flow and should remain ON tocontinue solving. The calculations are based on your parametersentered into the input registers. The input to the middle node allowsyou to set a warning. The input to the bottom node allows you to set anerror and STOP the flow function. These two inputs permit you tocapture any user defined warnings/errors as needed in your applications.

Warning! NEVER detach the top input while the block isrunning. You will generate an error 188 and the data in thisblock could be corrupted.

OutputsGD92 may produce three possible outputs. The outputs from the topnode goes ON while a GD92 operation is in progress. The output fromthe middle node goes ON when GD92 has detected a system or programwarning. The output from the bottom node goes ON when GD92 hasdetected a system or program error. Refer to Section 2.3.2.1 for systemwarning/error codes (4x+0), and to Section 2.3.2.2 for programwarning/error codes (4x+1).

Top Node ContentThe top node must contain a constant (#0001).

Middle Node ContentThe 4x register entered in the middle node is the first in a group ofcontiguous holding registers that comprise the configuration parametersand values associated with the Gas Flow Block. Refer to Section 2.1.3.1.

Warning! Do not attempt to change the middle node 4xregister while the Gas Flow Block is running. You will loseyour data and generate an error 302. If you need to changethe 4x register, first STOP the PLC.

Bottom Node ContentThe bottom node specifies the calculation type and must contain aconstant (#0003).


2.1.3 GD92 Configuration Table

You MUST fill in all pertinent values in the configuration table usingeither the reference data editor in Modsoft or Concept, or the DX Zoomscreens in Modsoft, or Meter Manager (offered by Starling Associates)refer to Appendix C. The following input table lists all of theconfiguration parameters that MUST be filled in. The outputs andoptional outputs show the calculation results of the block. Some of thesevariables use multiple registers to hold the specific configurationparameters required. Refer to Section 2.1.3.1, Section 2.1.3.2, andSection 2.1.3.3 below.

Warning! Only valid entries are allowed; entries outside thevalid ranges are not accepted by either Modsoft, Concept orMeter Manager. Illegal entries result in errors or warnings.

To run the DX Zoom configuration refer to Section 2.2. When usingMeter Manager refer to its user manual provided by Starling Associates,Inc.


2.1.3.1 Inputs

GD92 Gas Flow Configuration Table Description

Inputs Description

4x+3: 1 ... 2 Location of Taps: 1=Upstream, 2=Downstream

4x+3: 3 ... 4 Meter Tube Material: 1=Stainless Steel, 2=Monel, 3=Carbon Steel

4x+3: 5 ... 6 Orifice Material: 1=Stainless Steel, 2=Monel, 3=Carbon Steel

4x+3: 7 ... 8 Reserved for Future Use (Do not use)

4x+3: 9 ... 10 Optional Outputs: 1=Yes, 2=No *When using only the standard outputs (see Sec-tion 2.1.3.2) the loadable uses 157 4x registers. When using the optional outputs(see Section 2.1.3.3) the loadable uses 181 4x registers.


4x+4: 1 Absolute/Gauge Pressure: 0=Static Pressure Measured in Absolute Units, 1=StaticPressure Measured in Gauge Units

4x+4: 2 Low Flow Cut Off: 0=Do Not Use Flow Cut Off, 1=Use Flow Cut Off

4x+4: 3 ... 6 Load Command 0=Ready to Accept Command, 1=CMD: Send Configuration toInternal Table from 4X, 2=CMD: Read Configuration from Internal Table to 4X,(Commands 3 ... 15 Reserved)


4x+4: 7 ... 8 Input Type: 1=3X Pointer, 2=Input Value

4x+4: 9 ... 10 Mole % Error Limits: 1=Enable, 2=Disable

4x+4: 11 ... 12 Dual Range Differential Pressure Option: 1=Yes, 2=No

4x+4: 13 ... 14 Compressible/Incompressible: 1=Compressible, 2=Incompressible

4x+4: 15 ... 16 Averaging Methods: 0=Flow Dependent Time Weighted Linear, 1=Flow DependentTime Weighted Formulaic, 2=Flow Weighted Linear, 3=Flow Weighted Formulaic

4x+5: 1 ... 2 Measurement Units: 1=US, 2=Metric (SI)


4x+6 Temperature 3X Pointer or Input Value

4x+7 Pressure (absolute) 3X Pointer or Input Value

4x+8 Differential Pressure 1 3X Pointer or Input Value


4x+10 Analog Input Raw Value Minimum Temperature

4x+11 Analog Input Raw Value Maximum Temperature

4x+12 Analog Input Raw Value Minimum Pressure

4x+13 Analog Input Raw Value Maximum Pressure

4x+14 Analog Input Raw Value Minimum Differential Pressure 1

4x+15 Analog Input Raw Value Maximum Differential Pressure 1



4x+18 ... 19 Engineering Unit Temperature Minimum --200 ... 760°F (--128.89 ... 404.4°C)

4x+20 ... 21 Engineering Unit Temperature Maximum --200 ... 760°F (--128.89 ... 404.4°C)

4x+22 ... 23 Engineering Unit Pressure Minimum 0 ... 40,000psia (0 ... 275,790.28kPa)

4x+24 ... 25 Engineering Unit Pressure Maximum 0 ... 40,000psia (0 ... 275,790.28kPa)

4x+26 ... 27 Engineering Unit Differential Pressure 1 Minimum >=0 (inches H2O or kPa)

4x+28 ... 29 Engineering Unit Differential Pressure 1 Maximum >0 (inches H2O or kPa)



4x+34 ... 35 Orifice Plate Diameter, dr (0<dr<100in) (0<dr<2540mm)

4x+36 ... 37 Orifice Plate Diameter Measurement Temperature, Tr (32<=Tr<77°F) (0<=Tr<25°C)

4x+38 ... 39 Meter Tube Internal Diameter, Dr (0<Dr<100in) (0<Dr<2540mm)

4x+40 ... 41 Meter Tube Diameter Measurement Temperature, Tr (32<=Tr<77°F) (0<=Tr<25°C)

4x+42 ... 43 Base Temperature, Tb (32.0<=Tb<77.0°F) (0<=Tb<25°C)

4x+44 ... 45 Base Pressure, Pb (13.0<=Pb<16.0PSIA) (89.63<=Pb<110.32kPa)

4x+46 ... 47 Reference Temperature for Relative Density, Tgr (32.0<=Tgr<77.0°F)(0<=Tgr<25°C)

4x+48 ... 49 Reference Pressure for Relative Density, Pgr (13.0<=Pgr<16.0PSIA)(89.63<=Pgr<110.32kPa)

4x+50 ... 57 Reserved for Future Use


4x+58 ... 59 User Input Correction Factor, Fu (0<Fu<2.0)

4x+60 ... 61 Absolute Viscosity of Flowing Fluid, cP (0.005<=cP<=0.5)

4x+62 ... 63 Isentropic Exponent, k (1.0<=k<2.0)

4x+64 Beginning of Day Hour, (0 ... 23)

4x+65 ... 78 Reserved for Future Use

4x+79 ... 80 Atmospheric Pressure, Pat (3<=Pat<30psi) (20.684<=Pat<206.843kPa)

4x+81 ... 82 Low Flow Cut Off Level (>=0ft3/Hr) (>=0m3/Hr)

4x+83 ... 84 Mole % of Methane, xi (0.0<=xi<=100)

4x+85 ... 86 Mole % of Nitrogen, xi (0.0<=xi<=100)

4x+87 ... 88 Mole % of Carbon Dioxide, xi (0.0<=xi<=100)

4x+89 ... 90 Mole % of Ethane, xi (0.0<=xi<=100)

4x+91 ... 92 Mole % of Propane, xi (0.0<=xi<=12)

4x+93 ... 94 Mole % of Water, xi (0.0<=xi<=10)

4x+95 ... 96 Mole % of Hydrogen Sulfide, xi (0.0<=xi<=100)

4x+97 ... 98 Mole % of Hydrogen, xi (0.0<=xi<=100)

4x+99 ... 100 Mole % of Carbon Monoxide, xi (0.0<=xi<=3)

4x+101 ... 102 Mole % of Oxygen, xi (0.0<=xi<=21)

4x+103 ... 104 Mole % of I--Butane, xi Valid Entry for Com-bined Butanes is(0.0<=xi<=6)

4x+105 ... 106 Mole % of n--Butane, xi Valid Entry for Com-bined Butanes is(0.0<=xi<=6)

4x+107 ... 108 Mole % of I--Pentane, xi Valid Entry for Com-bined Pentanes is(0.0<=xi<=4)

4x+109 ... 110 Mole % of n--Pentane, xi Valid Entry for Com-bined Pentanes is(0.0<=xi<=4)

4x+111 ... 112 Mole % of Hexane, xi Valid Entry for Com-bined Hexanes + is(0.0<=xi<=10)

4x+113 ... 114 Mole % of Heptane, xi Valid Entry for Com-bined Hexanes + is(0.0<=xi<=10)

4x+115 ... 116 Mole % of Octane, xi Valid Entry for Com-bined Hexanes + is(0.0<=xi<=10)

4x+117 ... 118 Mole % of Nonane, xi Valid Entry for Com-bined Hexanes + is(0.0<=xi<=10)

4x+119 ... 120 Mole % of Decane, xi Valid Entry for Com-bined Hexanes + is(0.0<=xi<=10)


4x+121 ... 122 Mole % of Helium, xi (0.0<=xi<=30)

4x+123 ... 124 Mole % of Argon, xi (0.0<=xi<=100)

2.1.3.2 Outputs


Outputs Description

4x+0 System Warning/Error Code (Displayed in Hex mode)

4x+1 Program Warning/Error Code

4x+2 Version Number (Displayed in Hex mode)

4x+125 ... 126 Temperature at Flowing Conditions, Tf

4x+127 ... 128 Pressure, Pf

4x+129 ... 130 Differential Pressure, hw

4x+131 ... 132 Integral Value, IV

4x+133 ... 134 Integral Multiplier Value, IMV

4x+135 ... 136 Volume Flow Rate at Base Conditions, (Tb,Pb), Qb

4x+137 ... 138 Mass Flow Rate, Qm

4x+139 ... 140 Accumulated Volume Current Day

4x+141 ... 142 Accumulated Volume Last Hour

4x+143 ... 144 Accumulated Volume Last Day

4x+145 ... 146 Average Temperature Last Day

4x+147 ... 148 Average Pressure Last Day

4x+149 ... 150 Average Differential Pressure Last Day

4x+151 ... 152 Average IV Last Day

4x+153 ... 154 Average Volume Flow Rate at Base Conditions (Tb,Pb) for the Last Day

4x+155: 13 4X Table Differs from Actual Configuration

4x+155: 14 Flow Rate Solve Complete Heartbeat

4x+155: 15 Block is Functioning Heartbeat

4x+155: 16 End of Day Flag (NOTE: This status bit does not appear in the DX Zoom screen but may be used in pro-gram logic).

2.1.3.3 Optional Outputs


OptionalOutputs

Description

4x+156 ... 157 Compressibility at Flowing Conditions (Tf,Pf), Zf

4x+158 ... 159 Compressibility at Base Conditions (Tb,Pb), Zb

4x+160 ... 161 Compressibility at Standard Conditions (Ts,Ps), Zs


4x+162 ... 163 Density at Fluid Flowing Conditions, Pt,p

4x+164 ... 165 Density of Fluid at Base Conditions, ρ

4x+166 ... 167 Supercompressibility, Fpv

4x+168 ... 169 Gas Relative Density, Gr

4x+170 ... 171 Orifice Plate Coefficient of Discharge, Cd

4x+172 ... 173 Expansion Factor, Y

4x+174 ... 175 Velocity of Approach Factor, Ev

4x+176 ... 177 Volume Flow Rate at Flowing Conditions, (Tf, Pf ),Qf

4x+178 ... 179 Reserved for Future Use (Do Not Use)

4x+180 Orifice Plate Coefficient of Discharge Bounds Flag within Iteration Scheme, Cd--f


2.2 DX Zoom Screens (Modsoft Only)

Assuming you have already loaded Gxxx.EXE files into Modsoft.

Step 1 Choose the GD92 Loadable now.

Step 2 Place your cursor on the top node of the Gas block, type #0001 andpress enter.

Step 3 Place your cursor on the middle node of the Gas block, enter your 4xregister and press enter.

Step 4 Place your cursor on the bottom node of the Gas block, type #0003 andpress enter.

Step 5 Place your cursor on the Gas Flow Block and hit ALTZ to pull-up theGas Flow zoom screens. At this point you may set your parametersbased on your application and the details of the Gas Flow Block foundin Gas Flow Configuration Table, Section 2.3.

Step 6 Enter the required information into the following 12 DX Zoom screens.

Note: You may wish to refer to Section 2.4 for possible configurationexamples for the GD92 Block.

Note: To access the help screen for the GD92 Block place your cursoron the GD92 Block and hit ALTH.


Utility Hex Dec Bin Goto QuitF1-----GD92_2-----F3-------F4-- DX Zoom Editor -------F7-Lev 8-F8-OFF---F9-----+

GD92:AGA8 1992, Detail Method and AGA3 1992 Page 1 / 12

4X+2 Version Number (Read Only) 40203 UINT = 2A02 HEX

4X+0 System Warning/Error Code (Read Only) 40201 UINT = 0000 HEX4X+1 Program Warning/Error Code (Read Only) 40202 UINT = 0 DEC4X+64 Beginning of Day Hour (0 - 23) 40265 INT = 7 DEC

4X+4:3-6 Load Command 40205 03:06 = 0 DEC0 - Ready to Accept Command.1 - CMD: Send Configuration to Internal Table from 4X.2 - CMD: Read Configuration From Internal Table to 4X.

4X+4:9-10 Mole % Limits 1-Enable 2-Disable 40205 09:10 = 2 DEC

4X+4:11-12 Dual Range Differential Pressure 40205 11:12 = 2 DEC(1 - Yes 2 - No)

4X+3:9-10 Optional Outputs (1-Yes 2-No) 40204 09:10 = 1 DEC

Page up/down for next screen

Figure 12 GD92 Zoom Screen 1 of 12



4X+4:15-16 Averaging Method 40205 15:16 = 0 DEC0-Flow Dependent Time Weighted Linear1-Flow Dependent Time Weighted Formulaic2-Flow Weighted Linear3-Flow Weighted Formulaic

4X+4:2 Low Flow Cutoff(0: Disable 1: Enable) 40205 02:02 = 0 DEC

4X+4:1 Pressure Measurement Type 40205 01:01 = 0 DEC(0: Absolute 1: Gauge)






Input Registers

4X+4:7-8 Input Type 1-3X 2-Input Value 40205 07:08 = 2 DEC

4X+6 Temperature 3X Ptr or Input Value 40207 INT = 1333 DEC4X+7 Pressure 3X Ptr or Input Value 40208 INT = 2000 DEC4X+8 Diff. Pressure 1 3X Ptr or Input Value 40209 INT = 1483 DEC4X+9 Diff. Pressure 2 3X Ptr or Input Value 40210 INT = 0 DEC

Analog Input Raw Value Limits

4X+10 Minimum Temperature 40211 INT = 0 DEC4X+11 Maximum Temperature 40212 INT = 4000 DEC4X+12 Minimum Pressure 40213 INT = 0 DEC4X+13 Maximum Pressure 40214 INT = 4000 DEC4X+14 Minimum Differential Pressure 1 40215 INT = 0 DEC4X+15 Maximum Differential Pressure 1 40216 INT = 4000 DEC4X+16 Minimum Differential Pressure 2 40217 INT = 0 DEC4X+17 Maximum Differential Pressure 2 40218 INT = 0 DEC





4X+5:1-2 Measurement Units 1-US 2-Metric(SI) 40206 01:02 = 1 DEC

Engineering Unit Limits4X+18-19 Temperature Minimum (-200 to 760 F/ 40219 FLT32 = 0.

-128.89 to 404.44 C)4X+20-21 Temperature Maximum (-200 to 760 F/ 40221 FLT32 = 150.

-128.89 to 404.44 C)4X+22-23 Pressure Min. (0 to 40,000 psia 40223 FLT32 = 0.

/0 to < 275,790.28 kPa)4X+24-25 Pressure Max. ( > 0 to 40,000 psia 40225 FLT32 = 2000.

/ > 0 to 275,790.28 kPa)4X+26-27 Differential Pressure 1 Minimum 40227 FLT32 = 0.

( >=0 in.H2O/kPa)4X+28-29 Differential Pressure 1 Maximum 40229 FLT32 = 50.

( > 0 in.H2O/kPa)4X+30-31 Differential Pressure 2 Minimum 40231 FLT32 = 0.


( > 0 in.H2O/kPa)Page up/down for next screen





4X+34-35 Orifice Plate Bore Diameter, dr 40235 FLT32 = 5.0038(0<dr<100inches / 0<dr<2540mm)

4X+36-37 Measured Orifice Plate Bore Diameter 40237 FLT32 = 60.Temperature, Tr (32<=Tr<77F / 0<=Tr<25C)

4x+3:5-6 Orifice Material 40204 05:06 = 1 DEC(1-Stainless Steel 2-Monel 3-Carbon Steel)

4X+38-39 Meter Tube Internal Diameter, Dr 40239 FLT32 = 10.026(0<Dr<100inches / 0<Dr<2540mm)

4X+40-41 Measured Meter Tube Internal Diameter 40241 FLT32 = 60.Temperature, Tr(32<=Tr<77F / 0<=Tr<25C)

4x+3:3-4 Meter Tube Material 40204 03:04 = 3 DEC(1-Stainless Steel 2-Monel 3-Carbon Steel)

4X+3:1-2 Location of Taps 40204 01:02 = 2 DEC(1 - Upstream, 2 - Downstream)





4X+79-80 Atmospheric Pressure, Pat 40280 FLT32 = 0.(3<=Pat<30psia / 20.68<=Pat<206.8kPa)

4X+81-82 Low Flow Cutoff 40282 FLT32 = 10.(>=0 ft^3/Hr / >=0 m^3/Hr)

Gas Composition AnalysisSUM OF ALL MOLE PERCENTS SHOULD EQUAL 100. ALL RANGES SHOWN ARE ERRORLIMITS. FOR WARNING LIMITS, REFER TO USER DOCUMENTATION.

4X+83-84 Mole % of Methane (0<=xi<=100) 40284 FLT32 = 100.4X+85-86 Mole % of Nitrogen (0<=xi<=100) 40286 FLT32 = 0.4X+87-88 Mole % of CO2 (0<=xi<=100) 40288 FLT32 = 0.4X+89-90 Mole % of Ethane (0<=xi<=100) 40290 FLT32 = 0.4X+91-92 Mole % of Propane (0<=xi<=12) 40292 FLT32 = 0.4X+93-94 Mole % of Water (0<=xi<=10) 40294 FLT32 = 0.4X+95-96 Mole % of H2S (0<=xi<=100) 40296 FLT32 = 0.4X+97-98 Mole % of Hydrogen (0<=xi<=100) 40298 FLT32 = 0.4X+99-100 Mole % of Carbon Monoxide(0<=xi<=3) 40300 FLT32 = 0.4X+101-102 Mole % of Oxygen (0<=xi<=21) 40302 FLT32 = 0.





GD92:AGA8 1992, Detail Method and AGA3 1992 Page 7 / 12Gas Composition Analysis (continued)

4X+103-104 Mole % of I-Butane 40304 FLT32 = 0.4X+105-106 Mole % of n-Butane 40306 FLT32 = 0.Valid Range for Combined Butanes is 0<=xi<=6

4X+107-108 Mole % of I-Pentane 40308 FLT32 = 0.4X+109-110 Mole % of n-Pentane 40310 FLT32 = 0.Valid Range for Combined Pentanes is 0<=xi<=4

4X+111-112 Mole % of Hexane 40312 FLT32 = 0.4X+113-114 Mole % of Heptane 40314 FLT32 = 0.4X+115-116 Mole % of Octane 40316 FLT32 = 0.4X+117-118 Mole % of Nonane 40318 FLT32 = 0.4X+119-120 Mole % of Decane 40320 FLT32 = 0.Valid Range for Hexane+ is 0<=xi<=10

4X+121-122 Mole % of Helium (0<=xi<=3) 40322 FLT32 = 0.4X+123-124 Mole % of Argon (0<=xi<=100) 40324 FLT32 = 0.





Reference Conditions4X+42-43 Base Temperature, Tb 40243 FLT32 = 60.

(32<=Tb<77 F / 0<=Tb<25 C)4X+44-45 Base Pressure, Pb 40245 FLT32 = 14.73

(13<=Pb<16 psia / 89.63<=Pb<110.32 kPa)4X+46-47 Reference Temperature for Relative 40247 FLT32 = 60.

Density, Tgr(32<=Tgr<77 F / 0<=Tgr<25 C)4X+48-49 Ref. Press. for Relative Density 40249 FLT32 = 14.73

Pgr(13<=Pgr<16 psia / 89.63<=Pgr<110.32 kPa)Other

4X+4:13-14 Compressible/Incompressible Fluid 40205 13:14 = 1 DEC1 - Compressible 2 - Incompressible

4X+62-63 Isentropic Exponent 40263 FLT32 = 1.2817(k)(1.0<=k<2.0)

4X+60-61 Absolute Viscosity of Flowing 40261 FLT32 = 2.E-02Fluid (cP)(0.005<=cP<=0.5)

4X+58-59 User Input Correction Factor, Fu 40259 FLT32 = 1.(0.0<Fu<2.0)






OUTPUTS

4X+155:15 Block is Functioning Heartbeat 40356 15:15 = 1 DEC4X+155:14 Flow Rate Solve Complete Heartbeat 40356 14:14 = 0 DEC4X+155:13 4X Table Differs from Actual Config. 40356 13:13 = 0 DEC

(0:False 1:True)

Live Quantities

4X+125-126 Temp. @ Flowing Conds.,Tf(F/C) 40326 FLT32 = 49.98754X+127-128 Pressure,Pf(psia/kPa) 40328 FLT32 = 1000.4X+129-130 Differential Press.,hw(in H2O/kPa) 40330 FLT32 = 18.53754X+131-132 Integral Value,IV 40332 FLT32 = 136.1984X+133-134 Integral Multiplier Value,IMV 40334 FLT32 = 7684.964X+135-136 Vol. Flow Rate at Base Conditions 40336 FLT32 = 1046677.

(Tb,Pb),Qb (ft^3/hr or m^3/hr)4X+137-138 Mass Flow Rate,Qm (lbm/hr or kg/hr) 40338 FLT32 = 44438.77





OUTPUTS..Continuation

Accumulated Quantities

4X+139-140 Accum. Vol. Current Day(ft^3/m^3) 40340 FLT32 = 149532.34X+141-142 Accum. Vol. Last Hour(ft^3/m^3) 40342 FLT32 = 0.4X+143-144 Accum. Vol. Last Day (ft^3/m^3) 40344 FLT32 = 0.

Average Quantities4X+145-146 Average Temperature Last Day(F/C) 40346 FLT32 = 0.4X+147-148 Average Pressure Last Day(psia/kPa) 40348 FLT32 = 0.4X+149-150 Average Diff. Pressure Last Day 40350 FLT32 = 4.563684E-38

(in H2O/kPa)4X+151-152 Average IV Last Day 40352 FLT32 = 0.4X+153-154 Average Volume Flow Rate Last Day 40354 FLT32 = 0.






Optional Outputs

4X+156-157 Compressibility at Flowing 40357 FLT32 = 0.8634509Conditions (Tf , Pf ), Zf

4X+158-159 Compressibility at Base 40359 FLT32 = 0.9980333Conditions (Tb , Pb ), Zb

4X+160-161 Compressibility at Standard 40361 FLT32 = 0.9980333Conditions (Ts , Ps ), Zs

4X+162-163 Density at Fluid Flowing 40363 FLT32 = 3.399334Conditions(lbm/ft^3 or kg/m^3)

4X+164-165 Density of Fluid at Base 40365 FLT32 = 4.245703E-02Conditions(lbm/ft^3 or kg/m^3)

4X+166-167 Supercompressibility (Fpvs) 40367 FLT32 = 1.0751124X+168-169 Gas Relative Density, Gr 40369 FLT32 = 0.55478294X+170-171 Orifice Plate Coefficient 40371 FLT32 = 0.6032944

of Discharge(Cd)4X+172-173 Expansion Factor, Y 40373 FLT32 = 0.9997748





Optional Outputs..Continuation

4X+174-175 Velocity of Approach Factor (Ev) 40375 FLT32 = 1.032539

4X+180 Orifice Plate Coefficient of 40381 UINT = 2 DECDischarge Bounds Flag Within Iteration Scheme, Cd_f

4X+176-177 Vol.Flow Rate at Flowing Conditions 40377 FLT32 = 8.380246E+07(Tf,Pf),Qf (ft^3/hr or m^3/hr)

End of GD92 Zoom Screens


Tip: We recommend you review your data entered in the 12 DX Zoomscreens.


2.3 Gas Flow Configuration Table

The following is a detailed description of configuration variables for theGD92 gas flow function block: input, output and optional outputvariables. When applicable, the reference publication, page number, andformula number are provided noting where this variable may be found.AGA#3 refers to AGA Report No.3, Part 3, 1992 (aka GPA 8185, Part 3;ANSI/API 2530 1991). AGA#8 refers to AGA Report No. 8, 1992 (akaAPI 14.2). API#21 refers to API 21.1, 1993. AGA stands for theAmerican Gas Association.

2.3.1 Gas Flow Configuration Input Table

The following is a detailed description of each of the input variables tothe GD92 gas flow function block.

2.3.1.1 Location of Taps (4x +3 bits 1 ... 2)

The location of the Taps may be either upstream or downstream. Twobits are assigned for the input of this variable. Set the variable to 1 forupstream or 2 for downstream.

Reference None

2.3.1.2 Meter Tube Material (4x +3 bits 3 ... 4)

Construction material of the Meter Tube. The orifice material may beset to either stainless steel, carbon steel or monel. Two bits are assignedfor the input of this variable. Enter 1 for stainless steel, 2 for monel, or3 for carbon steel.

Reference: AGA#3, pp8, formula#3-10

2.3.1.3 Orifice Material (4x +3 bits 5 ... 6)

Construction material of the Orifice Plate. The orifice material may beset to either stainless steel, carbon steel or monel. Two bits are assignedfor the input of this variable. Enter 1 for stainless steel, 2 for monel, or3 for carbon steel.


2.3.1.4 Reserved for Future Use (4x +3 bits 7 ... 8)

These bits are reserved for future use, and therefore may not be used.

Reference: None


2.3.1.5 Optional Outputs (4x +3 bits 9 ... 10)

You may select optional outputs that may be desirable, yet not requiredin all cases. Simply enter 1 to turn optional outputs on or 2 to turnoptional outputs off. Two bits are assigned to specify this selection.When set to 2 (turned off) the output registers for the optional outputsare not used by GD92. When using only the standard outputs (SeeSection 2.1.3.2) the loadable uses 157 4x registers. When using theoptional outputs (See Section 2.1.3.3) the loadable uses 181 4x registers.

Reference: None



Reference: None

2.3.1.7 Absolute/Gauge Pressure Switch (4x +4 bit 1)

You may select from two pressure transducers. Simply enter 0 for Staticpressure measured in absolute units, or enter 1 for static pressuremeasured in gauge units.

Reference: None

2.3.1.8 Low Flow Cut Off (4x +4 bit 2)

You may select to use low flow cut off or not. Simply enter 0 NOT to uselow flow cut off, or enter 1 to use low flow cut off.

Reference: API21.1, Section 1.2.2.2

2.3.1.9 Load Commands (4x +4 bits 3 ... 6)

These bits are used to load input table configuration informationcontained in the 4x registers to the loadable and vice versa. Simplyenter 0 for ready, or enter 1 for send to PLC, or enter 2 for load fromPLC. Commands 3 ... 15 are reserved. These bits reset to zero when theoperation is completed by the loadable.

Reference: None


2.3.1.10 Input Type (4x +4 bits 7 ... 8)

You may specify either 3X as pointers or input value for the live inputs(temperature, static pressure and differential pressure). Two bits areassigned to input this variable. Set the variable to 1 for 3X addressesand use (4X +6 ... 9) as pointers to the proper 3X addresses, or set to 2for input value and use (4X +6 ... 9) to hold the raw value of theseinputs.

Reference: None

2.3.1.11 Mole Percent Error Limits (4x +4 bits 9 ... 10)

You may select to enable or disable error checking for mole percentlimits. If this option is selected as disabled, no errors or warnings forindividual mole percent will be generated. The sum of mole percentsmust always be >99.99 and <100.01. Two bits are assigned to input ofthis variable. Set the variable to 1 when error detection is desirable, orset to 2 when you need the values that are outside the AGA#8.

Reference: None

2.3.1.12 Dual Range Differential Pressure Option (4x +4 bits 11 ... 12)

To cover a wider range of pressure differential, GD92 allows the use oftwo staggered range differential pressure measurement devices. Youmay specify either single or dual differential pressures scales. Two bitsare assigned for the input of this variable. Set the variable to 1 for twodifferential pressure scales, or set to 2 for single differential range.

Reference: None

2.3.1.13 Compressible/Incompressible (4x +4 bits 13 ... 14)

The natural gas you are measuring must be specified as beingcompressible or incompressible. Two bits are assigned for the input ofthis variable. Set the variable to 1 for compressible, or 2 forincompressible. When a gas is assumed to be incompressible, theexpansion factor is Y=1. Therefore, we recommend setting it to 2 forbest results.

Reference: None


2.3.1.14 Averaging Methods (4x +4 bits 15 ... 16)

You may select one of four different averaging methods suggested by(API21.1). Two bits are assigned for the input of this variable. Set thevariable to 0 for flow dependent time weighted linear averagingtechnique, 1 for flow dependent time weighted formulaic averagingtechnique, 2 for flow weighted linear averaging technique, or 3 for flowweighted formulaic averaging technique.

Reference: API#21, pp31, formula#2-31

2.3.1.15 Measurement Units (4x +5 bits 1 ... 2)

You may select from two types of measurement units. Two bits areassigned for the input of this variable. Set the variable to 1 for US, or 2for Metric (SI). The table below defines the units.

Reference: None

Measurement Units Defined (4X +5 bits 1 .. 2)

Type of Measure-ment

US Metric (SI)

Temperature °F °C

Static pressure psia kPa

Differential pressure Inches ofH2O

kPa

Length Inches mm

Volume SCFD Sm3/D

Mass Lbm/hr kg/D

Density Lbm/ft3 kg/m3

Viscosity cP cP



Reference: None


2.3.1.17 Temperature 3X Pointer or Input Value (4x +6)

This field may be used to hold a pointer to the 3X address containing theappropriate analog input value or as a 4X holding register containing theactual input value. When Input Type (4X +4 bits 7 ... 8) is 2 this register(4X+6) holds the input value for temperature. When Input Type (4X +4bits 7 ... 8) is 1 this register (4X+6) is a pointer to the 3X address usedfor the temperature input. For 30002 the entry for temperature 3Xpointer or 4X register would be 2. You MUST enter the register pointerfor temperature as an unsigned decimal value.

Reference: None

Note: Ensure the 3X pointer address selected matches those used inyour Modsoft or Concept I/O Map configuration.

2.3.1.18 Pressure (absolute) 3X Pointer or Input Value (4x +7)

This field may be used to hold a pointer to the 3X address containing theappropriate analog input value or as a 4X holding register containing theactual input value. When Input Type (4X +4 bits 7 ... 8) is 2 this register(4X+7) holds the input value for static pressure. When Input Type (4X+4 bits 7 ... 8) is 1 this register (4X+7) is a pointer to the 3X addressused for the static pressure input. For 30003 the entry for staticpressure pointer or input value would be 3. You MUST enter the registerpointer for static pressure as an unsigned decimal value.

Reference: None



2.3.1.19 Differential Pressure 1 3X Pointer or Input Value (4x +8)

This field may be used to hold a pointer to the 3X address containing theappropriate analog input value or as a 4X holding register containing theactual input value. When Input Type (4X +4 bits 7 ... 8) is 2 this register(4X+8) holds the input value for differential pressure 1. When InputType (4X +4 bits 7 ... 8) is 1 this register (4X+8) is a pointer to the 3Xaddress used for the differential pressure 1 input. For 30004 the entryfor differential pressure 1 3X pointer or 4X register would be 4. YouMUST enter the register pointer for static pressure as an unsigneddecimal value. GD92 allows two differential pressure input devices ofdifferent ranges that provides a higher accuracy over a wider range.

Reference: None



This field may be used to hold a pointer to the 3X address containing theappropriate analog input value or as a 4X holding register containing theactual input value. When Input Type (4X +4 bits 7 ... 8) is 2 this register(4X+9) holds the input value for differential pressure 2. When InputType (4X +4 bits 7 ... 8) is 1 this register (4X+9) is a pointer to the 3Xaddress used for the differential pressure 2 input. For 30005 the entryfor differential pressure 2 3X pointer or input value would be 5. YouMUST enter the register pointer for static pressure as an unsigneddecimal value. GD92 allows two differential pressure input devices ofdifferent ranges that provides a higher accuracy over a wider range.

Reference: None


2.3.1.21 Analog Input Raw Value Minimum Temperature (4x +10)

This is the lower limit (raw value) of the temperature input device (readfrom the analog input module). You MUST enter the raw valueminimum for the temperature input device as a decimal unsignedinteger value.

Reference: None


2.3.1.22 Analog Input Raw Value Maximum Temperature (4x +11)

This is the upper limit (raw value) of the temperature input device (readfrom the analog input module). You MUST enter the raw valuemaximum for the temperature input device as a decimal unsignedinteger value.

Reference: None

2.3.1.23 Analog Input Raw Value Minimum Pressure (4x +12)

This is the lower limit (raw value) of the static pressure input device(read from the analog input module). You MUST enter the raw valueminimum for the static pressure input device as a decimal signed integervalue.

Reference: None

2.3.1.24 Analog Input Raw Value Maximum Pressure (4x +13)

This is the upper limit (raw value) of the static pressure input device(read from the analog input module). You MUST enter the raw valuemaximum for the static pressure input device as a decimal signed integervalue.

Reference: None

2.3.1.25 Analog Input Raw Value Minimum Differential Pressure 1 (4x +14)

This is the lower limit (raw value) of the differential pressure 1 inputdevice (read from the analog input module). You MUST enter the rawvalue minimum for the differential pressure 1 input device as a decimalsigned integer value.

Reference: None

2.3.1.26 Analog Input Raw Value Maximum Differential Pressure 1 (4x +15)

This is the upper limit (raw value) of the differential pressure 1 inputdevice (read from the analog input module). You MUST enter the rawvalue maximum for the differential pressure 1 input device as a decimalsigned integer value.

Reference: None




Reference: None



Reference: None

2.3.1.29 Engineering Unit Temperature Minimum (4x +18 ... 19)

This is the lower limit (°F or°C value) of the temperature input device(read from the analog input module) in engineering units. You MUSTenter the engineering unit scale minimum for temperature input deviceas a floating point number.

Reference: None

2.3.1.30 Engineering Unit Temperature Maximum (4x +20 ... 21)

This is the upper limit (°F or°C value) of the temperature input device(read from the analog input module) in engineering units. You MUSTenter the engineering unit scale maximum for temperature input deviceas a floating point number.

Reference: None

2.3.1.31 Engineering Unit Pressure Minimum (4x +22 ... 23)

This is the lower limit (PSIA or kPa) of the pressure input device (readfrom the analog input module) in engineering units. You MUST enterthe engineering unit scale minimum for pressure input device as afloating point number. This entry is the absolute pressure. When gaugepressure is required you MUST enter the atmospheric pressure (if it is aconstant) plus the minimum EU. For example, if the atmosphericpressure is 14.73 and the EU minimum is 0, then 14.73 +0=14.73.Thus, the entry would be 14.73.

Reference: None


2.3.1.32 Engineering Unit Pressure Maximum (4x +24 ... 25)

This is the upper limit (PSIA or kPa) of the pressure input device (readfrom the analog input module) in engineering units. You MUST enterthe engineering unit scale maximum for pressure input device as afloating point number. This entry is the absolute pressure. When gaugepressure is required you MUST enter the atmospheric pressure (if it is aconstant) plus the maximum EU. For example, if the atmosphericpressure is 14.73 and the EU maximum is 100, then 14.73 +100=114.73.Thus, the entry would be 14.73.

Reference: None

2.3.1.33 Engineering Unit Differential Pressure 1 Minimum (4x +26 ... 27)

This is the lower limit (inches H2O or kPa) of the differential pressure 1input device (read from the analog input module) in engineering units.You MUST enter the engineering unit scale minimum for differentialpressure 1 input device as a floating point number.

Reference: None

2.3.1.34 Engineering Unit Differential Pressure 1 Maximum (4x +28 ... 29)

This is the upper limit (inches H2O or kPa) of the differential pressure 1input device (read from the analog input module) in engineering units.You MUST enter the engineering unit scale maximum for differentialpressure 1 input device as a floating point number.

Reference: None



Reference: None



Reference: None


2.3.1.37 Orifice Plate Diameter, dr (4x +34 ... 35)

The orifice plate bore diameter (measured at reference temperature),dr=inches or mm and MUST be entered as a floating point number. Thevalid entry range is 0<dr<100 in., the Meter Tube Internal Diameter(Section 2.3.1.39)


2.3.1.38 Orifice Plate Diameter Measurement Temperature, Tr (4x +36 ... 37)

The measured orifice plate bore diameter temperature, Tr=°F or (°C)and MUST be entered as a floating point number. The valid entry rangeis 32<=Tr<77°F.


2.3.1.39 Meter Tube Internal Diameter, Dr (4x +38 ... 39)

The meter tube internal diameter calculated at reference temperature,Dr=in or (mm) and MUST be entered as a floating point number. Thevalid entry range is 0.0<Dr<100.0.


2.3.1.40 Measured Meter Tube Internal Diameter Temperature, Tr (4x+40 ... 41)

The measured meter tube internal diameter temperature, Tr=°F or (°C)and MUST be entered as a floating point number. The valid entry rangeis 32<=Tr<77°F.


2.3.1.41 Base Temperature, Tb (4x +42 ... 43)

The base temperature, Tb=°F or (°C) and MUST be entered as a floatingpoint number. The valid entry range is 32.0<=Tb<77.0.

Reference: AGA#8, pp11, formula#7

2.3.1.42 Base Pressure, Pb (4x +44 ... 45)

The base pressure, Pb=PSIA or (kPa A) and MUST be entered as afloating point number. The valid entry range is 13.0<=Pb<16.0.



2.3.1.43 Reference Temperature for Relative Density, Tgr (4x +46 ... 47)

The reference temperature for relative density, Tgr=°F or (°C) andMUST be entered as a floating point number. The valid entry range is32.0<=Tgr<77.0.


2.3.1.44 Reference Pressure for Relative Density, Pgr (4x +48 ... 49)

The reference pressure for relative density, Pgr=PSIA or (kPa A) andMUST be entered as a floating point number. The valid entry range is13.0<=Pgr<16.0.


2.3.1.45 Reserved for Future Use (4x +50 ... 57)


Reference: None

2.3.1.46 User Input Correction Factor, Fu (4x +58 ... 59)

The user input calibration factor, Fu MUST be entered as a floatingpoint number. The valid entry range is 0.0<Fu<2.0. This field isprovided to enter a calculated correction factor. Use this variablecautiously, as the calculated volume deviates proportionally to thisfactor. Also, when no information is available about correction factors,set this variable to 1.

Reference: AGA#8, pp136, formula#C.4.5

2.3.1.47 Absolute Viscosity of Flowing Fluid, cP (4x +60 ... 61)

The absolute viscosity of flowing fluid, cP MUST be entered as a floatingpoint number. The valid entry range is 0.005<cP<0.5.


2.3.1.48 Isentropic Exponent, k (4x +62 ... 63)

The isentropic exponent, k MUST be entered as a floating point number.The valid entry range is 1.0<k<2.0. The recommended value per thestandard is 1.3.



2.3.1.49 Beginning of Day Hour (4x +64)

Denotes the hour of the day to start calculation of daily values. Thevalid entry range is 0 ... 23.

Reference: None



Reference: None

2.3.1.51 Atmospheric Pressure, Pat (4x +79 ... 80)

The atmospheric pressure is required when you specify the staticpressure as a gage quantity. The valid entry range is 3<=Pat<30psi.

Reference: None

2.3.1.52 Low Flow Cut Off (4x +81 ... 82)

Refers to the volumetric flow rate under which zero flow is recorded.The valid entry range is >=0ft3 /Hr.

Reference: None

2.3.1.53 Mole Percentages, Xi (4x +83 ... 124)

This value is the mole percentages for all twenty one possible gascomponents.



2.3.2 Gas Flow Configuration Output Table

The following is a detailed description of each of the output variablesfrom the GD92 gas flow function block.

2.3.2.1 System Warning/Error Codes (4x + 0)

This field displays a fault code generated by the Gas Flow block. Acomplete list is shown in the table below. System warning codes do NOThalt the calculation. In contrast, system error codes DO halt thecalculation. When a system or program warning is detected by the blockthe middle output turns ON. When a system or program error isdetected by the block the bottom output turns ON. Refer to the first DXZoom screen to view the system warning/error codes detected by the GasFlow Block.

System Warning/Error Codes (4x + 0)

DisplayedCode

Type ofCode

Description

0101 Hex Warning Hardware enabler is missing. Gasflow only operates for 48 hourswithout enabler present, 60 se-conds when enabler present thenremoved. Please insert the hard-ware enabler.

0201 Hex Error Engineering Units min. is > Engi-neering Units max. on temperature,pressure or differential pressure.

0202 Hex Error Raw value min. = raw value max.on temperature, pressure or differ-ential pressure.

0301 Hex Error Hardware enabler is missing, gasflow blocks stop solving.

0302 Hex Error Create a second meter attemptedon a single meter function block.

0303 Hex Error Time of day clock not configured, orTOD clock 4X registers being over-written.

FFXX Hex Error System error. Please contact Modi-con Technical Support.

0401 Hex Error Insufficient amount of heap memoryto run this function block meter, orPLC is not compatible.

0402 Hex Error Not enough heap memory.


2.3.2.2 Program Warning/Error Codes (4x + 1)

This field displays a fault code generated by the Gas Flow block. Acomplete list is shown in the table below. Program warning codes doNOT halt the calculation. In contrast, program error codes DO halt thecalculation. When a system or program warning is detected by the blockthe middle output turns ON. When a system or program error isdetected by the block the bottom output turns ON. Refer to the first DXZoom screen to view the program warning/error codes detected by theGas Flow Block.

Program Warning/Error Code (4x + 1)

DisplayedCode

Type ofCode

Description

1 Warning Pressure has a negative derivative.

2 Warning Density calculated exceeds themaximum, and the gas density de-fault is used.

3 Warning Number of iterations to bracket thedensity has exceeded the maxi-mum.

4 Warning Number of iterations to obtain thedensity has exceeded the maxi-mum.

36 Warning Mole percent exceeds limits.Warning only occurs when the molepercent limits are disabled. Refer toError 136 for valid limits.

42 Warning Pressure is <0.0 or >1750 psia(<0.0 or >12, 065.82 kPa)

43 Warning Temperature is <17 or >143(<--8.334>61.667°C)

46 Warning Methane < 45 or > 100Nitrogen > 50Carbon Dioxide < 0.0 or >30Ethane > 10Propane > 4Water > 0.05Hydrogen Sulfide > 0.02Hydrogen > 10Carbon Monoxide >3Oxygen >0Butanes > 1Pentanes > 0.3Hexanes+ > 0.2Helium > 0.2Argon >0

49 Warning Sum of mole % are <99.99 or >100.01

71 Warning Volume flow rate below low flow cutoff


75 Warning Orifice diameter is < 0.45 in(11.44mm)

76 Warning Pipe diameter is <= 2.0 in

79 Warning Beta ratio => 0.75

89 Warning User defined warning

188 Error Top input disconnected

189 Error User defined error

132 Error Pressure Engineering Units min. ormax. is specified as < 0.0 or >40,000 psia (<0.0 or >275,790.78kPa) or measured pres-sure is <=0.0 or > 40,000 PSIA

133 Error Temperature Engineering Units min.or max. is specified as < --200 or >760°F (<--128.89 or > 404.444°C) ormeasured pressure is <=0.0 or >40,000 PSIA

136 Error Methane < 0.0 or > 100Nitrogen < 0.0 or > 100Carbon Dioxide < 0.0 or >100Ethane < 0.0 or > 100Propane < 0.0 or > 12Water < 0.0 or > 10Hydrogen Sulfide < 0.0 or > 100Hydrogen < 0.0 or >100Carbon Monoxide < 0.0 or > 3Oxygen < 0.0 or > 21Butanes < 0.0 or > 6Pentanes < 0.0 or > 4Hexanes+< 0.0 or > 10Helium < 0.0 or > 3Argon < 0.0 or > 100

137 Error Reference temperature or basetemperature< 32.0 or > 77°F (<0 or> 25°C)

138 Error Reference pressure or base pres-sure< 13.0 or >16.0 psia (<89.63 or> 110.32 kPa)

139 Error Sum of mole % < 98 or > 102

152 Error Atmospheric pressure <3 or>30psia (20.68 < or > 206.8kPa)

153 Error Flow cut off <0

154 Error Pipe or orifice material is NOT 1,2or 3

155 Error Orifice diameter is <=0 or => 100.0in (<=0 or=> 2540mm)

156 Error Pipe diameter is <=0 or => 100.0 in(<=0 or=> 2540mm)

157 Error Flowing or base density is <= 0.0Ibm/ft3 (<=0.0kg/m3)


158 Error Differential pressure EngineeringUnits min. is specified as < 0.0 inH2O (<0.0kPa) or measured differ-ential pressure is <=0.0 lbm/ft3(<=0.0kg/m3)

159 Error Absolute viscosity is < 0.005 or >0.5 cP

160 Error Isentropic exponent <= 1.0 or =>2.0

161 Error Compressible or Incompressible isset to something other than 1 or 2

164 Error Tap location is NOT 1 for upstreamor 2 for downstream

165 Error Supercompressibility is <= 0.0

166 Error Relative density at standard condi-tions are < 0.07 or > 1.52

167 Error Calibration factor is < = 0.0 or > 2.0

169 Error Beta ratio <= 0.0 or => 1.0

170 Error Dm <= 0.0

186 Error Optional outputs not 1 or 2

190 Error Orifice diameter measurement tem-perature or Tube internal diametermeasurement temperature32<Tr<=77° F (0<Tr<=25° C)

193 Error Input type not set to 1 for 3X pointeror 2 for input value

194 Error Mole percent limits not set to 1 forenable or 2 for disable

196 Error Measurement units not set to 1 forUS or to 2 for metric (SI)

197 Error Differential pressure is > flowingpressure

198 Error Dual range differential pressure not1 or 2

199 Error Engineering unit range(4x+18 ... 33) is incorrect


2.3.2.3 Version Number (4x +2)

Displays the current revision number of Gas Flow block. This number isautomatically loaded by the block and the block overwrites any othernumber entered into this register.

2.3.2.4 Temperature at Flowing Conditions, Tf (4x +125 ... 126)

This value is the temperature at fluid flowing conditions Tf=°F or (°C).


2.3.2.5 Pressure, Pf (4x +127 ... 128)

This value is the static pressure of fluid at pressure tap Pf=PSIA or (kPaA).


2.3.2.6 Differential Pressure, hw (4x +129 ... 130)

This value is the orifice differential pressure hw=in H2O or (kPa A).


2.3.2.7 Integral Value, IV (4x +131 ... 132)

This value is the integral value IV.

Reference: API#21, pp6, formula#1.4.2.5

2.3.2.8 Integral Multiplier Value, IMV (4x +133 ... 134)

This value is the integral multiplier value IMV.


2.3.2.9 Volume Flow Rate at Base Conditions, (Tb,Pb), Qb (4x +135 ... 136)

This value is the volume flow rate at base conditions value Qb=ft3/hr or(m3/hr).

Reference: AGA#3, pp7, formula#3-4a

2.3.2.10 Mass Flow Rate, Qm (4x +137 ... 138)

This value is the mass flow rate per hour value Qm=lbm/hr or (kg/hr).



2.3.2.11 Accumulated Volume Current Day, (4x +139 ... 140)

This value is the volume that has accumulated for the current runningday in SCF or (Sm3). This value is reset every day.

Reference: None

2.3.2.12 Accumulated Volume Last Hour, (4x +141 ... 142)

This value is the volume that has accumulated during the last hour inSCF or (Sm3). This value is reset every hour to the current accumulatedvolume at the end/beginning of every hour.

Reference: None

2.3.2.13 Accumulated Volume Last Day, (4x +143 ... 144)

This value is the volume that has accumulated during the last day inSCF or (Sm3). This value is reset every day to the sum of the previoustwenty four hours of accumulated volume.

Reference: None

2.3.2.14 Average Temperature Last Day, (4x +145 ... 146)

This value is the average temperature for the last day in °F or (°C). Thisvalue is reset every day to the arithmetic average of the twenty fourhourly averages of temperature obtained.

Reference: None

2.3.2.15 Average Pressure Last Day, (4x +147 ... 148)

This value is the average static pressure for the last day in PSIA or (kPaA). This value is reset every day to the arithmetic average of the twentyfour hourly averages of static pressure obtained.

Reference: None

2.3.2.16 Average Differential Pressure Last Day, (4x +149 ... 150)

This value is the average differential pressure for the last day in H2O or(kPa A). This value is reset every day to the arithmetic average of thetwenty four hourly averages of differential pressure obtained.

Reference: None


2.3.2.17 Average IV Last Day (4x +151 ... 152)

This value is the integral value for the last day. This value is reset everyday to the arithmetic average of the twenty four hourly averages ofvolume flow rates obtained.

Reference: None

2.3.2.18 Average Volume Flow Rate at Base Conditions Last Day,Tb,Pb (4x+153 ... 154)

This value is the average volume flow rate for the last day in ft3/hr or(m3/hr). This value is reset every day to the arithmetic average of thetwenty four hourly averages of volume flow rates obtained.

Reference: None

2.3.2.19 4X Table Differs from Actual Configuration, (4x +155: 13)

Automatically goes on when the 4x table is different than the actualconfiguration. It automatically resets.

Reference: None

2.3.2.20 Flow Rate Solve Complete Heartbeat (4x +155: 14)

This bit goes on each time the flow block completes one solve. When thisbit is not toggling between 0 and 1, the block is not solving the flowequation.

Reference: None

2.3.2.21 Block is Functioning Heartbeat (4x +155: 15)

This heartbeat occurs once per second when the flow block isfunctioning correctly. When the flow block is not functioning properlythe heartbeat stops.

Reference: None

2.3.2.22 End of Day (4x +155: 16)

This bit goes on for one scan when the block resets the dailyaccumulators. This bit may be monitored for peripheral control in theprogram.

Reference: None

Note: This bit does not appear in the DX Zoom screen, but, may beused in program logic peripheral to the gas flow block.


2.3.3 Gas Flow Configuration Optional Output Table

The following is a detailed description of each of the optional outputvariables from the GD92 gas flow function block.

2.3.3.1 Compressibility at Flowing Conditions, (Tf,Pf) Zf (4x +156 ... 157)

This value is calculated by GD92 gas flow function block.


2.3.3.2 Compressibility at Base Conditions, (Tb,Pb) Zb (4x +158 ... 159)



2.3.3.3 Compressibility at Standard Conditions, (Ts,Ps) Zs (4x +160 ... 161)



2.3.3.4 Density at Fluid Flowing Conditions, ρt,p (4x +162 ... 163)

This value ρt,p=lbm/ft3 or (kg/m3) is calculated by GD92 gas flow functionblock.

Reference: AGA#3, pp6, formula#3-a

2.3.3.5 Density of a Fluid at Base Conditions, ρb (4x +164 ... 165)

This value ρb=lbm/ft3 or (kg/m3) is calculated by GD92 gas flow functionblock.

Reference: AGA#3, pp6, formula#3-4b

2.3.3.6 Supercompressibility, Fpv (4x +166 ... 167)


Reference: None

2.3.3.7 Gas Relative Density, Gr (4x +168 ... 169)




2.3.3.8 Orifice Plate Coefficient of Discharge, Cd (4x +170 ... 171)



2.3.3.9 Expansion Factor, Y (4x +172 ... 173)


Reference: AGA#3, pp82, formula#3-D-3

2.3.3.10 Velocity of Approach Factor, Ev (4x +174 ... 175)



2.3.3.11 Volume Flow Rate at Flowing Conditions Use, (Tf, Pf ),Qf (4x+176 ... 177)


Reference: None



Reference: None

2.3.3.13 Orifice Plate Coefficient of Discharge Bounds Flag within IterationScheme, Cd_f (4x +180)




2.4 Possible Configuration Example for theGas Flow Block

Using the inputs given with the GD92 function block you should obtainthe same outputs as noted below for the example that calculates avolumetric flow rate. They may be used to: troubleshoot, measureaccuracy, compare different inputs and how they affect the flow rate.

2.4.1 Example with US Units



4X+2 Version Number (Read Only) 40203 UINT = 2000 HEX


4X+4:3-6 Load Command 40205 03:06 = 0 DEC0 - Ready to Accept Command.1 - CMD: Send Configuration to Internal Table from 4X.2 - CMD: Read Configuration From Internal Table to 4X.





Figure 24 GD92 Example Screen 1 of 12











Input Registers

4X+4:7-8 Input Type 1-3X 2-Input Value 40205 07:08 = 2 DEC




























4X+3:1-2 Location of Taps 40204 01:02 = 2 DEC(1 - Upstream, 2 - Downstream)













GD92:AGA8 1992, Detail Method and AGA3 1992 Page 7 / 12Gas Composition Analysis (continued)

4X+103-104 Mole % of I-Butane 40304 FLT32 = 9.77E-024X+105-106 Mole % of n-Butane 40306 FLT32 = 0.1007Valid Range for Combined Butanes is 0<=xi<=6

4X+107-108 Mole % of I-Pentane 40308 FLT32 = 4.73E-024X+109-110 Mole % of n-Pentane 40310 FLT32 = 3.24E-02Valid Range for Combined Pentanes is 0<=xi<=4

4X+111-112 Mole % of Hexane 40312 FLT32 = 6.64E-024X+113-114 Mole % of Heptane 40314 FLT32 = 0.4X+115-116 Mole % of Octane 40316 FLT32 = 0.4X+117-118 Mole % of Nonane 40318 FLT32 = 0.4X+119-120 Mole % of Decane 40320 FLT32 = 0.Valid Range for Hexane+ is 0<=xi<=10




















OUTPUTS


(0:False 1:True)

Live Quantities

4X+125-126 Temp. @ Flowing Conds.,Tf(F/C) 40326 FLT32 = 50.4X+127-128 Pressure,Pf(psia/kPa) 40328 FLT32 = 250.4X+129-130 Differential Press.,hw(in H2O/kPa) 40330 FLT32 = 50.4X+131-132 Integral Value,IV 40332 FLT32 = 112.20624X+133-134 Integral Multiplier Value,IMV 40334 FLT32 = 68.756014X+135-136 Vol. Flow Rate at Base Conditions 40336 FLT32 = 7714.85










Average Quantities4X+145-146 Average Temperature Last Day(F/C) 40346 FLT32 = -1000.4X+147-148 Average Pressure Last Day(psia/kPa) 40348 FLT32 = -1000.4X+149-150 Average Diff. Pressure Last Day 40350 FLT32 = -1000.

(in H2O/kPa)4X+151-152 Average IV Last Day 40352 FLT32 = 0.4X+153-154 Average Volume Flow Rate Last Day 40354 FLT32 = 0.





Optional Outputs
















4X+176-177 Vol.Flow Rate at Flowing Conditions 40377 FLT32 = 139652.(Tf,Pf),Qf (ft^3/hr or m^3/hr)

End of GD92 Zoom Screens


GM92 AGA#3&8 1992 Detail Method Gas Flow Function Block890 USE 137 00 67

Chapter 3GM92 AGA#3&8 1992 DetailMethod Gas Flow FunctionBlock


V DX Zoom Screens



GM92 AGA#3&8 1992 Detail Method Gas Flow Function Block 890 USE 137 0068



3.1.1.1 Size

Three nodes high


V Compact PLCs: PC E984 251, and PC E984 255 (with 1.02 execu-tive firmware or higher).



Note: The GM92, GG92 and GFNX blocks require a 16K total usermemory PLC model. Therefore, they do NOT support the followingmodels: PC A984 141, PC A984 145, PC E984 241, and PC E984 245.However, the 110 CPU 612 04 PLC DOES support these blocks eventhough it is an 8K PLC because of its execution buffer design.

3.1.1.3 Opcode

1f hex for GM92.EXE file.





4xxxx

GM92System or ProgramError#0003

User defined Error



InputsGM92 Gas Flow Block has three control inputs. The input to the topnode starts the calculation of the gas flow and should remain ON tocontinue solving. The calculations are based on your parametersentered into the input registers. The input to the middle node allowsyou to set a warning and log peripheral activities in the audit trail eventlog without stopping the block. The input to the bottom node allows youto set an error, log peripheral errors in the audit trail event log, andSTOP the flow function.


OutputsGM92 may produce three possible outputs. The outputs from the topnode goes ON while a GM92 operation is in progress. The output fromthe middle node goes ON when GM92 has detected a system or programwarning. The output from the bottom node goes ON when GM92 hasdetected a system or program error. Refer to Section 3.3.2.1 for systemwarning/error codes (4x+0), and to Section 3.3.2.2 for programwarning/error codes (4x+1).




Warning! Do not attempt to change the middle node 4xregister while the Gas Flow Block is running. You will loseyour data. If you need to change the 4x register, first STOPthe PLC.


3.1.3 GM92 Configuration Table

You MUST fill in all pertinent values in the configuration table usingeither the reference data editor in Modsoft or Concept, or the DX Zoomscreens in Modsoft, or Meter Manager (offered by Starling Associates)refer to Appendix C. The following input table lists all of theconfiguration parameters that MUST be filled in. The outputs andoptional outputs show the calculation results of the block. Some of thesevariables use multiple registers to hold the specific configurationparameters required. Refer to Section 3.1.3.1, Section 3.1.3.2, andSection 3.1.3.3 below




3.1.3.1 Inputs

GM92 Gas Flow Configuration Table Description

Inputs Description






4x+3: 9 ... 10 Optional Outputs: 1=Yes, 2=No *When using only the standard outputs (seeSection 3.1.3.2) the loadable uses 157 4x registers. When using the op-tional outputs (see Section 3.1.3.3) the loadable uses 181 4x registers.




4x+4: 3 ... 6 Load Command:: 0=Ready to Accept Command, 1=CMD: Send Configuration toInternal Table from 4X, 2=CMD: Read Configuration from Internal Table to 4X,3=CMD: Reset API 21.1 Configuration Change Log, (Commands 3 ... 15 Reserved)








4x+5: 15 ... 16 Reserved for API21.1 Refer to Appendix A

























4x+40 ... 41 Measured Meter Tube Diameter Internal Diameter Temperature, Tr (32<=Tr<77°F)(0<=Tr<25°C)










4x+65 ... 78 Reserved for API21.1 Refer to Appendix A

4x+79 ... 80 Atmospheric Pressure, Pat (3<=Pat<30psi (20.684<=Pat<206.843kPa)












4x+103 ... 104 Mole % of I--Butane, xi Valid Entry for Com-bined Butanes is(0.0<=xi<=6)

4x+105 ... 106 Mole % of n--Butane, xi Valid Entry for Com-bined Butanes is(0.0<=xi<=6)

4x+107 ... 108 Mole % of I--Pentane, xi Valid Entry for Com-bined Pentanes is(0.0<=xi<=4)

4x+109 ... 110 Mole % of n--Pentane, xi Valid Entry for Com-bined Pentanes is(0.0<=xi<=4)


4x+111 ... 112 Mole % of Hexane, xi Valid Entry for Com-bined Hexanes + is(0.0<=xi<=10)

4x+113 ... 114 Mole % of Heptane, xi Valid Entry for Com-bined Hexanes + is(0.0<=xi<=10)

4x+115 ... 116 Mole % of Octane, xi Valid Entry for Com-bined Hexanes + is(0.0<=xi<=10)

4x+117 ... 118 Mole % of Nonane, xi Valid Entry for Com-bined Hexanes + is(0.0<=xi<=10)

4x+119 ... 120 Mole % of Decane, xi Valid Entry for Com-bined Hexanes + is(0.0<=xi<=10)


4x+123 ... 124 Mole % of Argon, xi (0.0<=xi<=100)

3.1.3.2 Outputs


Outputs Description















4x+153 User definable warning/error value Use for API21.1 Refer to Appendix A








OptionalOutputs

Description











4x+176 ... 177 Volume Flow Rate at Flowing Conditions, (Tf, Pf), Qf






Step 1 Choose the GM92 Loadable now.



Step 4 Place your cursor on the bottom node of the Gas block, type #0003 andpress enter.



Note: You may wish to refer to Section 3.4 for possible configurationexamples for the GM92 Block.

Note: To access the help screen for the GM92 Block place your cursoron the GM92 Block and hit ALTH.


Utility Hex Dec Bin Goto QuitF1-----GM92_2-----F3-------F4-- DX Zoom Editor -------F7-Lev 8-F8-OFF---F9-----+

GM92:AGA8 1992, Detail Method and AGA3 1992 Page 1 / 14



4X+4:3-6 Load Command 40205 03:06 = 0 DEC0 - Ready to Accept Command.1 - CMD: Send Configuration to Internal Table from 4X.2 - CMD: Read Configuration From Internal Table to 4X.3 - CMD: Reset API 21.1 Config. Changed Log.

4X+4:9-10 Mole % Limits (1-Enable 2-Disable) 40205 09:10 = 2 DEC




Figure 36 GM92 Zoom Screen 1 of 14






4X+5:16 API Audit Trail (0: Disable 1:Enable) 40206 16:16 = 1 DEC4X+5:15 ConfigChange Log Type. When full, 40206 15:15 = 1 DEC

(0:Changes not logged. 1:Wraps & logs Changes.)






Input Registers

4X+4:7-8 Register Type 1-3X 2-Input Value 40205 07:08 = 2 DEC









Engineering Unit Limits4X+18-19 Temperature Minimum (-200 to 760 F / 40219 FLT32 = 0.

-128.89 to 404.44 C)4X+20-21 Temperature Maximum (-200 to 760 F / 40221 FLT32 = 100.


/ 0 to < 275,790.28 kPa)4X+24-25 Pressure Max. ( > 0 to 40,000 psia 40225 FLT32 = 1700.


( >=0 in.H2O / kPa)4X+28-29 Differential Pressure 1 Maximum 40229 FLT32 = 50.

( > 0 in.H2O / kPa)4X+30-31 Differential Pressure 2 Minimum 40231 FLT32 = 0.


( > 0 in.H2O / kPa)Page up/down for next screen











4X+3:1-2 Location of Taps 40204 01:02 = 2 DEC1 - Upstream, 2 - Downstream













GM92:AGA8 1992, Detail Method and AGA3 1992 Page 7 / 14Gas Composition Analysis (continued)

4X+103-104 Mole % of I-Butane 40304 FLT32 = 0.4X+105-106 Mole % of n-Butane 40306 FLT32 = 0.Valid Range for Combined Butanes is 0<=xi<=6

4X+107-108 Mole % of I-Pentane 40308 FLT32 = 0.4X+109-110 Mole % of n-Pentane 40310 FLT32 = 0.Valid Range for Combined Pentanes is 0<=xi<=4

4X+111-112 Mole % of Hexane 40312 FLT32 = 0.4X+113-114 Mole % of Heptane 40314 FLT32 = 0.4X+115-116 Mole % of Octane 40316 FLT32 = 0.4X+117-118 Mole % of Nonane 40318 FLT32 = 0.4X+119-120 Mole % of Decane 40320 FLT32 = 0.Valid Range for Hexane+ is 0<=xi<=10




















API 21.1 Audit Trail

Modifying API 21.1 Configuration Will Clear any Existing Audit Trail Data

4X+71-72 Meter ID (+-2147483647) 40272 INT32 = 1 DEC

4X+65-66 Audit Trail Start Register No. 40266 INT32 = 0 DEC

4X+68:1-8 Number of Daily Records (0-100) 40269 01:08 = 1 DEC

4X+69 Number of Hourly Records (0-840) 40270 UINT = 1 DEC

4X+70:1-8 Number of Config Chg. Records(0-250) 40271 01:08 = 1 DEC

4X+70:9-16 Number of Event Records(0-250) 40271 09:16 = 2 DEC





Outputs for Setting API 21.1 Audit Trail

4X+145-146 Total Available Audit Trail 40346 INT32 = 24457 DECRegisters for ALL Meters (Read Only)

4X+147-148 Ending Audit Trail 40348 INT32 = 5581 DECRegister No. for This Meter (Read Only)

0 in the Ending Audit Trail Register Field Indicates an Invalid Config.






OUTPUTS


(0:False 1:True)

Live Quantities















Optional Outputs
















End of GM92 Zoom Screens





The following is a detailed description of configuration variables for theGM92 gas flow function block: input, output and optional outputvariables. When applicable, the reference publication, page number, andformula number are provided noting where this variable may be found.AGA#3 refers to AGA Report No.3, Part 3, 1992 (aka GPA 8185, Part 3;ANSI/API 2530 1991). AGA#8 refers to AGA Report No. 8, 1992 (akaAPI 14.2). API#21 refers to API 21.1, 1993. AGA stands for theAmerican Gas Association.


The following is a detailed description of each of the input variables tothe GM92 gas flow function block.



Reference None









Reference: None



You may select optional outputs that may be desirable, yet not requiredin all cases. Simply enter 1 to turn optional outputs on or 2 to turnoptional outputs off. Two bits are assigned to specify this selection.When set to 2 (turned off) the output registers for the optional outputsare not used by GM92. When using only the standard outputs (SeeSection 3.1.3.2) the loadable uses 157 4x registers. When using theoptional outputs (See Section 3.1.3.3) the loadable uses 181 4x registers.

Reference: None



Reference: None



Reference: None





These bits are used to load input table configuration informationcontained in the 4x registers to the loadable and vice versa. Simplyenter 0 for ready, or enter 1 for send to PLC, or enter 2 for load fromPLC. Commands 3 ... 15 are reserved for API21.1. Refer to Appendix A.These bits reset to zero when the operation is completed by the loadable.

Reference: None


3.3.1.10 Input Type (4x +4 bits 7 ... 8)


Reference: None



Reference: None


To cover a wider range of pressure differential, GM92 allows the use oftwo staggered range differential pressure measurement devices. Youmay specify either single or dual differential pressures scales. Two bitsare assigned for the input of this variable. Set the variable to 1 for twodifferential pressure scales, or set to 2 for single differential range.

Reference: None



Reference: None







Reference: None



US Metric (SI)

Temperature °F °C



kPa

Length Inches mm

Volume SCFD Sm3/D

Mass Lbm/hr kg/D


Viscosity cP cP



Reference: None

3.3.1.17 Reserved for API21.1 (4x +5 bits 15 ... 16)

These bits are reserved for API21.1. Refer to Appendix A.

Reference: None




Reference: None




Reference: None




This field may be used to hold a pointer to the 3X address containing theappropriate analog input value or as a 4X holding register containing theactual input value. When Input Type (4X +4 bits 7 ... 8) is 2 this register(4X+8) holds the input value for differential pressure 1. When InputType (4X +4 bits 7 ... 8) is 1 this register (4X+8) is a pointer to the 3Xaddress used for the differential pressure 1 input. For 30004 the entryfor differential pressure 1 3X pointer or 4X register would be 4. YouMUST enter the register pointer for static pressure as an unsigneddecimal value. GM92 allows two differential pressure input devices ofdifferent ranges that provides a higher accuracy over a wider range.

Reference: None



This field may be used to hold a pointer to the 3X address containing theappropriate analog input value or as a 4X holding register containing theactual input value. When Input Type (4X +4 bits 7 ... 8) is 2 this register(4X+9) holds the input value for differential pressure 2. When InputType (4X +4 bits 7 ... 8) is 1 this register (4X+9) is a pointer to the 3Xaddress used for the differential pressure 2 input. For 30005 the entryfor differential pressure 2 3X pointer or input value would be 5. YouMUST enter the register pointer for static pressure as an unsigneddecimal value. GM92 allows two differential pressure input devices ofdifferent ranges that provides a higher accuracy over a wider range.

Reference: None




Reference: None




Reference: None



Reference: None



Reference: None



Reference: None



Reference: None




Reference: None



Reference: None



Reference: None



Reference: None



Reference: None




Reference: None



Reference: None



Reference: None



Reference: None



Reference: None











3.3.1.41 Measured Meter Tube Internal Diameter Temperature, Tdm (4x+40 ... 41)


















Reference: None













Reference: None

3.3.1.51 Reserved for API21.1 (4x +65 ... 78)


Reference: None



Reference: None

3.3.1.53 Low Flow Cut Off (4x +81 ... 82)

Refers to the volumetric flow rate under which zero flow is recorded.The valid entry range is >=0ft3/Hr.

Reference: None


This value is the mole percentages for all twenty one possible gascomponents.



The following is a detailed description of each of the output variablesfrom the GM92 gas flow function block.





DisplayedCode

Type ofCode

Description













DisplayedCode

Type ofCode

Description





36 Warning Mole percent exceeds limits.Warning only occurs when the molepercent limits are disabled. Refer toError 136 for valid limits.



46 Warning Methane < 45 or > 100Nitrogen > 50Carbon Dioxide < 0.0 or >30Ethane > 10Propane > 4Water > 0.05Hydrogen Sulfide > 0.02Hydrogen > 10Carbon Monoxide >3Oxygen >0Butanes > 1Pentanes > 0.3Hexanes+ > 0.2Helium > 0.2Argon >0












136 Error Methane < 0.0 or > 100Nitrogen < 0.0 or > 100Carbon Dioxide < 0.0 or >100Ethane < 0.0 or > 100Propane < 0.0 or > 12Water < 0.0 or > 10Hydrogen Sulfide < 0.0 or > 100Hydrogen < 0.0 or >100Carbon Monoxide < 0.0 or > 3Oxygen < 0.0 or > 21Butanes < 0.0 or > 6Pentanes < 0.0 or > 4Hexanes+< 0.0 or > 10Helium < 0.0 or > 3Argon < 0.0 or > 100









157 Error Flowing or base density is <= 0.0Ibm/ft3 (<=0.0kg/m3)



160 Error Isentropic exponent <= 1.0 or =>2.0








170 Error Dm <= 0.0














3.3.2.5 Pressure, Pf (4x +127 ... 128)





















Reference: None



Reference: None




Reference: None



Reference: None

3.3.2.15 User Definable Warning/Error Value (4x +153)

These bits are used with API21.1. Refer to Appendix A.

Reference: None



Reference: None



Reference: None



Reference: None


3.3.2.19 End of Day (4x +155: 16)


Reference: None



The following is a detailed description of each of the optional outputvariables from the GM92 gas flow function block.


This value is calculated by GM92 gas flow function block.









This value ρt,p=lbm/ft3 or (kg/m3) is calculated by GM92 gas flow functionblock.

Reference: AGA#3, pp6, formula#3-a


This value ρb=lbm/ft3 or (kg/m3) is calculated by GM92 gas flow functionblock.





Reference: None













3.3.3.11 Volume Flow Rate at Flowing Conditions Use, (Tf, Pf), Qf (4x+176 ... 177)


Reference: None



Reference: None






Using the inputs given with the GM92 function block you should obtainthe same outputs as noted below for the example that calculates avolumetric flow rate. They may be used to: troubleshoot, measureaccuracy, compare different inputs and how they affect the flow rate.

3.4.1 Example with Metric Units






4X+4:9-10 Mole % Limits (1-Enable 2-Disable) 40205 09:10 = 1 DEC




Figure 50 GM92 Example Screen 1 of 14













Input Registers











Engineering Unit Limits4X+18-19 Temperature Minimum (-200 to 760 F / 40219 FLT32 = 0.

-128.89 to 404.44 C)4X+20-21 Temperature Maximum (-200 to 760 F / 40221 FLT32 = 50.


/ 0 to < 275,790.28 kPa)4X+24-25 Pressure Max. ( > 0 to 40,000 psia 40225 FLT32 = 15.



( > 0 in.H2O / kPa)4X+30-31 Differential Pressure 2 Minimum 40231 FLT32 = 0.


( > 0 in.H2O / kPa)Page up/down for next screen





4X+36-37 Measured Orifice Plate Bore Diameter 40237 FLT32 = 15.5556Temperature, Tr (32<=Tr<77F / 0<=Tr<25C)



4X+40-41 Measured Meter Tube Internal Diameter 40241 FLT32 = 15.5556Temperature, Tr(32<=Tr<77F / 0<=Tr<25C)















GM92:AGA8 1992, Detail Method and AGA3 1992 Page 7 / 14Gas Composition Analysis (continued)

4X+103-104 Mole % of I-Butane 40304 FLT32 = 9.77E-024X+105-106 Mole % of n-Butane 40306 FLT32 = 0.1007Valid Range for Combined Butanes is 0<=xi<=6

4X+107-108 Mole % of I-Pentane 40308 FLT32 = 4.73E-024X+109-110 Mole % of n-Pentane 40310 FLT32 = 3.24E-02Valid Range for Combined Pentanes is 0<=xi<=4

4X+111-112 Mole % of Hexane 40312 FLT32 = 6.64E-024X+113-114 Mole % of Heptane 40314 FLT32 = 0.4X+115-116 Mole % of Octane 40316 FLT32 = 0.4X+117-118 Mole % of Nonane 40318 FLT32 = 0.4X+119-120 Mole % of Decane 40320 FLT32 = 0.Valid Range for Hexane+ is 0<=xi<=10







Reference Conditions4X+42-43 Base Temperature, Tb 40243 FLT32 = 15.5556


(13<=Pb<16 psia / 89.63<=Pb<110.32 kPa)4X+46-47 Reference Temperature for Relative 40247 FLT32 = 15.5556













4X+71-72 Meter ID (+-2147483647) 40272 INT32 = 1234567 DEC



















OUTPUTS


(0:False 1:True)

Live Quantities










4X+139-140 Accum. Vol. Current Day(ft^3/m^3) 40340 FLT32 = 4.3032484X+141-142 Accum. Vol. Last Hour(ft^3/m^3) 40342 FLT32 = 44.587754X+143-144 Accum. Vol. Last Day (ft^3/m^3) 40344 FLT32 = 44.58775





Optional Outputs




4X+162-163 Density at Fluid Flowing 40363 FLT32 = 5.276012E-02Conditions(lbm/ft^3 or kg/m^3)

4X+164-165 Density of Fluid at Base 40365 FLT32 = 0.7122889Conditions(lbm/ft^3 or kg/m^3)











4X+176-177 Vol.Flow Rate at Flowing Conditions 40377 FLT32 = 21.39627(Tf,Pf),Qf (ft^3/hr or m^3/hr)

End of GM92 Zoom Screens


G392 AGA#3 1992 Gas Flow Function Block890 USE 137 00 111

Chapter 4G392 AGA#3 1992 Gas FlowFunction Block


V DX Zoom Screens



G392 AGA#3 1992 Gas Flow Function Block 890 USE 137 00112



4.1.1.1 Size

Three nodes high


V Compact PLCs: PC A984 141, and PC A984 145 (with no loadableexecutive firmware).

V Compact PLCs: PC E984 241, PC E984 245, PC E984 251, and PCE984 255 (with 1.02 executive firmware or higher).



4.1.1.3 Opcode

1f hex for G392.EXE file.




4xxxx

G392System or ProgramError#0017

User defined Error




InputsG392 Gas Flow Block has one control input. The input to the top nodestarts the calculation of the gas flow and should remain ON to continuesolving. The calculations are based on your parameters entered into theinput registers. The input to the middle node allows you to set awarning and log peripheral activities in the audit trail event log withoutstopping the block. The input to the bottom node allows you to set anerror, log peripheral errors in the audit trail event log, and STOP theflow function.

Warning! NEVER detach the top input while the block isrunning. You will lgenerate an error 188 and the data in thisblock could be corrupted.

OutputsG392 may produce three possible outputs. The outputs from the topnode goes ON while a G392 operation is in progress. The output fromthe middle node goes ON when G392 has detected a system or programwarning. The output from the bottom node goes ON when G392 hasdetected a system or program error. Refer to Section 4.3.2.1 for systemwarning/error codes (4x+0), and to Section 4.3.2.2 for programwarning/error codes (4x+1).






4.1.3 G392 Configuration Table

You MUST fill in all pertinent values in the configuration table usingeither the reference data editor in Modsoft or Concept, or the DX Zoomscreens in Modsoft, or Meter Manager (offered by Starling Associates)refer to Appendix C. The following three tables (inputs, outputs andoptional outputs) lists all of the configuration parameters that MUST befilled in. Some of these variables use multiple registers to hold thespecific configuration parameters required. Refer to Section 4.1.3.1,Section 4.1.3.2, and Section 4.1.3.3 below.

Warning! Only valid entries are allowed; entries outside thevalid ranges are not accepted in either Modsoft, Concept orMeter Manager. Illegal entries result in errors or warnings.



4.1.3.1 Inputs

G392 Gas Flow Configuration Table Description

Inputs Description




4x+3: 7 ... 8 Compressibility User Input Type: 1=Density at flowing and base condition, 2=Com-pressibility factor at flowing and base conditions and gas relative density at baseconditions

4x+3: 9 ... 10 Optional Outputs: 1=Yes, 2=No *When using only the standard outputs (see Sec-tion 4.1.3.2) the loadable uses 157 4x registers. When using the optional outputs(see Section 4.1.3.3) the loadable uses 181 4x registers.





4x+4: 3 ... 6 Load Command:: 0=Ready to Accept Command, 1=CMD: Send Configuration toInternal Table from 4X, 2=CMD: Read Configuration from Internal Table to 4X,3=CMD: Reset API 21.1 Configuration Change Log, (Commands 3 ... 15 Reserved)


4x+4: 9 ... 10 Reserved for Future Use






























4x+40 ... 41 Measured Meter Tube Internal Diameter Temperature, Tr (32<=Tr<77°F)(0<=Tr<25°C)



4x+46 ... 57 Reserved for Future Use (Do not use)









4x+83 ... 84 Density at Flowing Conditions, (ρf) (0<ρf<100.0lbm/ft3) (0< ρf<1601.846kg/m3)

4x+85 ... 86 Density at Base Conditions (ρb)(0<ρb<100.0lbm/ft3) (0< ρb<1601.846kg/m3)

4x+87 ... 88 Compressibility Factor at Flowing Conditions (Zf) (0<Zf<3)

4x+89 ... 90 Compressibility Factor at Base Conditions (Zb) (0<Zb<3)

4x+91 ... 92 Gas Relative Density at Base Conditions (Gr) (0.07<=Gr<1.52)


4.1.3.2 Outputs

G392 Gas Flow Configuration Table Description

Outputs Description






















G392Gas Flow Configuration Table Description

OptionalOutputs

Description











4x+176 ... 177 Volume Flow Rate at Flowing Conditions, (Tf ,Pf ), Qf






Step 1 Choose the G392 Loadable now.

Step 2 Place your cursor onto the top node of the Gas block and type #0001and press enter.

Step 3 Place your cursor onto the middle node of the Gas block and enter your4x register and press enter.

Step 4 Place your cursor onto the bottom node of the Gas block and type#0017 and press enter.

Step 5 Place your cursor onto the Gas Flow Block and hit ALTZ to pull-up theGas Flow zoom screens. At this point you may set your parametersbased upon your application and the details of the Gas Flow Blockfound in Gas Flow Configuration Table, Section 4.3.


Note: You may wish to refer to Section 4.4 for possible configurationexamples for the G392 Block.

Note: To access the help screen for the G392 Block place your cursoron the G392 Block and hit ALTH.


Utility Hex Dec Bin Goto QuitF1-----G392_2-----F3-------F4-- DX Zoom Editor -------F7-Lev 8-F8-OFF---F9-----+

G392:AGA3 1992 Page 1 / 13







Figure 64 G392 Zoom Screen 1 of 13


G392:AGA3 1992 Page 2 / 13






4X+3:7-8 Compressibility User Input Type 40204 07:08 = 1 DEC(1-Density at Flowing and Base Conditions)(2-Compressibility Factor at Flowing and Base Conditionsand Gas Relative Density at Base Conditions)





G392:AGA3 1992 Page 3 / 13

Compressibility User Input Type 14X+83-84 Density at Flowing Conditions(rhof) 40284 FLT32 = 100.

(0<rhof<100 lbm/ft^3 or 0<rhof<1601.84 kgm/m^3)4X+85-86 Density at Base Conditions(rhob) 40286 FLT32 = 10.

(0<rhob<100 lbm/ft^3 or 0<rhob<1601.84 kgm/m^3)

Compressibility User Input Type 24X+87-88 Compressibility Factor at Flowing 40288 FLT32 = 0.

Conditions(Zf)(0<Zf<3)4X+89-90 Compressibility Factor at Base 40290 FLT32 = 0.

Conditions(Zb)(0<Zb<3)4X+91-92 Gas Relative Density at Base 40292 FLT32 = 0.

Conditions(Gr)(0.07<=Gr<1.52)

Other4X+79-80 Atmospheric Pressure, Pat 40280 FLT32 = 0.

(3<=Pat<30psia / 20.68<=Pat<206.8kPa)4X+81-82 Low Flow Cutoff 40282 FLT32 = 10.

(>=0 ft^3/Hr / >=0 m^3/Hr)Page up/down for next screen



G392:AGA3 1992 Page 4 / 13

Input Registers









G392:AGA3 1992 Page 5 / 13













G392:AGA3 1992 Page 6 / 13












G392:AGA3 1992 Page 7 / 13



(13<=Pb<16 psia / 89.63<=Pb<110.32 kPa)

Other








G392:AGA3 1992 Page 8 / 13



4X+71-72 Meter ID (+-2147483647) 40272 INT32 = 1 DEC










G392:AGA3 1992 Page 9 / 13








G392:AGA3 1992 Page 10 / 13

OUTPUTS


(0:False 1:True)

Live Quantities







OUTPUTS..Continuation G392:AGA3 1992 Page 11 / 13






G392:AGA3 1992 Page 12 / 13

Optional Outputs

4X+156-157 Compressibility at Flowing 40357 FLT32 = 0.Conditions (Tf , Pf ), Zf

4X+158-159 Compressibility at Base 40359 FLT32 = 0.Conditions (Tb , Pb ), Zb

4X+162-163 Density at Fluid Flowing 40363 FLT32 = 100.Conditions(lbm/ft^3 or kg/m^3)

4X+164-165 Density of Fluid at Base 40365 FLT32 = 10.Conditions(lbm/ft^3 or kg/m^3)







G392:AGA3 1992 Page 13 / 13





End of G392 Zoom Screens





The following is a detailed description of each of the configurationvariables for the G392 gas flow function block: input, output andoptional output variables. When applicable, the reference publication,page number, and formula number are provided noting where thisvariable may be found. AGA#3 refers to AGA Report No.3, Part 3, 1992(aka GPA 8185, Part 3; ANSI/API 2530 1991). AGA#8 refers to AGAReport No. 8, 1992 (aka API 14.2). API#21 refers to API 21.1, 1993.AGA stands for the American Gas Association.

4.3.1 Gas Flow Configuration Table (Inputs)

The following is a detailed description of each of the input variables tothe G392 gas flow function block.



Reference None


Construction material of the Meter Tube. The orifice material may beset to either stainless steel, carbon steel or monel. Two bits are assignedfor the input of this variable. Enter 1 for stainless steel, 2 for carbonsteel, or 3 for monel.



Construction material of the Orifice Plate. The orifice material may beset to either stainless steel, carbon steel or monel. Two bits are assignedfor the input of this variable. Enter 1 for stainless steel, 2 for carbonsteel, or 3 for monel.



4.3.1.4 Compressibility User Input Type (4x +3 bits 7 ... 8)

The gas may be characterized by one of two methods. Enter 1 fordensity at flowing and base condition, or enter 2 for compressibilityfactor at flowing and base conditions and gas relative density at baseconditions.

Reference: None


You may select optional outputs that may be desirable, yet not requiredin all cases. Simply enter 1 to turn optional outputs on or 2 to turnoptional outputs off. Two bits are assigned to specify this selection.When set to 2 (turned off) the output registers for the optional outputsare not used by G392. When using only the standard outputs (SeeSection 4.1.3.2) the loadable uses 157 4x registers. When using theoptional outputs (See Section 4.1.3.3) the loadable uses 181 4x registers.

Reference: None



Reference: None



Reference: None







Reference: None

4.3.1.10 Input Type (4x +4 bits 7 ... 8)


Reference: None



Reference: None


To cover a wider range of pressure differential, G392 allows the use oftwo staggered range differential pressure measurement devices. Youmay specify either single or dual differential pressures scales. Two bitsare assigned for the input of this variable. Set the variable to 1 for twodifferential pressure scales, or set to 2 for single differential range.

Reference: None



Reference: None



You may select one of four different averaging methods suggested by(API21.1). Two bits are assigned for the input of this variable. Set thevariable to 0 for flow dependent time weighted linear averagingtechnique, 1 for flow dependent time weighted formulaic averagingtechnique, 2 for flow weighted linear averaging technique, or 3 for flowweighted linear formulaic averaging technique.




Reference: None



US Metric (SI)

Temperature °F °C



kPa

Length Inches mm

Volume SCFD Sm3/D

Mass Lbm/hr kg/D


Viscosity cP cP



Reference: None



Reference: API21.1




Reference: None




Reference: None




This field may be used to hold a pointer to the 3X address containing theappropriate analog input value or as a 4X holding register containing theactual input value. When Input Type (4X +4 bits 7 ... 8) is 2 this register(4X+8) holds the input value for differential pressure 1. When InputType (4X +4 bits 7 ... 8) is 1 this register (4X+8) is a pointer to the 3Xaddress used for the differential pressure 1 input. For 30004 the entryfor differential pressure 1 3X pointer or 4X register would be 4. YouMUST enter the register pointer for static pressure as an unsigneddecimal value. G392 allows two differential pressure input devices ofdifferent ranges that provides a higher accuracy over a wider range.

Reference: None



This field may be used to hold a pointer to the 3X address containing theappropriate analog input value or as a 4X holding register containing theactual input value. When Input Type (4X +4 bits 7 ... 8) is 2 this register(4X+9) holds the input value for differential pressure 2. When InputType (4X +4 bits 7 ... 8) is 1 this register (4X+9) is a pointer to the 3Xaddress used for the differential pressure 2 input. For 30005 the entryfor differential pressure 2 3X pointer or input value would be 5. YouMUST enter the register pointer for static pressure as an unsigneddecimal value. G392 allows two differential pressure input devices ofdifferent ranges that provides a higher accuracy over a wider range.

Reference: None




Reference: None




Reference: None



Reference: None



Reference: None



Reference: None



Reference: None




Reference: None



Reference: None



Reference: None



Reference: None



Reference: None




Reference: None



Reference: None



Reference: None



Reference: None



Reference: None



The orifice plate bore diameter (measured at reference temperature),dr=inches or mm and MUST be entered as a floating point number. Thevalid entry range is 0<dr<100.0.




















Reference: None












Reference: None



Reference: None




Reference: None

4.3.1.51 Low Flow Cut Off (4x +81 ... 82)

Refers to the volumetric flow rate under which zero flow is recorded.The valid entry range is >=0ft3 /Hr.

Reference: None

4.3.1.52 Density at Flowing Conditions, ρf (4x +83 ... 84)

This value is the mass of a gas per unit of volume at flowing conditions.In US units the density at flowing conditions corresponds to themass-pounds of gas contained in a volume of ft3 at flowing conditions(Tf, Pf).


4.3.1.53 Density at Base Conditions, ρb (4x +85 ... 86)

This value is the mass of a gas per unit of volume at base conditions(contract reference conditions) In US units the density at baseconditions corresponds to the mass-pounds of gas contained in a volumeof 1 ft3 at base conditions (Tb, Pb).


4.3.1.54 Compressibility Factor at Flowing Conditions Zf (4x +87 ... 88)

This value is the measure of the deviation of the gas from ideal behaviorsuch that PV=ZnRT. The compressibility factor is a function oftemperature, pressure and the composition of the gas. Thecompressibility factor at flowing conditions (Zf) corresponds to Z atflowing conditions (Tf, Pf).



4.3.1.55 Compressibility Factor at Base Conditions Zb (4x +89 ... 90)

This value is the measure of the deviation of the gas from ideal behaviorsuch that PV=ZnRT. The compressibility factor is a function oftemperature, pressure and the composition of the gas. Thecompressibility factor at base conditions (Zb) corresponds to Z at baseconditions (Tb, Pb).


4.3.1.56 Gas Relative Density at Base Conditions Gr (4x +91 ... 92)

This value corresponds to the ratio of the mass density of the gas at baseconditions over the mass density of air at base conditions. Gas relativedensity at base conditions is not expressed in any units.




Reference: None

4.3.2 Gas Flow Output Table

The following is a detailed description of each of the output variablesfrom the G392 gas flow function block.





DisplayedCode

Type ofCode

Description













DisplayedCode

Type ofCode

Description






















157 Error Flowing or base density is0.0<ρ<=100.00.0<ρ<=1601.846



160 Error Isentropic exponent <= 1.0 or=> 2.0







170 Error Dm <= 0.0

171 Error 0.0<Zb or Zf<=3.0

172 Error 0.07<=Gr<=1.52



192 Error User input type has not been se-lected as 1 or 2










This value is the temperature at fluid flowing conditions Tf=°F or (°C).Reference: AGA#3, pp5, formula#3-2

4.3.2.5 Pressure, Pf (4x +127 ... 128)




















Reference: None




Reference: None



Reference: None



Reference: None


These bits are reserved with API21.1. Refer to Appendix A.

Reference: None



Reference: None


This bit goes on each time the flow block completes one solve. When thisbit stops the block has stopped solving the flow equation.

Reference: None


This heartbeat occurs once per second when the flow block isfunctioning correctly. When the flow block stops functioning properlythe heartbeat stops.

Reference: None


4.3.2.19 End of Day (4x +155: 16)


Reference: None


4.3.3 Gas Flow Output Table (Optional Outputs)

The following is a detail description of each of the optional outputvariables from the G392 gas flow function block.


This value is calculated by G392 gas flow function block.






This register is reserved for future use, and therefore may not be used.

Reference: None


This value ρt,p=lbm/ft3 or (kg/m3) is calculated by G392 gas flow functionblock.



This value ρb=lbm/ft3 or (kg/m3) is calculated by G392 gas flow functionblock.





Reference: None













4.3.3.11 Volume Flow Rate at Flowing Conditions Use, (Tf,Pf), Qf (4x+176 ... 177)


Reference: None


This register is reserved for future use, and therefore may not be used.

Reference: None






Using the inputs given with the G392 function block you should obtainthe same outputs as noted below for the application example thatcalculates a volumetric flow rate. They may be used to: troubleshoot,measure accuracy, compare different inputs and how they affect the flowrate.



G392:AGA3 1992 Page 1 / 13







Figure 77 G392 Example Screen 1 of 13



G392:AGA3 1992 Page 2 / 13






4X+3:7-8 Compressibility User Input Type 40204 07:08 = 1 DEC(1-Density at Flowing and Base Conditions)(2-Compressibility Factor at Flowing and Base Conditionsand Gas Relative Density at Base Conditions)




G392:AGA3 1992 Page 3 / 13

Compressibility User Input Type 14X+83-84 Density at Flowing Conditions(rhof) 40284 FLT32 = 32.783

(0<rhof<100 lbm/ft^3 or 0<rhof<1601.84 kgm/m^3)4X+85-86 Density at Base Conditions(rhob) 40286 FLT32 = 1.86131

(0<rhob<100 lbm/ft^3 or 0<rhob<1601.84 kgm/m^3)

Compressibility User Input Type 24X+87-88 Compressibility Factor at Flowing 40288 FLT32 = 0.5956

Conditions(Zf)(0<Zf<3)4X+89-90 Compressibility Factor at Base 40290 FLT32 = 1.8186

Conditions(Zb)(0<Zb<3)4X+91-92 Gas Relative Density at Base 40292 FLT32 = 0.4596

Conditions(Gr)(0.07<=Gr<1.52)

Other4X+79-80 Atmospheric Pressure, Pat 40280 FLT32 = 0.

(3<=Pat<30psia / 20.68<=Pat<206.8kPa)4X+81-82 Low Flow Cutoff 40282 FLT32 = 10.

(>=0 ft^3/Hr / >=0 m^3/Hr)Page up/down for next screen




G392:AGA3 1992 Page 4 / 13

Input Registers








G392:AGA3 1992 Page 5 / 13


Engineering Unit Limits4X+18-19 Temperature Minimum (-200 to 760 F/ 40219 FLT32 = -50.












G392:AGA3 1992 Page 6 / 13


4X+36-37 Measured Orifice Plate Bore Diameter 40237 FLT32 = 15.5556Temperature, Tr (32<=Tr<77F / 0<=Tr<25C)



4X+40-41 Measured Meter Tube Internal Diameter 40241 FLT32 = 15.5556Temperature, Tr(32<=Tr<77F / 0<=Tr<25C)






G392:AGA3 1992 Page 7 / 13

Reference Conditions4X+42-43 Base Temperature, Tb 40243 FLT32 = 15.5556


(13<=Pb<16 psia / 89.63<=Pb<110.32 kPa)

Other



4X+60-61 Absolute Viscosity of Flowing 40261 FLT32 = 1.352E-02Fluid (cP)(0.005<=cP<=0.5)






G392:AGA3 1992 Page 8 / 13



4X+71-72 Meter ID (+-2147483647) 40272 INT32 = 1234567 DEC









G392:AGA3 1992 Page 9 / 13









G392:AGA3 1992 Page 10 / 13

OUTPUTS


(0:False 1:True)

Live Quantities

4X+125-126 Temp. @ Flowing Conds.,Tf(F/C) 40326 FLT32 = 2.119276E-064X+127-128 Pressure,Pf(psia/kPa) 40328 FLT32 = 10004X+129-130 Differential Press.,hw(in H2O/kPa) 40330 FLT32 = 2.54X+131-132 Integral Value,IV 40332 FLT32 = 50.04X+133-134 Integral Multiplier Value,IMV 40334 FLT32 = 1.8886044X+135-136 Vol. Flow Rate at Base Conditions 40336 FLT32 = 94.43018





OUTPUTS..Continuation G392:AGA3 1992 Page 11 / 13







G392:AGA3 1992 Page 12 / 13

Optional Outputs

4X+156-157 Compressibility at Flowing 40357 FLT32 = 0Conditions (Tf , Pf ), Zf

4X+158-159 Compressibility at Base 40359 FLT32 = 0Conditions (Tb , Pb ), Zb


4X+164-165 Density of Fluid at Base 40365 FLT32 = 1.86131Conditions(lbm/ft^3 or kg/m^3)






G392:AGA3 1992 Page 13 / 13





End of G392 Zoom Screens


GG92 AGA#3 1992 Gross Method Flow Function Block890 USE 137 00 153

Chapter 5GG92 AGA#3 1992 GrossMethod Flow Function Block


V DX Zoom Screens



GG92 AGA#3 1992 Gross Method Flow Function Block 890 USE 137 00154



5.1.1.1 Size

Three nodes high






5.1.1.3 Opcode

1f hex for GG92.EXE file.





4xxxx

GG92System or ProgramErrorMethod

User defined Error



InputsGG92 Gas Flow Block has one control input. The input to the top nodestarts the calculation of the gas flow and should remain ON to continuesolving. The calculations are based on your parameters entered into theinput registers. The input to the middle node allows you to set awarning and log peripheral activities in the audit trail event log withoutstopping the block. The input to the bottom node allows you to set anerror, log peripheral errors in the audit trail event log, and STOP theflow function.

Warning! NEVER detach the top input while the block isrunning. You will generate an error 188 and the data in thisblock could be corrupted..

OutputsGG92 may produce three possible outputs. The outputs from the topnode goes ON while a GG92 operation is in progress. The output fromthe middle node goes ON when GG92 has detected a system or programwarning. The output from the bottom node goes ON when GG92 hasdetected a system or program error. Refer to Section 5.3.2.1 for systemwarning/error codes (4x+0), and to Section 5.3.2.2 for programwarning/error codes (4x+1).





Bottom Node ContentThe integer value entered in the bottom node specifies thecharacterization method—i.e., 1=Gross Method 1 (HV-Gr-CO2), 2=GrossMethod 2 (Gr-CO2-N2). The characterization method must contain aconstant.

Warning! Use only valid entries; others deny access to theblocks DX zoom screens.

5.1.3 GG92 Configuration Table

You MUST fill in all pertinent values in the configuration table usingeither the reference data editor in Modsoft or Concept, or the DX Zoomscreens in Modsoft, or Meter Manager (Offered by Starling Associates,Refer to Appendix C). The following input table lists all of theconfiguration parameters that MUST be filled in. The outputs andoptional outputs show the calculation results of the block. Some of thesevariables use multiple registers to hold the specific configurationparameters required. Refer to Section 5.1.3.1, Section 5.1.3.2, andSection 5.1.3.3 below





5.1.3.1 Inputs

GG92 Gas Flow Configuration Table Description

Inputs Description





4x+3: 9 ... 10 Optional Outputs: 1=Yes, 2=No *When using only the standard outputs (see Section5.1.3.2) the loadable uses 157 4x registers. When using the optional outputs (seeSection 5.1.3.3) the loadable uses 181 4x registers.




4x+4: 3 ... 6 Load Command: 0=Ready to Accept Command, 1=CMD: Send Configuration toInternal Table from 4X, 2=CMD: Read Configuration from Internal Table to 4X,3=CMD: Reset API 21.1 Configuration Change Log, (Commands 3 ... 15 Reserved)





4x+4: 15 ... 16 Averaging Methods: 0=Flow Dependent Time Weighted, 1=Flow Dependent TimeWeighted Formulaic, 2=Flow Weighted Linear, 3=Flow Weighted Linear Formulaic
















4x+18 ... 19 Engineering Unit Temperature Minimum 14 ... 149°F (--10 ... 65°C)

4x+20 ... 21 Engineering Unit Temperature Maximum 14 ... 149°F (--10 ... 65°C)


4x+22 ... 23 Engineering Unit Pressure Minimum > minimum<= 1740psia ( > minimum<=11,996kPa)

4x+24 ... 25 Engineering Unit Pressure Maximum > minimum<= 1740psia ( > minimum<=11,996kPa)













4x+50 ... 51 Reference Temperature for Molar Density, Td (32.0<=Td<77.0°F) (0<=Td<25°C)

4x+52 ... 53 Reference Pressure for Molar Density, Pd (13.0<=Pd<16.0PSIA)(89.63<=Pd<110.32kPa)

4x+54 ... 55 Reference Temperature for Heating Value, Th (32.0<=Th<77.0°F) (0<=Th<25°C)



4x+60 ... 61 Absolute Viscosity of Flowing Fluid, cP (0.01<=Viscosity<=0.1)

4x+62 ... 63 Isentropic Exponent k, (1<=k<2)






4x+85 ... 86 Mole % of Nitrogen, xi (0.0<=xi<=50) (Required for method 2 ONLY)




4x+93 ... 94 Specific Gravity, Gr (Gas Relative Density) (.55<=Gr<0.87)

4x+95 ... 96 Heating Value, HV (477<=HV<1211BTU/Ft3) (17.7725<=HV<45.1206Kj/dm3) (Re-quired for method 1 ONLY)



5.1.3.2 Outputs


Outputs Description






















OptionalOutputs

Description




4x+162 ... 163 Density at Fluid Flowing Conditions, ρT,p








4x+176 ... 177 Volume Flow Rate at Flowing Conditions, (Tf,Pf), Qf


4x+180 Orfice Plate Coefficient of Discharge Bounds Flag within Iteration Scheme, Cd-f




Step 1 Choose the GG92 Loadable now.



Step 4 Place your cursor on the bottom node of the Gas block, type #1 forGross method 1 or #2 for Gross Method 2 and press enter.


Step 6 Enter the required information into the following 14 DX Zoom screens.Gross Method 1 uses 14 unique DX Zoom screens just for this method.Refer to Section 5.2.1. Gross Method 2 uses 14 unique DX Zoomscreens just for this method. Refer to Section 5.2.2. Ensure you referto the correct set of DX Zoom screens based upon the desired method.

Note: To access the help screen for the GG92 Block place your cursoron the GG92 Block and hit ALTH.


5.2.1 Gross Method 1 DX Zoom Screens

Utility Hex Dec Bin Goto QuitF1-----GG92_2-----F3-------F4-- DX Zoom Editor -------F7-Lev 8-F8-OFF---F9-----+

GG92: AGA8 92 Gross Method 1 and AGA3 1992 Page 1 / 14








Figure 90 GG92 Zoom Screen 1 of 14, Gross Method 1













Input Registers











-10 to 65 C)4X+20-21 Temperature Maximum (-14 to 149 F/ 40221 FLT32 = 100.

-10 to 65 C)4X+22-23 Pressure Min. (> 0 to 1,740 psia 40223 FLT32 = 0.

/ > 0 to < 11,996 kPa)4X+24-25 Pressure Max. (> 0 to 1,740 psia 40225 FLT32 = 1700.

/ > 0 to < 11,996 kPa)4X+26-27 Differential Pressure 1 Minimum 40227 FLT32 = 0.





















40282 FLT32 = 10.4X+81-82 Low Flow Cutoff

(>=0 ft^3/Hr / >=0 m^3/Hr)Gas Characterization

4X+87-88 Mole % of Carbon Dioxide (0<=xi<=30) 40288 FLT32 = 5.4X+89-90 Mole % of Hydrogen (0<=xi<=10) 40290 FLT32 = 5.4X+91-92 Mole % of Carbon Monoxide (0<=xi<=3) 40292 FLT32 = 3.4X+93-94 Relative Density (0.55<=Gr<0.87) 40294 FLT32 = 0.664X+95-96 Volumetric Gross Heating Value, HV 40296 FLT32 = 477.

(477<=HV<1211 Btu/ft^3 / 17.7725<=HV<45.1206 Kj/dm^3)








(13<=Pb<16 psia / 89.63<=Pb<110.32 kPa)4X+46-47 Ref. Temperature for Relative 40247 FLT32 = 60.


Pgr(13<=Pgr<16 psia / 89.63<=Pgr<110.32 kPa)4X+50-51 Ref. Temperature for Molar 40251 FLT32 = 60.

Density, Td(32<=Td<77 F / 0<=Td<25 C)4X+52-53 Ref. Press. for Molar Density 40253 FLT32 = 14.73

Pd(13<=Pd<16 psia / 89.63<=Pd<110.32 kPa)4X+54-55 Ref. Temperature for Heating 40255 FLT32 = 60.

Value, Th(32<=Th<77 F / 0<=Th<25 C)





Other












4X+71-72 Meter ID (+-2147483647) 40272 INT32 = 123456789 DEC



















OUTPUTS


(0:False 1:True)

Live Quantities















Optional Outputs
















End of GG92 Zoom Screens



5.2.2 Gross Method 2 DX Zoom Screens























Input Registers




































(>=0 ft^3/Hr / >=0 m^3/Hr)Gross Method 2

4X+85-86 Mole % of Nitrogen (0<=xi<=50) 40286 FLT32 = 5.4X+87-88 Mole % of Carbon Dioxide (0<=xi<=30) 40288 FLT32 = 5.4X+89-90 Mole % of Hydrogen (0<=xi<=10) 40290 FLT32 = 5.4X+91-92 Mole % of Carbon Monoxide (0<=xi<=3) 40292 FLT32 = 3.4X+93-94 Relative Density (0.55<=Gr<0.87) 40294 FLT32 = 0.66













Value, Th(32<=Th<77 F / 0<=Th<25 C)





Other












4X+71-72 Meter ID (+-2147483647) 40272 INT32 = 123456789 DEC



















OUTPUTS


(0:False 1:True)

Live Quantities















Optional Outputs





















The following is a detailed description of configuration variables for theGG92 gas flow function block: input, output and optional outputvariables. When applicable, the reference publication, page number, andformula number are provided noting where this variable may be found.AGA#3 refers to AGA Report No.3, Part 3, 1992 (aka GPA 8185, Part 3;ANSI/API 2530 1991). AGA#8 refers to AGA Report No. 8, 1992 (akaAPI 14.2). API#21 refers to API 21.1, 1993. AGA stands for theAmerican Gas Association.


The following is a detailed description of each of the input variables tothe GG92 gas flow function block.



Reference None









Reference: None



You may select optional outputs that may be desirable, yet not requiredin all cases. Simply enter 1 to turn optional outputs on or 2 to turnoptional outputs off. Two bits are assigned to specify this selection.When set to 2 (turned off) the output registers for the optional outputsare not used by GG92. When using only the standard outputs (seeSection 5.1.3.2) the loadable uses 157 4x registers. When using theoptional outputs (see Section 5.1.3.3) the loadable uses 181 4x registers.

Reference: None



Reference: None



Reference: None






Reference: None


5.3.1.10 Input Type (4x +4 bits 7 ... 8)


Reference: None



Reference: None


To cover a wider range of pressure differential, GG92 allows the use oftwo staggered range differential pressure measurement devices. Youmay specify either single or dual differential pressures scales. Two bitsare assigned for the input of this variable. Set the variable to 1 for twodifferential pressure scales, or set to 2 for single differential range.

Reference: None



Reference: None







Reference: None



US Metric (SI)

Temperature °F °C



kPa

Length Inches mm

Volume SCFD Sm3/D

Mass Lbm/hr kg/D


Viscosity cP cP

Heat Value BTU/ft3 Kj/dm3



Reference: None



Reference: API21.1




Reference: None




Reference: None




This field may be used to hold a pointer to the 3X address containing theappropriate analog input value or as a 4X holding register containing theactual input value. When Input Type (4X +4 bits 7 ... 8) is 2 this register(4X+8) holds the input value for differential pressure 1. When InputType (4X +4 bits 7 ... 8) is 1 this register (4X+8) is a pointer to the 3Xaddress used for the differential pressure 1 input. For 30004 the entryfor differential pressure 1 3X pointer or 4X register would be 4. YouMUST enter the register pointer for static pressure as an unsigneddecimal value. GG92 allows two differential pressure input devices ofdifferent ranges that provides a higher accuracy over a wider range.

Reference: None



This field may be used to hold a pointer to the 3X address containing theappropriate analog input value or as a 4X holding register containing theactual input value. When Input Type (4X +4 bits 7 ... 8) is 2 this register(4X+9) holds the input value for differential pressure 2. When InputType (4X +4 bits 7 ... 8) is 1 this register (4X+9) is a pointer to the 3Xaddress used for the differential pressure 2 input. For 30005 the entryfor differential pressure 2 3X pointer or input value would be 5. YouMUST enter the register pointer for static pressure as an unsigneddecimal value. GG92 allows two differential pressure input devices ofdifferent ranges that provides a higher accuracy over a wider range.

Reference: None




Reference: None




Reference: None



Reference: None



Reference: None



Reference: None



Reference: None




Reference: None



Reference: None



Reference: None



Reference: None


This is the lower limit (PSI or kPa) of the pressure input device (readfrom the analog input module) in engineering units. You MUST enterthe engineering unit scale minimum for pressure input device as afloating point number. This entry must be made in either absolute orgauge pressure. Refer to Section 5.3.1.7 and Section 5.3.1.55.

Reference: None



This is the upper limit (PSI or kPa) of the pressure input device (readfrom the analog input module) in engineering units. You MUST enterthe engineering unit scale maximum for pressure input device as afloating point number. This entry must be made in either absolute orgauge pressure. Refer to Section 5.3.1.7 and Section 5.3.1.55.

Reference: None



Reference: None



Reference: None



Reference: None



Reference: None



























5.3.1.46 Reference Temperature for Molar Density, Td (4x +50 ... 51)

The reference temperature for molar density, Td=°F or (°C) and MUSTbe entered as a floating point number. The valid entry range is32.0<=Td<77.0.


5.3.1.47 Reference Pressure for Molar Density, Pd (4x +52 ... 53)

The reference pressure for relative density, Pd=PSIA or (kPaA) andMUST be entered as a floating point number. The valid entry range is13.0<=Pd<16.0


5.3.1.48 Reference Temperature for Heating Value, Th (4x +54 ... 55)

The reference temperature for molar density, Th=°F or (°C) and MUSTbe entered as a floating point number. The valid entry range is32.0<=Th<77.0.




Reference: None






The absolute viscosity of flowing fluid, cP MUST be entered as a floatingpoint number. The valid entry range is 0.01<=cP<=0.1.



The isentropic exponent, k MUST be entered as a floating point number.The valid entry range is 1.0<=k<2.0. The recommended value per thestandard is 1.3.




Reference: None



Reference: None



Reference: None


5.3.1.56 Low Flow Cut Off (4x +81 ... 82)


Reference: None



Reference: None

5.3.1.58 Mole Percentage of Nitrogen, Xi (4x +85 ... 86)

This value is the mole percentage for Nitrogen in the gas mixture. Thevalid entry range is 0.0<=Xi<=50. This input is required for method 2ONLY.

Reference: AGA#8, section 8.2.2

5.3.1.59 Mole Percentage of Carbon Dioxide, Xi (4x +87 ... 88)

This value is the mole percentage for Carbon Dioxide in the gas mixture.The valid entry range is 0.0<=Xi<=30.


5.3.1.60 Mole Percentage of Hydrogen, Xi (4x +89 ... 90)

This value is the mole percentage for Hydrogen in the gas mixture. Thevalid entry range is 0.0<=Xi<=10.


5.3.1.61 Mole Percentage of Carbon Monoxide, Xi (4x +91 ... 92)

This value is the mole percentage for Carbon Monoxide in the gasmixture.Reference: AGA#8 section 8.2.2

5.3.1.62 Specific Gravity, Gr (4x +93 ... 94)

This value is the specific gravity of the gas mixture. The valid entryrange is .55<=Gr<0.87.

Reference: AGA#8 section 8.2.2


5.3.1.63 Heating Value, HV (4x +95 ... 96)

This value is the heating value of the gas mixture. The valid entry rangeis 477<=HV<1211BTU/Ft3. This input is required for method 1 ONLY.




Reference: None


The following is a detailed description of each of the output variablesfrom the GG92 gas flow function block.





DisplayedCode

Type ofCode

Description













DisplayedCode

Type ofCode

Description

42 Warning Pressure is <0.0 or >1200 psia(<0.0 or >8273.7084 kPa)

43 Warning Temperature is <32 or >130 (<0 or>54.4444°C)



72 Warning For methods 1 and 2:

0> (CO2 mole %) >20, or H2 moleand/or CO mole % is a non 0 value,or .55> (specific gravity) >0.8, or

For method 1:

0> (N2 mole %) >20







132 Error Pressure Engineering Units min. ormax. is specified as < 0.0 or > 1740psia (<0.0 or >11,996.8772kPa) ormeasured pressure is <=0.0 or>1740 psia (<0.0 or>11,996.8772kPa)

133 Error Temperature Engineering Units min.or max. is specified as < --14.00001or > 149.00001°F (<--128.89 or>404.444°C) or measured pressureis <=0.0 or >40,000psia

136 Error For methods 1 and 2:

One component mole % is <0 or>100, or 0> (CO2 mole %) >30, or0> (H2 mole %) >10, or0> (CO mole%) >3.0, or

For method 2:

0> (N2 mole %) >50, or the sum ofN2, CO2, H2 and CO mole % >100







154 Error Pipe material is NOT 1,2,3 or

Orifice material is NOT 1 or 2



158 Error Differential pressure EngineeringUnits min. is specified as < 0.0 inH2O (<0.0kPa) or measured differ-ential pressure is <=0 in H2O(<=0.0kPa)

159 Error Viscosity <0.001 or >0.1 cP

160 Error Isentropic exponent <=1 or =>2


162 Error *Inconsistent gas characterization.Invalid derived N2 component. Ap-plies to Method 1 ONLY.

163 Error *Inconsistent gas characterization.Invalid derived second virial coeffi-cient for CO2. Applies to bothMethod 1 and 2.






172 Error For methods 1 and 2:

0.55<= Gr <=0.87

For method 1:

477> HV>1211


190 Error Orifice diameter measurement tem-perature or Tube internal diametermeasurement temperature32<Tr<=77°F (0<Tr<=25°C)


191 Error Characterization method is NOT 1or 2







*NOTE: For errors 162 and 163. The gross method treatment fornatural gas is based on a three component mixture where CO2 andN2 are the only diluents. All hydrocarbon components are collectedinto a single equivalent hydrocarbon component, CH.

For gross method 1, the input parameters are volumetric gross heat-ing value, gas relative density and mole fraction of CO2. This meth-od estimates the fraction of hydrocarbon component based on yourinputs. Then, it estimates the N2 content from the hydrocarboncontent and the CO2 content.

When the estimate of N2 content is negative, your inputs are incon-sistent and error 162 is generated. When this occurs, check yourinputs.

Error 163 is generated when the product of the second virial coeffi-cient for CO2 and the single equivalent hydrocarbon is negative.This occurs when the inputs are incompatible. The square root ofthe referred product is taken in successive steps of the compress-ibility calculation. Error 163 prevents the PLC from attempting tocalculate the square root of a negative number. When error 163occurs, check your inputs.







5.3.2.5 Pressure, Pf (4x +127 ... 128)




















Reference: None




Reference: None



Reference: None



Reference: None



Reference: None



Reference: None



Reference: None



Reference: None


5.3.2.19 End of Day (4x +155: 16)


Reference: None



The following is a detailed description of each of the optional outputvariables from the GG92 gas flow function block.


This value is calculated by GG92 gas flow function block.









This value ρt,p=lbm/ft3 or (kg/m3) is calculated by GG92 gas flow functionblock.



This value ρb=lbm/ft3 or (kg/m3) is calculated by GG92 gas flow functionblock.





Reference: None













5.3.3.11 Volume Flow Rate at Flowing Conditions Use, (Tf,Pf), Qf (4x+176 ... 177)


Reference: None



Reference: None






Using the inputs given with the GG92 function block you should obtainthe same outputs as noted below for the application example thatcalculates a volumetric flow rate. They may be used to: troubleshoot,measure accuracy, compare different inputs and how they affect the flowrate.

Note: This example shows a configuration that although valid isoutside the operating range specified in the 1992 AGA 8 standard.This configuration has non zero entries for hydrogen and carbonmonoxide as shown in the DX zoom screen example. A warning 72would be reported by the block if Mole Percent Limit were enabled.However, the block operates properly and generates valid outputs.











Figure 118 GG92 Example Screen 1 of 14, Gross Method 2













Input Registers





































(>=0 ft^3/Hr / >=0 m^3/Hr)Gross Method 2

4X+85-86 Mole % of Nitrogen (0<=xi<=50) 40286 FLT32 = 1.861314X+87-88 Mole % of Carbon Dioxide (0<=xi<=30) 40288 FLT32 = 0.59564X+89-90 Mole % of Hydrogen (0<=xi<=10) 40290 FLT32 = 1.81864X+91-92 Mole % of Carbon Monoxide (0<=xi<=3) 40292 FLT32 = 0.45964X+93-94 Relative Density (0.55<=Gr<0.87) 40294 FLT32 = 0.5810435












Value, Th(32<=Th<77 F / 0<=Th<25 C)






Other











4X+71-72 Meter ID (+-2147483647) 40272 INT32 = 1234567 DEC



















OUTPUTS


(0:False 1:True)

Live Quantities










4X+139-140 Accum. Vol. Current Day(ft^3/m^3) 40340 FLT32 = 91923.224X+141-142 Accum. Vol. Last Hour(ft^3/m^3) 40342 FLT32 = 10057.724X+143-144 Accum. Vol. Last Day (ft^3/m^3) 40344 FLT32 = 10057.72





Optional Outputs



















GFNX AGA#3 ’85 & NX19 ’68 Flow Function Block890 USE 137 00 207

Chapter 6GFNX AGA#3 ’85 & NX19 ’68Flow Function Block


V DX Zoom Screens



GFNX AGA#3 ’85 & NX19 ’68 Flow Function Block 890 USE 137 00208



6.1.1.1 Size

Three nodes high






6.1.1.3 Opcode

1f hex for GFNX.EXE file.





4xxxx

GFNXSystem or ProgramErrorMethod

User defined Error



InputsGFNX Gas Flow Block has one control input. The input to the top nodestarts the calculation of the gas flow and should remain ON to continuesolving. The calculations are based on your parameters entered into theinput registers. The input to the middle node allows you to set awarning and log peripheral activities in the audit trail event log withoutstopping the block. The input to the bottom node allows you to set anerror, log peripheral errors in the audit trail event log, and STOP theflow function.


OutputsGFNX may produce three possible outputs. The outputs from the topnode goes ON while a GFNX operation is in progress. The output fromthe middle node goes ON when GFNX has detected a system or programwarning. The output from the bottom node goes ON when GFNX hasdetected a system or program error. Refer to Section 6.3.2.1 for systemwarning/error codes (4x+0), and to Section 6.3.2.2 for programwarning/error codes (4x+1).





Bottom Node ContentThe integer value entered in the bottom node specifies thecharacterization method—i.e., 10=Gross Method 1 (Gr-CO2-N2),11=Detail Method 1 (Analysis method), 12=Gross Method 2(HV-CO2-N2, heating value method), 13=Gross Method 3(Gravity-Methane-CO2-N2). The characterization method must containa constant.

Warning! Use only valid entries; others deny access to theblocks DX zoom screens.

6.1.3 GFNX Configuration Table

You MUST fill in all pertinent values in the configuration table usingeither the reference data editor in Modsoft or Concept, or the DX Zoomscreens in Modsoft, or Meter Manager (Offered by Starling Associates,Refer to Appendix C). The following input table lists all of theconfiguration parameters that MUST be filled in. The outputs andoptional outputs show the calculation results of the block. Some of thesevariables use multiple registers to hold the specific configurationparameters required. Refer to Section 6.1.3.1, Section 6.1.3.2, andSection 6.1.3.3 below.





6.1.3.1 Inputs

GFNX Gas Flow Configuration Table Description

Inputs Description



4x+3: 5 ... 6 Orifice Material: 1=Stainless Steel, 2=Monel


4x+3: 9 ... 10 Optional Outputs: 1=Yes, 2=No *When using only the standard outputs (see Section6.1.3.2) the loadable uses 157 4x registers. When using the optional outputs (seeSection 6.1.3.3) the loadable uses 181 4x registers.




4x+4: 3 ... 6 Load Command:: 0=Ready to Accept Command, 1=CMD: Send Configuration toInternal Table from 4X, 2=CMD: Read Configuration from Internal Table to 4X,3=CMD: Reset API 21.1 Configuration Change Log, (4 ... 15 Reserved)





















4x+18 ... 19 Engineering Unit Temperature Minimum -40 ... 240°F (-40 ... 115.5556°C)

4x+20 ... 21 Engineering Unit Temperature Maximum -40 ... 240°F (-40 ... 115.5556°C)


4x+22 ... 23 Engineering Unit Pressure Minimum 0 ... 5,000 psia (0 ... 34473.785kPa)

4x+24 ... 25 Engineering Unit Pressure Maximum 0 ... 5,000 psia (0 ... 34473.785kPa)


















Applies when Using Detail Method (11)











4x+103 ... 104 Mole % of I--Butane, xi (0.0<=xi<=100)

4x+105 ... 106 Mole % of n--Butane, xi (0.0<=xi<=100)

4x+107 ... 108 Mole % of I--Pentane, xi (0.0<=xi<=100)

4x+109 ... 110 Mole % of n--Pentane, xi (0.0<=xi<=100)

4x+111 ... 112 Mole % of Hexane, xi (0.0<=xi<=100)

4x+113 ... 114 Mole % of Heptane, xi (0.0<=xi<=100)

4x+115 ... 116 Mole % of Octane, xi (0.0<=xi<=100)

4x+117 ... 118 Mole % of Nonane, xi (0.0<=xi<=100)


4x+119 ... 120 Mole % of Decane, xi (0.0<=xi<=100)



Applies when Using Gross Methods (10,12,13)

4x+83 ... 84 Mole % of Methane, xi (0.0<=xi<=100) (Required for method 13 ONLY)

4x+85 ... 86 Mole % of Nitrogen, xi (0.0<=xi<=100) (Required for methods 10, 12 & 13)

4x+87 ... 88 Mole % of Carbon Dioxide, xi (0.0<=xi<=100) (Required for methods 10, 12 & 13)

4x+93 ... 94 Specific Gravity (0.07<=Gr<1.52) (Required for methods 10, 12 & 13)

4x+95 ... 96 Heating Value (0<HV<1800) (Required for method 12 ONLY)

6.1.3.2 Outputs


Outputs Description























OptionalOutputs

Description










Step 1 Choose the GFNX Loadable now.



Step 4 Place your cursor on the bottom node of the Gas block, type #10 forGross Method 1 (Gr-CO2-N2), #11 for Detail Method 1 (Gas Analysismethod), #12 for Gross Method 2 (HV-CO2-N2, heating value method),#13 for Gross Method 3 (Gravity-Methane-CO2-N2) and press enter.


Step 6 Enter the required information into the following DX Zoom screens.Gross Method 1 uses 12 unique DX Zoom screens just for this method.Refer to Section 6.2.1. Analysis Method 1 uses 13 unique DX Zoomscreens just for this method. Refer to Section 6.2.2. Gross Method 2uses 12 unique DX Zoom screens just for this method. Refer to Section6.2.3. Gross Method 3 uses 12 unique DX Zoom screens just for thismethod. Refer to Section 6.2.4. Ensure you refer to the correct set ofDX Zoom screens based upon the desired method.

Note: To access the help screen for the GFNX Block place yourcursor on the GFNX Block and hit ALTH.


6.2.1 Gross Method 1 (10) DX Zoom Screens

Utility Hex Dec Bin Goto QuitF1-----GFNX_2-----F3-------F4-- DX Zoom Editor -------F7-Lev 8-F8-OFF---F9-----+

GFNX:NX19 1962, Gravity - %CO2 - %N2 Method and AGA3 1985Page 1 / 12








Figure 132 GFNX Zoom Screen 1 of 12, Gross Method 1













Input Registers











-40 to 115.5556 C)4X+20-21 Temperature Maximum (-40 to 240 F/ 40221 FLT32 = 150.

-40 to 115.5556 C)4X+22-23 Pressure Min. (> 0 to 5,000 psia 40223 FLT32 = 0.













4x+3:5-6 Orifice Material 40204 05:06 = 1 DEC(1-Stainless Steel 2-Monel)











Gas Characterization Method 10 GR - %CO2 - %N2

4X+93-94 Gravity (0.07<=GR<1.52) 40294 FLT32 = 1.4X+87-88 Mole % of CO2 (0<=xi<=100) 40288 FLT32 = 5.4X+85-86 Mole % of Nitrogen (0<=xi<=100) 40286 FLT32 = 5.








(13<=Pb<16 psia / 89.63<=Pb<110.32 kPa)

Other








4X+71-72 Meter ID (+-2147483647) 40272 INT32 = 123456789 DEC



















OUTPUTS


(0:False 1:True)

Live Quantities


(Tb,Pb),Qb (ft^3/hr or m^3/hr)













Optional Outputs

4X+166-167 Supercompressibility (Fpvs) 40367 FLT32 = 1.0751124X+168-169 Gas Relative Density, Gr 40369 FLT32 = 0.55478294X+172-173 Expansion Factor, Y 40373 FLT32 = 0.9997748

End of GFNX Zoom Screens



6.2.2 Detail Method 1 (11) (Gas Analysis) DX Zoom Screens


GFNX:NX19 1962, Gas Analysis Method and AGA3 1985 Page 1 / 13








Figure 144 GFNX Zoom Screen 1 of 13, Detail Method 1 (Gas Analysis)













Input Registers




































Gas Composition Analysis

SUM OF ALL MOLE PERCENTS SHOULD EQUAL 100. ALL RANGES SHOWN ARE ERRORLIMITS. FOR WARNING LIMITS, REFER TO USER DOCUMENTATION.

4X+83-84 Mole % of Methane (0<=xi<=100) 40284 FLT32 = 89.4X+85-86 Mole % of Nitrogen (0<=xi<=100) 40286 FLT32 = 5.4X+87-88 Mole % of CO2 (0<=xi<=100) 40288 FLT32 = 5.4X+89-90 Mole % of Ethane (0<=xi<=100) 40290 FLT32 = 0.4X+91-92 Mole % of Propane (0<=xi<=100) 40292 FLT32 = 0.4X+93-94 Mole % of Water (0<=xi<=100) 40294 FLT32 = 1.4X+95-96 Mole % of H2S (0<=xi<=100) 40296 FLT32 = 1.





GFNX:NX19 1962, Gas Analysis Method and AGA3 1985 Page 7 / 13Gas Composition Analysis (continued)

4X+97-98 Mole % of Hydrogen (0<=xi<=100) 40298 FLT32 = 0.4X+99-100 Mole % of Carbon Monoxide(0<=xi<=100)40300 FLT32 = 0.4X+101-102 Mole % of Oxygen (0<=xi<=100) 40302 FLT32 = 0.4X+103-104 Mole % of I-Butane (0<=xi<=100) 40304 FLT32 = 0.4X+105-106 Mole % of n-Butane (0<=xi<=100) 40306 FLT32 = 0.4X+107-108 Mole % of I-Pentane (0<=xi<=100) 40308 FLT32 = 0.4X+109-110 Mole % of n-Pentane (0<=xi<=100) 40310 FLT32 = 0.4X+111-112 Mole % of Hexane (0<=xi<=100) 40312 FLT32 = 0.4X+113-114 Mole % of Heptane (0<=xi<=100) 40314 FLT32 = 0.4X+115-116 Mole % of Octane (0<=xi<=100) 40316 FLT32 = 0.4X+117-118 Mole % of Nonane (0<=xi<=100) 40318 FLT32 = 0.4X+119-120 Mole % of Decane (0<=xi<=100) 40320 FLT32 = 0.4X+121-122 Mole % of Helium (0<=xi<=100) 40322 FLT32 = 0.







(13<=Pb<16 psia / 89.63<=Pb<110.32 kPa)

Other









4X+71-72 Meter ID (+-2147483647) 40272 INT32 = 123456789 DEC



















OUTPUTS


(0:False 1:True)

Live Quantities















Optional Outputs






GFNX:NX19 1962, Heating Value - CO2 - N2 Method and AGA3 1985Page 1 / 12





















Input Registers




































Heating Value - %CO2 - %N2

4X+93-94 Gravity (0.07<=GR<1.52) 40294 FLT32 = 1.

4X+95-96 Gross Heating Value 40296 FLT32 = 1.(0<HV<1800 Btu/ft^3)

4X+87-88 Mole % of CO2 (0<=xi<=100) 40288 FLT32 = 5.4X+85-86 Mole % of Nitrogen (0<=xi<=100) 40286 FLT32 = 5.







(13<=Pb<16 psia / 89.63<=Pb<110.32 kPa)

Other









4X+71-72 Meter ID (+-2147483647) 40272 INT32 = 123456789 DEC



















OUTPUTS


(0:False 1:True)

Live Quantities















Optional Outputs






GFNX:NX19 1962, Gravity - Methane - %CO2 - %N2 Method and AGA3 1985Page 1 / 12





















Input Registers





































Gravity - Methane - %CO2 - %N2

4X+93-94 Gravity (0.07<=GR<1.52) 40294 FLT32 = 1.4X+83-84 Mole % of Methane (0<=xi<=100) 40284 FLT32 = 89.4X+87-88 Mole % of CO2 (0<=xi<=100) 40288 FLT32 = 5.4X+85-86 Mole % of Nitrogen (0<=xi<=100) 40286 FLT32 = 5.







(13<=Pb<16 psia / 89.63<=Pb<110.32 kPa)

Other









4X+71-72 Meter ID (+-2147483647) 40272 INT32 = 123456789 DEC



















OUTPUTS


(0:False 1:True)

Live Quantities















Optional Outputs




Tip: We recommend you review your data entered in all DX Zoomscreens.



The following is a detailed description of configuration variables for theGFNX gas flow function block: input, output and optional outputvariables. When applicable, the reference publication, page number, andformula number are provided noting where this variable may be found.AGA#3 refers to AGA Report No.3, Part 3, 1992 (aka GPA 8185, Part 3,ANSI/API 2530 1991). AGA#8 refers to AGA Report No. 8, 1992 (akaAPI 14.2. API#21 refers to API 21.1, 1993. AGA stands for theAmerican Gas Association.


The following is a detailed description of each of the input variables tothe GFNX gas flow function block.



Reference None





Construction material of the Orifice Plate. The orifice material may beset to either stainless steel, carbon steel or monel. Two bits are assignedfor the input of this variable. Enter 1 for stainless steel, 2 for monel.




Reference: None



You may select optional outputs that may be desirable, yet not requiredin all cases. Simply enter 1 to turn optional outputs on or 2 to turnoptional outputs off. Two bits are assigned to specify this selection.When set to 2 (turned off) the output registers for the optional outputsare not used by GFNX. When using only the standard outputs (SeeSection 6.1.3.2) the loadable uses 157 4x registers. When using theoptional outputs (See Section 6.1.3.3) the loadable uses 181 4x registers.

Reference: None



Reference: None

6.3.1.7 Absolute\Gauge Pressure Switch (4x +4 bit 1)


Reference: None






Reference: None


6.3.1.10 Input Type (4x +4 bits 7 ... 8)


Reference: None



Reference: None


To cover a wider range of pressure differential, GFNX allows the use oftwo staggered range differential pressure measurement devices. Youmay specify either single or dual differential pressures scales. Two bitsare assigned for the input of this variable. Set the variable to 1 for twodifferential pressure scales, or set to 2 for single differential range.

Reference: None



Reference: None







Reference: None



US Metric (SI)

Temperature °F °C



kPa

Length Inches mm

Volume SCFD Sm3/D

Mass Lbm/hr kg/D


Viscosity cP cP

Heat Value BTU/ft3 Kj/dm3



Reference: None



Reference: API21.1


6.3.1.18 Temperature 3X Pointer or 4X Input Value (4x +6)


Reference: None




Reference: None




This field may be used to hold a pointer to the 3X address containing theappropriate analog input value or as a 4X holding register containing theactual input value. When Input Type (4X +4 bits 7 ... 8) is 2 this register(4X+8) holds the input value for differential pressure 1. When InputType (4X +4 bits 7 ... 8) is 1 this register (4X+8) is a pointer to the 3Xaddress used for the differential pressure 1 input. For 30004 the entryfor differential pressure 1 3X pointer or 4X register would be 4. YouMUST enter the register pointer for static pressure as an unsigneddecimal value. GFNX allows two differential pressure input devices ofdifferent ranges that provides a higher accuracy over a wider range.

Reference: None



This field may be used to hold a pointer to the 3X address containing theappropriate analog input value or as a 4X holding register containing theactual input value. When Input Type (4X +4 bits 7 ... 8) is 2 this register(4X+9) holds the input value for differential pressure 2. When InputType (4X +4 bits 7 ... 8) is 1 this register (4X+9) is a pointer to the 3Xaddress used for the differential pressure 2 input. For 30005 the entryfor differential pressure 2 3X pointer or input value would be 5. YouMUST enter the register pointer for static pressure as an unsigneddecimal value. GFNX allows two differential pressure input devices ofdifferent ranges that provides a higher accuracy over a wider range.

Reference: None




Reference: None




Reference: None



Reference: None



Reference: None



Reference: None



Reference: None




Reference: None



Reference: None



Reference: None



Reference: None


This is the lower limit (PSI or kPa) of the pressure input device (readfrom the analog input module) in engineering units. You MUST enterthe engineering unit scale minimum for pressure input device as afloating point number. This entry must be made in either absolute orgauge pressure. Refer to Section 6.3.1.7 and Section 6.3.1.49.

Reference: None



This is the upper limit (PSI or kPa) of the pressure input device (readfrom the analog input module) in engineering units. You MUST enterthe engineering unit scale maximum for pressure input device as afloating point number. This entry must be made in either absolute orgauge pressure. Refer to Section 6.3.1.7 and Section 6.3.1.49.

Reference: None



Reference: None



Reference: None



Reference: None



Reference: None























Reference: None






Reference: None



Reference: None



Reference: None



Reference: None

6.3.1.50 Low Flow Cut Off (4x +81 ... 82)


Reference: None



This range of inputs are the mole percentages for all twenty possible gascomponents. These are ONLY required for Detail Method 11.




Reference: None

6.3.1.53 Mole % of Methane, Xi (4x +83 ... 84)

This value is the mole percentage for Methane in the gas mixture. Thisinput is required for method 13 ONLY.


6.3.1.54 Mole Percentage of Nitrogen, Xi (4x +85 ... 86)

This value is the mole percentage for Nitrogen in the gas mixture. Thisinput is required for methods 10, 12, & 13.


6.3.1.55 Mole Percentage of Carbon Dioxide, Xi (4x +87 ... 88)

This value is the mole percentage for Carbon Dioxide in the gas mixture.This input is required for methods 10, 12, & 13.


6.3.1.56 Specific Gravity, Gr (4x +93 ... 94)

This value is the specific gravity of the gas mixture. The valid range is0.07<=Gr<1.52. This input is required for methods 10, 12, & 13.


6.3.1.57 Heating Value, HV (4x +95 ... 96)

This value is the heating value of the gas mixture. The valid range is0<=HV<1800. This input is required for method 12 ONLY.




The following is a detailed description of each of the output variablesfrom the GFNX gas flow function block.




DisplayedCode

Type ofCode

Description










This field displays a fault code generated by the Gas Flow block. Acomplete list is shown in the table below. Program warning codes doNOT halt the calculation. In contrast, program error codes DO halt the


calculation. When a system or program warning is detected by the blockthe middle output turns ON. When a system or program error isdetected by the block the bottom output turns ON. Refer to the first DXZoom screen to view the program warning/error codes detected by theGas Flow Block.


DisplayedCode

Type ofCode

Description

36 Warning Mole percent exceeds limits. Warn-ing only occurs when the mole per-cent limits are disabled. Refer toError 136 for valid limits.


43 WarningTemperature is <40 or >240 (<--40

or >115.5556°C)


71 Warning Volume flow rate below flow cut off

72 Warning For methods 10, 12, and 13:

specific gravity <=0.07 or >=0.75

CO2 mole % >15 or <0,

N2 mole % >15 or <0







132 Error Pressure Engineering Units min. ormax. is specified as <0.0 or >5,000psia (<0.0 or >34473.785kPa)

133 Error Temperature Engineering Units min.or max. is specified as < --40 or >240°F (<--40 or >115.556°C)


136 Error For methods 10, 12 and 13:

CO2 mole % >100 or <0,

NO2 mole % >100 or <0

For method 11:

Component mole % >100 or <0

For method 13 :

Method mole % >100 or <0






154 Error Pipe material is NOT 1,2,3 or

Orifice material is NOT 1 or 2



158 Error Differential pressure EngineeringUnits min. is specified as <= 0.0 inH2O (<0.0kPa) or measured differ-ential pressure is <=0.0lbm/ft3(<=0.0kg/m3)







172 Error For methods 10, 11 and 13:

0.07<= Gr <=1.52

For method 12:

0>= HV >=1800



190 Error Orifice diameter measurement tem-perature or Tube internal diametermeasurement temperature32<Tr<77°F (0<Tr<25°C)

191 Error Characterization method is NOT 10,11, 12, or 13










This value is the temperature at fluid flowing conditions Tf=°F or (°C).Reference: AGA#3, pp5, formula#3-2

6.3.2.5 Pressure, Pf (4x +127 ... 128)


















Reference: None



Reference: None



Reference: None



Reference: None



Reference: None


6.3.2.15 User Definable Warning/Error (4x +153)


Reference: None



Reference: None



Reference: None



Reference: None

6.3.2.19 End of Day (4x +155: 16)


Reference: None




The following is a detailed description of each of the optional outputvariables from the GFNX gas flow function block.



Reference: None


This value is calculated by GFNX gas flow function block.

Reference: None






Reference: None






Reference: None



Using the inputs given with the GFNX function block you should obtainthe same outputs as noted below for the application example thatcalculates a volumetric flow rate. They may be used to: troubleshoot,measure accuracy, compare different inputs and how they affect the flowrate.











Figure 181 GFNX Example Screen 1 of 13, Detail Method 1 (Gas Analysis)













Input Registers





































Gas Composition Analysis

SUM OF ALL MOLE PERCENTS SHOULD EQUAL 100. ALL RANGES SHOWN ARE ERRORLIMITS. FOR WARNING LIMITS, REFER TO USER DOCUMENTATION.

4X+83-84 Mole % of Methane (0<=xi<=100) 40284 FLT32 = 89.4X+85-86 Mole % of Nitrogen (0<=xi<=100) 40286 FLT32 = 5.4X+87-88 Mole % of CO2 (0<=xi<=100) 40288 FLT32 = 5.4X+89-90 Mole % of Ethane (0<=xi<=100) 40290 FLT32 = 0.4X+91-92 Mole % of Propane (0<=xi<=100) 40292 FLT32 = 0.4X+93-94 Mole % of Water (0<=xi<=100) 40294 FLT32 = 1.4X+95-96 Mole % of H2S (0<=xi<=100) 40296 FLT32 = 1.




GFNX:NX19 1962, Gas Analysis Method and AGA3 1985 Page 7 / 13Gas Composition Analysis (continued)

4X+97-98 Mole % of Hydrogen (0<=xi<=100) 40298 FLT32 = 0.4X+99-100 Mole % of Carbon Monoxide(0<=xi<=100)40300 FLT32 = 0.4X+101-102 Mole % of Oxygen (0<=xi<=100) 40302 FLT32 = 0.4X+103-104 Mole % of I-Butane (0<=xi<=100) 40304 FLT32 = 0.4X+105-106 Mole % of n-Butane (0<=xi<=100) 40306 FLT32 = 0.4X+107-108 Mole % of I-Pentane (0<=xi<=100) 40308 FLT32 = 0.4X+109-110 Mole % of n-Pentane (0<=xi<=100) 40310 FLT32 = 0.4X+111-112 Mole % of Hexane (0<=xi<=100) 40312 FLT32 = 0.4X+113-114 Mole % of Heptane (0<=xi<=100) 40314 FLT32 = 0.4X+115-116 Mole % of Octane (0<=xi<=100) 40316 FLT32 = 0.4X+117-118 Mole % of Nonane (0<=xi<=100) 40318 FLT32 = 0.4X+119-120 Mole % of Decane (0<=xi<=100) 40320 FLT32 = 0.4X+121-122 Mole % of Helium (0<=xi<=100) 40322 FLT32 = 0.








(13<=Pb<16 psia / 89.63<=Pb<110.32 kPa)

Other








4X+71-72 Meter ID (+-2147483647) 40272 INT32 = 123456789 DEC



















OUTPUTS


(0:False 1:True)

Live Quantities















Optional Outputs




API 21.1 Audit Trail890 USE 137 00 267

Appendix AAPI 21.1 Audit Trail

V API21.1 Audit Trail Overview

V API21.1 Audit Trail Configuration Table

V API21.1 Audit Trail Area

API 21.1 Audit Trail268268 890 USE 137 00

A.1 API 21.1 Audit Trail Overview

The API21.1 audit trail feature provide time stamped records in one filethat contains five items listed below. These items provide informationfor accounting purposes, configuration changes for trackingconfiguration parameter changes, and for tracking alarms and errors.The audit trail maintains up to 100 daily records, up to 840 hourlyrecords, up to 250 event records, and up to 250 configuration changerecords.

The related API21.1 audit trail information is stored in the followingorder:

1. Configuration table, that includes the entire gas flow block set upinputs,

2. Daily transaction log, that includes all daily transaction records,

3. Hourly transaction log, that includes all hourly transaction records,

4. Event log, that includes special events that occur during the gasflow calculation.

5. Configuration change log, that includes all changes made to theconfiguration table,

Note: All five items above are referred to as the API21.1 audit trail.

Note: API 21.1 audit trail applies to all the Gas blocks except forGD92.

Caution: To use API 21.1 audit trail with PLCs that do NOTsupport 6x registers you MUST change the heap memory usingthe SET_SIZE.EXE utility.

Note: Total Available Audit Trail Registers for All Meters (Read only)(4x+145 ... 146) will be set to 0, if you do not use the SET_SIZE.EXEutility with these PLCs. Refer to Section B.2 for details usingSET_SIZE.EXE.


A.2 API21.1 Audit Trail Configuration Table

You MUST fill in all pertinent values in the configuration table usingeither the reference data editor in Modsoft or Concept, or the DX Zoomscreens in Modsoft, or Meter Manager (offered by Starling Associates)refer to Appendix C. The following input table lists all of theconfiguration parameters that MUST be filled in. The outputs show thecalculation results of the block. Some of these variables use multipleregisters to hold the specific configuration parameters required. Referto Section A.2.1, Section A.2.2 and Section A.2.3.


A.2.1 Inputs

API21.1 Audit Trail Configuration Table Description

Inputs Description

4x+4: 3 ... 6 Reset Command Flag for the Configuration Change Log: 0=Ready to acceptcommand, 3=Resets configuration change log file and logs the event

4x+5: 15 Configuration Change Log Buffer Type: 0=Locks out additional changesonce full, 1=Keeps changes and wraps (circular buffer)

4x+5: 16 Keep API21.1 Audit Trail Log: 1=Yes (Turn ON API21.1 audit trail), 0=No(Turn OFF API21.1 audit trail)

4x+65 ... 66 Audit Trail Start Register Number

4x+68: 1 ... 8 Desired Number of Daily Records: (0 ... 100)

4x+69 Desired Number of Hourly Records: (0 ... 840)

4x+70: 9 ... 16 Desired Number of Event Records: (0 ... 250)

4x+70: 1 ... 8 Desired Number of Configuration Change Records: (0 ... 250)

4x+71 ... 72 Meter ID: (+/- 2147483647)

Warning: Changes made to any of the above registers(API21.1 Audit Trail Configuration Table Inputs), except for(4x+4: 3 ... 6) results in a complete reset of API21.1 audit traildata. ALL prior API21.1 audit trail related information isdeleted.


A.2.2 Outputs

API21.1 Audit Trail Configuration Table Description

Outputs Description

4x+145 ... 146 Total Available Audit Trail Registers for All Meters (Read only): Total num-ber of audit trail registers available for the entire PLC.

4x+147 ... 148 Ending Audit Trail Register Number for this Meter (Read only): The endingaudit trail register for the meter under configuration.

NOTE: 4x+149 ... 152 are reserved (Do Not Use).

A.2.3 API21.1 Audit Trail Detailed Descriptions

The following is a detailed description of each of the input and outputvariables to the API21.1 audit trail function. API21.1 audit trail refersto the American Petroleum Measurement Standards Chapter 21: FlowMeasurement Using Electronic Metering Systems; Section 1: ElectronicGas Measurement, First Edition, September, 1993.

A.2.3.1 Keep API21.1 Audit Trail Log (4x +5 bits 16)

Use to turn on or off the support of API21.1 audit trail operation for themeter being configured. Set the variable to 1 to use API21.1 audit trailor 0 to NOT use API21.1 audit trail.

Reference: None

A.2.3.2 Audit Trail Start Register Number (4x +65)

Enter the starting API21.1 audit trail register index number for themeter being configured. The API21.1 audit trail area is a memory areaof a number of 16 bit words (registers) indexed from zero to themaximum available. Each meter occupies a portion of this memory inorder to store API21.1 audit trail related data for that meter. You MUSTmanage the audit trail memory area properly so that data from differentmeters do not over write each other. The gas flow blocks DO NOT detectany configuration error caused by overlaying of the memory area.

Reference: None


A.2.3.3 Desired Number of Daily Records (4x +68: 1 ... 8)

Enter the total number of daily records to keep. The legal range is0 ... 100. The typical number for daily records is 32. If for any reasonthe function block determines there is NOT enough space to store therequired records, this register along with Number of Daily Records,Number of Hourly Records, and Number of Event Records in the inputsection automatically resets to 0. The records are stored as a circularbuffer that wraps around to the beginning of the record area when itreaches the end of the record area.

Reference: None

A.2.3.4 Desired Number of Hourly Records (4x +69)

Enter the total number of hourly records to keep. The legal range is0 ... 840. The typical number for hourly records is 70. If a numbergreater than the 840 is entered, the loadable attempts to allocate themaximum allowable and changes the input. If for any reason thefunction block determines there is NOT enough space to store therequired records, this register along with Number of Daily Records,Number of Hourly Records, and Number of Event Records in the inputsection automatically resets to 0. The records are stored as a circularbuffer that wraps around to the beginning of the record area when itreaches the end of the record area.

Reference: None

A.2.3.5 Desired Number of Event Records (4x +70: 9 ... 16)

Enter the total number of event records to keep. The legal range is0 ... 250. The typical number for event records is 100. If a numbergreater than the 250 is entered, the loadable attempts to allocate themaximum allowable and changes the input. If for any reason thefunction block determines there is NOT enough space to store therequired records, this register along with Number of Daily Records,Number of Hourly Records, and Number of Event Records in the inputsection automatically resets to 0. The records are stored as a circularbuffer that wraps around to the beginning of the record area when itreaches the end of the record area.

Reference: None


A.2.3.6 Desired Number of Configuration Change Records (4x +70: 1 ... 8)

Enter the total number of configuration change records to keep. Thelegal range is 0 ... 250. The typical number for configuration changerecords are 100. If a number greater than the 250 is entered, theloadable attempts to allocate the maximum allowable and changes theinput. If for any reason the function block determines there is NOTenough space to store the required records, this register along withNumber of Daily Records, Number of Hourly Records, and Number ofEvent Records in the input section automatically resets to 0. An optionis provided in the configuration table to select either record storage as acircular buffer that wraps around to the beginning of the record areawhen it reaches the end of the record area or stops configurationchanges at the second to the last log until the log is manually reset.

Reference: None

A.2.3.7 Meter ID (4x +71 ... 72)

Enter the ID number of your meter. The legal range is 0 ... 2147483647.

Reference: None

A.2.3.8 Reset Command Flag for the Configuration Change Log (4x +4:3 ... 6)

Enter 3 to reset the configuration change log file. Once done, an event islogged that this was done.

Reference: None

A.2.3.9 Configuration Change Log Buffer Type (4x +5: 15)

Enter 0 or 1. A 0 locks out additional changes once the buffer is full. A1 keeps recording changes and wraps to the beginning once it reachesthe end (circular buffer.)

Reference: None

A.2.4 API21.1 Audit Trail Configuration Output Table

The following is a detailed description of each of the output variables tothe API21.1 audit trail function.


A.2.4.1 Total Available Audit Trail Registers for All Meters (4x +145 ... 146)

Total number of registers available for audit trail registers available forthe entire PLC. On power up this number is calculated and reportedhere. If the PLC does NOT support 6x extended memory, based on thePLC type and the resource available, this number could be a maximumof 128K (131072 words) and as low as 512 words. Each step is 512 wordsso if the space is 1020 words, the PLC allocates only 512 words. For PLCthat support the 6x extended memory area, the entire 6x memoryregisters are reported as available. This memory area is shared by allmeters running in this PLC. This variable is calculated by the Gasfunction block.

Reference: None

A.2.4.2 Ending Audit Trail Register Number for Meters (4x +147-148)

The ending audit trail register for the meter under configuration. For atypical configuration of 35 daily, 168 hourly, 100 event records, and 100Configuration Change records, this register shows a number of (5581+Audit Trail Start Register Number, (4x+65 ... 66)). If for any reason thefunction block determines there is NOT enough space to store therequired records, this register along with Number of Daily Records,Number of Hourly Records, and Number of Event Records in the inputsection automatically resets to 0. This variable is calculated by the Gasfunction block.

Reference: None


A.3 API21.1 Audit Trail Area

The related API21.1 audit trail detail data information is stored in theaudit trail as outlined below.

A.3.1 Configuration Table Data

This area requires 130 words. These words maybe stored in the audittrail area.

Configuration Table Data

Name Description

Version Number Records the version in Hex

Time Stamp Records the time when the configuration was last updated.Obtained from the PLCs internal clock in seconds elapsed since1/1/70. Various applications using a common C library timefunction such as gmttime may be used to convert this informa-tion into a readable format.

Meter FunctionNumber*

Records the top node of the loadable gas block

Meter 4x Offset* Records the middle node of the loadable gas block

Method* Records the bottom node of the loadable gas block

ConfigurationData

Records the entire 4x input configuration parameters. The infor-mation varies with each gas flow block. Refer to the individualgas flow block chapter in this book.

*The top node is NOT used and MUST be set to 1. The middle node is the starting 4xlocation of the meter. The bottom node is the meter method.

A.3.2 Daily Transaction Log Data

This area requires (17 times the number of daily records you entered)words. These words maybe stored in the audit trail area.


Daily Transaction Log Data

Name Description

Record ID Records the daily record ID. It Counts from 0 and up to 100records based on the contents of (4x+68: 1 ... 8). Once themaximum is reached, it resets and starts at 0. When wraparound occurs, the information stored in the records is overwrit-ten they are NOT downloaded.

Time Start Records the time when the day starts. Obtained from the PLCsinternal clock in seconds elapsed since 1/1/70. Various applica-tions using a common C library time function such as gmttimemay be used to convert this information into a readable format.

Day Period Records the total elapsed time in 2 second increments sincetime start.

Flow Time Records the total flow time in 2 second increments since timestart.

Day AccumulatedQb*

Records the accumulated volume for the day at base (Tb+Pb)conditions.

Average Tf Records flowing temperature daily average of the input.

Average Pf Records flowing pressure daily average of the input.

Average HW Records flowing differential pressure daily average of the input.

Average IV Records flowing integral value daily average of the input.

*The method of average is defined in the gas flow block configuration table.

A.3.3 Hourly Transaction Log Data

This area requires (17 times the number of hourly records you entered)words. These words maybe stored in the audit trail area.


Hourly Transaction Log Data

Name Description

Record ID Records the daily record ID. It Counts from 0 and up to 840based on the contents of (4x+69). Once the maximum isreached, it resets and starts at 0. When wrap around occurs, theinformation stored in the records is overwritten if they are NOTdownloaded.

Time Start Records the time when the hour starts. Obtained from the PLCsinternal clock in seconds elapsed since 1/1/70. Various applica-tions using a common C library time function such as gmttimemay be used to convert this information into a readable format.

Hour Period Records the total elapsed time in 2 second increments sincetime start.

Flow Time Records the total flow time in 2 second increments since timestart.

Hour Accumu-lated Qb*

Records the accumulated volume for the hour at base (Tb+Pb)conditions.

Average Tf Records flowing temperature hourly average of the input.

Average Pf Records flowing pressure hourly average of the input.

Average HW Records flowing differential pressure hourly average of the input.

Average IV Records flowing integral value hourly average of the input.

*The method of average is defined in the gas flow block configuration table.

A.3.4 Event Log Data

This area requires (10 times the number of event records you entered)words. These words maybe stored in the audit trail area.


Event Log Data

Name Description

Record ID Records the daily record ID. It Counts from 0 and up to 250based on the contents of (4x+70: 9 ... 16). Once the maximumis reached, it resets and starts at 0. When wrap around occurs,the information stored in the records is overwritten if they areNOT downloaded.

Time Stamp Records the time when the event occurred. Obtained from thePLCs internal clock in seconds elapsed since 1/1/70. Variousapplications using a common C library time function such asgmttime may be used to convert this information into a readableformat.

Type of Event* Records the event type. Defined types: 00*=System Error Reg-isters Value Changed.

01*=Operation Error Registers Value Changed.

02*=API Log Reset or Wrap Around.

03*=Loadable Start/Restart or Halted Event. May result in anew daily record.

Reserved 11 Bits Reserved Do Not Use

Old Value* Records the old value.

New Value* Records the new value.

*These three data fields are used together to provide you with detail audit trail informa-tion. Refer to the section below for more details.

A.3.4.1 System Error Registers Value Changed Event (00)

This type of event (00) occurs when the current system error registervalue changes from what was recorded in the prior scan. When thisevent type occurs the gas flow block records both the old and newwarning/error.

A.3.4.2 Operation Error Registers Value Changed Event (01)

This type of event (01) occurs when the current operation error registervalue changes from what was recorded in the prior scan. When thisevent type occurs the gas flow block records both the old and newwarning/error.

In addition, when you receive either a User Defined Warning (Warning89) or a User Defined Error (Error 189) the 4x+153 User DefinableWarning/Error Value is stored and reported in the audit trail Event logas 89.xxxxx or 189.xxxxx. The prefix denoted the warning/error code,and the suffix denotes the actual value. The value range is 1 ... 65,535.When either the user defined warning or error inputs are activated thevalue in this register will be written into the audit trail event log. Usersmay use program logic to load any number of user defined warnings orerrors representing peripheral control activity. This register will be


cleared (zeroed) after the warning/error has been logged. This is usefulwhen an analog input failure occurs and you want to record the event.

In the example shown in Figure 194 and Figure 195, an ADU 206 Analogmodule is used for the pressure and differential pressure inputs. Ifeither channel 1 or channel 2 are out of range the SENS BIT blocksdetects the error in register 30001. The middle output of the SENS BITblock actives the SUB block placing the designated value (1 or 2) in thisexample into register 40154 (4x+153 User Definable Warning/ErrorValue Register) and coil 00100 is activated stopping the flow functionand generating an API21.1 event log entry. The error in the flowfunction block will be 189. The error in the event log is displayed as189.1.

#0001

#0000

SUB40154

00100

#0009

30001

SENS#0001

#0010

30001

SENS#0001

#0002

#0000

SUB40154

Figure 194 Network #1 using 4x+153

#0001

40001

G392#0017

00100

00101

Figure 195 Network #2 using 4x+153


A.3.4.3 API21.1 Audit Trail Log Reset or Wrap Event (02)

This type of event (02) occurs when the Configuration change log resetcommand bit is set or one of the other log files wrap around. The gasflow block records the time the event occurs. This event normally occurswhen a download of logs occurs. When this type of event occurs the oldvalue register stores the log type, (1=daily log, 2=hourly log, 3=eventlog, or 4=configuration change log). In addition, the new value registerstores the action, (0=reset, 1=wrap, 2=stop).

A.3.4.4 Loadable Start, Halt or Restart Event (03)

A Start event occurs when the PLC and flow function block is startedfirst time. The flow function block records an “End of Hour“ and “Endof Day“ event at this time. These two records are not valid and shouldbe discounted. For a Start event the “Old Value“ register will contain avalue of 0 and the “New Value“ register will contain a value of 1(start/restart event). The gas flow block records the event and beginsthe hourly and daily logs.

A Halt event occurs when the PLC and flow function block has beenrunning and the PLC is stopped and restarted. The flow function blockrecords a valid “End of Hour“ and “End of Day“ event at this time. Inthis case, the “Old Value“ register will contain a 0. The “New Value“register stores a value 0 (halt event). A Halt event is always followed bya Restart event, which indicates the beginning of new hourly and dailylogs.

A Restart event occurs when the PLC has been turned off or stopped,and restarted. The result of this event is similar to a Start event exceptthat the “End of Hour“ and “End of Day“ events are recorded by theHalt event which always precedes a Restart event.

A.3.5 Configuration Change Log Data

This area requires (10 times the number of event records you entered)words. These words maybe stored in the audit trail area.


Configuration Change Log Data

Name Description

Record ID Records the daily record ID. It Counts from 0 and up to 250based on the contents of (4x+70: 1 ... 8). Once the maximum isreached, it resets and starts at 0. When wrap around occurs, theinformation stored in the records are overwritten if they are NOTdownloaded.

Time Stamp Records the time when the event occurred. Obtained from thePLCs internal clock in seconds elapsed since 1/1/70. Variousapplications using a common C library time function such asgmttime may be used to convert this information into a readableformat.

Type of Event* Records the event type. Defined types: 00*=Configuration waschanged. Results in a new daily record.

01*=PLC time modified. Results in a new daily record.

Register Index* Records the configuration register index number. Allows to up2048. Refer to the register index table.

Old Value* Records the old value.

New Value* Records the new value.

*These four data fields are used together to provide you with detail audit trail informa-tion. Refer to the section below for more details.

A.3.5.1 Configuration Change Event (00)

A Configuration Change Event occurs when one or more register valuein the 4X configuration input table is changed and the “Sendconfiguration to internal table from 4X” command is set. The functionblock:

1. Logs the changes,

2. Finishes the current calculation using the old configuration,

3. Records an “End of Hour“ and “End of Day“ event,

4. Copies the new configuration values to the internal configurationtable, and the Audit Trail Configuration log,

5. Resets the “Send configuration to internal table from 4X“command,

6. Resumes normal operations.

When multiple configuration parameters are changed, the function blocklogs each changes with a Configuration Change log entry, however, onlyone configuration change event occurs. Configuration parameters areidentified by a register index number. Refer to Section A.3.5.3 for theRegister Index Numbers and their descriptions.


A.3.5.2 PLC Time Modified Event (01)

A PLC Time Modified Event occurs when the function block detects thePLC “Time of Day Clock“ differs more than 5 seconds from the previousPLC scan. The function block:

1. Logs the event,

2. Finishes the current calculation using the old configuration,

3. Records an “End of Hour“ and “End of Day“ event,

4. Resumes normal operation based on the new time.

If the PLC “Time of Day Clock“ is changed, the function block’saccumulation figures will be affected.

A.3.5.3 Register Index Numbers

When you print the GET_LOGS.EXE file it references the register indexnumbers. The table below lists these numbers and there descriptions.

Register Index Numbers and Description

Number Description

0 Meter Method

4 Optional Output

6 User Input Type

10 Orifice Material

12 Pipe Material

14 Taps Location

16 Average Method

18 Fluid Compressible

20 Dual Range HW

22 Mole % Limits Check

24 Input from 3x or 4x

29 Use Flow Cut Off

30 Gauged Pressure

31 Keep API Logs

32 Configuration Change Log Type

46 Unit Selected

80 API Data Start At

84 Total Daily Records

86 Total Hourly Records

88 Total Event Records

89 Total Configuration Change Records


92 Meter ID

500 Tf 3x Pointer

502 Pf 3x Pointer

504 hw 3x Pointer

506 Dual Range hw 3x Pointer

508 Tf Raw Minimum Scale

510 Tf Raw Maximum Scale

512 Pf Raw Minimum Scale

514 Pf Raw Maximum Scale

516 hw Raw Minimum Scale

518 hw Raw Maximum Scale

520 Dual Range hw Raw Minimum Scale

522 Dual Range hw Raw Maximum Scale

550 Day Starts At

1000 Tf Minimum

1001 Tf Maximum

1002 Pf Minimum

1003 Pf Maximum

1004 hw Minimum

1005 hw Maximum

1006 Dual Range hw Minimum

1007 Dual Range hw Maximum

1008 Orifice Plate Diameter

1009 Orifice Plate Diameter Measurement Temperature

1010 Meter Tube Internal Diameter

1011 Meter Tube Internal Diameter Measurement Temperature

1012 Base Temperature

1013 Base Pressure

1014 Relative Density Reference Temperature

1015 Relative Density Reference Pressure

1016 Calorimeter Density Reference Temperature

1017 Calorimeter Density Reference Pressure

1018 Combustion Reference Temperature

1020 User Input Calibration Factor

1021 Fluid Flowing Absolute Viscosity

1022 Isentropic Exponent

1030 Atmosphere Pressure

1031 Flow Cut Off Level

Detail Method

1032 Methane %

1033 Nitrogen %


1034 CO2 %

1035 Ethane %

1036 Propane %

1037 Water %

1038 H2S %

1039 Hydrogen %

1040 CO %

1041 Oxygen %

1042 I Butane %

1043 N Butane %

1044 I Pentane %

1045 N Pentane %

1046 Hexane %

1047 Heptane %

1048 Octane %

1049 Nonane %

1050 Decane %

1051 Helium %

1052 Argon %

Gross Method

1032 Methane %

1033 Nitrogen %

1034 CO2 %

1035 Hydrogen %

1036 CO %

1037 Specific Gravity

1038 Heating Value

User Input

1032 Flowing Condition Density

1033 Base Condition Density

1034 Flowing Condition Compressibility Factor

1035 Base Condition Compressibility Factor

1036 Base Condition Gas Relative Density

1500 ... 2047 Reserved Do No Use

Utility Functions890 USE 137 00 285

Appendix BUtility Functions

V GET_LOGS.EXE

V SET_SIZE.EXE

Utility Functions286286 890 USE 137 00

B.1 GET_LOGS.EXE

The GET_LOGS.EXE allows you retrieve the API21.1 audit trailinformation from the audit trail memory area of the PLC into your PC.Once in your PC you may use other DOS or Windows applicationsoftware programs to read or rearrange the information based upon yourneeds.

Note: Modbus RTU in Modsoft and in GET_LOGS.EXE are NOTsupported by Windows NT.

B.1.1 Parameters and Switches

The format is:

1 2 3 4

GET-LOGS.EXE [/A=] [/C=m[p1,p2,p3,p4,p5]] [/X=] [/E=] [/R=] [/P=]

5 6

Figure 196 GET_LOGS Format


Get API Format and Switches

Item#

Switch Re-quired

Default Option/Range

Description

1 [/A=o] No 1 1 ... 255 Enter the address of the PLC.When using Modbus this is the actu-al PLC Modbus address. When us-ing Modbus Plus this is the ModbusDevice ID Number to the routing ad-dress map file MBPx.adr. For de-tails on map files refer to SectionB.1.1.1.

2 [/C=m[p1 ... p5]] No mp,5c,0 m=MP/MB

m=MPp1,p2

m=MBp1 ... p5

Enter the desired communicationpath to the PLC and its options asnoted here.

When using MP (Modbus Plus):

p1=Sa85 (Mbp adapter) softwareinterrupt address, (10 ... FF), default=5c

p2=Modbus Plus adapter number,(0 ... 3), default=0

p3 ... p5 are not used

*When using MB (Modbus):

p1=Com port, (1 ... 4), default=1

p2=Baud rate, (50,75,110, 134, 150,300, 600, 1200, 1800, 2000, 2400,3600, 4800, 7200, 9600, 19200),default=9600

p3=Data bits, (8=RTU/7=ASCII), de-fault=8

p4=Stop bit, (1/2), default=1

p5=Parity, (0=none, 1=even,2=odd), default=1

3 [/X=o] No 1 1 ... 65535 Enter the starting 4x location of thedesired meter information you wantuploaded. To choose a starting ad-dress of 400001, just enter 1. Thisswitch automatically searches forthe API21.1 data in the audit trailmemory area of the PLC.

4 [/E=o] No Yes Y, N Enter Y when you want the informa-tion contained in the MES-SAGE.LOG to be displayed on yourPCs screen.


5 [/R=o] No Yes Y, N Enter Y to reset the Config ChangeLog. When Config Change Log isset to flat file mode it automaticallyresets regardless of this switch set-ting. When Config Change Log isset to wrap around file mode the re-set action is determined by thisswitch setting.

6 [/P=o] No None 16 maxi-mum char-acters

Access password. (Reserved forFuture Use).

B.1.1.1 Modbus Plus Network Routing Parameter Map Files

When using Modbus Plus, your host PC can contain up to four ModbusPlus network adapter boards. Your application must have one addressconfiguration file for each board. Their file names must be: MBP0.ADR,MBP1.ADR, MBP2.ADR, MBP3.ADR for boards 0 ... 3. These filesconvert target 984 PLC slave device IDs into network routing paths andnode addresses for the specific network connected at each interfaceboard. Each address file can contain from 1 ... 255 entries. Refer to thetable for the format.

Map File Format with Examples

Modbus deviceID (1 ... 255 indecimal)

Routing by-tes(1.2.3.4.5 indecimal)

Description

2 2.0.0.0.0 Maps Modbus device ID 2 to ModbusPlus node 2 on the local network

10 22.10.0.0.0 Maps Modbus device ID 10 throughBridge Plus node 22 to node 10 on asecond network

200 22.24.12.0.0 Maps Modbus device ID 200 throughBridge Plus nodes 22 and 24 to node 12on a third network

Refer to Modbus Plus Network Planning and Installation Guide (890USE 100 00) for a full description of Modbus Plus routing paths. TheGas Flow Loadable Function Block disk (309 ULD 455 00) comes with asample MBP0.ADR file, that shows examples of how to assign device IDsto network addresses. You can use this file as a template for editing thedevice assignments on your networks or you can create your own files.

Note: These files must reside in the same directory asGET_LOGS.EXE file.


B.1.2 Output Files

Two files are generated when you execute the GET_LOGS.EXE utility.They are the MESSAGE.LOG and M4xxxxx.aaa files. Both files useASCII text format. This allows you to easily read the information usingother DOS or Windows programs.

B.1.2.1 Message.Log File

The MESSAGE.LOG output file logs all communication messages duringthe GET_LOGS.EXE execution time. This is a good tool to determine ifthere are any errors while trying to connect to the PLC. Refer toFigure 197 for an example of an MESSAGE.LOG.

GET_LOGS V0.a1 11/11/1998Gas Flow Loadable Audit Trail Data utilityCurrentPC_Date= 11/17/1998CurrentPC_Time= 11:16:00(mbp_open) mbp_open Command Completed Successfully.(login) Login Command Completed Successfully, Port = 2(OpenPLC) my_login Command OK.(Main) Retrieving Audit Trail data from PLC....(Main) Creating Audit Trail data file: M400201.002(logout) Logout Command Completed Successfully.(mbp_close) mbp_close Command Completed Successfully.

Figure 197 MESSAGE.LOG Example

In this example, the file MESSAGE.LOG recorded the current timestored in your PC when GET_LOGS.EXE was called. Followed by asequence of actions taken by GET_LOGS.EXE in order to complete theupload task. The information in the parentheses ( ) are the names of thefunctions that print out the message and are provided for debuggingpurposes if you need them.

B.1.2.2 M4xxxxx.aaa File

The M4xxxxx.aaa output file contains the API.21.1 audit trail relatedinformation from the desired meter indicated.

The format is:

1 2

M4xxxxx.aaa

Figure 198 GET_LOGS.EXE File Format


GET_LOGS.EXE File Format Descriptions

Field Function Description

1 Starting 4xLocation

Referring to Figure 198. This field is the starting 4x loca-tion you provided when GET_LOGS.EXE was executed.

2 PLC Address This field is the PLC address you provided whenGET_LOGS.EXE was executed. For example,M400010.032 is the output file that contains API21.1 re-lated information from a meter located at PLC Modbusaddress 32 with a starting 4x location of 400010.

Where 1 is the starting 4x location you provided when GET_LOGS.EXEwas executed. Where 2 is the PLC address you provided whenGET_LOGS.EXE was executed. For example, M400010.032 is theoutput file that contains API21.1 audit trail related information from ameter located at PLC Modbus address 32 with a starting 4x location of400010.

B.1.2.3 Output Report Details

Below is an example of an output report for the GM92 block. Theinformation in the output reports vary form block to block. Please referto the individual chapter of the applicable block and to Appendix A forAPI 21.1 audit trail details.

M4xxxxx.aaa File Format StructureRefer to the following as we describe the M4xxxxx.aaa file format andthe six sections of the M4xxxxx.aaa output file.


The information contained in these output files are intended to be usedmostly for other software applications. However, a comment field issometimes displayed for your convince. A comment field always startswith a ( ’ ).

The format is:

1 2

(1030)

3 4

IsentropicExponent= 1.281700

5 6

1 2

(xxxx)

3 4

EventType= 3

5 6

Example B

Example A

’Loadable restart or halted event.

Figure 199 M4xxxxx.aaa File Format

M4xxxxx.aaa File Format Descriptions

Field Function Description

1 Register IndexNumber

Referring to Figure 199, example A and B. This field isoptional and can be up to four numbers. It is mostly seenin the Configuration Table File. Refer to Section A.3.5.3for details on the register index numbers.

2 Variable Name Capital letters indicate the beginning of the word. Whenan abbreviation is used a _ is used to connect the vari-able name.

3 Tab Spaces These allow spread sheet programs such as MicrosoftExcel to easily parse the information into columns of data.

4 Content Value This is a alphanumerical field that shows the actual con-tent of the variable.

5 Optional TabSpaces

These too allow spread sheet programs such as Micro-soft Excel to easily parse the information into columnsof data.

6 Optional Com-ment Field

Available for your comments.


M4xxxxx.aaa File, Header SectionThe first section of the M4xxxxx.aaa output file prints out the companyheader, the utility version number and the name of the output file. Thisis followed with the current time/date information collected from boththe PC and PLC. Refer to Figure 200.

’********************************************************************’Schneider Electric Inc. (r) 1998, 1999’Upload Utility Version 0.a1’Gas Flow Loadable Audit Trail Data File: M400201.002’’ Please refer to Modicon Starling Associates Gas Flow Loadable

Function Block User Guide (890 USE 137 00)’ for information on individual parameters.’********************************************************************CurrentPC_Date= 11/17/1998CurrentPC_Time= 11:16:00CurrentPLC_Date= 11/17/1998CurrentPLC_Time= 11:16:00

Figure 200 M4xxxxx.aaa Head Section Example

M4xxxxx.aaa File, Configuration Table SectionFollowing the header section is the configuration table. The length ofthe configuration table varies slightly among the loadables. This isbecause each loadable requires different configuration parameters to setup. Only those parameters that are required in the loadable arerecorded in the configuration table file. The configuration table filebegins with the loadable block information (its name and versionnumber) and the date and time information when the configurationtable was last updated in the PLC. The configuration table examplesA ... D show the actual running configuration of a meter.


’---------------------- Configuration Table Record ------------LoadableName= GM92LoadableSoftwareVersion= 2a03MeterTopNode= 1Meter4XOffset= 201

RecordStampYear= 1998RecordStampMonth= 11RecordStampDay= 17RecordStampHour= 11RecordStampMinute= 13RecordStampSecond= 21

Figure 201 M4xxxxx.aaa Configuration Table, A Example

(4)OptionalOutput= 1(10)OrificeMaterial= 1(12)PipeMaterial= 3(14)TapsLocation= 2(16)AverageMethod= 1(18)FluidCompressible= 1(20)DualRangeHW= 2(22)MolePercentLimitsCheck= 2(24)InputFrom3X4X= 2(29)UseFlowCutoff= 0(30)GagedPressure= 0(31)KeepAuditTrailLogs= 1(32)ConfigChngLogType= 1(46)UnitSelected= 1(80)AuditTrailStartRegisterNo= 0(84)TotalDailyRecords= 35(86)TotalHourlyRecords= 168(88)TotalEventRecords= 100(89)TotalConfigChangedRecords= 100(92)MeterID= 123456789

Figure 202 M4xxxxx.aaa Configuration Table, B Example


(508)TF_RawMinimumScale= 0(510)TF_RawMaximumScale= 4000(512)PF_RawMinimumScale= 0(514)PF_RawMaximumScale= 4000(516)HW_RawMinimumScale= 0(518)HW_RawMaximumScale= 4000(550)DayStartsAt= 7(1000)TF_Minimum= 0.000000(1001)TF_Maximum= 150.000000(1002)PF_Minimum= 0.000000(1003)PF_Maximum= 2000.000000(1004)HW_Minimum= 0.000000(1005)HW_Maximum= 50.000000(1008)OrificePlateDiameter= 5.003800(1009)OrificePlateDiameterMeasurementTemperature= 60.000000(1010)MeterTubeInternalDiameter= 10.026000(1011)MeterTubeInternalDiameterMeasurementTemperature= 60.000000(1012)BaseTemperature= 60.000000(1013)BasePressure= 14.730000(1014)RelativeDensityReferenceTemperature= 60.000000(1015)RelativeDensityReferencePressure= 14.730000(1020)UserInputCalibrationFactor= 1.000000

Figure 203 M4xxxxx.aaa Configuration Table, C Example


(1021)FluidFlowingAbsoluteViscosity= 0.020000(1022)IsentropicExponent= 1.281700(1030)AtmosphericPressure= 0.000000(1031)FlowCutoffLevel= 10.000000(1032)PercentMethane= 100.000000(1033)PercentNitrogen= 0.000000(1034)PercentCO2= 0.000000(1035)PercentEthane= 0.000000(1036)PercentPropane= 0.000000(1037)PercentWater= 0.000000(1038)PercentH2S= 0.000000(1039)PercentHydrogen= 0.000000(1040)PercentCO= 0.000000(1041)PercentOxygen= 0.000000(1042)PercentI_Butane= 0.000000(1043)PercentN_Butane= 0.000000(1044)PercentI_Pentane= 0.000000(1045)PercentN_Pentane= 0.000000(1046)PercentHexane= 0.000000(1047)PercentHeptane= 0.000000(1048)PercentOctane= 0.000000(1049)PercentNonane= 0.000000(1050)PercentDecane= 0.000000(1051)PercentHelium= 0.000000(1052)PercentArgon= 0.000000

Figure 204 M4xxxxx.aaa Configuration Table, D Example


M4xxxxx.aaa File, Daily Records SectionFollowing the configuration table is the daily accumulated flowinformation record.

’---------------------- Daily Record ---------------DailyRecordIndexNumber= 1DailyRecordID= 1

RecordStartYear= 1998RecordStartMonth= 11RecordStartDay= 17RecordStartHour= 11RecordStartMinute= 11RecordStartSecond= 15DailyPeriodHours= 0DailyPeriodMinutes= 2DailyPeriodSeconds= 6DailyFlowTimeHours= 0DailyFlowTimeMinutes= 2DailyFlowTimeSeconds= 6

DailyAccumulatedVolume(ft^3/m^3)= 36537.730469DailyAverageTemperature(F/C)= 49.987503DailyAveragePresure(psia/kPa)= 1000.000000DailyAverageDiffPresure(inH2O/kPa)= 18.537500DailyAverageIV= 136.198029

Figure 205 M4xxxxx.aaa Daily Record Example

Daily records are arranged into three parts.

Part one is the index. Where the index number of the record and the IDnumber of the record are reported. The daily record index number is acounter that counts from 1 to (the total number of valid records), andchanges as more records are added. The daily record ID number is theidentification for a given record and it stays with that record as long asthe record exists. The ID record is stored in the PLCs API21.1 dataarea. The index record is NOT stored in the PLCs API21.1 data area.

The second part is the time information. This gives the start of therecord, the total period of the day, and the total flow time of the day.

The third part is the actual flow information accumulated during theday period. Both the accumulation and averages are calculated based onthe flow time. No flow information is recorded during error time or lowflow cut off time.


M4xxxxx.aaa File, Hourly Records SectionFollowing the daily records is the hourly accumulated flow informationrecords.

’---------------------- Hourly Record ---------------HourlyRecordIndexNumber= 1HourlyRecordID= 1

RecordStartYear= 1998RecordStartMonth= 11RecordStartDay= 17RecordStartHour= 11RecordStartMinute= 11RecordStartSecond= 15HourlyPeriodHours= 0HourlyPeriodMinutes= 2HourlyPeriodSeconds= 6HourlyFlowTimeHours= 0HourlyFlowTimeMinutes= 2HourlyFlowTimeSeconds= 6

HourlyAccumulatedVolume(ft^3/m^3)= 36537.730469HourlyAverageTemperature(F/C)= 49.987503HourlyAveragePresure(psia/kPa)= 1000.000000HourlyAverageDiffPresure(inH2O/kPa)= 18.537500HourlyAverageIV= 136.198029

Figure 206 M4xxxxx.aaa Hourly Record Example

Hourly records are arranged into three parts.

Part one is the index. Where the index number of the record and the IDnumber of the record are reported. The hourly record index number is acounter that counts from 1 to (the total number of valid records), andchanges as more records are added. The hourly record ID number is theidentification for a given record and it stays with that record as long asthe record exists. The ID record is stored in the PLCs API21.1 audittrail area. The index record is NOT stored in the PLCs API21.1 audittrail area.

The second part is the time information. This gives the start of therecord, the total period of the hour, and the total flow time of the hour.

The third part is the actual flow information accumulated during thehour period. Both the accumulation and averages are calculated based


on the flow time. No flow information is recorded during error time orlow flow cut off time.

M4xxxxx.aaa File, Event Records SectionFollowing the hourly record is the event log record.

’---------------------- Event Record ---------------EventRecordIndexNumber= 1EventRecordID= 0


EventType= 3 ’Loadable restart or halted event.LoadableHaltStart= 1

Figure 207 M4xxxxx.aaa Event Record Example

Event records are arranged into three parts.

Part one is the index. Where the index number of the record and the IDnumber of the record are reported. The event record index number is acounter that counts from 1 to (the total number of valid records), andchanges as more records are added. The event record ID number is theidentification for a given record and it stays with that record as long asthe record exists. The ID record is stored in the PLCs API21.1 audittrail area. The index record is NOT stored in the PLCs API21.1 audittrail area.

The second part is the time information. This gives the time stamp ofevent.

The third part is the actual event and information related to the event.Refer to Appendix A for API21.1 audit trail details.


M4xxxxx.aaa File, Configuration Change Records SectionFollowing the event record is the configuration changed log record.

’---------------------- ConfigChanged Record ---------------ConfigChangedRecordIndexNumber= 1ConfigChangedRecordID= 0


ConfigChangedType= 0 ’Config table changed. Result a new daily record.RegIndex= 16OldValue= 0NewValue= 1

Figure 208 M4xxxxx.aaa Configuration Changed Log Record Example

Configuration changed log records are arranged into three parts.

Part one is the index. Where the index number of the record and the IDnumber of the record are reported. The configuration change recordindex number is a counter that counts from 1 to (the total number ofvalid records), and changes as more records are added. Theconfiguration change record ID number is the identification for a givenrecord and it stays with that record as long as the record exists. The IDrecord is stored in the PLCs API21.1 audit trail area. The index recordis NOT stored in the PLCs API21.1 audit trail area.

The second part is the time information. This gives the time stamp ofevent.

The third part is the actual event and information related to the event.Refer to Appendix A for API21.1 audit trail details.


B.2 SET_SIZE.EXE

The heap area of the gas flow block is used to store internal operationregisters and the API21.1 audit trail data. Running this utility beforeyou load the gas flow block into Modsoft or Concept allows you toreconfigure the heap size. Thus reducing or increasing the amount ofmemory the gas flow block uses. This utility is a DOS 16 bit EXEprogram that may be run in any DOS or Windows DOS box commandline environment. The following describes the parameters and optionalswitches provided with this utility.

Note: GD92 does NOT support the API21.1 audit trail feature.

Caution: Setting the heap size area does NOT guarantee thatthe PLC actually has the requested space. This occurs whenother ladder logic programs use a large amount of the PLCsmemory. There are three possible indications that you mayhave this type of issue: your panel software returns a messagethat the program is too big to fit while loading the Gas Block,you receive either a 401 or 402 Error, or the Total AvailableAUdit Trail Registers for All Meters (read only) register(4x+145 ... 146) equals 0 during run time. Possible solutions in-clude using a PLC model with large memory, or using less GasBlocks per PLC.

B.2.1 Format and Switches

The format is:

SET-SIZE.EXE GXXX.EXE [/A=] [/E=] [/M=]

1 2 3 4

Figure 209 SET_SIZE Format


SET_SIZE Format and Switches

Item#

Function Re-quired

Default Option/Range

Description

1 ParameterGXXX.EXE

Yes None None Enter the gas flow block youwish to reconfigure. For ex-ample enter GM92.EXE forthe GM92 block.

2 Switch[/A=o]

No Yes Y, N Enter Y if the blocks is usingthe API21.1 function.

3 Switch

[/E=r]

No 24 0<= r<=127

Enter the the size of the de-sired API21.1 audit trail dataarea. The range units are Kwords. To determine the re-quired memory size, refer tothe example in SectionA.2.4.2, and Section A.3.The exact number variessince loadables use heapmemory area for other nonAPI21.1 operations and mayor may not allocate the ex-act number of registers forthe audit trail function. If the6x register is supported bythe PLC used, it is a goodidea to cut down the heapmemory size by using thisswitch with the number 0.Thus, NOT using heapmemory to store the audittrail.

4 Switch[/M=r] *

No 8 1<= r<=8

Enter the number of metersrunning with this PLC. Theutility allocates enoughmemory to run only thenumber of meters entered.Smaller numbers mean lessmemory used by the gasblock and more memoryavailable to the PLC.

NOTE: * This switch is ignored when API21.1 audit trail switch is [/A=Y], because theheap memory manager allocates the maximum number of meters before the API21.1data registers. The only exception is when audit trail memory size switch is [/E=0].

Technical References890 USE 137 00 303

Appendix CTechnical References

V Performance of Gas Blocks

V End User Part Numbers

V Formula Nomenclature

V Conversion Factors

V Possible Application Examples for PLCs

V Technical Expertise in Gas Measurement

Technical References304304 890 USE 137 00

C.1 Performance of Gas Blocks

Performance Values using a E984-255 PLC

Gas Block Type TypicalSolve Time/Meter in ms

MaximumScan Time/Meter in ms

GD92 1000 50

GM92 1000 50

G392 220 50

GG92 620* 50

GFNX 250* 50

*These values vary depending on which method is selected.

NOTE: When using the E984-258/265/275/285 PLCs theSolve Time and the Scan Time values are halved, approxi-mately.

Note: Your total typical solve time or maximum scan time is calcu-lated by the total number of meters times the given value of that gasblock type. For example, you have 5 GM92 meters and you want to cal-culate the total typical solve time. (5 x 1000) = 5000 ms typical solvetime for your system.


C.2 End User Part Numbers

Compact and Micro PLC Descriptions

Models PC A984 141* With two Modbus communication ports standard;User logic size: 8.0K words, 8Mhz.

PC A984 145* With one Modbus communication port and oneModbus Plus peer--to--peer network communica-tion port standard; User logic size: 8.0K words,8Mhz.

PC E984 241* With two Modbus communication port standard;User logic size: 8.0K words, FLASH RAM,16Mhz.

PC E984 245* With one Modbus communication port and oneModbus Plus peer--to--peer network communica-tion port standard; User logic size: 8.0K wordsFLASH RAM, 16Mhz.

PC E984 251* With two Modbus communication ports standard;User logic size:16.0K Words FLASH RAM,16Mhz, 24K of extended registers.

PC E984 255* With one Modbus communication port and oneModbus Plus peer--to--peer network communica-tion port standard; User logic size: 16.0K wordsFLASH RAM, 16Mhz, 24K of extended registers.

PC E984 258* With two Modbus communication ports standard;User logic size: 16.0K words, State RAM size:32K words, Total size: 48K words, FLASH RAM,25Mhz, operating temperature --40 ... +70°C, theRun, Ready, Modbus 1 and Modbus 2 LEDs areyellow.

PC E984 265* With two Modbus communication ports and oneModbus Plus peer--to--peer network communica-tion port standard; User logic size: 8.0K words,State RAM size: 16K words, Total size: 24Kwords, FLASH RAM, 25Mhz.

PC E984 275* With two Modbus communication ports and oneModbus Plus peer--to--peer network communica-tion port standard; User logic size: 16.0K words,State RAM size: 32K words, Total size: 48Kwords, FLASH RAM, 25Mhz, and one PCMCIAslot.

PC E984 285* With two Modbus communication ports and oneModbus Plus peer--to--peer network communica-tion port standard; User logic size: 32.0K words,State RAM size: 64K words, Total size: 96Kwords, FLASH RAM, 25Mhz, operating tempera-ture --40 ... +70°C and one PCMCIA card slot.


110CPU61204*** With a 24Vdc power supply, fixed discrete andanalog I/O, 8.0K user logic size.

* Refer to the Modicon 984--A120 Compact Programmable ControllersUser Guide (890 USE 108 00).*** Refer to the Modicon 512/612 Micro PLC Hardware User Manual(890 USE 145 00).

PLC Programming Tools

Programming Panel Soft-ware

SW--MSxD--9SA Full--feature Modsoft

371SPU921000 Modsoft Lite

372 SPU 472 01 V2x Concept M

372 SPU 474 01 V2x Concept XL

372 SPU 479 01 V2x Concept 984 XL

Analog Input Modules

Analog Input Modules 4 channel +500 mV RTD AS BADU 204

4 channel +10 V/+20 mA AS BADU 205

4 channel 12 bit AS BADU 206*

8 channel 12 bit, RTD, TC,Vdc, mA

AS BADU 211*

8 channel 12 bit, RTD, TC,Vdc, mA

AS BADU 212*

8 channel 12 bit, RTD, Vdc,mA

AS BADU 214*

8 channel 15 bit, TC, Vdc AS BADU 216*

*Indicates A120 I/O Modules that are not supported by thePC--0984--1xx controller.For a full list of Compact I/O, please refer to the A120 Se-ries I/O Modules User Guide (890 USE 109 00 formerlyGM--A984--IOS).

Note: Some A120 I/O modules need loadables for proper operation.Refer to the A120 Series I/O Modules User Guide (890 USE 109 00 for-merly GM-A984-IOS).


C.3 Formula Nomenclature

Refer to the table below for descriptions of various symbols used in theformulas to calculate gas flow.

Gas Flow Formula Nomenclature

Symbols Description

Cd Orifice Plate Coefficient of Discharge

Cd_f Orifice Plate Coefficient of Discharge bounds Flag within Iteration Scheme

Ev Velocity of Approach Factor

Fpv Gas Supercompressibility Factor

Fu User Input Correction Factor

Gr Gas Relative Density (Specific Gravity)

rt,p Density of a Fluid at Flowing Conditions (Pf, Tf), Ibm/ft3

SCF Standard Cubic Feet

SCFD Standard Cubic Feet per Day

SM3 Standard Cubic Meters

SM3/D Standard Cubic Meters per Day

ρ Density of a Fluid at Base Conditions, Ibm/ft3

Y Expansion Factor

Zb Compressibility at Base Conditions (Pb, Tb)

Zf Compressibility at Flowing Conditions (Pf, Tf)

Zs Compressibility at Standard Conditions (Ps, Ts)


C.4 Conversion Factors

Refer to the table below for conversion factors.

Conversion Factors

Problem Conversion Formula

°F to °C (°F --32) * 5/9

Psi to kPa Psi * 6.894757

Inches H2O @ 60°F to kPa Inches H2O * 0.2488429

Inches to mm Inches * 25.4

ft3 to m3 ft3 * 0.02831685

ft3 to US gallons ft3 * 7.480520

M3 to liters M3 * 1000.0

US gallons to liters US gallons * 3.785412


C.5 Possible Application Examples for PLCs

GAS FLOW SOFTWARE IN CPU(LOADABLE FUNCTION)

PT1

DPT1

DPT2

FLOW

PIPELINE

ANALOG

IN

P120

COMPACTCPU

TT1

Figure 210 Single Meter Run in a Compact 984 PLC


PT1

DPT1

DPT2

FLOW

PIPELINE

REGULATION SOFTWAREIN CPU (USER DEVELOPED)

ANALOG

IN

ANALOG

OUT

I/P

Control Valve

P120

COMPACTCPU

TT1

Figure 211 Single Meter Run in a Compact 984 PLC with Pressure Regulation



PT1

DPT1

DPT2

FLOW

PIPELINE

MICRO 612--04

ANALOGIN

TT1

Figure 212 Single Meter Run in a Mirco 612 04 PLC


PT1

DPT1

DPT2

FLOW

PIPELINE

REGULATION SOFTWAREIN CPU (USER DEVELOPED)

I/P

Control Valve

MICRO 612--04

ANALOGIN

ANALOGOUT

TT1

Figure 213 Single Meter Run in a Micro 612 04 PLC with Pressure Regulation


DPT1

DPT2

FLOW

PIPELINE

RUN #1

PT1

RUN #2FLOW

DPT3

DPT4

RUN #3FLOW

DPT5

DPT6

RUN #4FLOW

DPT7

DPT8

TT1

ANALOG

IN

P120

COMPACTCPU

ANALOG

IN

Figure 214 Four Meter Run in Compact 984 PLC using Upstream Temperature andPressure


DPT1

DPT2

FLOW

PIPELINE

ANALOG

IN

ANALOG

IN

PT1

FLOW

DPT3

DPT4

FLOW

DPT5

DPT6

FLOW

DPT7

DPT8

P120

COMPACTCPU

TT1

ANALOG

OUT

ANALOG

OUT

I/P

Control ValveI/P

Control Valve

I/P

Control ValveI/P

Control Valve

Figure 215 Four Meter Run in Compact 984 PLC using Upstream Temperature andPressure with Pressure Regulation

XMITBLOCKIN CPU

XMITBLOCKIN CPU

HSBY LINK

REMOTE I/O

MODBUS MODBUS

PORT SHARING DEVICE

PDP1DP2T

MICRO 612--04ONE OR MORE MICRO 612--04s SERVE ASDISTRIBUTED ”COMPUTATION ENGINES”,

OFFLOADING QUANTUM CPU

Figure 216 Gas Flow in Quantum HSBY Systems using Distributed Micro 612 04PLCs


PDP1DP2T

MICRO 612--04

PDP1DP2T

MICRO 612--04

PDP1DP2T

MICRO 612--04

PDP1DP2T

MICRO 612--04

PARENT

CHILD

CHILD

CHILD

UP TO 5 MICRO 612--04s(PARENT AND CHILDREN) SERVEAS DISTRIBUTED ”COMPUTATIONENGINES”, OFFLOADINGQUANTUM CPU. EACH MICROCAN HANDLE UP TO 8 GASFLOW METER RUNS.

XMITBLOCKIN CPU

XMITBLOCKIN CPU

HSBY LINK

REMOTE I/O

MODBUS MODBUS

PORT SHARING DEVICE

Figure 217 Gas Flow in Quantum HSBY Systems using Distributed Micro 612 04PLCs, Parent/Child

P1DP1DP2T1

MICRO 612--04PARENT

CHILD

P2-P8DP1(2)--DP1 (8)DP2(2)-DP2(8)T2-T8

MICRO 612--03

AS-HDTA-201

A120I/O MODULES

Figure 218 Eight Meter Runs Solved in Parent 612 04 with 612 03 Child Using A120I/O Analog Inputs


PDP1DP2T

MICRO 612--04PDP1DP2T

MICRO 612--04

HSBY LINK

REMOTE I/O

MODBUS MODBUS

REDUNDANT MICRO 612--04s SERVE ASDISTRIBUTED ”COMPUTATION ENGINES”,

OFFLOADING QUANTUM CPU

Figure 219 Gas Flow in Quantum HSBY Systems using Redundant Distributed Micro612 04 PLCs

PDP1DP2T

HSBY LINK

REMOTE I/O

MODBUS MODBUS

COMPACT984

COMPACT 984 SERVES AS ADISTRIBUTED ”COMPUTATIONENGINE”, OFFLOADINGQUANTUM CPU. COMPACTCAN USE ITS OWN INPUTSFOR GAS FLOW EQUATIONS.

Figure 220 Gas Flow in Quantum HSBY Systems using Distributed Compact 984PLCs


HSBY LINK

REMOTE I/O

COMPACT984

REMOTEI/O DROP

PDP1DP2T

MODBUS PLUS

GAS FLOW I/O CAN BECONNECTED TO QUANTUM

COMPACT 984 SERVES AS A DISTRIBUTED”COMPUTATION ENGINE”, OFFLOADINGQUANTUM CPU. COMPACT CAN USE”PEERCOPPED” QUANTUM INPUTS FORGAS FLOW WQUATIONS.

Figure 221 Gas Flow in Quantum HSBY Systems using Distributed Compact 984PLCS and Quantum I/O


C.6 Technical Expertise in Gas Measurement

For technical expertise in gas measurement theory, or to order MeterManager please contact the following:

Starling Associates, Inc.16350 Park Ten Place, Suite 100-2Houston, TX 77084

Telephone (281) 398-8330Fax (281) 398-8331E-Mail [email protected] http:\\www.starlingassoc.com

Starling Associates, Inc. (SAI) has considerable experience inimplementing the 1992 AGA Reports No. 3 and 8. The personalexperience of Dr. Kenneth Starling, SAI chairman, is extensive, startingwith field experience with Republic Pipeline, continuing through naturalgas properties and flow research at the Institute of Gas Technology,EXXON and the University of Oklahoma and compressibility factorresearch for the Gas Research Institute and the American GasAssociation and as a participant in developing both the 1985 and 1992versions of AGA Reports No. 3 and 8. As Chairman of the ExecutiveCommittee of the International School of Hydrocarbon Measurementfrom 1981 to 1992, Dr. Starling observed the industry direction towardincreased real-time measurement, more rapid accounting and editingand development of more defensible audit trails.

Starling Associates, Inc. offers a number of educational classes onvarious Gas Measurement topics. For more information on theseofferings and other services provided, please call them at (281) 398-8330.

Index890 USE 137 00 317

Index

Numbers130 HEK 301 01 AGA Full Enabler, Available

gas instruction blocks, 3130 HEK 301 02 AGA Lite Enabler, Available

gas instruction blocks, 320x8.HLP file, Installation, 8309 ULD 455 00 disk files, 4

AAPI21.1, Configuration table

Inputs, 269Outputs, 270

API21.1 audit trail/secured data area, Datainformation, 274

CConfiguration, Modsoft zoom screens

G392, 118GD92, 31GFNX, 215GG92, 161GM92, 75

Configuration example for blockG392, 146GD92, 59GFNX, 260GG92, 198GM92, 103

Configuration tableAPI21.1

Inputs, 269Outputs, 270

G392Inputs, 114Optional outputs, 117Outputs, 116

GD92Inputs, 26Optional outputs, 29Outputs, 29

GFNXInputs, 211

Optional outputs, 214Outputs, 213

GG92Inputs, 157Optional outputs, 159Outputs, 159

GM92Inputs, 70Optional outputs, 74Outputs, 73

Controller models, 305

DData information, API21.1 audit trail/secured

data area, 274DXFDT.SYS, Installation, 8

EEnabler for Compact CPUs, Installation, 18Enabler for Micro 110CPU61204,

Installation, 20

GG392

Configuration example for block, 146Configuration table

Inputs, 114Optional outputs, 117Outputs, 116

Gas instruction blocks, 112Program warning/error codes, 140System warning/error codes, 139

Gas instruction blocksG392, 112GD92, 24GFNX, 209GG92, 155GM92, 69

GD92Configuration example for block, 59Configuration table

Inputs, 26

890 USE 137 00Index318

Optional outputs, 29Outputs, 29


GET_LOGS.EXE fileM4xxxxx.aaa file, 289MBP0.ADR file, 288MESSAGE.LOG file, 289Utilities, 286

GFNXConfiguration example for block, 260Configuration table



GG92Configuration example for block, 198Configuration table



GM92Configuration example for block, 103Configuration table



Gxxx.EXE, Installation, 10, 17Gxxx.ZMM, Installation, 8

II/O Specifications, 306Installation

20x8.HLP file, 8DXFDT.SYS file, 8

Enabler for Compact CPUs, 18Enabler for Micro 110CPU61204, 20Gxxx.EXE files, 10, 17Gxxx.ZMM file, 8LSUP.EXE file, 9, 16

LLSUP.EXE, Installation, 9, 16

MM4xxxxx.aaa file, GET_LOGS.EXE file, 289MBP0.ADR file, GET_LOGS.EXE file, 288MESSAGE.LOG file, GET_LOGS.EXE file,

289Modsoft zoom screens, Configuration

G392, 118GD92, 31GFNX, 215GG92, 161GM92, 75

PPanel Software, 306Performance of gas blocks, 304Program warning/error codes

G392, 140GD92, 51GFNX, 254GG92, 191GM92, 96

SSET_SIZE.EXE, Utilites, 300System warning/error codes

G392, 139GD92, 50GFNX, 253GG92, 190GM92, 95

UUtilities

GET_LOGS.EXE file, 286SET_SIZE.EXE, 300