Skip to main content

System Coupling Python library 2023 R2

System Coupling Participant Library Capabilities

Last update: 10.07.2023
  • Co-simulation with System Coupling
  • Standalone mapping
  • Mixed co-simulation and mapping
  • Co-simulation analysis type options
    • Steady coupled analysis
    • Transient coupled analysis
  • Co-simulation restarts
  • Options for communicating co-simulation setup information
    • System Coupling Participant (SCP) file writing
    • Direct setup communication via socket connection
  • Region topology options
    • Surfaces
    • Volumes
  • Region discretization options
    • Mesh
    • Point cloud*
  • High-order mesh elements
  • Polygons and polyhedral mesh elements
  • Support for specifying mesh model (i.e., sharing of bounding surface region between two volume regions, etc.)
  • Variable tensor type options
    • Scalar
    • Vector
  • Support for intensive and extensive variables
  • Real-valued and complex-valued variables
  • Element-based and node-based variables
  • Integer-valued variable attributes
  • Real-valued variable attributes with specified dimensionality
  • N:M mapping (i.e., mapping between different numbers of regions on source and on target)
  • Mapping of variables with different properties:
    • Mapping between element-based and node-based variables
    • Mapping between intensive and extensive variables
  • Debugging tools
    • Mesh validity checks
    • Code tracer and log output
    • Standalone mode for co-simulation
  • EnSight results writing**
  • Support for MPI parallel processing***
  • Languages supported****
    • C++
    • C
    • Fortran
    • Python
  • Support for streaming transcript file to System Coupling GUI for co-simulation*****
  • Point cloud is only supported for standalone mapping when mapping intensive variable from volume mesh or point cloud region to volume point cloud region, or surface point cloud region to surface point cloud region.

** EnSight results can be written by the participant library only if the mapping workflow is used.

*** For details, see Execution in a Parallel Environment.

**** For details, see Compiling, Linking, and Executing Applications That Use the Participant Library.

***** Not currently supported in Fortran

Note the following limitations:

  • Currently, all values are assumed to be in SI units.
  • Currently, re-meshing and mesh re-partitioning are not supported in the participant library (however, mesh deformation is supported).