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/binfolder.
- 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
/libfolder 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
/includefolder.
- 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
/includefolder.
- 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
/dictionaryfolder. You must set theCATDICTIONARYPATHenvironment variable to point to the/dictionaryfolder.
- Results Provider
- A template file to start to develop a Results Provider is located in the
/resultsProviderfolder. 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
/examplesfolder.
| 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. |