Introduction

The Ansys Common Fluids Format SDK is a collection of APIs, data models and example programs that allow you to access or write data to Ansys Common Fluids Format files using a common format that is also used by Ansys Fluids products.

The Common Fluids Format SDK is made up of:

Application Programming Interface

Prerequisites for using the Application Programming Interface

Refer to the Requirements section in this document, which details the prerequesites you should consider before using the Ansys Common Fluids Format SDK.

Overview

The Application Programming Interface (API) provided within this SDK provides you with a number of classes, functions, and enumerated types that allow you access to read in existing files and to write your own data to new files.

If the API is used correctly your own files will be readable within selected Ansys Fluids products.

Note: To enable you to read or write files correctly using the API, it is important to understand the Data Models that are used by the API to describe the data and the relationships between data held within those models.

For further information see

• Ansys Project API
• Ansys Common Fluids API

Data Models

Use of the Common Fluids API depends on the understanding of how data is held within the models of the data that are typically provided by Computational Fluid Dynamics (CFD) software.

A number of data models exist:

• Project Data Model
• CFF Restart Data Model
• CFF Post Data Model

A model is an abstraction of the data. Each model consists of a number of submodels that each hold related data.

The three core data models mentioned above correspond to the concrete implementations of each model in the Files listed below. In the future it may be possible to access implementations of these models from other data sources.

Files

Representing the models used to hold the complex CFD data as files allows the user to save and recover data between sessions and between applications. Each of the models previously mentioned has a corresponding file format.

File Formats

There are three distinct classes of file used by the CFF.

• Project File Format
• CFF Restart File Format
• CFF Post File Format

Each in turn corresponds to the Data Models previously mentioned. The APIs provide you with access to the data held within each file.

You do not need to know how or where the data is stored in the files, instead you should rely on the APIs and your knowledge of the specific Data Models when reading from or writing.

Examples

Source code examples are provided in Examples.

One example reads given case and results files, another example writes a simple case and data file. There are also two 'C' examples that illustrate how to use the 'C' API for reading and writing a CFF case or results file.

All examples include comments that provide guidance on use of the API and associated Data Models.

Further examples are included to demonstrate more specific capabilities of the API, such as parallel write.