gPROMS Link Reference

You specify all export details in a gPROMS link node under the External Links node. A gPROMS link node represents a connection to a gPROMS file.

[Link 1] Properties

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

[Link 1] Models

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 1] Conditions and Values

Multizonal File Version
Specifies the version of the HDF5 data format standard. Automatically set to 1. Read-only.
Transfer Direction
Automatically set to Export. Read-only.
Verbosity Level
Allows you to tune the level of information that Simcenter STAR-CCM+ prints to the Output window.
External Continua
Allows you to associate this link with an external physics continuum. Select a physics continuum that the contains the gPROMS Export model.
Lagrangian Phases
Allows you to select the Lagrangian phases that are coupled with gPROMS. Available only when the associated external continuum contains the Particle Clustering model.
File
Specifies the details for the exported gPROMS file:
  • Directory—location in which Simcenter STAR-CCM+ saves the gPROMS file.
  • Base Filename—name of the exported file, without extension. The default base filename is solution.
  • File Extension—automatically set to .hdf5. Read-only.
Particle Tracks Extractor
For export of Lagrangian phase data, allows you to specify the criteria by which particles are divided into groups before export.
  • Number of Bins—number of groups in which the particles are divided.
  • Diameter Range—specifies the minimum and maximum diameter of the particles that are exported to gPROMS.
  • Absolute Cluster Centroid Tolerance—specifies the tolerance for the distance between cell clusters.

Zones Manager Properties

Number of Zones
Displays the number of zones defined for this link. Read-only.

Zones Manager Right-Click Actions

New
Adds a zone under the Zones node.

[Zone] Properties

Index
Specifies a unique index which identifies a zone. Read-only.
Zone Type
Specifies whether the zone contains volume parts (regions) or surface parts (boundaries). A volume zone couples a Simcenter STAR-CCM+ region with a gPROMS network; a surface zone couples a Simcenter STAR-CCM+ boundary with a gPROMS environment zone or surface.

[Zone] Conditions and Values

A zone allows you to couple a Simcenter STAR-CCM+ region, inlet/outlet boundary, or wall boundary with a gPROMS network, environment zone, or surface, respectively. The zone conditions and values specify the coupled parts and the fields that are exported from the Simcenter STAR-CCM+ coupled part.

Exported Fields
Lists the fields that are exported from the specified Simcenter STAR-CCM+ coupled parts. Simcenter STAR-CCM+ automatically determines the fields that are required from gPROMS based on the specified coupled parts (see Exported Fields). For each field node, Simcenter STAR-CCM+ automatically specifies the following properties:
  • Initialization Method: always set to User-specified initialization value. You can change the initialization value under the relevant [Zone] > Values > Initialization Values node.
  • Field Stencil: the location on the coupled part (face, vertex, or cell) from which the field is exported.
  • Field Treatment: automatically set to Unmanaged. Read-only.
  • Scalar/Vector Function: specifies the field function containing the data to be exported.
You can export additional fields by adding auxiliary field specifications and setting their properties.
Volume Parts
For a volume zone, specifies the Simcenter STAR-CCM+ fluid region that couples with the gPROMS network.
Surface Parts
For a surface zone, specifies the Simcenter STAR-CCM+ boundary that couples with a gPROMS environment zone or surface.
External Volume Part
For a volume zone, specifies the external region that represents the gPROMS network in the Simcenter STAR-CCM+ simulation. The specified External Volume Part couples with the Simcenter STAR-CCM+ region specified for the zone Volume Parts.
External Surface Part
For a surface zone, specifies the external boundary that represents the coupled gPROMS environment zone or surface. The specified External Surface Part couples with the Simcenter STAR-CCM+ boundary specified for the zone Surface Parts.
Particle Tracks
When coupling Lagrangian phases, specifies the particle tracks (that are loaded from the particle track file) associated with the Simcenter STAR-CCM+ boundaries in this zone.
Initialization Values
Allows you to change the initialization values for the exported fields.

Link Right-Click Actions

Create New Zone
Allows you to create a new zone within an existing link.