You can create a coupled analysis in Workbench and export its setup for execution in one of System Coupling's user interfaces. Because all the steps are automated, this is the preferred method of making a Workbench-based analysis available in System Coupling's GUI or CLI.
Note: The import of .sci files via System Coupling's File > Import SCI File GUI option or ImportSystemCouplingInputFile() command is still supported, but not recommended.
The setup process is similar to that for an analysis to be run in Workbench, as described in Setting Up a Coupled Analysis in Workbench (though completion of the System Coupling system is optional). When the setup of participant systems is complete (including schematic connections between participant systems' Setup cells and the System Coupling system's Setup cell), you can export the files needed to execute the analysis in the GUI or CLI. The capabilities available for the coupled analysis are determined by the timing of the export within the Workbench workflow. The export operation automatically creates a directory structure and writes the necessary System Coupling and participant files to it.
For more information, see:
To create the System Coupling setup in Workbench, perform the following steps:
Complete the setup for each coupling participant system.
Set up the physics for each participant in the same way as for a Workbench run, as described in Completing the Coupling Setup.
Note: Ensure that the paths to all required scripts and executables are added to the PATH environment variable so that participating applications can be launched from the GUI or CLI.
Optionally, complete the setup for the System Coupling system.
Whether you should perform this step depends on the type of coupling setup file you want to use for the execution of the analysis. For details, see Files Needed for a User-Interface Run.
Whether you should perform this step before the export depends on the capabilities required for the coupled analysis. For details, see Exporting Partial vs. Full Coupling Setups.
Export the System Coupling setup.
Export the files necessary for the user-interface run, as described in Exporting the System Coupling Setup.
When the coupling setup is exported, a coupled analysis working directory and subdirectory structure is created. The following required files are automatically written:
- Solver Input Files
An input file for each participant solver is written to a participant working directory created inside the coupled analysis working directory.
- System Coupling Settings File
Setup information is written to a System Coupling Settings file in the SyC folder created in the coupled analysis working directory.
The contents of the Settings file, which reflects the state of the data model at the time of the export, determines the coupling capabilities that are available for the analysis. For more information, see Exporting Partial vs. Full Coupling Setups.
Depending on the capabilities required for the analysis, you can export either a partial or a full coupling setup, as follows:
- Partial Setup:
To export a partial coupling setup, perform the export before the coupling setup is completed in Workbench. When a partial coupling setup is loaded into System Coupling's GUI or CLI:
Additional coupled analysis setup steps must be completed in the System Coupling user interface. Participant information is loaded, but Coupling Control, Coupling Interface, and Data Transfer settings must be specified.
All capabilities supported by the user-interface context are available for the coupled analysis. A partial setup provides access to the broadest range of capabilities and gives the most control over the coupled analysis configuration.
- Full Setup:
To export a full coupling setup, perform the export after the coupling setup is completed in Workbench. When a full coupling setup is loaded into System Coupling's GUI or CLI:
No additional setup steps are required. Once the setup is loaded into the System Coupling user interface, the solution is ready for execution.
Only the capabilities supported by the Workbench context are available for the coupled analysis.
Note: When exporting a full coupling setup, restarts are not supported if the default participant names (that is, Solution, Solution 1, and so on) have been changed.
To export the System Coupling setup, perform the following steps:
On Workbench's Project Schematic, right-click the System Coupling system's Setup cell and select Export System Coupling Setup.
The Browse for Folder dialog opens.
Navigate to the location that will be the working directory for the coupled analysis. This should be a folder outside the Workbench project directory structure.
Select the working directory (or click Make New Folder to create one).
Click OK.
This folder is now designated as System Coupling's working directory for the coupled analysis. A folder structure similar to the one described in Recommended Directory Structure is created inside it. When the export is completed, it contains the following items:
- SyC directory
Directory created by System Coupling for the storage of its own output files. It contains the following file:
Settings file (Settings.h5)
System Coupling file populated by content from the Workbench setup. This file is used to load the coupled analysis into one of System Coupling's user interfaces.
- Export Setup Log file
Export Setup Log file (exportSetup.log) containing summary information for all the coupled analysis systems, folders, and files involved in the export.
- Participant working directories
A working directory for the storage of input and output files is created for each participant. Participant working directories are named according to the following convention:
< ParticipantID>_<#>where:
" ParticipantID" is the participant system's Component ID property, accessed by right-clicking the Project Schematic and selecting Properties" #" is an index to ensure uniqueness of the system identifier. For example, the working directories created for two Fluent participants would be named FFF and FFF-1- System Coupling input files
System Coupling input files — either participant .scp files or an .sci file, depending on whether a partial or full coupling setup was exported — are written to the working directory. The sole purpose of these files, however, is to populate the Settings.h5 file.