SIMULIA Co-Simulation Services API Kit

The SIMULIA Co-Simulation Services API Kit contains all the software components required to couple your application. It also includes examples illustrating how to embed the SIMULIA Co-Simulation Services API.

This page discusses:

SIMULIA Co-Simulation Services API Kit Contents

The SIMULIA Co-Simulation Services API Kit includes the following:

SIMULIA Co-Simulation Services Director
The SIMULIA Co-Simulation Services Director controls the coupled simulation. For more information, see SIMULIA Co-Simulation Services Director.

The SIMULIA Co-Simulation Services Director executable, SMACseCtlMain, is located in the /bin folder.

Simulation Runtime Environment
The Simulation Runtime Environment (SRE) is the SIMULIA Co-Simulation Services component embedded into a client. It is responsible for all services including communication, mapping, and field operations.

The SRE consists of dynamic link libraries: .dll files on Windows and .so files on Linux. The dynamic link libraries are located in the /lib folder and are required at run time.

Header files
The header files provide the function signatures of the SIMULIA Co-Simulation Services API and are required for compiling your application.

Table 1 summarizes the header files. The header files are located in the /include folder.

XML document style and definitions files
The XML documentation style and definition files are required to perform XSLD transformations of the co-simulation configuration file and are required at run time by the SIMULIA Co-Simulation Services Director.

These files are located in the /include folder.

Dictionary files
The dictionary files are required by the SIMULIA Co-Simulation Services Director and the clients to parse XML.

The dictionary files are located in the /dictionary folder. You must set the CATDICTIONARYPATH environment variable to point to the /dictionary folder.

Results Provider
A template file to start to develop a Results Provider is located in the /resultsProvider folder. For information about how to develop Results Provider, see Developing a Results Provider.
Examples
Examples are provided to help illustrate how to use the SIMULIA Co-Simulation Services API kit. For more information, see Examples.

The coding examples are located in the /examples folder.

Table 1. Header file descriptions.
Header File Description
SMACseApi.h Contains the function signatures for the core functionality.
SMACseApiEnums.h Defines the enumerated symbols.
SMACseDmp.h Defines the interface definition for distributed memory parallel implementation.

This file is required when embedding the services in distributed parallel mode.

SMACseApiSignalInterface.h Contains the function signatures for the signal interface class.

This file is required when coupling to FMU’s.

SMACseApiMesh.h Defines the function signatures for the mesh interface services to import remote meshes.

This file is required when providing your own mapping services.

SMACseApiResultsProvider.h Define additional functions for the results provider.

This file is required when developing a results provider.

SMACseApiService.h Defines the function signatures for the service interface.

The service interface is used to define the advanced coupling algorithm.

Release Compatibility

Third-party applications might use an earlier release of the SIMULIA Co-Simulation Services than the release of the Dassault Systèmes application being coupled. If the communication protocol is compatible between the releases, this should not cause any issues.

The SIMULIA Co-Simulation Services has a versioning mechanism to ensure the communication protocol is compatible between all applications in the coupled simulation. The SIMULIA Co-Simulation Services Director prints out the communication protocol version and issues an error message if one of the clients uses an incompatible protocol. In this case, you must upgrade the libraries.

It is highly recommended to update the SIMULIA Co-Simulation Services with every major release.