Executing System Couplings Using the Command Line

You can set up system coupling simulations by using the command line, rather than by using the Workbench user interface.

To perform a system coupling simulation from the command line, you need to ensure paths to all required scripts and executables are added to the PATH environment variable so that these applications can be launched from command line.


Tip:  Search your installation to help resolve any missing dynamic libraries.


To run an analysis from the command line, execute the steps below. If you would like an example of this process, the tutorial "Oscillating Plate with Two-Way Fluid-Structure Interaction" provides detailed steps on how to use the command line. To access tutorials and their input files on the ANSYS Customer Portal, go to http://support.ansys.com/training.

  1. Generate the System Coupling Input file and place this file in the desired working directory for the Coupling Service. To do this, enter (double-click) the System Coupling Setup cell in the Workbench schematic, and select the Export SCI File option from the File menu. Note that this option is only available when the state of the Setup cell is up-to-date.

  2. Generate all input files required for the co-simulation participants (that is, input files required for the solvers involved in the coupling) and place these files in the respective desired working directories.

  3. The command to start the Coupling Service differs between Linux and Windows:

    • Linux:

      /ansys_inc/v181/aisol/.workbench -cmd 
      ansys.services.systemcoupling.exe -inputFile 
      oscillating_plate.sci
      
    • Windows:

      C:~\ANSYS Inc\v181\aisol\workbench.bat -cmd 
      ansys.services.systemcoupling.exe -inputFile 
      oscillating_plate.sci
      

    Note:  The paths to the .workbench and workbench.bat scripts may differ, depending upon your installation.


    These commands launch the Coupling Service and create a System Coupling Server file (scServer.scs) in the working directory. As described in System Coupling Server File (scServer.scs), this file contains information needed to start each of the co-simulation participants, specifically port and host information for the coupling service and identifiers for the participants.

    Additional information needed to run from the command line is accessible below for each of the co-simulation participants that support system couplings.

For more information about command line execution and options for supported co-simulation participants, see Supported System Coupling Participants. Co-simulation participants will tend to use a common set of system coupling related command line options (such as -schost, -scport, -scname, -scid, -sclic). You are strongly encouraged, however, to develop some expertise in running each of the participants without system couplings before attempting to execute coupled analyses from the command line.

Additional system coupling command line information can also be found in the following section:


Release 18.2 - © ANSYS, Inc. All rights reserved.