Coupling to GT-SUITE

Specify the settings for launching and connecting to GT-SUITE, then initiate coupling.

  1. Expand the External Links > Link 1 node.
  2. Select the Conditions > GT-SUITE Version node and select the version of GT-SUITE that you are running.
  3. Select the Conditions > Partner Filesystem node and specify the location of the GT-SUITE model file:
    • When Simcenter STAR-CCM+ and GT-SUITE run on the same machine, set Option to Local Filesystem.
    • When Simcenter STAR-CCM+ and GT-SUITE run on different machines, set Option to Remote Filesystem.

      For remote locations, the GT-SUITE model file must be located in the directory from which you execute the GT-SUITE command, gtlink.

  4. Select the Values > GT-SUITE Model File node and set GT-SUITE Input File to either the .gtm or .dat model file, as follows:
    • When Simcenter STAR-CCM+ and GT-SUITE run on the same machine, click (Custom Editor) and use the dialog to select the file in the local filesystem.
    • When Simcenter STAR-CCM+ and GT-SUITE run on different machines, specify the full name of the model file, including the extension (either .gtm or .dat), without including any folder path.
To initiate the communication with GT-SUITE, Simcenter STAR-CCM+ requires the location of the GT-SUITE coupling libraries (see GT-SUITE Coupling Libraries):
  1. Select the Conditions > Load Partner Library Option node and set Option to one of the following:
    • When Simcenter STAR-CCM+ and GT-SUITE run on the same machine:
      1. Select Use environment variable.
      2. Select the Values > GTIHOME Environment Variable and set GTIHOME to the path to the GT-SUITE installation. For more information, see Load Partner Library Option.

        Simcenter STAR-CCM+ looks for the library file in the default location (see GT-SUITE Coupling Libraries) within the specified GT-SUITE installation.

    • When Simcenter STAR-CCM+ and GT-SUITE run on different machines:
      1. Select Specify library file.
      2. Copy the coupling library file (for information on the default location, see GT-SUITE Coupling Libraries) to the machine where Simcenter STAR-CCM+ is running.
      3. Select the Values > GT-SUITE Library node and set GT-SUITE Library to the library file that you copied.
Specify the method for launching GT-SUITE:
  1. Select the Conditions > Launch Partner Option node and set Option to one of the following:
    • To launch GT-SUITE manually, select Do Not Launch. If GT-SUITE runs on a remote host, this is the only suitable option.
    • To instruct Simcenter STAR-CCM+ to automatically launch GT-SUITE:
      1. Select Launch Default Application.
      2. Select the Values > GTIHOME Environment Variable node and set GTIHOME to the path to the GT-SUITE installation.
      3. Select the Values > GTISOFT_LICENSE_FILE Environment Variable node and set GTISOFT_LICENSE_FILE to the path to the directory containing the license file.

      For more information, see Launch Partner Option.

When Simcenter STAR-CCM+ launches GT-SUITE (that is, Launch Partner Option is set to Launch Default Application), Simcenter STAR-CCM+ automatically uses the launching details for connection. When you launch GT-SUITE manually (that is, Launch Partner Option is set to Do Not Launch), the coupling library requires the host and port on which GT-SUITE is running. The host and port information is stored in a connection file, gtlink.prm. To create this file:
  1. Select the Conditions > Connect Option node and set Option to Partner Code Creates Connection File.
    When launched, GT-SUITE automatically creates the required gtlink.prm connection file in the directory containing the gtlink command.
  2. Copy the gtlink.prm file to the directory containing the Simcenter STAR-CCM+ simulation file.
    NoteVersions of GT-SUITE older than v2017 do not create the connection file automatically. In this case, you can instruct Simcenter STAR-CCM+ to create the connection file in the simulation directory, based on the host and port that you specify using the Values > Partner Host:Port node. For more information, see Connect Option.
  3. To run the co-simulation, click Run (Ctrl+R).
    Simcenter STAR-CCM+ automatically loads the coupling library and, based on the specified launch and connect methods, connects, or launches and connects to, to the specified GT-SUITE server.

    On connection, Simcenter STAR-CCM+ matches the co-simulation zones with the corresponding GT-SUITE CFD connections.

    Simcenter STAR-CCM+ also allows you to manually load or unload the coupling library, and manually control the launch and connect steps. For more information, see Link Right-Click Actions.

To terminate the connection:
  1. Right-click the Link node and select Terminate.
  2. To restart the co-simulation:
    • If the Simcenter STAR-CCM+ session is active, select Solution > Clear Solution. You can then start GT-SUITE using the previous method.
    • If you close Simcenter STAR-CCM+, perform a restart-run by modifying the GT-SUITE model file to restart from a user-defined time-step. Restart the Simcenter STAR-CCM+ simulation from an autosave file.