Function-Based API for Gas Turbine Engine Performance Programs
The SAE Aerospace Standard document AS681 is the parent document of this SAE Aerospace Recommended Practice (ARP). AS681 applies to Engine programs written to conform to this document. This ARP specifies a set of functions and their expected behaviors that constitute a function based Application Program Interface (API) for gas turbine engine customer programs. The functions specified in this API are delivered by the Supplier as part of the Engine model.
This document defines generic language independent functions and specific appendices for implementations in C and Fortran.
The function based API specified in this ARP represents an alternative to the Fortran COMMON block structure, as specified in AS4191, historically used to communicate with an engine program. The customer may request emulation of the AS4191 interface if desired.
This document does not specify how the parameter names in the Engine program are constructed, how program capabilities might be expanded or altered, or how error messages are constructed. See AS755 for overall guidelines for nomenclature. See ARP5571 for information on nomenclature, expanding program operational capabilities and generating error values and messages for object-oriented models.
Gas turbine engine manufacturers (suppliers) have long provided their customers with computer programs that simulate engine performance. Application manufacturers and others (customers) use these programs, often called models or simulations, in design studies, mission analysis, life cycle analysis, and performance prediction of their products. These models are used throughout the life of a product, from conceptual design through production, deployment, field use, maintenance, and overhaul. Communication between suppliers and customers is more productive and less error prone if all engine models adhere to common guidelines with respect to presentation of data and interface with other computer programs.
Rev A represents a substantial revision and simplification of the API presented in the original document. The intent of the document is the same but all function names and their arguments have been changed.