Skip to main content

System Coupling Participant library 2026 R1

Namespace sysc

Last update: 09.03.2026

Definition: Attribute.hpp (line 14)

Classes

Enumeration types

Enumeration type AnalysisType

enum AnalysisType { /* ... */ }

Enumeration type TimeIntegration

enum TimeIntegration { /* ... */ }

Enumeration type Dimension

enum Dimension { /* ... */ }

Enumeration type TensorType

enum TensorType { /* ... */ }

Enumeration type RegionDiscretizationType

enum RegionDiscretizationType { /* ... */ }

Enumeration type InterfaceSide

enum InterfaceSide { /* ... */ }

Enumeration type Location

enum Location { /* ... */ }

Enumeration type QuantityType

enum QuantityType { /* ... */ }

Enumeration type ParticipantType

enum ParticipantType { /* ... */ }

Enumeration type ConvergenceStatus

enum ConvergenceStatus { /* ... */ }

Enumeration type DataType

enum DataType { /* ... */ }

Enumeration type Topology

enum Topology { /* ... */ }

Enumeration type PrimitiveType

enum PrimitiveType { /* ... */ }

Enumeration type ElementTypes

enum ElementTypes { /* ... */ }

Typedefs

Typedef ElementTypeUnderlyingType

Definition: ElementTypes.hpp (line 250)

using sysc::ElementTypeUnderlyingType =  typename std::underlying_type<ElementTypes>::type

Return type: typename std::underlying_type< ElementTypes >::type

Typedef ComplexScalarData

Definition: InputComplexScalarData.hpp (line 269)

using sysc::ComplexScalarData =  InputComplexScalarData

Provide an alias when input/output distinction is not required.

Return type: InputComplexScalarData

Typedef ComplexVectorData

Definition: InputComplexVectorData.hpp (line 765)

using sysc::ComplexVectorData =  InputComplexVectorData

Provide an alias when input/output distinction is not required.

Return type: InputComplexVectorData

Typedef IntegerData

Definition: InputIntegerData.hpp (line 184)

using sysc::IntegerData =  InputIntegerData

Provide an alias when input/output distinction is not required.

Return type: InputIntegerData

Typedef ScalarData

Definition: InputScalarData.hpp (line 125)

using sysc::ScalarData =  InputScalarData

Provide an alias when input/output distinction is not required.

Return type: InputScalarData

Typedef VectorData

Definition: InputVectorData.hpp (line 369)

using sysc::VectorData =  InputVectorData

Provide an alias when input/output distinction is not required.

Return type: InputVectorData

Typedef OpaqueDataAccess

Typedef RegionName

Typedef VariableName

Typedef CouplingInterfaceName

Typedef RestartPoint

Typedef TargetDataLocation

Typedef DisplayName

Typedef AttributeName

Typedef ParameterName

Typedef Port

Typedef Host

Typedef InputScalarDataAccess

Typedef InputScalarDataAccessWithPointer

Typedef InputVectorDataAccess

Typedef InputVectorDataAccessWithPointer

Typedef OutputScalarDataAccess

Typedef OutputScalarDataAccessWithPointer

Typedef OutputVectorDataAccess

Typedef OutputVectorDataAccessWithPointer

Typedef InputComplexScalarDataAccess

Typedef InputComplexScalarDataAccessWithPointer

Typedef InputComplexVectorDataAccess

Typedef InputComplexVectorDataAccessWithPointer

Typedef OutputComplexScalarDataAccess

Typedef OutputComplexScalarDataAccessWithPointer

Typedef OutputComplexVectorDataAccess

Typedef OutputComplexVectorDataAccessWithPointer

Typedef SurfaceMeshAccess

Typedef SurfaceMeshAccessWithPointer

Typedef VolumeMeshAccess

Typedef VolumeMeshAccessWithPointer

Typedef PointCloudAccess

Typedef PointCloudAccessWithPointer

Typedef RestartPointCreation

Typedef TargetDataCreation

Typedef TargetDataCreationWithPointer

Typedef TargetDataExistenceChecker

Typedef TargetDataExistenceCheckerWithPointer

Typedef ZoneCountAccess

Typedef SurfaceMeshMultiZoneAccess

Typedef VolumeMeshMultiZoneAccess

Typedef PointCloudMultiZoneAccess

Typedef InputScalarDataMultiZoneAccess

Typedef OutputScalarDataMultiZoneAccess

Typedef InputVectorDataMultiZoneAccess

Typedef OutputVectorDataMultiZoneAccess

Typedef InputScalarVariableAccess

Typedef InputVectorVariableAccess

Typedef OutputScalarVariableAccess

Typedef OutputVectorVariableAccess

Functions

Function getNumDimensions

std::uint8_t sysc::getNumDimensions(enum sysc::Dimension dimension) noexcept

Parameters:

Return type: std::uint8_t

Function rearrange

void SYSTEM_COUPLING_PARTICIPANT_DLL sysc::rearrange(OutputScalarData source, InputScalarData target)

Function to re-arrange distributed parallel scalar data.

This function can be used in the context of distributed parallel applications, interconnected by SCP library. It performs an efficient parallel re-distribution of data, from the order implied in the source data to the order implied in the target data.

"Rearrange*" set of functions are helper functions that tie together a more general datashipper interface (see Datashipper.hpp). These functions can be helpful, for example, to move the data in from one application to another). However, they do not change the relative order or elements in the array.

See System Coupling Participant library developer documentation for examples.

Constraints:

global size of source and target datas must match. An exception will be thrown otherwise.

Connection must be initialized (i.e. sysc::SystemCoupling object correctly constructed). An exception will be thrown otherwise.

Parameters:

Return type: void SYSTEM_COUPLING_PARTICIPANT_DLL

Function rearrange

void SYSTEM_COUPLING_PARTICIPANT_DLL sysc::rearrange(OutputVectorData source, InputVectorData target)

Similar function as rearrange(OutputScalarData source, InputScalarData target), but it operates on vector data.

Parameters:

Return type: void SYSTEM_COUPLING_PARTICIPANT_DLL

Function rearrange

void SYSTEM_COUPLING_PARTICIPANT_DLL sysc::rearrange(OutputIntegerData source, InputIntegerData target)

Similar function as rearrange(OutputScalarData source, InputScalarData target), but it operates on integer data.

Parameters:

Return type: void SYSTEM_COUPLING_PARTICIPANT_DLL

Function rearrange

void SYSTEM_COUPLING_PARTICIPANT_DLL sysc::rearrange(NodeData source, InputNodeData target)

Function to re-arrange distributed parallel node data.

This function is analogous to rearrange(OutputScalarData source, InputScalarData target), and has the same constraints, but it operates on node data.

Parameters:

Return type: void SYSTEM_COUPLING_PARTICIPANT_DLL

Function rearrange

void SYSTEM_COUPLING_PARTICIPANT_DLL sysc::rearrange(FaceData source, InputFaceData target)

Function to re-arrange distributed parallel face data.

This function is analogous to rearrange(OutputScalarData source, InputScalarData target), and has the same constraints, but it operates on face data.

Parameters:

Return type: void SYSTEM_COUPLING_PARTICIPANT_DLL

Function rearrange

void SYSTEM_COUPLING_PARTICIPANT_DLL sysc::rearrange(CellData source, InputCellData target)

Function to re-arrange distributed parallel cell data.

This function is analogous to rearrange(OutputScalarData source, InputScalarData target), and has the same constraints, but it operates on cell data.

Parameters:

Return type: void SYSTEM_COUPLING_PARTICIPANT_DLL

Function rearrange

void SYSTEM_COUPLING_PARTICIPANT_DLL sysc::rearrange(PointCloud source, InputPointCloud target)

Function to re-arrange distributed parallel point cloud data.

This function is analogous to rearrange(OutputScalarData source, InputScalarData target), and has the same constraints, but it operates on point cloud data.

Parameters:

Return type: void SYSTEM_COUPLING_PARTICIPANT_DLL

Function createRootServer

HostAndPort SYSTEM_COUPLING_PARTICIPANT_DLL sysc::createRootServer(Host host, Port port)

Provide a function to create a remote server for connecting multiple applications.

If it is desired to connect multiple applications using the SCP library, the global root rank must create a remote server for client connections from other processes. This function creates this remote server and returns its host name and port number. Note that only the global root process should call this function.

The returned host and port structure provides the information for other processes to connect to the global root process. The connections are established during the constructor of sysc::SystemCoupling object. See the SCP library developer's guide for more details.

Parameters:

  • host: Host name for the remote server. If left empty, SCP library will automatically determine the host name and return the value. If the non-empty host name is provided, it will be respected and returned in the host and port structure.
  • port: Port number for the remote server. If zero value is provided, SCP library will automatically determine the available port number on which the remote server is listening for incoming connections and return the value. If non-zero value is provided, SCP library will attempt to start the remote server on that port. If the requested port is not available, an exception will be thrown.

Parameters:

Return type: HostAndPort SYSTEM_COUPLING_PARTICIPANT_DLL

Function isRootServerCreated

bool SYSTEM_COUPLING_PARTICIPANT_DLL sysc::isRootServerCreated()

Query is the root server has been created. This function should only be called on the global root process.

Return type: bool SYSTEM_COUPLING_PARTICIPANT_DLL

Function getMyRank

int SYSTEM_COUPLING_PARTICIPANT_DLL sysc::getMyRank()

Get the unique rank assigned to this process by the SCP library.

Return type: int SYSTEM_COUPLING_PARTICIPANT_DLL

Function getNumRanks

int SYSTEM_COUPLING_PARTICIPANT_DLL sysc::getNumRanks()

Get the total number of processes connected by the SCP library.

Return type: int SYSTEM_COUPLING_PARTICIPANT_DLL

Function reduceMax

double SYSTEM_COUPLING_PARTICIPANT_DLL sysc::reduceMax(double value)

Perform a reduction to get max value across all processes, connected by the SCP library.

Parameters:

  • double value

Return type: double SYSTEM_COUPLING_PARTICIPANT_DLL

Function reduceMax

std::uint16_t SYSTEM_COUPLING_PARTICIPANT_DLL sysc::reduceMax(std::uint16_t value)

Perform a reduction to get max value across all processes, connected by the SCP library.

Parameters:

  • std::uint16_t value

Return type: std::uint16_t SYSTEM_COUPLING_PARTICIPANT_DLL

Function reduceSum

std::uint64_t SYSTEM_COUPLING_PARTICIPANT_DLL sysc::reduceSum(std::uint64_t value)

Perform a reduction to get sum of value across all processes, connected by the SCP library.

Parameters:

  • std::uint64_t value

Return type: std::uint64_t SYSTEM_COUPLING_PARTICIPANT_DLL

Function reduceAnd

bool SYSTEM_COUPLING_PARTICIPANT_DLL sysc::reduceAnd(bool value)

Perform a reduction to get logical AND of value across all processes, connected by the SCP library.

Parameters:

  • bool value

Return type: bool SYSTEM_COUPLING_PARTICIPANT_DLL

Function broadcast

void SYSTEM_COUPLING_PARTICIPANT_DLL sysc::broadcast(IntegerData data, int rootRank)

Perform a broadcast of an integer data from one process to all processes connected by the SCP library.

Parameters:

  • data: - data to be broadcast. Only significant on root rank.
  • rootRank: - rank of the process that is broadcasting the value.

Parameters:

Return type: void SYSTEM_COUPLING_PARTICIPANT_DLL

Function throwNonFatalError

Connect with Ansys