Skip to main content

Namespace sysc

Definition: Attribute.hpp (line 13)

Classes​

Enumeration types​

Enumeration type AnalysisType​

Definition: CommonSettings.hpp (line 14)

enum AnalysisType {
  Steady = 0,
  Transient = 1
}

Provide an enum for coupled analysis type.

Enumerator Steady​

Enumerator Transient​

Enumeration type TimeIntegration​

Definition: CommonSettings.hpp (line 20)

enum TimeIntegration {
  Implicit = 0,
  Explicit = 1
}

Provide an enum for time integration.

Enumerator Implicit​

Enumerator Explicit​

Enumeration type Dimension​

Definition: CommonSettings.hpp (line 26)

enum Dimension {
  D2 = 2,
  D3 = 3
}

Provide an enum for participant dimension.

Enumerator D2​

Enumerator D3​

Enumeration type TensorType​

Definition: CommonSettings.hpp (line 32)

enum TensorType {
  Scalar = 0,
  Vector = 1
}

Provide enum for variable tensor types.

Enumerator Scalar​

Enumerator Vector​

Enumeration type RegionDiscretizationType​

Definition: CommonSettings.hpp (line 38)

enum RegionDiscretizationType {
  MeshRegion = 0,
  PointCloudRegion = 1
}

Provide enum for region discretization types.

Enumerator MeshRegion​

Enumerator PointCloudRegion​

Enumeration type InterfaceSide​

Definition: CommonSettings.hpp (line 44)

enum InterfaceSide {
  One = 1,
  Two = 2
}

Provide enum for coupling interface side.

Enumerator One​

Enumerator Two​

Enumeration type Location​

Definition: CommonSettings.hpp (line 50)

enum Location {
  Node = 0,
  Element = 1
}

Provide enum for variable mesh locations.

Enumerator Node​

Enumerator Element​

Enumeration type QuantityType​

Definition: CommonSettings.hpp (line 63)

enum QuantityType {
  Unspecified = 0,
  Force = 1,
  IncrementalDisplacement = 2,
  Temperature = 3,
  HeatRate = 4,
  HeatTransferCoefficient = 5,
  ConvectionReferenceTemperature = 6,
  ModeShape = 7,
  ElectricalConductivity = 8
}

Provide an enum for variable quantity types.

Quantity type provides information about the physical meaning of the variable. This can be useful for detecting validation errors during the coupled analysis setup. If the variable does not match any of the provided quantity types, quantity type can be set to unspecified.

Enumerator Unspecified​

Enumerator Force​

Enumerator IncrementalDisplacement​

Enumerator Temperature​

Enumerator HeatRate​

Enumerator HeatTransferCoefficient​

Enumerator ConvectionReferenceTemperature​

Enumerator ModeShape​

Enumerator ElectricalConductivity​

Enumeration type ParticipantType​

Definition: CommonSettings.hpp (line 123)

enum ParticipantType {
  DEFAULT = 0,
  CFX = 1,
  FLUENT = 2,
  MAPDL = 3,
  AEDT = 4,
  FMU = 5,
  FMU_PROXY = 6,
  EXTERNALDATA = 7,
  FORTE = 8,
  DEFAULT_SRV = 9,
  MECH_SRV = 10,
  CFD_SRV = 11,
  SCDT_SRV = 12,
  THERMAL_DESKTOP = 13,
  LS_DYNA = 14,
  ROCKY = 15
}

Enumerator DEFAULT​

Enumerator CFX​

Enumerator FLUENT​

Enumerator MAPDL​

Enumerator AEDT​

Enumerator FMU​

Enumerator FMU_PROXY​

Enumerator EXTERNALDATA​

Enumerator FORTE​

Enumerator DEFAULT_SRV​

Enumerator MECH_SRV​

Enumerator CFD_SRV​

Enumerator SCDT_SRV​

Enumerator THERMAL_DESKTOP​

Enumerator LS_DYNA​

Enumerator ROCKY​

Enumeration type ConvergenceStatus​

Definition: CommonTypes.hpp (line 27)

enum ConvergenceStatus {
  Diverging = -1,
  NotYetConverged = 0,
  Converged = 1,
  Complete = 2,
  NotEvaluated = 3
}

Provide enum for participant's solver convergence status.

Possible values are Converged, NotYetConverged, Diverging, Complete (can be used if, for example, direct solver is used), and NotEvaluated.

Enumerator Diverging​

Enumerator NotYetConverged​

Enumerator Converged​

Enumerator Complete​

Enumerator NotEvaluated​

Enumeration type DataType​

Definition: CommonTypes.hpp (line 36)

enum DataType {
  Real = 0,
  Complex = 1
}

Provide enum for variable data types.

Enumerator Real​

Enumerator Complex​

Enumeration type Topology​

Definition: CommonTypes.hpp (line 196)

enum Topology {
  Surface = 2,
  Volume = 3
}

Provide enum for region topologies.

Enumerator Surface​

Enumerator Volume​

Enumeration type PrimitiveType​

Definition: CommonTypes.hpp (line 242)

enum PrimitiveType {
  Float = 0,
  Double = 1,
  Int32 = 2,
  Int64 = 3,
  UnsignedInt16 = 4,
  UnsignedInt64 = 5
}

Provide enum for supported primitive types.

Enumerator Float​

Single-precision floating point.

Enumerator Double​

Double-precision floating point.

Enumerator Int32​

Signed 32-bit integer.

Enumerator Int64​

Signed 64-bit integer.

Enumerator UnsignedInt16​

Unsigned 16-bit integer.

Enumerator UnsignedInt64​

Unsigned 64-bit integer.

Enumeration type ElementTypes​

Definition: ElementTypes.hpp (line 233)

enum ElementTypes {
  Tri3 = 5u,
  Tri6 = 6u,
  Quad4 = 7u,
  Quad8 = 8u,
  Tet4 = 9u,
  Tet10 = 10u,
  Hex8 = 11u,
  Hex20 = 12u,
  Wedge6 = 13u,
  Wedge15 = 14u,
  Pyramid5 = 15u,
  Pyramid13 = 16u,
  Polygon = 18u,
  Polyhedron = 19u
}

Provide an enum for element types.

Enumerator Tri3​

Enumerator Tri6​

Enumerator Quad4​

Enumerator Quad8​

Enumerator Tet4​

Enumerator Tet10​

Enumerator Hex8​

Enumerator Hex20​

Enumerator Wedge6​

Enumerator Wedge15​

Enumerator Pyramid5​

Enumerator Pyramid13​

Enumerator Polygon​

Enumerator Polyhedron​

Typedefs​

Typedef OpaqueDataAccess​

Definition: CommonTypes.hpp (line 251)

using sysc::OpaqueDataAccess = typedef void*

Declare an opaque pointer type.

Return type: void *

Typedef RegionName​

Definition: CommonTypes.hpp (line 253)

using sysc::RegionName = typedef std::string

An alias for region name.

Return type: std::string

Typedef VariableName​

Definition: CommonTypes.hpp (line 254)

using sysc::VariableName = typedef std::string

An alias for variable name.

Return type: std::string

Typedef CouplingInterfaceName​

Definition: CommonTypes.hpp (line 255)

using sysc::CouplingInterfaceName = typedef std::string

An alias for coupling interface name.

Return type: std::string

Typedef RestartPoint​

Definition: CommonTypes.hpp (line 256)

using sysc::RestartPoint = typedef std::string

An alias for restart point.

Return type: std::string

Typedef TargetDataLocation​

Definition: CommonTypes.hpp (line 257)

using sysc::TargetDataLocation = typedef std::string

An alias for target data location.

Return type: std::string

Typedef DisplayName​

Definition: CommonTypes.hpp (line 258)

using sysc::DisplayName = typedef std::string

An alias for display name.

Return type: std::string

Typedef AttributeName​

Definition: CommonTypes.hpp (line 259)

using sysc::AttributeName = typedef std::string

An alias for attribute name.

Return type: std::string

Typedef ParameterName​

Definition: CommonTypes.hpp (line 260)

using sysc::ParameterName = typedef std::string

An alias for parameter name.

Return type: std::string

Typedef Port​

Definition: CommonTypes.hpp (line 261)

using sysc::Port = typedef unsigned short

An alias for port.

Return type: unsigned short

Typedef Host​

Definition: CommonTypes.hpp (line 262)

using sysc::Host = typedef std::string

An alias for host name.

Return type: std::string

Typedef ElementTypeUnderlyingType​

Definition: ElementTypes.hpp (line 250)

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

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

Typedef InputScalarDataAccess​

Definition: FunctionTypes.hpp (line 38)

using sysc::InputScalarDataAccess = typedef InputScalarData( const RegionName&, const VariableName&)

Provide function prototype for access to input scalar data.

This function takes in the region and variable names and returns an InputScalarData object which provides access to the field data for that variable on that region.

Return type: InputScalarData(const RegionName &, const VariableName &)

Typedef InputScalarDataAccessWithPointer​

Definition: FunctionTypes.hpp (line 48)

using sysc::InputScalarDataAccessWithPointer = typedef InputScalarData( OpaqueDataAccess, const RegionName&, const VariableName&)

Provide function prototype for access to input scalar data.

This function takes the opaque pointer that is passed when this function is registered, as well as the region and variable names and returns an InputScalarData object which provides access to the field data for that variable on that region.

Return type: InputScalarData(OpaqueDataAccess, const RegionName &, const VariableName &)

Typedef InputVectorDataAccess​

Definition: FunctionTypes.hpp (line 57)

using sysc::InputVectorDataAccess = typedef InputVectorData( const RegionName&, const VariableName&)

Provide function prototype for access to input vector data.

This function takes in the region and variable names and returns an InputVectorData object which provides access to the field data for that variable on that region.

Return type: InputVectorData(const RegionName &, const VariableName &)

Typedef InputVectorDataAccessWithPointer​

Definition: FunctionTypes.hpp (line 67)

using sysc::InputVectorDataAccessWithPointer = typedef InputVectorData( OpaqueDataAccess, const RegionName&, const VariableName&)

Provide function prototype for access to input vector data.

This function takes the opaque pointer that is passed when this function is registered, as well as the region and variable names and returns an InputVectorData object which provides access to the field data for that variable on that region.

Return type: InputVectorData(OpaqueDataAccess, const RegionName &, const VariableName &)

Typedef OutputScalarDataAccess​

Definition: FunctionTypes.hpp (line 76)

using sysc::OutputScalarDataAccess = typedef OutputScalarData( const RegionName&, const VariableName&)

Provide function prototype for access to output scalar data.

This function takes in the region and variable names and returns an OutputScalarData object which provides access to the field data for that variable on that region.

Return type: OutputScalarData(const RegionName &, const VariableName &)

Typedef OutputScalarDataAccessWithPointer​

Definition: FunctionTypes.hpp (line 86)

using sysc::OutputScalarDataAccessWithPointer = typedef OutputScalarData( OpaqueDataAccess, const RegionName&, const VariableName&)

Provide function prototype for access to output scalar data.

This function takes the opaque pointer that is passed when this function is registered, as well as the region and variable names and returns an OutputScalarData object which provides access to the field data for that variable on that region.

Return type: OutputScalarData(OpaqueDataAccess, const RegionName &, const VariableName &)

Typedef OutputVectorDataAccess​

Definition: FunctionTypes.hpp (line 95)

using sysc::OutputVectorDataAccess = typedef OutputVectorData( const RegionName&, const VariableName&)

Provide function prototype for access to output vector data.

This function takes in the region and variable names and returns an OutputVectorData object which provides access to the field data for that variable on that region.

Return type: OutputVectorData(const RegionName &, const VariableName &)

Typedef OutputVectorDataAccessWithPointer​

Definition: FunctionTypes.hpp (line 105)

using sysc::OutputVectorDataAccessWithPointer = typedef OutputVectorData( OpaqueDataAccess, const RegionName&, const VariableName&)

Provide function prototype for access to output vector data.

This function takes the opaque pointer that is passed when this function is registered, as well as the region and variable names and returns an OutputVectorData object which provides access to the field data for that variable on that region.

Return type: OutputVectorData(OpaqueDataAccess, const RegionName &, const VariableName &)

Typedef InputComplexScalarDataAccess​

Definition: FunctionTypes.hpp (line 114)

using sysc::InputComplexScalarDataAccess = typedef InputComplexScalarData( const RegionName&, const VariableName&)

Provide function prototype for access to input complex scalar data.

This function takes in the region and variable names and returns an InputComplexScalarData object which provides access to the field data for that variable on that region.

Return type: InputComplexScalarData(const RegionName &, const VariableName &)

Typedef InputComplexScalarDataAccessWithPointer​

Definition: FunctionTypes.hpp (line 124)

using sysc::InputComplexScalarDataAccessWithPointer = typedef InputComplexScalarData( OpaqueDataAccess, const RegionName&, const VariableName&)

Provide function prototype for access to input complex scalar data.

This function takes the opaque pointer that is passed when this function is registered, as well as the region and variable names and returns an InputComplexScalarData object which provides access to the field data for that variable on that region.

Return type: InputComplexScalarData(OpaqueDataAccess, const RegionName &, const VariableName &)

Typedef InputComplexVectorDataAccess​

Definition: FunctionTypes.hpp (line 133)

using sysc::InputComplexVectorDataAccess = typedef InputComplexVectorData( const RegionName&, const VariableName&)

Provide function prototype for access to input complex vector data.

This function takes in the region and variable names and returns an InputComplexVectorData object which provides access to the field data for that variable on that region.

Return type: InputComplexVectorData(const RegionName &, const VariableName &)

Typedef InputComplexVectorDataAccessWithPointer​

Definition: FunctionTypes.hpp (line 143)

using sysc::InputComplexVectorDataAccessWithPointer = typedef InputComplexVectorData( OpaqueDataAccess, const RegionName&, const VariableName&)

Provide function prototype for access to input complex vector data.

This function takes the opaque pointer that is passed when this function is registered, as well as the region and variable names and returns an InputComplexVectorData object which provides access to the field data for that variable on that region.

Return type: InputComplexVectorData(OpaqueDataAccess, const RegionName &, const VariableName &)

Typedef OutputComplexScalarDataAccess​

Definition: FunctionTypes.hpp (line 152)

using sysc::OutputComplexScalarDataAccess = typedef OutputComplexScalarData( const RegionName&, const VariableName&)

Provide function prototype for access to output complex scalar data.

This function takes in the region and variable names and returns an OutputComplexScalarData object which provides access to the field data for that variable on that region.

Return type: OutputComplexScalarData(const RegionName &, const VariableName &)

Typedef OutputComplexScalarDataAccessWithPointer​

Definition: FunctionTypes.hpp (line 162)

using sysc::OutputComplexScalarDataAccessWithPointer = typedef OutputComplexScalarData( OpaqueDataAccess, const RegionName&, const VariableName&)

Provide function prototype for access to output complex scalar data.

This function takes the opaque pointer that is passed when this function is registered, as well as the region and variable names and returns an OutputComplexScalarData object which provides access to the field data for that variable on that region.

Return type: OutputComplexScalarData(OpaqueDataAccess, const RegionName &, const VariableName &)

Typedef OutputComplexVectorDataAccess​

Definition: FunctionTypes.hpp (line 171)

using sysc::OutputComplexVectorDataAccess = typedef OutputComplexVectorData( const RegionName&, const VariableName&)

Provide function prototype for access to output complex vector data.

This function takes in the region and variable names and returns an OutputComplexVectorData object which provides access to the field data for that variable on that region.

Return type: OutputComplexVectorData(const RegionName &, const VariableName &)

Typedef OutputComplexVectorDataAccessWithPointer​

Definition: FunctionTypes.hpp (line 181)

using sysc::OutputComplexVectorDataAccessWithPointer = typedef OutputComplexVectorData( OpaqueDataAccess, const RegionName&, const VariableName&)

Provide function prototype for access to output complex vector data.

This function takes the opaque pointer that is passed when this function is registered, as well as the region and variable names and returns an OutputComplexVectorData object which provides access to the field data for that variable on that region.

Return type: OutputComplexVectorData(OpaqueDataAccess, const RegionName &, const VariableName &)

Typedef SurfaceMeshAccess​

Definition: FunctionTypes.hpp (line 190)

using sysc::SurfaceMeshAccess = typedef SurfaceMesh(const RegionName&)

Provide alias for function that provides access to surface mesh.

This function takes in a region name and returns a SurfaceMesh object which provides access to the surface mesh of that region. Topology of this region must be surface.

Return type: SurfaceMesh(const RegionName &)

Typedef SurfaceMeshAccessWithPointer​

Definition: FunctionTypes.hpp (line 199)

using sysc::SurfaceMeshAccessWithPointer = typedef SurfaceMesh( OpaqueDataAccess, const RegionName&)

Provide alias for function that provides access to surface mesh.

This function takes the opaque pointer that is passed when this function is registered, as well as the region name and returns a SurfaceMesh object which provides access to the surface mesh of that region. Topology of this region must be surface.

Return type: SurfaceMesh(OpaqueDataAccess, const RegionName &)

Typedef VolumeMeshAccess​

Definition: FunctionTypes.hpp (line 208)

using sysc::VolumeMeshAccess = typedef VolumeMesh(const RegionName&)

Provide alias for function that provides access to volume mesh.

This function takes in a region name and returns a VolumeMesh object which provides access to the volume mesh of that region. Topology of this region must be volume.

Return type: VolumeMesh(const RegionName &)

Typedef VolumeMeshAccessWithPointer​

Definition: FunctionTypes.hpp (line 217)

using sysc::VolumeMeshAccessWithPointer = typedef VolumeMesh( OpaqueDataAccess, const RegionName&)

Provide alias for function that provides access to volume mesh.

This function takes the opaque pointer that is passed when this function is registered, as well as the region name and returns a VolumeMesh object which provides access to the volume mesh of that region. Topology of this region must be volume.

Return type: VolumeMesh(OpaqueDataAccess, const RegionName &)

Typedef PointCloudAccess​

Definition: FunctionTypes.hpp (line 225)

using sysc::PointCloudAccess = typedef PointCloud(const RegionName&)

Provide alias for function that provides access to point cloud.

This function takes in a region name and returns a PointCloud object which provides access to the point cloud of that region.

Return type: PointCloud(const RegionName &)

Typedef PointCloudAccessWithPointer​

Definition: FunctionTypes.hpp (line 233)

using sysc::PointCloudAccessWithPointer = typedef PointCloud( OpaqueDataAccess, const RegionName&)

Provide alias for function that provides access to point cloud.

This function takes the opaque pointer that is passed when this function is registered, as well as the region name and returns a PointCloud object which provides access to the point cloud of that region.

Return type: PointCloud(OpaqueDataAccess, const RegionName &)

Typedef RestartPointCreation​

Definition: FunctionTypes.hpp (line 241)

using sysc::RestartPointCreation = typedef RestartPoint()

Provide an alias for function prototype that creates restart points.

This function may be called only during outputs update, and is expected to return a unique string identifier for a given restart point.

Return type: RestartPoint()

Typedef TargetDataCreation​

Definition: FunctionTypes.hpp (line 249)

using sysc::TargetDataCreation = typedef TargetDataLocation(bool)

Provide an alias for function prototype that write target data.

This function may be called only during user friendly mapping workflow after Map() command, and is expected to return a unique string identifier for a target data file location.

Return type: TargetDataLocation(bool)

Typedef TargetDataCreationWithPointer​

Definition: FunctionTypes.hpp (line 257)

using sysc::TargetDataCreationWithPointer = typedef TargetDataLocation(OpaqueDataAccess, bool)

Provide an alias for function prototype that write target data.

This function may be called only during user friendly mapping workflow after Map() command, and is expected to return a unique string identifier for a target data file location.

Return type: TargetDataLocation(OpaqueDataAccess, bool)

Typedef TargetDataExistenceChecker​

Definition: FunctionTypes.hpp (line 267)

using sysc::TargetDataExistenceChecker = typedef bool()

Provide an alias for function prototype that checks if target data exists.

this function may be called only during user friendly mapping workflow after map() command and before writetargetdata(), and is expected to return a boolean value indicating if target data exists. True value indicates that target data exists.

Return type: bool()

Typedef TargetDataExistenceCheckerWithPointer​

Definition: FunctionTypes.hpp (line 277)

using sysc::TargetDataExistenceCheckerWithPointer = typedef bool(OpaqueDataAccess)

Provide an alias for function prototype that checks if target data exists.

this function may be called only during user friendly mapping workflow after map() command and before writetargetdata(), and is expected to return a boolean value indicating if target data exists. True value indicates that target data exists.

Return type: bool(OpaqueDataAccess)

Typedef ZoneCountAccess​

Definition: FunctionTypes.hpp (line 282)

using sysc::ZoneCountAccess = typedef std::uint16_t(OpaqueDataAccess, const RegionName&)

Function prototype to get the number of zones for a given region.

Return type: std::uint16_t(OpaqueDataAccess, const RegionName &)

Typedef SurfaceMeshMultiZoneAccess​

Definition: FunctionTypes.hpp (line 289)

using sysc::SurfaceMeshMultiZoneAccess = typedef SurfaceMesh( OpaqueDataAccess, const RegionName&, std::uint16_t zoneIndex)

Function prototype to get the mesh zone, given region name and zone index.

Certain restrictions apply:

  • Surface mesh objects must provide correct face ids.

Return type: SurfaceMesh(OpaqueDataAccess, const RegionName &, std::uint16_t zoneIndex)

Typedef VolumeMeshMultiZoneAccess​

Definition: FunctionTypes.hpp (line 298)

using sysc::VolumeMeshMultiZoneAccess = typedef VolumeMesh( OpaqueDataAccess, const RegionName&, std::uint16_t zoneIndex)

Function prototype to get the mesh zone, given region name and zone index.

This function is provided for consistency only. Only one volume zone per region is supported.

Return type: VolumeMesh(OpaqueDataAccess, const RegionName &, std::uint16_t zoneIndex)

Typedef PointCloudMultiZoneAccess​

Definition: FunctionTypes.hpp (line 306)

using sysc::PointCloudMultiZoneAccess = typedef PointCloud( OpaqueDataAccess, const RegionName&, std::uint16_t zoneIndex)

Provide alias for function that provides access to point cloud.

This function is provided for consistency only. Only one point cloud zone per region is supported.

Return type: PointCloud(OpaqueDataAccess, const RegionName &, std::uint16_t zoneIndex)

Typedef InputScalarDataMultiZoneAccess​

Definition: FunctionTypes.hpp (line 313)

using sysc::InputScalarDataMultiZoneAccess = typedef InputScalarData( OpaqueDataAccess, const RegionName&, const VariableName&, std::uint16_t zoneIndex)

Function prototype to get the input scalar data, given region name and zone index.

Return type: InputScalarData(OpaqueDataAccess, const RegionName &, const VariableName &, std::uint16_t zoneIndex)

Typedef OutputScalarDataMultiZoneAccess​

Definition: FunctionTypes.hpp (line 321)

using sysc::OutputScalarDataMultiZoneAccess = typedef OutputScalarData( OpaqueDataAccess, const RegionName&, const VariableName&, std::uint16_t zoneIndex)

Function prototype to get the output scalar data, given region name and zone index.

Return type: OutputScalarData(OpaqueDataAccess, const RegionName &, const VariableName &, std::uint16_t zoneIndex)

Typedef InputVectorDataMultiZoneAccess​

Definition: FunctionTypes.hpp (line 329)

using sysc::InputVectorDataMultiZoneAccess = typedef InputVectorData( OpaqueDataAccess, const RegionName&, const VariableName&, std::uint16_t zoneIndex)

Function prototype to get the input vector data, given region name and zone index.

Return type: InputVectorData(OpaqueDataAccess, const RegionName &, const VariableName &, std::uint16_t zoneIndex)

Typedef OutputVectorDataMultiZoneAccess​

Definition: FunctionTypes.hpp (line 337)

using sysc::OutputVectorDataMultiZoneAccess = typedef OutputVectorData( OpaqueDataAccess, const RegionName&, const VariableName&, std::uint16_t zoneIndex)

Function prototype to get the input vector data, given region name and zone index.

Return type: OutputVectorData(OpaqueDataAccess, const RegionName &, const VariableName &, std::uint16_t zoneIndex)

Typedef InputScalarVariableAccess​

Definition: FunctionTypes.hpp (line 346)

using sysc::InputScalarVariableAccess = typedef InputScalarData(const std::string&, const std::string&)

This alias will be deprecated - use InputScalarDataAccess instead.

Return type: InputScalarData(const std::string &, const std::string &)

Typedef InputVectorVariableAccess​

Definition: FunctionTypes.hpp (line 349)

using sysc::InputVectorVariableAccess = typedef InputVectorData(const std::string&, const std::string&)

This alias will be deprecated - use InputVectorDataAccess instead.

Return type: InputVectorData(const std::string &, const std::string &)

Typedef OutputScalarVariableAccess​

Definition: FunctionTypes.hpp (line 352)

using sysc::OutputScalarVariableAccess = typedef OutputScalarData(const std::string&, const std::string&)

This alias will be deprecated - use OutputScalarDataAccess instead.

Return type: OutputScalarData(const std::string &, const std::string &)

Typedef OutputVectorVariableAccess​

Definition: FunctionTypes.hpp (line 355)

using sysc::OutputVectorVariableAccess = typedef OutputVectorData(const std::string&, const std::string&)

This alias will be deprecated - use OutputVectorDataAccess instead.

Return type: OutputVectorData(const std::string &, const std::string &)

Functions​

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.

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(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 throwNonFatalError​

void SYSTEM_COUPLING_PARTICIPANT_DLL sysc::throwNonFatalError(const std::string &errorMessage)

Provide a helper function to throw a non-fatal error.

Parameters:

  • const std::string & errorMessage

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 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

Last updated on by rborsaru-ansys