System Coupling Participant library 2025 R2

File syscOutputComplexScalarData.h

Last update: 17.07.2025

Location: syscOutputComplexScalarData.h

Classes

Includes

  • SystemCouplingParticipant/LibraryType.hpp
  • SystemCouplingParticipant/syscCommonTypes.h
  • <stddef.h>
  • <stdint.h>
graph LR
5["stdint.h"]

1["syscOutputComplexScalarData.h"]
click 1 "syscOutputComplexScalarData_8h.md#syscOutputComplexScalarData_8h"
1 --> 2
1 --> 3
1 --> 4
1 --> 5

3["SystemCouplingParticipant/syscCommonTypes.h"]

4["stddef.h"]

2["SystemCouplingParticipant/LibraryType.hpp"]

Functions

Function syscGetOutputComplexScalarData

SyscOutputComplexScalarData syscGetOutputComplexScalarData()

Create an empty output complex scalar data access struct.

Primitive type will default to double-precision. Data size will be set to zero. Data pointers will be set to null.

Return type: SyscOutputComplexScalarData

Function syscGetOutputComplexScalarDataSplitDouble

SyscOutputComplexScalarData syscGetOutputComplexScalarDataSplitDouble(const double *const dataReal, const double *const dataImag, size_t dataSize)

Create a complex output scalar data access struct.

Parameters:

  • dataReal: - pointer to the double-precision real data component.
  • dataImag: - pointer to the double-precision imaginary data component.
  • dataSize: - data size.

Parameters:

  • const double *const dataReal
  • const double *const dataImag
  • size_t dataSize

Return type: SyscOutputComplexScalarData

Function syscGetOutputComplexScalarDataSplitFloat

SyscOutputComplexScalarData syscGetOutputComplexScalarDataSplitFloat(const float *const dataReal, const float *const dataImag, size_t dataSize)

Create a complex output scalar data access struct.

Parameters:

  • dataReal: - pointer to the single-precision real data component.
  • dataImag: - pointer to the single-precision imaginary data component.
  • dataSize: - data size.

Parameters:

  • const float *const dataReal
  • const float *const dataImag
  • size_t dataSize

Return type: SyscOutputComplexScalarData

Function syscGetOutputComplexScalarDataCompactDouble

SyscOutputComplexScalarData syscGetOutputComplexScalarDataCompactDouble(const double *const data, size_t dataSize)

Create a complex output scalar data access struct.

Parameters:

  • data: - pointer to the double-precision data.
  • dataSize: - data size.

Parameters:

  • const double *const data
  • size_t dataSize

Return type: SyscOutputComplexScalarData

Function syscGetOutputComplexScalarDataCompactFloat

SyscOutputComplexScalarData syscGetOutputComplexScalarDataCompactFloat(const float *const data, size_t dataSize)

Create a complex output scalar data access struct.

Parameters:

  • data: - pointer to the single-precision data.
  • dataSize: - data size.

Parameters:

  • const float *const data
  • size_t dataSize

Return type: SyscOutputComplexScalarData

Source

/*
* Copyright ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
*/

#pragma once

#include "SystemCouplingParticipant/LibraryType.hpp"

#include "SystemCouplingParticipant/syscCommonTypes.h"

#include <stddef.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
  enum SyscPrimitiveType primitiveType; 
  const void* data1;                    
  const void* data2;                    
  size_t size;                          
} SyscOutputComplexScalarData;

SyscOutputComplexScalarData syscGetOutputComplexScalarData();

SyscOutputComplexScalarData syscGetOutputComplexScalarDataSplitDouble(
  const double* const dataReal,
  const double* const dataImag,
  size_t dataSize);

SyscOutputComplexScalarData syscGetOutputComplexScalarDataSplitFloat(
  const float* const dataReal,
  const float* const dataImag,
  size_t dataSize);

SyscOutputComplexScalarData syscGetOutputComplexScalarDataCompactDouble(
  const double* const data,
  size_t dataSize);

SyscOutputComplexScalarData syscGetOutputComplexScalarDataCompactFloat(
  const float* const data,
  size_t dataSize);

#ifdef __cplusplus
}
#endif

Connect with Ansys