Co-Simulation API
Simcenter STAR-CCM+ provides an Application Programming Interface (API) that allows you to write partner code that exchanges data with a running Simcenter STAR-CCM+ simulation. As the partner code can be part of any other application that supports linking to a flat C library, the co-simulation API extends the range of co-simulation scenarios possible with Simcenter STAR-CCM+.
When initialized, the Co-Simulation API launches a companion Simcenter STAR-CCM+ API server alongside the partner software. During co-simulation, the companion Simcenter STAR-CCM+ API server communicates with other Simcenter STAR-CCM+ servers using the same protocols as a co-simulation between two Simcenter STAR-CCM+ simulations. Partner software makes calls into the Co-Simulation API library to receive data from, and transfer data to, the companion Simcenter STAR-CCM+ API server.

Each release of the Co-Simulation API is identified with a unique number, that is, the API version. Typically, new versions of the Co-Simulation API are released less frequently than new versions of Simcenter STAR-CCM+. To facilitate the transition to newer API versions and to prolong backwards compatibility, each Simcenter STAR-CCM+ release supports multiple versions of the Co-Simulation API. You are advised to keep your program up-to-date with the latest version of the Co-Simulation API, as older API versions may be retired in future Simcenter STAR-CCM+ releases.
The following sections describe the latest version of the API. For more information on older API versions, refer to the User Guide of previous Simcenter STAR-CCM+ releases.