## On this page # C++ Interfaces for Participant Library Last update: 17.07.2025 Provides C++ interfaces to the System Coupling participant library. [More...](#details) ## Classes struct [sysc::Dimensionality](structsysc_1_1Dimensionality.xhtml) Provide a structure for dimensionality. [More...](structsysc_1_1Dimensionality.xhtml#details) struct [sysc::TimeStep](structsysc_1_1TimeStep.xhtml) Provide a struct for time step. [More...](structsysc_1_1TimeStep.xhtml#details) struct [sysc::SolutionControl](structsysc_1_1SolutionControl.xhtml) Provide a structure containing solution control. [More...](structsysc_1_1SolutionControl.xhtml#details) struct [sysc::SetupInfo](structsysc_1_1SetupInfo.xhtml) Provide a structure for System Coupling setup information. [More...](structsysc_1_1SetupInfo.xhtml#details) struct [sysc::SetupFileInfo](structsysc_1_1SetupFileInfo.xhtml) Provide a structure for writing System Coupling setup files. [More...](structsysc_1_1SetupFileInfo.xhtml#details) struct [sysc::ResultsInfo](structsysc_1_1ResultsInfo.xhtml) Provide a structure for writing System Coupling results files. [More...](structsysc_1_1ResultsInfo.xhtml#details) struct [sysc::ValidityStatus](structsysc_1_1ValidityStatus.xhtml) Provide a struct that contains information about validity. [More...](structsysc_1_1ValidityStatus.xhtml#details) struct [sysc::MeshValidityStatus](structsysc_1_1MeshValidityStatus.xhtml) Provide a struct that contains information about mesh validity. [More...](structsysc_1_1MeshValidityStatus.xhtml#details) class [sysc::InputComplexScalarData](classsysc_1_1InputComplexScalarData.xhtml) Provide a class for input complex scalar data. [More...](classsysc_1_1InputComplexScalarData.xhtml#details) class [sysc::InputComplexVectorData](classsysc_1_1InputComplexVectorData.xhtml) Provide a class for input complex vector data. [More...](classsysc_1_1InputComplexVectorData.xhtml#details) class [sysc::InputScalarData](classsysc_1_1InputScalarData.xhtml) Provide a class for input scalar data. [More...](classsysc_1_1InputScalarData.xhtml#details) class [sysc::InputVectorData](classsysc_1_1InputVectorData.xhtml) Provide a class for input vector data. [More...](classsysc_1_1InputVectorData.xhtml#details) struct [sysc::ElementIdData](structsysc_1_1ElementIdData.xhtml) Element id access struct, provides read-only access to the mesh element ids. [More...](structsysc_1_1ElementIdData.xhtml#details) struct [sysc::ElementTypeData](structsysc_1_1ElementTypeData.xhtml) Element types access struct, provides read-only access to the mesh element types. [More...](structsysc_1_1ElementTypeData.xhtml#details) struct [sysc::ElementNodeCountData](structsysc_1_1ElementNodeCountData.xhtml) Describes element node counts. [More...](structsysc_1_1ElementNodeCountData.xhtml#details) struct [sysc::ElementNodeConnectivityData](structsysc_1_1ElementNodeConnectivityData.xhtml) Describes element-to-node connectivity. [More...](structsysc_1_1ElementNodeConnectivityData.xhtml#details) struct [sysc::FaceCellConnectivityData](structsysc_1_1FaceCellConnectivityData.xhtml) Describes face-to-cell connectivity. [More...](structsysc_1_1FaceCellConnectivityData.xhtml#details) struct [sysc::CellIdData](structsysc_1_1CellIdData.xhtml) Cell ids struct, provides read-only access to the mesh cell ids. [More...](structsysc_1_1CellIdData.xhtml#details) struct [sysc::NodeData](structsysc_1_1NodeData.xhtml) Node data access struct, provides read-only access to the mesh nodes. [More...](structsysc_1_1NodeData.xhtml#details) struct [sysc::FaceData](structsysc_1_1FaceData.xhtml) Face data access struct, provides read-only access to the mesh faces. [More...](structsysc_1_1FaceData.xhtml#details) struct [sysc::CellData](structsysc_1_1CellData.xhtml) Cell data access struct, provides read-only access to the mesh cells. [More...](structsysc_1_1CellData.xhtml#details) class [sysc::OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml) Provide a class for output complex scalar data. [More...](classsysc_1_1OutputComplexScalarData.xhtml#details) class [sysc::OutputComplexVectorData](classsysc_1_1OutputComplexVectorData.xhtml) Provide a class for output complex vector data. [More...](classsysc_1_1OutputComplexVectorData.xhtml#details) class [sysc::OutputIntegerData](classsysc_1_1OutputIntegerData.xhtml) Provide a class for output integer data. [More...](classsysc_1_1OutputIntegerData.xhtml#details) class [sysc::OutputScalarData](classsysc_1_1OutputScalarData.xhtml) Provide a class for output scalar data. [More...](classsysc_1_1OutputScalarData.xhtml#details) class [sysc::OutputVectorData](classsysc_1_1OutputVectorData.xhtml) Provide a class for output vector data. [More...](classsysc_1_1OutputVectorData.xhtml#details) class [sysc::Parameter](classsysc_1_1Parameter.xhtml) Provide a class for a System Coupling parameter. [More...](classsysc_1_1Parameter.xhtml#details) class [sysc::PointCloud](classsysc_1_1PointCloud.xhtml) Provide a point cloud access class. [More...](classsysc_1_1PointCloud.xhtml#details) class [sysc::Region](classsysc_1_1Region.xhtml) Provide a class for a System Coupling region. [More...](classsysc_1_1Region.xhtml#details) class [sysc::SurfaceMesh](classsysc_1_1SurfaceMesh.xhtml) Provide a surface mesh access class. [More...](classsysc_1_1SurfaceMesh.xhtml#details) class [sysc::SystemCoupling](classsysc_1_1SystemCoupling.xhtml) Provide the main class for interacting with the System Coupling participant library. [More...](classsysc_1_1SystemCoupling.xhtml#details) class [sysc::Variable](classsysc_1_1Variable.xhtml) Provide a class for a System Coupling variable. [More...](classsysc_1_1Variable.xhtml#details) class [sysc::VolumeMesh](classsysc_1_1VolumeMesh.xhtml) Provide a volume mesh access class. [More...](classsysc_1_1VolumeMesh.xhtml#details) class [sysc::RealAttribute](classsysc_1_1RealAttribute.xhtml) Provide a class for a real-valued attribute. [More...](classsysc_1_1RealAttribute.xhtml#details) class [sysc::IntegerAttribute](classsysc_1_1IntegerAttribute.xhtml) Provide a class for an integer-valued attribute. [More...](classsysc_1_1IntegerAttribute.xhtml#details) class [sysc::CouplingInterface](classsysc_1_1CouplingInterface.xhtml) Provide a class for a coupling interface. [More...](classsysc_1_1CouplingInterface.xhtml#details) class [sysc::DataTransfer](classsysc_1_1DataTransfer.xhtml) Provide a class for a data transfer. [More...](classsysc_1_1DataTransfer.xhtml#details) ## Typedefs using [sysc::OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80) = void \* using [sysc::RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) = std::string using [sysc::VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) = std::string using [sysc::CouplingInterfaceName](group__SystemCouplingParticipantAPIs.xhtml#ga8a62847c55d192b835faff927dbf41a3) = std::string using [sysc::RestartPoint](group__SystemCouplingParticipantAPIs.xhtml#gaf2402e0ffcce217d0b9d2dda8dc2e61f) = std::string using [sysc::DisplayName](group__SystemCouplingParticipantAPIs.xhtml#ga708d69b0e949d6a42b6a0d7885eed90f) = std::string using [sysc::AttributeName](group__SystemCouplingParticipantAPIs.xhtml#gadb06eacf4ed0787d18e8ddbf0612c83c) = std::string using [sysc::ParameterName](group__SystemCouplingParticipantAPIs.xhtml#ga9cadba4f4e91a46ad88e42877c682d46) = std::string using [sysc::InputScalarDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga88faa9caadb9f89ef2f465085093961f) = [InputScalarData](classsysc_1_1InputScalarData.xhtml)(const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to input scalar data. using [sysc::InputScalarDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga7aebda691f791bc067ce644f3335ec51) = [InputScalarData](classsysc_1_1InputScalarData.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to input scalar data. using [sysc::InputVectorDataAccess](group__SystemCouplingParticipantAPIs.xhtml#gaa3a77dd5932907b2027244ab5beb3695) = [InputVectorData](classsysc_1_1InputVectorData.xhtml)(const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to input vector data. using [sysc::InputVectorDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#gaee02967775ba550055d38c3579ed5b36) = [InputVectorData](classsysc_1_1InputVectorData.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to input vector data. using [sysc::OutputScalarDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga6150f44005caeded6200c2b98dc53cef) = [OutputScalarData](classsysc_1_1OutputScalarData.xhtml)(const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to output scalar data. using [sysc::OutputScalarDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#gaf120edc186d323dc3fb469df4fc84ec2) = [OutputScalarData](classsysc_1_1OutputScalarData.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to output scalar data. using [sysc::OutputVectorDataAccess](group__SystemCouplingParticipantAPIs.xhtml#gaadcc300a7640f75b943f30a15f85089c) = [OutputVectorData](classsysc_1_1OutputVectorData.xhtml)(const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to output vector data. using [sysc::OutputVectorDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga60886cecd39cc32ceedb285bd4084803) = [OutputVectorData](classsysc_1_1OutputVectorData.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to output vector data. using [sysc::InputComplexScalarDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga708013358bf00f27601dde31ff58b6e9) = [InputComplexScalarData](classsysc_1_1InputComplexScalarData.xhtml)(const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to input complex scalar data. using [sysc::InputComplexScalarDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga3c9eb0fa515f7ae910fbe2e0cd163e16) = [InputComplexScalarData](classsysc_1_1InputComplexScalarData.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to input complex scalar data. using [sysc::InputComplexVectorDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga91180ca8de6730f4642c0ff9b4a7cb54) = [InputComplexVectorData](classsysc_1_1InputComplexVectorData.xhtml)(const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to input complex vector data. using [sysc::InputComplexVectorDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga9e38e3cd15119683d4a1a5b314b80df8) = [InputComplexVectorData](classsysc_1_1InputComplexVectorData.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to input complex vector data. using [sysc::OutputComplexScalarDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga7174b8f2d783a5b6307445f58c1a197a) = [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml)(const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to output complex scalar data. using [sysc::OutputComplexScalarDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga45096854c7d4c125089ae1877cebc1ef) = [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to output complex scalar data. using [sysc::OutputComplexVectorDataAccess](group__SystemCouplingParticipantAPIs.xhtml#gab8704721c5ff968837c46d31f733eae7) = [OutputComplexVectorData](classsysc_1_1OutputComplexVectorData.xhtml)(const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to output complex vector data. using [sysc::OutputComplexVectorDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga6a27b5d229a5dc6fa47757a2025520c5) = [OutputComplexVectorData](classsysc_1_1OutputComplexVectorData.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to output complex vector data. using [sysc::SurfaceMeshAccess](group__SystemCouplingParticipantAPIs.xhtml#ga20560636d14cb9091077bf32da18122d) = [SurfaceMesh](classsysc_1_1SurfaceMesh.xhtml)(const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &) Provide alias for function that provides access to surface mesh. using [sysc::SurfaceMeshAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga5c5ff28896203a2f4d1d52b86e97a2fc) = [SurfaceMesh](classsysc_1_1SurfaceMesh.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &) Provide alias for function that provides access to surface mesh. using [sysc::VolumeMeshAccess](group__SystemCouplingParticipantAPIs.xhtml#gab2403193e3c26aecb55c948ab023ea0e) = [VolumeMesh](classsysc_1_1VolumeMesh.xhtml)(const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &) Provide alias for function that provides access to volume mesh. using [sysc::VolumeMeshAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga1cfd8d9e43ab57d1baea0b6e556d5c8e) = [VolumeMesh](classsysc_1_1VolumeMesh.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &) Provide alias for function that provides access to volume mesh. using [sysc::PointCloudAccess](group__SystemCouplingParticipantAPIs.xhtml#ga4982690226c3e65a4f34c246b8c9efab) = [PointCloud](classsysc_1_1PointCloud.xhtml)(const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &) Provide alias for function that provides access to point cloud. using [sysc::PointCloudAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga5fe46152d97709b3c4816b78cec17b19) = [PointCloud](classsysc_1_1PointCloud.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &) Provide alias for function that provides access to point cloud. using [sysc::RestartPointCreation](group__SystemCouplingParticipantAPIs.xhtml#ga871467e0179633e71b13d4a1904ad732) = [RestartPoint](group__SystemCouplingParticipantAPIs.xhtml#gaf2402e0ffcce217d0b9d2dda8dc2e61f)() Provide an alias for function prototype that creates restart points. using [sysc::ZoneCountAccess](group__SystemCouplingParticipantAPIs.xhtml#ga06e123a795bd9a1fcfb9d265fa41c03c) = std::uint16\_t([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &) Function prototype to get the number of zones for a given region. using [sysc::SurfaceMeshMultiZoneAccess](group__SystemCouplingParticipantAPIs.xhtml#ga49df81b768fa6ca78aa043801b8500b6) = [SurfaceMesh](classsysc_1_1SurfaceMesh.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, std::uint16\_t zoneIndex) Function prototype to get the mesh zone, given region name and zone index. using [sysc::VolumeMeshMultiZoneAccess](group__SystemCouplingParticipantAPIs.xhtml#ga2d841a7268d03d17854589de965ba566) = [VolumeMesh](classsysc_1_1VolumeMesh.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, std::uint16\_t zoneIndex) Function prototype to get the mesh zone, given region name and zone index. using [sysc::PointCloudMultiZoneAccess](group__SystemCouplingParticipantAPIs.xhtml#gaead62a21fca5bebc5d525af3b314614a) = [PointCloud](classsysc_1_1PointCloud.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, std::uint16\_t zoneIndex) Provide alias for function that provides access to point cloud. using [sysc::InputScalarDataMultiZoneAccess](group__SystemCouplingParticipantAPIs.xhtml#gadf27ddb479fac7526bde872990e0dced) = [InputScalarData](classsysc_1_1InputScalarData.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &, std::uint16\_t zoneIndex) Function prototype to get the input scalar data, given region name and zone index. using [sysc::OutputScalarDataMultiZoneAccess](group__SystemCouplingParticipantAPIs.xhtml#ga21b6f5e23d943c5c7c9516f5697f5412) = [OutputScalarData](classsysc_1_1OutputScalarData.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &, std::uint16\_t zoneIndex) Function prototype to get the output scalar data, given region name and zone index. using [sysc::InputVectorDataMultiZoneAccess](group__SystemCouplingParticipantAPIs.xhtml#ga65e53939afbfb8002d58e3562ec781c6) = [InputVectorData](classsysc_1_1InputVectorData.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &, std::uint16\_t zoneIndex) Function prototype to get the input vector data, given region name and zone index. using [sysc::OutputVectorDataMultiZoneAccess](group__SystemCouplingParticipantAPIs.xhtml#gaecb624302a983c473dc368df828af07c) = [OutputVectorData](classsysc_1_1OutputVectorData.xhtml)([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &, std::uint16\_t zoneIndex) Function prototype to get the input vector data, given region name and zone index. using [sysc::InputScalarVariableAccess](group__SystemCouplingParticipantAPIs.xhtml#ga42fdaa9b44a04687caeb31b59fec2407) = [InputScalarData](classsysc_1_1InputScalarData.xhtml)(const std::string &, const std::string &) This alias will be deprecated - use InputScalarDataAccess instead. using [sysc::InputVectorVariableAccess](group__SystemCouplingParticipantAPIs.xhtml#gac5c27c7ff1bfef23b6e26ca4e1e20cc8) = [InputVectorData](classsysc_1_1InputVectorData.xhtml)(const std::string &, const std::string &) This alias will be deprecated - use InputVectorDataAccess instead. using [sysc::OutputScalarVariableAccess](group__SystemCouplingParticipantAPIs.xhtml#gab07a85938d44b2e2603abd5ed23b0b4a) = [OutputScalarData](classsysc_1_1OutputScalarData.xhtml)(const std::string &, const std::string &) This alias will be deprecated - use OutputScalarDataAccess instead. using [sysc::OutputVectorVariableAccess](group__SystemCouplingParticipantAPIs.xhtml#gab271290d308f0ed8243df67c084795c7) = [OutputVectorData](classsysc_1_1OutputVectorData.xhtml)(const std::string &, const std::string &) This alias will be deprecated - use OutputVectorDataAccess instead. ## Enumerations enum [sysc::AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967) { **Steady** = 0 , **Transient** = 1 } Provide an enum for coupled analysis type. [More...](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967) enum class [sysc::TimeIntegration](group__SystemCouplingParticipantAPIs.xhtml#gad13ee117d1f4408660fa2e70ee27b454) { **Implicit** = 0 , **Explicit** = 1 } Provide an enum for time integration. [More...](group__SystemCouplingParticipantAPIs.xhtml#gad13ee117d1f4408660fa2e70ee27b454) enum class [sysc::Dimension](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c) { **D2** = 2 , **D3** = 3 } Provide an enum for participant dimension. [More...](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c) enum [sysc::TensorType](group__SystemCouplingParticipantAPIs.xhtml#ga8f85e1fca4e3c3d086644ea6fb4b8fb7) { **Scalar** = 0 , **Vector** = 1 } Provide enum for variable tensor types. [More...](group__SystemCouplingParticipantAPIs.xhtml#ga8f85e1fca4e3c3d086644ea6fb4b8fb7) enum [sysc::RegionDiscretizationType](group__SystemCouplingParticipantAPIs.xhtml#ga59080d26b5838a6c678ee5f0d6ff63a4) { **MeshRegion** = 0 , **PointCloudRegion** = 1 } Provide enum for region discretization types. [More...](group__SystemCouplingParticipantAPIs.xhtml#ga59080d26b5838a6c678ee5f0d6ff63a4) enum class [sysc::InterfaceSide](group__SystemCouplingParticipantAPIs.xhtml#gae8967650e49639319360bad6efc649a4) { **One** = 1 , **Two** = 2 } Provide enum for coupling interface side. [More...](group__SystemCouplingParticipantAPIs.xhtml#gae8967650e49639319360bad6efc649a4) enum [sysc::Location](group__SystemCouplingParticipantAPIs.xhtml#gaced2664a481a6250f46140266dd38c2a) { **Node** = 0 , **Element** = 1 } Provide enum for variable mesh locations. [More...](group__SystemCouplingParticipantAPIs.xhtml#gaced2664a481a6250f46140266dd38c2a) enum [sysc::QuantityType](group__SystemCouplingParticipantAPIs.xhtml#gab4cbdd3230a1cb38956f5b93f941f89b) { **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. [More...](group__SystemCouplingParticipantAPIs.xhtml#gab4cbdd3230a1cb38956f5b93f941f89b) enum [sysc::ConvergenceStatus](group__SystemCouplingParticipantAPIs.xhtml#ga0b8801743579159eb41cf07d8372a734) { **Diverging** = -1 , **NotYetConverged** = 0 , **Converged** = 1 , **Complete** = 2 , **NotEvaluated** = 3 } Provide enum for participant's solver convergence status. [More...](group__SystemCouplingParticipantAPIs.xhtml#ga0b8801743579159eb41cf07d8372a734) enum class [sysc::DataType](group__SystemCouplingParticipantAPIs.xhtml#ga8c2b9557240fd9b2f908c98e3b1b27d3) { **Real** = 0 , **Complex** = 1 } Provide enum for variable data types. [More...](group__SystemCouplingParticipantAPIs.xhtml#ga8c2b9557240fd9b2f908c98e3b1b27d3) enum [sysc::Topology](group__SystemCouplingParticipantAPIs.xhtml#gadbbc75f28fce0c9b5b31fa64bb8b1e39) { **Surface** = 2 , **Volume** = 3 } Provide enum for region topologies. [More...](group__SystemCouplingParticipantAPIs.xhtml#gadbbc75f28fce0c9b5b31fa64bb8b1e39) enum [sysc::PrimitiveType](group__SystemCouplingParticipantAPIs.xhtml#gad3b1c73e4a63f4d292d65f3db875e844) { [sysc::Float](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844af25f11e4d5a18405d2880727956e3c06) = 0 , [sysc::Double](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a29843d2c1bb5760f768dcc066dac1ac1) = 1 , [sysc::Int32](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a65168a2fa10ccf906e55b9ae11f4d98d) = 2 , [sysc::Int64](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a7280672fe5e965512085d9837dbacf7f) = 3 , [sysc::UnsignedInt16](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844aa75e06a552b1c3cbfd131efe80431fa0) = 4 , [sysc::UnsignedInt64](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a89e71558fbcaabe137d0bcf04df90462) = 5 } Provide enum for supported primitive types. [More...](group__SystemCouplingParticipantAPIs.xhtml#gad3b1c73e4a63f4d292d65f3db875e844) enum class [sysc::ElementTypes](group__SystemCouplingParticipantAPIs.xhtml#ga0ae3dc5b82c48ff55c9a7b8064b67323) : std::uint16\_t { **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. [More...](group__SystemCouplingParticipantAPIs.xhtml#ga0ae3dc5b82c48ff55c9a7b8064b67323) ## Detailed Description Provides C++ interfaces to the System Coupling participant library. ## Typedef Documentation ## [◆ ](#gadb06eacf4ed0787d18e8ddbf0612c83c)AttributeName using [sysc::AttributeName](group__SystemCouplingParticipantAPIs.xhtml#gadb06eacf4ed0787d18e8ddbf0612c83c) = typedef std::string An alias for attribute name. Definition at line [235](CommonTypes_8hpp_source.xhtml#l00235) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml). ## [◆ ](#ga8a62847c55d192b835faff927dbf41a3)CouplingInterfaceName using [sysc::CouplingInterfaceName](group__SystemCouplingParticipantAPIs.xhtml#ga8a62847c55d192b835faff927dbf41a3) = typedef std::string An alias for coupling interface name. Definition at line [232](CommonTypes_8hpp_source.xhtml#l00232) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml). ## [◆ ](#ga708d69b0e949d6a42b6a0d7885eed90f)DisplayName using [sysc::DisplayName](group__SystemCouplingParticipantAPIs.xhtml#ga708d69b0e949d6a42b6a0d7885eed90f) = typedef std::string An alias for display name. Definition at line [234](CommonTypes_8hpp_source.xhtml#l00234) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml). ## [◆ ](#ga708013358bf00f27601dde31ff58b6e9)InputComplexScalarDataAccess using [sysc::InputComplexScalarDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga708013358bf00f27601dde31ff58b6e9) = typedef [InputComplexScalarData](classsysc_1_1InputComplexScalarData.xhtml)( const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to input complex scalar data. This function takes in the region and variable names and returns an [InputComplexScalarData](classsysc_1_1InputComplexScalarData.xhtml "Provide a class for input complex scalar data.") object which provides access to the field data for that variable on that region. Definition at line [114](FunctionTypes_8hpp_source.xhtml#l00114) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga3c9eb0fa515f7ae910fbe2e0cd163e16)InputComplexScalarDataAccessWithPointer using [sysc::InputComplexScalarDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga3c9eb0fa515f7ae910fbe2e0cd163e16) = typedef [InputComplexScalarData](classsysc_1_1InputComplexScalarData.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) 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](classsysc_1_1InputComplexScalarData.xhtml "Provide a class for input complex scalar data.") object which provides access to the field data for that variable on that region. Definition at line [124](FunctionTypes_8hpp_source.xhtml#l00124) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga91180ca8de6730f4642c0ff9b4a7cb54)InputComplexVectorDataAccess using [sysc::InputComplexVectorDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga91180ca8de6730f4642c0ff9b4a7cb54) = typedef [InputComplexVectorData](classsysc_1_1InputComplexVectorData.xhtml)( const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to input complex vector data. This function takes in the region and variable names and returns an [InputComplexVectorData](classsysc_1_1InputComplexVectorData.xhtml "Provide a class for input complex vector data.") object which provides access to the field data for that variable on that region. Definition at line [133](FunctionTypes_8hpp_source.xhtml#l00133) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga9e38e3cd15119683d4a1a5b314b80df8)InputComplexVectorDataAccessWithPointer using [sysc::InputComplexVectorDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga9e38e3cd15119683d4a1a5b314b80df8) = typedef [InputComplexVectorData](classsysc_1_1InputComplexVectorData.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) 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](classsysc_1_1InputComplexVectorData.xhtml "Provide a class for input complex vector data.") object which provides access to the field data for that variable on that region. Definition at line [143](FunctionTypes_8hpp_source.xhtml#l00143) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga88faa9caadb9f89ef2f465085093961f)InputScalarDataAccess using [sysc::InputScalarDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga88faa9caadb9f89ef2f465085093961f) = typedef [InputScalarData](classsysc_1_1InputScalarData.xhtml)( const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to input scalar data. This function takes in the region and variable names and returns an [InputScalarData](classsysc_1_1InputScalarData.xhtml "Provide a class for input scalar data.") object which provides access to the field data for that variable on that region. Definition at line [38](FunctionTypes_8hpp_source.xhtml#l00038) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga7aebda691f791bc067ce644f3335ec51)InputScalarDataAccessWithPointer using [sysc::InputScalarDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga7aebda691f791bc067ce644f3335ec51) = typedef [InputScalarData](classsysc_1_1InputScalarData.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) 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](classsysc_1_1InputScalarData.xhtml "Provide a class for input scalar data.") object which provides access to the field data for that variable on that region. Definition at line [48](FunctionTypes_8hpp_source.xhtml#l00048) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#gadf27ddb479fac7526bde872990e0dced)InputScalarDataMultiZoneAccess using [sysc::InputScalarDataMultiZoneAccess](group__SystemCouplingParticipantAPIs.xhtml#gadf27ddb479fac7526bde872990e0dced) = typedef [InputScalarData](classsysc_1_1InputScalarData.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &, std::uint16\_t zoneIndex) Function prototype to get the input scalar data, given region name and zone index. Definition at line [278](FunctionTypes_8hpp_source.xhtml#l00278) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga42fdaa9b44a04687caeb31b59fec2407)InputScalarVariableAccess using [sysc::InputScalarVariableAccess](group__SystemCouplingParticipantAPIs.xhtml#ga42fdaa9b44a04687caeb31b59fec2407) = typedef [InputScalarData](classsysc_1_1InputScalarData.xhtml)(const std::string &, const std::string &) This alias will be deprecated - use InputScalarDataAccess instead. Definition at line [311](FunctionTypes_8hpp_source.xhtml#l00311) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#gaa3a77dd5932907b2027244ab5beb3695)InputVectorDataAccess using [sysc::InputVectorDataAccess](group__SystemCouplingParticipantAPIs.xhtml#gaa3a77dd5932907b2027244ab5beb3695) = typedef [InputVectorData](classsysc_1_1InputVectorData.xhtml)( const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to input vector data. This function takes in the region and variable names and returns an [InputVectorData](classsysc_1_1InputVectorData.xhtml "Provide a class for input vector data.") object which provides access to the field data for that variable on that region. Definition at line [57](FunctionTypes_8hpp_source.xhtml#l00057) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#gaee02967775ba550055d38c3579ed5b36)InputVectorDataAccessWithPointer using [sysc::InputVectorDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#gaee02967775ba550055d38c3579ed5b36) = typedef [InputVectorData](classsysc_1_1InputVectorData.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) 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](classsysc_1_1InputVectorData.xhtml "Provide a class for input vector data.") object which provides access to the field data for that variable on that region. Definition at line [67](FunctionTypes_8hpp_source.xhtml#l00067) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga65e53939afbfb8002d58e3562ec781c6)InputVectorDataMultiZoneAccess using [sysc::InputVectorDataMultiZoneAccess](group__SystemCouplingParticipantAPIs.xhtml#ga65e53939afbfb8002d58e3562ec781c6) = typedef [InputVectorData](classsysc_1_1InputVectorData.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &, std::uint16\_t zoneIndex) Function prototype to get the input vector data, given region name and zone index. Definition at line [294](FunctionTypes_8hpp_source.xhtml#l00294) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#gac5c27c7ff1bfef23b6e26ca4e1e20cc8)InputVectorVariableAccess using [sysc::InputVectorVariableAccess](group__SystemCouplingParticipantAPIs.xhtml#gac5c27c7ff1bfef23b6e26ca4e1e20cc8) = typedef [InputVectorData](classsysc_1_1InputVectorData.xhtml)(const std::string &, const std::string &) This alias will be deprecated - use InputVectorDataAccess instead. Definition at line [314](FunctionTypes_8hpp_source.xhtml#l00314) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga23b9971b358756814178dd1cb3c0bc80)OpaqueDataAccess using [sysc::OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80) = typedef void\* Declare an opaque pointer type. Definition at line [228](CommonTypes_8hpp_source.xhtml#l00228) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml). ## [◆ ](#ga7174b8f2d783a5b6307445f58c1a197a)OutputComplexScalarDataAccess using [sysc::OutputComplexScalarDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga7174b8f2d783a5b6307445f58c1a197a) = typedef [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml)( const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to output complex scalar data. This function takes in the region and variable names and returns an [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml "Provide a class for output complex scalar data.") object which provides access to the field data for that variable on that region. Definition at line [152](FunctionTypes_8hpp_source.xhtml#l00152) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga45096854c7d4c125089ae1877cebc1ef)OutputComplexScalarDataAccessWithPointer using [sysc::OutputComplexScalarDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga45096854c7d4c125089ae1877cebc1ef) = typedef [OutputComplexScalarData](classsysc_1_1OutputComplexScalarData.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) 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](classsysc_1_1OutputComplexScalarData.xhtml "Provide a class for output complex scalar data.") object which provides access to the field data for that variable on that region. Definition at line [162](FunctionTypes_8hpp_source.xhtml#l00162) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#gab8704721c5ff968837c46d31f733eae7)OutputComplexVectorDataAccess using [sysc::OutputComplexVectorDataAccess](group__SystemCouplingParticipantAPIs.xhtml#gab8704721c5ff968837c46d31f733eae7) = typedef [OutputComplexVectorData](classsysc_1_1OutputComplexVectorData.xhtml)( const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to output complex vector data. This function takes in the region and variable names and returns an [OutputComplexVectorData](classsysc_1_1OutputComplexVectorData.xhtml "Provide a class for output complex vector data.") object which provides access to the field data for that variable on that region. Definition at line [171](FunctionTypes_8hpp_source.xhtml#l00171) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga6a27b5d229a5dc6fa47757a2025520c5)OutputComplexVectorDataAccessWithPointer using [sysc::OutputComplexVectorDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga6a27b5d229a5dc6fa47757a2025520c5) = typedef [OutputComplexVectorData](classsysc_1_1OutputComplexVectorData.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) 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](classsysc_1_1OutputComplexVectorData.xhtml "Provide a class for output complex vector data.") object which provides access to the field data for that variable on that region. Definition at line [181](FunctionTypes_8hpp_source.xhtml#l00181) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga6150f44005caeded6200c2b98dc53cef)OutputScalarDataAccess using [sysc::OutputScalarDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga6150f44005caeded6200c2b98dc53cef) = typedef [OutputScalarData](classsysc_1_1OutputScalarData.xhtml)( const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to output scalar data. This function takes in the region and variable names and returns an [OutputScalarData](classsysc_1_1OutputScalarData.xhtml "Provide a class for output scalar data.") object which provides access to the field data for that variable on that region. Definition at line [76](FunctionTypes_8hpp_source.xhtml#l00076) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#gaf120edc186d323dc3fb469df4fc84ec2)OutputScalarDataAccessWithPointer using [sysc::OutputScalarDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#gaf120edc186d323dc3fb469df4fc84ec2) = typedef [OutputScalarData](classsysc_1_1OutputScalarData.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) 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](classsysc_1_1OutputScalarData.xhtml "Provide a class for output scalar data.") object which provides access to the field data for that variable on that region. Definition at line [86](FunctionTypes_8hpp_source.xhtml#l00086) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga21b6f5e23d943c5c7c9516f5697f5412)OutputScalarDataMultiZoneAccess using [sysc::OutputScalarDataMultiZoneAccess](group__SystemCouplingParticipantAPIs.xhtml#ga21b6f5e23d943c5c7c9516f5697f5412) = typedef [OutputScalarData](classsysc_1_1OutputScalarData.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &, std::uint16\_t zoneIndex) Function prototype to get the output scalar data, given region name and zone index. Definition at line [286](FunctionTypes_8hpp_source.xhtml#l00286) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#gab07a85938d44b2e2603abd5ed23b0b4a)OutputScalarVariableAccess using [sysc::OutputScalarVariableAccess](group__SystemCouplingParticipantAPIs.xhtml#gab07a85938d44b2e2603abd5ed23b0b4a) = typedef [OutputScalarData](classsysc_1_1OutputScalarData.xhtml)(const std::string &, const std::string &) This alias will be deprecated - use OutputScalarDataAccess instead. Definition at line [317](FunctionTypes_8hpp_source.xhtml#l00317) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#gaadcc300a7640f75b943f30a15f85089c)OutputVectorDataAccess using [sysc::OutputVectorDataAccess](group__SystemCouplingParticipantAPIs.xhtml#gaadcc300a7640f75b943f30a15f85089c) = typedef [OutputVectorData](classsysc_1_1OutputVectorData.xhtml)( const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) Provide function prototype for access to output vector data. This function takes in the region and variable names and returns an [OutputVectorData](classsysc_1_1OutputVectorData.xhtml "Provide a class for output vector data.") object which provides access to the field data for that variable on that region. Definition at line [95](FunctionTypes_8hpp_source.xhtml#l00095) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga60886cecd39cc32ceedb285bd4084803)OutputVectorDataAccessWithPointer using [sysc::OutputVectorDataAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga60886cecd39cc32ceedb285bd4084803) = typedef [OutputVectorData](classsysc_1_1OutputVectorData.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &) 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](classsysc_1_1OutputVectorData.xhtml "Provide a class for output vector data.") object which provides access to the field data for that variable on that region. Definition at line [105](FunctionTypes_8hpp_source.xhtml#l00105) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#gaecb624302a983c473dc368df828af07c)OutputVectorDataMultiZoneAccess using [sysc::OutputVectorDataMultiZoneAccess](group__SystemCouplingParticipantAPIs.xhtml#gaecb624302a983c473dc368df828af07c) = typedef [OutputVectorData](classsysc_1_1OutputVectorData.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, const [VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) &, std::uint16\_t zoneIndex) Function prototype to get the input vector data, given region name and zone index. Definition at line [302](FunctionTypes_8hpp_source.xhtml#l00302) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#gab271290d308f0ed8243df67c084795c7)OutputVectorVariableAccess using [sysc::OutputVectorVariableAccess](group__SystemCouplingParticipantAPIs.xhtml#gab271290d308f0ed8243df67c084795c7) = typedef [OutputVectorData](classsysc_1_1OutputVectorData.xhtml)(const std::string &, const std::string &) This alias will be deprecated - use OutputVectorDataAccess instead. Definition at line [320](FunctionTypes_8hpp_source.xhtml#l00320) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga9cadba4f4e91a46ad88e42877c682d46)ParameterName using [sysc::ParameterName](group__SystemCouplingParticipantAPIs.xhtml#ga9cadba4f4e91a46ad88e42877c682d46) = typedef std::string An alias for parameter name. Definition at line [236](CommonTypes_8hpp_source.xhtml#l00236) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml). ## [◆ ](#ga4982690226c3e65a4f34c246b8c9efab)PointCloudAccess using [sysc::PointCloudAccess](group__SystemCouplingParticipantAPIs.xhtml#ga4982690226c3e65a4f34c246b8c9efab) = typedef [PointCloud](classsysc_1_1PointCloud.xhtml)(const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &) Provide alias for function that provides access to point cloud. This function takes in a region name and returns a [PointCloud](classsysc_1_1PointCloud.xhtml "Provide a point cloud access class.") object which provides access to the point cloud of that region. Definition at line [225](FunctionTypes_8hpp_source.xhtml#l00225) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga5fe46152d97709b3c4816b78cec17b19)PointCloudAccessWithPointer using [sysc::PointCloudAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga5fe46152d97709b3c4816b78cec17b19) = typedef [PointCloud](classsysc_1_1PointCloud.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &) 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](classsysc_1_1PointCloud.xhtml "Provide a point cloud access class.") object which provides access to the point cloud of that region. Definition at line [233](FunctionTypes_8hpp_source.xhtml#l00233) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#gaead62a21fca5bebc5d525af3b314614a)PointCloudMultiZoneAccess using [sysc::PointCloudMultiZoneAccess](group__SystemCouplingParticipantAPIs.xhtml#gaead62a21fca5bebc5d525af3b314614a) = typedef [PointCloud](classsysc_1_1PointCloud.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, 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. Definition at line [271](FunctionTypes_8hpp_source.xhtml#l00271) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#gad700042fb75659f4591c4dae6560a62d)RegionName using [sysc::RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) = typedef std::string An alias for region name. Definition at line [230](CommonTypes_8hpp_source.xhtml#l00230) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml). ## [◆ ](#gaf2402e0ffcce217d0b9d2dda8dc2e61f)RestartPoint using [sysc::RestartPoint](group__SystemCouplingParticipantAPIs.xhtml#gaf2402e0ffcce217d0b9d2dda8dc2e61f) = typedef std::string An alias for restart point. Definition at line [233](CommonTypes_8hpp_source.xhtml#l00233) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml). ## [◆ ](#ga871467e0179633e71b13d4a1904ad732)RestartPointCreation using [sysc::RestartPointCreation](group__SystemCouplingParticipantAPIs.xhtml#ga871467e0179633e71b13d4a1904ad732) = typedef [RestartPoint](group__SystemCouplingParticipantAPIs.xhtml#gaf2402e0ffcce217d0b9d2dda8dc2e61f)() 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. Definition at line [241](FunctionTypes_8hpp_source.xhtml#l00241) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga20560636d14cb9091077bf32da18122d)SurfaceMeshAccess using [sysc::SurfaceMeshAccess](group__SystemCouplingParticipantAPIs.xhtml#ga20560636d14cb9091077bf32da18122d) = typedef [SurfaceMesh](classsysc_1_1SurfaceMesh.xhtml)(const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &) Provide alias for function that provides access to surface mesh. This function takes in a region name and returns a [SurfaceMesh](classsysc_1_1SurfaceMesh.xhtml "Provide a surface mesh access class.") object which provides access to the surface mesh of that region. Topology of this region must be surface. Definition at line [190](FunctionTypes_8hpp_source.xhtml#l00190) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga5c5ff28896203a2f4d1d52b86e97a2fc)SurfaceMeshAccessWithPointer using [sysc::SurfaceMeshAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga5c5ff28896203a2f4d1d52b86e97a2fc) = typedef [SurfaceMesh](classsysc_1_1SurfaceMesh.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &) 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](classsysc_1_1SurfaceMesh.xhtml "Provide a surface mesh access class.") object which provides access to the surface mesh of that region. Topology of this region must be surface. Definition at line [199](FunctionTypes_8hpp_source.xhtml#l00199) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga49df81b768fa6ca78aa043801b8500b6)SurfaceMeshMultiZoneAccess using [sysc::SurfaceMeshMultiZoneAccess](group__SystemCouplingParticipantAPIs.xhtml#ga49df81b768fa6ca78aa043801b8500b6) = typedef [SurfaceMesh](classsysc_1_1SurfaceMesh.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, 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. Definition at line [254](FunctionTypes_8hpp_source.xhtml#l00254) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga500337cdc8405b3e819ca3623bb44266)VariableName using [sysc::VariableName](group__SystemCouplingParticipantAPIs.xhtml#ga500337cdc8405b3e819ca3623bb44266) = typedef std::string An alias for variable name. Definition at line [231](CommonTypes_8hpp_source.xhtml#l00231) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml). ## [◆ ](#gab2403193e3c26aecb55c948ab023ea0e)VolumeMeshAccess using [sysc::VolumeMeshAccess](group__SystemCouplingParticipantAPIs.xhtml#gab2403193e3c26aecb55c948ab023ea0e) = typedef [VolumeMesh](classsysc_1_1VolumeMesh.xhtml)(const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &) Provide alias for function that provides access to volume mesh. This function takes in a region name and returns a [VolumeMesh](classsysc_1_1VolumeMesh.xhtml "Provide a volume mesh access class.") object which provides access to the volume mesh of that region. Topology of this region must be volume. Definition at line [208](FunctionTypes_8hpp_source.xhtml#l00208) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga1cfd8d9e43ab57d1baea0b6e556d5c8e)VolumeMeshAccessWithPointer using [sysc::VolumeMeshAccessWithPointer](group__SystemCouplingParticipantAPIs.xhtml#ga1cfd8d9e43ab57d1baea0b6e556d5c8e) = typedef [VolumeMesh](classsysc_1_1VolumeMesh.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &) 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](classsysc_1_1VolumeMesh.xhtml "Provide a volume mesh access class.") object which provides access to the volume mesh of that region. Topology of this region must be volume. Definition at line [217](FunctionTypes_8hpp_source.xhtml#l00217) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga2d841a7268d03d17854589de965ba566)VolumeMeshMultiZoneAccess using [sysc::VolumeMeshMultiZoneAccess](group__SystemCouplingParticipantAPIs.xhtml#ga2d841a7268d03d17854589de965ba566) = typedef [VolumeMesh](classsysc_1_1VolumeMesh.xhtml)( [OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &, 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. Definition at line [263](FunctionTypes_8hpp_source.xhtml#l00263) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## [◆ ](#ga06e123a795bd9a1fcfb9d265fa41c03c)ZoneCountAccess using [sysc::ZoneCountAccess](group__SystemCouplingParticipantAPIs.xhtml#ga06e123a795bd9a1fcfb9d265fa41c03c) = typedef std::uint16\_t([OpaqueDataAccess](group__SystemCouplingParticipantAPIs.xhtml#ga23b9971b358756814178dd1cb3c0bc80), const [RegionName](group__SystemCouplingParticipantAPIs.xhtml#gad700042fb75659f4591c4dae6560a62d) &) Function prototype to get the number of zones for a given region. Definition at line [247](FunctionTypes_8hpp_source.xhtml#l00247) of file [FunctionTypes.hpp](FunctionTypes_8hpp_source.xhtml). ## Enumeration Type Documentation ## [◆ ](#gaffd523474fbd708f481a712f1841a967)AnalysisType enum [sysc::AnalysisType](group__SystemCouplingParticipantAPIs.xhtml#gaffd523474fbd708f481a712f1841a967) Provide an enum for coupled analysis type. Definition at line [14](CommonSettings_8hpp_source.xhtml#l00014) of file [CommonSettings.hpp](CommonSettings_8hpp_source.xhtml). 14 { 15 Steady = 0, 16 Transient = 1 17}; ## [◆ ](#ga0b8801743579159eb41cf07d8372a734)ConvergenceStatus enum [sysc::ConvergenceStatus](group__SystemCouplingParticipantAPIs.xhtml#ga0b8801743579159eb41cf07d8372a734) 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`. Definition at line [26](CommonTypes_8hpp_source.xhtml#l00026) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml). 26 { 27 Diverging = -1, 28 NotYetConverged = 0, 29 Converged = 1, 30 Complete = 2, 31 NotEvaluated = 3 32}; ## [◆ ](#ga8c2b9557240fd9b2f908c98e3b1b27d3)DataType enum class [sysc::DataType](group__SystemCouplingParticipantAPIs.xhtml#ga8c2b9557240fd9b2f908c98e3b1b27d3) strong Provide enum for variable data types. Definition at line [35](CommonTypes_8hpp_source.xhtml#l00035) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml). 35 { 36 Real = 0, 37 Complex = 1 38}; ## [◆ ](#ga47c8e4142175574918b84d336780cc7c)Dimension enum class [sysc::Dimension](group__SystemCouplingParticipantAPIs.xhtml#ga47c8e4142175574918b84d336780cc7c) strong Provide an enum for participant dimension. Definition at line [26](CommonSettings_8hpp_source.xhtml#l00026) of file [CommonSettings.hpp](CommonSettings_8hpp_source.xhtml). 26 { 27 D2 = 2, 28 D3 = 3 29}; ## [◆ ](#ga0ae3dc5b82c48ff55c9a7b8064b67323)ElementTypes enum class [sysc::ElementTypes](group__SystemCouplingParticipantAPIs.xhtml#ga0ae3dc5b82c48ff55c9a7b8064b67323) : std::uint16\_t strong Provide an enum for element types. Tri3: Trilateral element with corner nodes only. ``` *2 / \ / \ / \ / \ / \ 0*-----------*1 ``` Tri6: Trilateral element with corner and mid-side nodes. ``` *2 / \ / \ 5* *4 / \ / \ 0*-----*-----*1 3 ``` Quad4: Quadrilateral element with corner nodes only. ``` 3*-----------*2 | | | | | | | | | | | | | | 0*-----------*1 ``` Quad8: Quadrilateral element with corner and mid-side nodes. ``` 6 3*-----*-----*2 | | | | | | 7* *5 | | | | | | 0*-----*-----*1 4 ``` Tet4: Tetrahedral element with corner nodes only. ``` 3 * /|\ / | \ / | \ / | \ / | \ 0*- - -|- - -*2 \ | / \ | / \ | / \ | / \|/ *1 ``` Tet10: Tetrahedral element with corner and mid-side nodes. ``` 3 * /|\ / | \ 7* | *9 / | \ / *8 \ 0*- - *|- - -*2 \ 6| / \ | / 4* | *5 \ | / \|/ *1 ``` Hex8: Hexahedral element with corner nodes only. ``` 7*-----------*6 /| /| / / | / | / | / | / | / | / | ``` 4\*--------—\*5 | | | | | | 3\*- - -|- - -\*2 | / | / | | / | / | / | | / |/ |/ 0\*--------—\*1 Hex20: Hexahedral element with corner and mid-side nodes. ``` 14 7*-----*-----*6 /| /| / / | 15* | 13* | / *19 / *18 / 12| / | ``` 4\*--—\*--—\*5 | | | | | | 3\*- - \*|- - -\*2 | / 10| / 16\* *17 / | \*11 | \*9 | | / |/ |/ 0*--—\*--—\*1 8 Wedge6: Wedge element with corner nodes only. ``` 3*-----------*5 |\ /| | \ / | | \ / | | \ / | | \ / | | *4 | | | | 0*- - -|- - -*2 \ | / \ | / \ | / \ | / \|/ * 1 ``` Wedge15: Wedge element with corner and mid-side nodes. ``` 11 3*-----*-----*5 |\ /| | \ / | | *9 10* | 12* \ / *14 | \ / | | *4 | | | | 0*- - -|*8- -*2 \ | / \ 13* / 6* | *7 \ | / \|/ * 1 ``` Pyramid5: Pyramid element with corner nodes only. ``` *4 4 /|\ * / | \ /|\ / | \ // \\ / | \ / | | \ / | \ / / \ \ 3*- - -|- - -*2 / | | \ / | / / / \ \ / | / 3*- -|- - -|- -*2 / | / | / \ | / | / | | | | / |/ | / \ | 0*-----------*1 | | | | |/ \| *-------------* 0 1 ``` Pyramid13: Pyramid element with corner and mid-side nodes. ``` *4 4 /|\ * / | \ /|\ 12* | *11 // \\ / | \ / | | \ / |7 \ 12* / \ *11 3*- - -|* - -*2 / | | \ / *10 / / / 7 \ \ / | / 3*- -|- * -|- -*2 8 * | * 6 | *9 10* | / | / | | | | / |/ 8* / \ *6 0*-----*-----*1 | | | | 5 |/ \| *------*------* 0 5 1 ``` Polygon: Arbitrary polygon. Polyhedron: Arbitrary polyhedron. Definition at line [231](ElementTypes_8hpp_source.xhtml#l00231) of file [ElementTypes.hpp](ElementTypes_8hpp_source.xhtml). 231 : std::uint16_t { 232 Tri3 = 5u, 233 Tri6 = 6u, 234 Quad4 = 7u, 235 Quad8 = 8u, 236 Tet4 = 9u, 237 Tet10 = 10u, 238 Hex8 = 11u, 239 Hex20 = 12u, 240 Wedge6 = 13u, 241 Wedge15 = 14u, 242 Pyramid5 = 15u, 243 Pyramid13 = 16u, 244 Polygon = 18u, 245 Polyhedron = 19u 246}; ## [◆ ](#gae8967650e49639319360bad6efc649a4)InterfaceSide enum class [sysc::InterfaceSide](group__SystemCouplingParticipantAPIs.xhtml#gae8967650e49639319360bad6efc649a4) strong Provide enum for coupling interface side. Definition at line [44](CommonSettings_8hpp_source.xhtml#l00044) of file [CommonSettings.hpp](CommonSettings_8hpp_source.xhtml). 44 { 45 One = 1, 46 Two = 2 47}; ## [◆ ](#gaced2664a481a6250f46140266dd38c2a)Location enum [sysc::Location](group__SystemCouplingParticipantAPIs.xhtml#gaced2664a481a6250f46140266dd38c2a) Provide enum for variable mesh locations. Definition at line [50](CommonSettings_8hpp_source.xhtml#l00050) of file [CommonSettings.hpp](CommonSettings_8hpp_source.xhtml). 50 { 51 Node = 0, 52 Element = 1 53}; ## [◆ ](#gad3b1c73e4a63f4d292d65f3db875e844)PrimitiveType enum [sysc::PrimitiveType](group__SystemCouplingParticipantAPIs.xhtml#gad3b1c73e4a63f4d292d65f3db875e844) Provide enum for supported primitive types. EnumeratorFloat Single-precision floating point. Double Double-precision floating point. Int32 Signed 32-bit integer. Int64 Signed 64-bit integer. UnsignedInt16 Unsigned 16-bit integer. UnsignedInt64 Unsigned 64-bit integer. Definition at line [219](CommonTypes_8hpp_source.xhtml#l00219) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml). 219 { 220 [Float](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844af25f11e4d5a18405d2880727956e3c06) = 0, 221 [Double](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a29843d2c1bb5760f768dcc066dac1ac1) = 1, 222 [Int32](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a65168a2fa10ccf906e55b9ae11f4d98d) = 2, 223 [Int64](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a7280672fe5e965512085d9837dbacf7f) = 3, 224 [UnsignedInt16](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844aa75e06a552b1c3cbfd131efe80431fa0) = 4, 225 [UnsignedInt64](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a89e71558fbcaabe137d0bcf04df90462) = 5 226}; [sysc::Double](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a29843d2c1bb5760f768dcc066dac1ac1) @ Double **Definition** [CommonTypes.hpp:221](CommonTypes_8hpp_source.xhtml#l00221) [sysc::Int32](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a65168a2fa10ccf906e55b9ae11f4d98d) @ Int32 **Definition** [CommonTypes.hpp:222](CommonTypes_8hpp_source.xhtml#l00222) [sysc::Int64](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a7280672fe5e965512085d9837dbacf7f) @ Int64 **Definition** [CommonTypes.hpp:223](CommonTypes_8hpp_source.xhtml#l00223) [sysc::UnsignedInt64](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844a89e71558fbcaabe137d0bcf04df90462) @ UnsignedInt64 **Definition** [CommonTypes.hpp:225](CommonTypes_8hpp_source.xhtml#l00226) [sysc::UnsignedInt16](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844aa75e06a552b1c3cbfd131efe80431fa0) @ UnsignedInt16 **Definition** [CommonTypes.hpp:224](CommonTypes_8hpp_source.xhtml#l00224) [sysc::Float](group__SystemCouplingParticipantAPIs.xhtml#ggad3b1c73e4a63f4d292d65f3db875e844af25f11e4d5a18405d2880727956e3c06) @ Float **Definition** [CommonTypes.hpp:220](CommonTypes_8hpp_source.xhtml#l00220) ## [◆ ](#gab4cbdd3230a1cb38956f5b93f941f89b)QuantityType enum [sysc::QuantityType](group__SystemCouplingParticipantAPIs.xhtml#gab4cbdd3230a1cb38956f5b93f941f89b) 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. Definition at line [63](CommonSettings_8hpp_source.xhtml#l00063) of file [CommonSettings.hpp](CommonSettings_8hpp_source.xhtml). 63 { 64 Unspecified = 0, 65 Force = 1, 66 IncrementalDisplacement = 2, 67 Temperature = 3, 68 HeatRate = 4, 69 HeatTransferCoefficient = 5, 70 ConvectionReferenceTemperature = 6, 71 ModeShape = 7, 72 ElectricalConductivity = 8 73}; ## [◆ ](#ga59080d26b5838a6c678ee5f0d6ff63a4)RegionDiscretizationType enum [sysc::RegionDiscretizationType](group__SystemCouplingParticipantAPIs.xhtml#ga59080d26b5838a6c678ee5f0d6ff63a4) Provide enum for region discretization types. Definition at line [38](CommonSettings_8hpp_source.xhtml#l00038) of file [CommonSettings.hpp](CommonSettings_8hpp_source.xhtml). 38 { 39 MeshRegion = 0, 40 PointCloudRegion = 1 41}; ## [◆ ](#ga8f85e1fca4e3c3d086644ea6fb4b8fb7)TensorType enum [sysc::TensorType](group__SystemCouplingParticipantAPIs.xhtml#ga8f85e1fca4e3c3d086644ea6fb4b8fb7) Provide enum for variable tensor types. Definition at line [32](CommonSettings_8hpp_source.xhtml#l00032) of file [CommonSettings.hpp](CommonSettings_8hpp_source.xhtml). 32 { 33 Scalar = 0, 34 Vector = 1 35}; ## [◆ ](#gad13ee117d1f4408660fa2e70ee27b454)TimeIntegration enum class [sysc::TimeIntegration](group__SystemCouplingParticipantAPIs.xhtml#gad13ee117d1f4408660fa2e70ee27b454) strong Provide an enum for time integration. Definition at line [20](CommonSettings_8hpp_source.xhtml#l00020) of file [CommonSettings.hpp](CommonSettings_8hpp_source.xhtml). 20 { 21 Implicit = 0, 22 Explicit = 1 23}; ## [◆ ](#gadbbc75f28fce0c9b5b31fa64bb8b1e39)Topology enum [sysc::Topology](group__SystemCouplingParticipantAPIs.xhtml#gadbbc75f28fce0c9b5b31fa64bb8b1e39) Provide enum for region topologies. Definition at line [173](CommonTypes_8hpp_source.xhtml#l00173) of file [CommonTypes.hpp](CommonTypes_8hpp_source.xhtml). 173 { 174 Surface = 2, 175 Volume = 3 176};