GT-SUITE Link Reference

In Simcenter STAR-CCM+, you specify the settings for co-simulation with GT-SUITE in a link node under the External Links node.

A link node, External Links > Link 1,appears in the simulation when you activate the GT-SUITE Co-Simulation model. This node allows you to specify co-simulation global settings, such as the connection method, as well as to define and set up co-simulation zones, which couple the Simcenter STAR-CCM+ boundaries with the corresponding GT-SUITE CFD Connections.

This section describes the global settings available for co-simulation with GT-SUITE. For details on the co-simulation zone settings, see Co-Simulation Zones Reference.

Link Properties

Link Type: Describes the type of connection. Read-only.
Link Priority: Specifies the order in which the links are executed.

Link Models

In a Simcenter STAR-CCM+ simulation, you access the co-simulation framework by activating co-simulation models in the physics continua. These models determine the physics of the coupling, including the fields that can be exchanged with the partner simulation.

Link models configure the connection to a partner application or file. The link icon changes based on the application, or file, that Simcenter STAR-CCM+ connects to through the link. The link model must be appropriate for the co-simulation or file export model selected in the physics continuum.

Link Conditions and Values

You specify the general settings of the co-simulation under the Link > Conditions and Link > Values nodes.

GT-SUITE Version

Allows you to specify which version of the partner software you are running. The available options include the recommended versions (see the section External Packages Support of the Simcenter STAR-CCM+ Release Notes), as well as a Custom option. The Custom option allows you to specify a version other than the recommended. In general, you are advised to use one of the recommended versions, as compatibility for other versions is not guaranteed. When using the Custom option, set the version using the Values > Custom Code Version node.

Load Partner Library Option

Allows you to specify the location of the GT-SUITE coupling library (see GT-SUITE Coupling Libraries).

Method	Corresponding Condition/Value Nodes
Specify Library File Allows you to manually specify the path to the GT-SUITE library file. This option is suitable for cases where the location of the library file is not the default. See Coupling to GT-SUITE.	GT-SUITE Library Specifies the path and name of the GT-SUITE library file. You can type the full path and name manually, or you can click (Custom Editor) and navigate to the file using the file selection dialog.
Use environment variable Instructs Simcenter STAR-CCM+ to load the library from the default location (see GT-SUITE Coupling Libraries). This option requires you to save the path to the GT-SUITE installation in the environment variable, $GTIHOME.	GTIHOME Environment Variable Specifies the path to the GT-SUITE installation. You can type the full path manually, or you can click (Custom Editor) and navigate to the installation directory using the file selection dialog. This setting overwrites any existing $GTIHOME environment variable, for the current co-simulation run. When restoring a simulation containing the GTIHOME Environment Variable setting, Simcenter STAR-CCM+ uses the $GTIHOME environment variable, if this is set on the system. If not set, Simcenter STAR-CCM+ uses the GTIHOME Environment Variable setting that is found in the simulation.

Method

Corresponding Condition/Value Nodes

Specify Library File: Allows you to manually specify the path to the GT-SUITE library file. This option is suitable for cases where the location of the library file is not the default. See Coupling to GT-SUITE.

GT-SUITE Library: Specifies the path and name of the GT-SUITE library file. You can type the full path and name manually, or you can click (Custom Editor) and navigate to the file using the file selection dialog.

Use environment variable: Instructs Simcenter STAR-CCM+ to load the library from the default location (see GT-SUITE Coupling Libraries). This option requires you to save the path to the GT-SUITE installation in the environment variable, $GTIHOME.

GTIHOME Environment Variable: Specifies the path to the GT-SUITE installation. You can type the full path manually, or you can click (Custom Editor) and navigate to the installation directory using the file selection dialog.; This setting overwrites any existing $GTIHOME environment variable, for the current co-simulation run.; When restoring a simulation containing the GTIHOME Environment Variable setting, Simcenter STAR-CCM+ uses the $GTIHOME environment variable, if this is set on the system. If not set, Simcenter STAR-CCM+ uses the GTIHOME Environment Variable setting that is found in the simulation.

Launch Partner Option

Allows you to specify which method Simcenter STAR-CCM+ uses to launch GT-SUITE.

Method	Corresponding Value Nodes
Launch Application Automatically launches GT-SUITE on co-simulation run. This option requires you to specify the path to the GT-SUITE installation and license file using the environment variables $GTIHOME and $GTISOFT_LICENSE_FILE.	The following settings allow you to overwrite the $GTIHOME and $GTISOFT_LICENSE_FILE environment variables defined on your system, for the current co-simulation run: GTIHOME Environment Variable Specifies the path to the GT-SUITE installation. You can type the full path manually, or you can click (Custom Editor) and navigate to the installation directory using the file selection dialog. GTISOFT_LICENSE_FILE Environment Variable Specifies the GT-SUITE license file. When restoring a simulation that contains these setting, Simcenter STAR-CCM+ uses the environment variables, if these are set on the system. If not set, Simcenter STAR-CCM+ uses the settings that are found in the simulation.
Do Not Launch Requires you to manually launch GT-SUITE.	None

Method

Corresponding Value Nodes

Launch Application: Automatically launches GT-SUITE on co-simulation run. This option requires you to specify the path to the GT-SUITE installation and license file using the environment variables $GTIHOME and $GTISOFT_LICENSE_FILE.

The following settings allow you to overwrite the $GTIHOME and $GTISOFT_LICENSE_FILE environment variables defined on your system, for the current co-simulation run:

GTIHOME Environment Variable: Specifies the path to the GT-SUITE installation. You can type the full path manually, or you can click (Custom Editor) and navigate to the installation directory using the file selection dialog.
GTISOFT_LICENSE_FILE Environment Variable: Specifies the GT-SUITE license file.

When restoring a simulation that contains these setting, Simcenter STAR-CCM+ uses the environment variables, if these are set on the system. If not set, Simcenter STAR-CCM+ uses the settings that are found in the simulation.

Do Not Launch: Requires you to manually launch GT-SUITE.

None

Connect Option

Allows you to specify which method Simcenter STAR-CCM+ uses to connect to GT-SUITE.

When Simcenter STAR-CCM+ launches GT-SUITE (that is, Launch Partner Option is set to Launch 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, which can be created using the following methods:

Method	Corresponding Value Nodes
Partner Code Creates Connection File Simcenter STAR-CCM+ does not create the connection file. From v2017, when you launch GT-SUITE in server mode using the gtlink command, GT-SUITE creates the required gtlink.prm connection file in the directory from which you instantiate gtlink. To use this file for connection, copy it to the directory containing the Simcenter STAR-CCM+ simulation file.	None
STAR-CCM+ Creates Connection File When co-simulation starts, Simcenter STAR-CCM+ automatically writes the specified host and port details to a file and saves the file in the simulation directory as gtlink.prm.	Partner Host:Port Specifies the host and port where GT-SUITE is running. Provide these details in the format [Host Name]:[Port Number] GT-SUITE Partner Connection File Displays the name of the connection file created by Simcenter STAR-CCM+ (read-only).

Partner Filesystem

Specifies whether the GT-SUITE files are located on a local or remote file system. See GT-SUITE Model File.

GT-SUITE

Displays the status of the connection between Simcenter STAR-CCM+ and GT-SUITE and the GT-SUITE library that Simcenter STAR-CCM+ uses to communicate with GT-SUITE.

GT-SUITE Model File

Specifies the location and name of the GT-SUITE case file. You can provide either the .gtm file or the .dat file. When providing the .dat file, make sure it is up-to-date. See Coupling to GT-SUITE.

Partner Material Components

For multi-component gases, allows you to couple the fluid components defined in GT-SUITE with gas components and passive scalars defined in Simcenter STAR-CCM+.

The [Material Component] nodes must match the species defined in GT-SUITE in number and name. See Specifying Co-Simulation Settings.

Link Right-Click Actions

Create New Zone: Allows you to create a new zone within an existing link.
Load Partner Library: Loads the specified GT-SUITE library file. See Load Partner Library Option.
Launch and Connect: Launches the specified partner simulation and starts the connection, coupling the Simcenter STAR-CCM+ simulation with the partner simulation.
Connect: Starts the connection, coupling the Simcenter STAR-CCM+ simulation with the running partner simulation that you specified.
Terminate: Terminates the connection between Simcenter STAR-CCM+ and GT-SUITE.
Unload Partner Library: Unloads any GT-SUITE library file that was previously loaded.