Provide the main class for interacting with the System Coupling participant library. More...

#include <SystemCoupling.hpp>

Public Member Functions
	SystemCoupling ()
	Provide a (default) constructor for the SystemCoupling class for non-cosimulation mode. More...

	SystemCoupling (std::size_t mpiCommunicator)
	Provide a constructor for the SystemCoupling class for non-cosimulation mode with a custom MPI communicator. More...

	SystemCoupling (const ParticipantInfo &participantInfo)
	Provide a constructor for the SystemCoupling class with a custom struct representing the default input parameters. More...

	SystemCoupling (const ParticipantInfo &participantInfo, std::size_t mpiCommunicator)
	Provide a constructor for the SystemCoupling class with an mpiCommunicator object set to non default. More...

	SystemCoupling (const std::string &scHost, unsigned short scPort, const std::string &participantName, const std::string &buildInformation="Unknown")
	Provide a constructor for the SystemCoupling class for cosimulation mode. More...

	SystemCoupling (const std::string &scHost, unsigned short scPort, const std::string &participantName, std::size_t mpiCommunicator, const std::string &buildInformation)
	Provide a constructor for the SystemCoupling class for cosimulation mode with a custom MPI communicator. More...

void	completeSetup (const sysc::SetupInfo &setupInfo)
	Provide a function to notify System Coupling that setup can be completed. More...

void	initializeAnalysis ()
	Provide a function to notify System Coupling that analysis initialization can be completed. More...

sysc::TimeStep	getCurrentTimeStep ()
	Provide a function to get current time step. More...

bool	doIteration ()
	Provide a function to check whether to do a coupling iteration. More...

bool	doTimeStep ()
	Provide a function to check whether to do a coupling time step. More...

void	updateInputs ()
	Provide a function to update the participants input variables. More...

void	updateOutputs (ConvergenceStatus status)
	Provide a function to update the participants output variables. More...

void	disconnect ()
	Provide a function to end the analysis and disconnect from System Coupling.

void	fatalError (const std::string &errorMessage)
	Provide a function to notify System Coupling about a fatal error.

void	addRegion (const Region &region)
	Provide a function to add a region that could be used in a coupled analysis. More...

void	addInputParameter (Parameter parameter)
	Provide a method to add an input parameter that could be used in a coupled analysis. More...

void	addOutputParameter (Parameter parameter)
	Provide a method to add an output parameter that could be used in a coupled analysis. More...

void	addRealAttribute (const RealAttribute &realAttribute)
	Provide a method to add a real attribute that could be used in a coupled analysis. More...

void	addIntegerAttribute (const IntegerAttribute &integerAttribute)
	Provide a method to add an integer attribute that could be used in a coupled analysis. More...

void	addCouplingInterface (const CouplingInterface &couplingInterface)
	Provide a function to add a coupling interface. More...

void	addCouplingInterface (const CouplingInterface &couplingInterface, bool autoGenerateTransfers)
	Provide a function to add a coupling interface. More...

double	getParameterValue (const ParameterName &parameterName)
	Provide a function to get a Parameter value. More...

void	setParameterValue (const ParameterName &parameterName, double value)
	Provide a function to set a Parameter value. More...

double	getRealAttributeValue (const AttributeName &attributeName)
	Provide a function to get a RealAttribute value. More...

int64_t	getIntegerAttributeValue (const AttributeName &attributeName)
	Provide a function to get an IntegerAttribute value. More...

void	registerInputScalarDataAccess (InputScalarDataAccess *dataAccess)
	Provide a function to register input scalar data access. More...

void	registerInputScalarDataAccess (OpaqueDataAccess opaqueDataAccess, InputScalarDataAccessWithPointer *dataAccess)
	Provide a function to register input scalar data access. More...

void	registerInputVectorDataAccess (InputVectorDataAccess *dataAccess)
	Provide a function to register input vector data access. More...

void	registerInputVectorDataAccess (OpaqueDataAccess opaqueDataAccess, InputVectorDataAccessWithPointer *dataAccess)
	Provide a function to register input vector data access. More...

void	registerOutputScalarDataAccess (OutputScalarDataAccess *dataAccess)
	Provide a function to register output scalar data access. More...

void	registerOutputScalarDataAccess (OpaqueDataAccess opaqueDataAccess, OutputScalarDataAccessWithPointer *dataAccess)
	Provide a function to register output scalar data access. More...

void	registerOutputVectorDataAccess (OutputVectorDataAccess *dataAccess)
	Provide a function to register output vector data access. More...

void	registerOutputVectorDataAccess (OpaqueDataAccess opaqueDataAccess, OutputVectorDataAccessWithPointer *dataAccess)
	Provide a function to register output vector data access. More...

void	registerInputComplexScalarDataAccess (InputComplexScalarDataAccess *dataAccess)
	Provide a function to register input complex scalar data access. More...

void	registerInputComplexScalarDataAccess (OpaqueDataAccess opaqueDataAccess, InputComplexScalarDataAccessWithPointer *dataAccess)
	Provide a function to register input complex scalar data access. More...

void	registerInputComplexVectorDataAccess (InputComplexVectorDataAccess *dataAccess)
	Provide a function to register input complex vector data access. More...

void	registerInputComplexVectorDataAccess (OpaqueDataAccess opaqueDataAccess, InputComplexVectorDataAccessWithPointer *dataAccess)
	Provide a function to register input complex vector data access. More...

void	registerOutputComplexScalarDataAccess (OutputComplexScalarDataAccess *dataAccess)
	Provide a function to register output complex scalar data access. More...

void	registerOutputComplexScalarDataAccess (OpaqueDataAccess opaqueDataAccess, OutputComplexScalarDataAccessWithPointer *dataAccess)
	Provide a function to register output complex scalar data access. More...

void	registerOutputComplexVectorDataAccess (OutputComplexVectorDataAccess *dataAccess)
	Provide a function to register output complex vector data access. More...

void	registerOutputComplexVectorDataAccess (OpaqueDataAccess opaqueDataAccess, OutputComplexVectorDataAccessWithPointer *dataAccess)
	Provide a function to register output complex vector data access. More...

void	registerSurfaceMeshAccess (SurfaceMeshAccess *meshAccess)
	Provide a function to register surface mesh access. More...

void	registerSurfaceMeshAccess (OpaqueDataAccess opaqueDataAccess, SurfaceMeshAccessWithPointer *meshAccess)
	Provide a function to register surface mesh access. More...

void	registerZoneCountAccess (OpaqueDataAccess opaqueDataAccess, ZoneCountAccess *zoneCountAccess)

void	registerSurfaceMeshAccess (OpaqueDataAccess opaqueDataAccess, SurfaceMeshMultiZoneAccess *dataAccess)

void	registerVolumeMeshAccess (OpaqueDataAccess opaqueDataAccess, VolumeMeshMultiZoneAccess *dataAccess)

void	registerInputScalarDataAccess (OpaqueDataAccess opaqueDataAccess, InputScalarDataMultiZoneAccess *dataAccess)

void	registerOutputScalarDataAccess (OpaqueDataAccess opaqueDataAccess, OutputScalarDataMultiZoneAccess *dataAccess)

void	registerInputVectorDataAccess (OpaqueDataAccess opaqueDataAccess, InputVectorDataMultiZoneAccess *dataAccess)

void	registerOutputVectorDataAccess (OpaqueDataAccess opaqueDataAccess, OutputVectorDataMultiZoneAccess *dataAccess)
	Provide a function to register output vector data access. More...

void	registerVolumeMeshAccess (VolumeMeshAccess *meshAccess)
	Provide a function to register volume mesh access. More...

void	registerVolumeMeshAccess (OpaqueDataAccess opaqueDataAccess, VolumeMeshAccessWithPointer *meshAccess)
	Provide a function to register volume mesh access. More...

void	registerPointCloudAccess (PointCloudAccess *pointCloudAccess)
	Provide a function to register point cloud access. More...

void	registerPointCloudAccess (OpaqueDataAccess opaqueDataAccess, PointCloudAccessWithPointer *pointCloudAccess)
	Provide a function to register point cloud access. More...

void	registerPointCloudAccess (OpaqueDataAccess opaqueDataAccess, PointCloudMultiZoneAccess *pointCloudAccess)
	Provide a function to register point cloud access. More...

void	registerRestartPointCreation (RestartPointCreation *restartPointCreation)
	Provide a function to register a restart point creation callback. More...

void	registerTargetDataCreation (TargetDataCreation *targetDataCreation)
	Provide a function to register a target data creation callback. More...

void	registerTargetDataCreation (OpaqueDataAccess opaqueDataAccess, TargetDataCreationWithPointer *targetDataCreation)
	Provide a function to register a target data creation callback. More...

bool	writeSetupFile (const SetupFileInfo &setupFileInfo) const
	Provide a function to write the setup file. More...

void	writeResults (const ResultsInfo &resultsInfo) const
	Write results to a file.

std::size_t	getNumRegions () const
	Provide a function to return the number of regions. More...

const Region &	getAddedRegion (std::size_t index) const
	Provide a function to return region information. More...

SolutionControl	getSolutionControl () const
	Get solution control.

std::size_t	getNumCouplingInterfaces () const
	Provide a function to return the number of coupling interfaces. More...

const CouplingInterface &	getAddedCouplingInterface (std::size_t index) const
	Provide a function to return coupling interface. More...

const Parameter &	getInputParameter (std::size_t index) const
	Provide a function to return input parameter information. More...

const Parameter &	getOutputParameter (std::size_t index) const
	Provide a function to return output parameter information. More...

std::size_t	getNumInputParameters () const
	Provide a function to return the number of input parameters. More...

std::size_t	getNumOutputParameters () const
	Provide a function to return the number of output parameters. More...

std::size_t	getNumRealAttributes () const
	Provide a function to return the number of real attributes. More...

std::size_t	getNumIntegerAttributes () const
	Provide a function to return the number of integer attributes. More...

const RealAttribute &	getRealAttribute (std::size_t index) const
	Provide a function to return real attribute information. More...

const IntegerAttribute &	getIntegerAttribute (std::size_t index) const
	Provide a function to return integer attribute information. More...

void	completeCouplingSetup ()
	This function will be deprecated. Use completeSetup() instead.

void	completeCouplingSetup (sysc::AnalysisType analysisType)
	This function will be deprecated. Use completeSetup() instead.

void	registerInputScalarVariableAccess (InputScalarVariableAccess *dataAccess)
	Deprecated - do not use.

void	registerInputVectorVariableAccess (InputVectorVariableAccess *dataAccess)
	Deprecated - do not use.

void	registerOutputScalarVariableAccess (OutputScalarVariableAccess *dataAccess)
	Deprecated - do not use.

void	registerOutputVectorVariableAccess (OutputVectorVariableAccess *dataAccess)
	Deprecated - do not use.

MeshValidityStatus	checkMeshValidity (const Region &region)
	Deprecated. Use sysc::SurfaceMesh::checkMeshValidity instead.

MeshValidityStatus	checkMeshValidity (const std::string &regionName)
	Deprecated. Use sysc::SurfaceMesh::checkMeshValidity instead.

const Region &	getRegion (std::size_t index) const
	Deprecated. Use getAddedRegion() instead.

	SystemCoupling (const SystemCoupling &)=delete
	Delete the copy-constructor.

	SystemCoupling (SystemCoupling &&)=default
	Provide the move-constructor.

SystemCoupling &	operator= (const SystemCoupling &)=delete
	Delete the copy-assign operator.

SystemCoupling &	operator= (SystemCoupling &&)=default
	Provide the move-assign operator.

Detailed Description

Provide the main class for interacting with the System Coupling participant library.

For co-simulation, this class maintains the socket connection to the System Coupling solver. The coupling participant will need to provide host and port information for existing System Coupling server, as well as the name of this coupling participant.

For mapping, an instance of this class should be created to perform mapping.

There should only be one instance of this System Coupling class.

Definition at line 45 of file SystemCoupling.hpp.

Constructor & Destructor Documentation

◆ SystemCoupling() [1/6]

sysc::SystemCoupling::SystemCoupling ( )

Provide a (default) constructor for the SystemCoupling class for non-cosimulation mode.

This is a default constructor that will initialize the participant library in standalone (non-cosimulation) mode.

When running in parallel MPI environment, the parallel communication within the participant library will use MPI_COMM_WORLD communicator.

◆ SystemCoupling() [2/6]

sysc::SystemCoupling::SystemCoupling ( std::size_t mpiCommunicator )

Provide a constructor for the SystemCoupling class for non-cosimulation mode with a custom MPI communicator.

Parameters

[in] mpiCommunicator MPI communicator cast to std::size_t.

This will initialize the participant library in standalone mode and will use the provided MPI communicator for all parallel communication.

◆ SystemCoupling() [3/6]

sysc::SystemCoupling::SystemCoupling ( const ParticipantInfo & participantInfo )

Provide a constructor for the SystemCoupling class with a custom struct representing the default input parameters.

Parameters

[in] participantInfo The struct containing the attributes needed to connect to System Coupling: scHost, scPort, participantName, etc.

◆ SystemCoupling() [4/6]

sysc::SystemCoupling::SystemCoupling	(	const ParticipantInfo &	participantInfo,
		std::size_t	mpiCommunicator
	)

Provide a constructor for the SystemCoupling class with an mpiCommunicator object set to non default.

Parameters

[in]	participantInfo	The struct containing the attributes needed to connect to System Coupling: scHost, scPort, participantName, etc.
[in]	mpiCommunicator	MPI communicator cast to std::size_t.

◆ SystemCoupling() [5/6]

sysc::SystemCoupling::SystemCoupling	(	const std::string &	scHost,
		unsigned short	scPort,
		const std::string &	participantName,
		const std::string &	buildInformation = `"Unknown"`
	)

Provide a constructor for the SystemCoupling class for cosimulation mode.

Initializes the participant library in cosimulation mode. It establishes the connection to the System Coupling solver.

The participant solver must have obtained the host and port information from System Coupling prior to creating this object (e.g. via an input argument when participant application was started). Copy constructor and assignment operators are disabled to avoid copying the created object.

Parameters

[in]	scHost	Name of the host on which System Coupling is running.
[in]	scPort	Port number on which System Coupling is listening for participant connections.
[in]	participantName	Name of this participant (e.g. "MAPDL-1")
[in]	buildInformation	Information about the build of this participant solver. This parameter is optional - default is "Unknown".

◆ SystemCoupling() [6/6]

sysc::SystemCoupling::SystemCoupling	(	const std::string &	scHost,
		unsigned short	scPort,
		const std::string &	participantName,
		std::size_t	mpiCommunicator,
		const std::string &	buildInformation
	)

Provide a constructor for the SystemCoupling class for cosimulation mode with a custom MPI communicator.

This constructor works the same way as the one above (see above), but it takes in one additional argument, which is the MPI communicator, cast as std::size_t.

Parameters

[in]	scHost	Name of the host on which System Coupling is running.
[in]	scPort	Port number on which System Coupling is listening for participant connections.
[in]	participantName	Name of this participant (e.g. "MAPDL-1")
[in]	mpiCommunicator	MPI communicator cast to std::size_t.
[in]	buildInformation	Information about the build of this participant solver. This parameter is optional - default is "Unknown".

Member Function Documentation

◆ addCouplingInterface() [1/2]

void sysc::SystemCoupling::addCouplingInterface ( const CouplingInterface & couplingInterface )

Provide a function to add a coupling interface.

Parameters

[in] couplingInterface - coupling interface to be added.

Data transfers will be automatically created. If a variable is defined as an output on all regions on one side of the interface and as an input on all regions on the opposite side of the interface, then the data transfer will be added for this variable.

If this coupling interface has already been added, then this call will have no effect.

If a different coupling interface with the same has already been added, then a runtime error will be thrown.

If the coupling interface name contains invalid characters, then a runtime error will be thrown.

See sysc::CouplingInterface for more details.

◆ addCouplingInterface() [2/2]

void sysc::SystemCoupling::addCouplingInterface	(	const CouplingInterface &	couplingInterface,
		bool	autoGenerateTransfers
	)

Provide a function to add a coupling interface.

Parameters

[in]	couplingInterface	- coupling interface to be added.
[in]	autoGenerateTransfers	- flag whether to automatically create data transfers.

If this coupling interface has already been added, then this call will have no effect.

If a different coupling interface with the same has already been added, then a runtime error will be thrown.

If the coupling interface name contains invalid characters, then a runtime error will be thrown.

If autoGenerateTransfers is true, then the data transfers are generated automatically according to the following rule: if a variable is defined as an output on all regions on one side of the interface and as an input on all regions on the opposite side of the interface, then the data transfer will be added for this variable.

See sysc::CouplingInterface for more details.

◆ addInputParameter()

void sysc::SystemCoupling::addInputParameter ( Parameter parameter )

Provide a method to add an input parameter that could be used in a coupled analysis.

If this parameter has already been added as an input solver parameter, then this call will have no effect.

If a different parameter with the same name has already been added as an input parameter, then a runtime error will be thrown.

If a parameter with the same name has already been added as an output parameter, then a runtime error will be thrown.

If the parameter name contains invalid characters, a runtime error will be thrown.

Parameters

parameter Parameter whose values are provided by System Coupling and consumed by the participant.

◆ addIntegerAttribute()

void sysc::SystemCoupling::addIntegerAttribute ( const IntegerAttribute & integerAttribute )

Provide a method to add an integer attribute that could be used in a coupled analysis.

If this attribute has already been added as an integer attribute, then this call will have no effect.

If a different integer attribute with the same name has already been added as an integer attribute, then a runtime error will be thrown.

If the integer attribute name contains invalid characters, a runtime error will be thrown.

Parameters

integerAttribute integer attribute whose values are provided by System Coupling and consumed by the participant.

◆ addOutputParameter()

void sysc::SystemCoupling::addOutputParameter ( Parameter parameter )

Provide a method to add an output parameter that could be used in a coupled analysis.

If this parameter has already been added as an output solver parameter, then this call will have no effect.

If a different parameter with the same name has already been added as an output parameter, then a runtime error will be thrown.

If a parameter with the same name has already been added as an input parameter, then a runtime error will be thrown.

If the parameter name contains invalid characters, a runtime error will be thrown.

Parameters

parameter Parameter whose values are provided by System Coupling and consumed by the participant.

◆ addRealAttribute()

void sysc::SystemCoupling::addRealAttribute ( const RealAttribute & realAttribute )

Provide a method to add a real attribute that could be used in a coupled analysis.

If this attribute has already been added as a real attribute, then this call will have no effect.

If a different real attribute with the same name has already been added as a real attribute, then a runtime error will be thrown.

If the real attribute name contains invalid characters, a runtime error will be thrown.

Parameters

realAttribute real attribute whose values are provided by System Coupling and consumed by the participant.

◆ addRegion()

void sysc::SystemCoupling::addRegion ( const Region & region )

Provide a function to add a region that could be used in a coupled analysis.

Parameters

[in] region - Region to be added.

If this region has already been added, then this call will have no effect.

If a different region with the same has already been added, then a runtime error will be thrown.

If the region name contains invalid characters, then a runtime error will be thrown.

◆ completeSetup()

void sysc::SystemCoupling::completeSetup ( const sysc::SetupInfo & setupInfo )

Provide a function to notify System Coupling that setup can be completed.

After this function is called, coupled analysis setup can no longer be updated, i.e. regions and variables cannot be changed. Participant should also pass in sysc::SetupInfo struct to provide additional information about the setup, such as whether steady or transient analysis is to be performed.

Once the setup is complete, any subsequent call to complete the setup will have no effect.

◆ doIteration()

bool sysc::SystemCoupling::doIteration ( )

Provide a function to check whether to do a coupling iteration.

This function returns true if another coupling iteration is required, otherwise it returns false.

◆ doTimeStep()

bool sysc::SystemCoupling::doTimeStep ( )

Provide a function to check whether to do a coupling time step.

This function returns true if another coupling time step is required, otherwise it returns false.

This function should be called to check if another coupling time step should be done. If the previous coupling time step is finished and another time step should be performed, then calling this function will tell System Coupling that the coupling participant is going to advance to the next time step (i.e. calling doTimeStep() will cause doIteration() to change from returning false to returning true, under the conditions described above).

This function only makes sense for transient analysis. It will always return false for steady analysis.

◆ getAddedCouplingInterface()

const CouplingInterface& sysc::SystemCoupling::getAddedCouplingInterface ( std::size_t index ) const

Provide a function to return coupling interface.

Parameters

[in] index - coupling interface index

Returns: Reference to the coupling interface at specified index.

◆ getAddedRegion()

const Region& sysc::SystemCoupling::getAddedRegion ( std::size_t index ) const

Provide a function to return region information.

Parameters

[in] index - region index

Returns: Reference to region information at specified index.

◆ getCurrentTimeStep()

sysc::TimeStep sysc::SystemCoupling::getCurrentTimeStep ( )

Provide a function to get current time step.

Returns: Returns a time step struct, which contains time step number, start time, and time step size for the current coupling time step.

A default value (time step number 0, start time 0.0, time step size 0.0) is returned if this function is called outside the coupled analysis loop or if the analysis is steady.

◆ getInputParameter()

const Parameter& sysc::SystemCoupling::getInputParameter ( std::size_t index ) const

Provide a function to return input parameter information.

Parameters

[in] index - input parameter index

Returns: Reference to input parameter information at specified index.

◆ getIntegerAttribute()

const IntegerAttribute& sysc::SystemCoupling::getIntegerAttribute ( std::size_t index ) const

Provide a function to return integer attribute information.

Parameters

[in] index - integer attribute index

Returns: Reference to integer attribute information at specified index.

◆ getIntegerAttributeValue()

int64_t sysc::SystemCoupling::getIntegerAttributeValue ( const AttributeName & attributeName )

Provide a function to get an IntegerAttribute value.

Parameters

[in] attributeName - name of the integer attribute.

◆ getNumCouplingInterfaces()

std::size_t sysc::SystemCoupling::getNumCouplingInterfaces ( ) const

Provide a function to return the number of coupling interfaces.

Returns: Number of coupling interfaces.

◆ getNumInputParameters()

std::size_t sysc::SystemCoupling::getNumInputParameters ( ) const

Provide a function to return the number of input parameters.

Returns: Number of input parameters.

◆ getNumIntegerAttributes()

std::size_t sysc::SystemCoupling::getNumIntegerAttributes ( ) const

Provide a function to return the number of integer attributes.

Returns: Number of integer attributes.

◆ getNumOutputParameters()

std::size_t sysc::SystemCoupling::getNumOutputParameters ( ) const

Provide a function to return the number of output parameters.

Returns: Number of output parameters.

◆ getNumRealAttributes()

std::size_t sysc::SystemCoupling::getNumRealAttributes ( ) const

Provide a function to return the number of real attributes.

Returns: Number of real attributes.

◆ getNumRegions()

std::size_t sysc::SystemCoupling::getNumRegions ( ) const

Provide a function to return the number of regions.

Returns: Number of regions.

◆ getOutputParameter()

const Parameter& sysc::SystemCoupling::getOutputParameter ( std::size_t index ) const

Provide a function to return output parameter information.

Parameters

[in] index - output parameter index

Returns: Reference to output parameter information at specified index.

◆ getParameterValue()

double sysc::SystemCoupling::getParameterValue ( const ParameterName & parameterName )

Provide a function to get a Parameter value.

Parameters

[in] parameterName - name of the parameter.

◆ getRealAttribute()

const RealAttribute& sysc::SystemCoupling::getRealAttribute ( std::size_t index ) const

Provide a function to return real attribute information.

Parameters

[in] index - real attribute index

Returns: Reference to real attribute information at specified index.

◆ getRealAttributeValue()

double sysc::SystemCoupling::getRealAttributeValue ( const AttributeName & attributeName )

Provide a function to get a RealAttribute value.

Parameters

[in] attributeName - name of the real attribute.

◆ initializeAnalysis()

void sysc::SystemCoupling::initializeAnalysis ( )

Provide a function to notify System Coupling that analysis initialization can be completed.

This function must be called after registering mesh and variable data access and prior to entering the coupled analysis loop.

If this function is called before the coupled analysis is complete, it will automatically complete the coupled analysis and assume steady analysis type.

◆ registerInputComplexScalarDataAccess() [1/2]

void sysc::SystemCoupling::registerInputComplexScalarDataAccess ( InputComplexScalarDataAccess * dataAccess )

Provide a function to register input complex scalar data access.

Parameters

dataAccess - a pointer to the function that conforms to sysc::InputComplexScalarDataAccess prototype.

◆ registerInputComplexScalarDataAccess() [2/2]

void sysc::SystemCoupling::registerInputComplexScalarDataAccess	(	OpaqueDataAccess	opaqueDataAccess,
		InputComplexScalarDataAccessWithPointer *	dataAccess
	)

Provide a function to register input complex scalar data access.

Parameters

opaqueDataAccess	- a pointer that is passed into the callback function.
dataAccess	- a pointer to the function that conforms to sysc::InputComplexScalarDataAccess prototype.

◆ registerInputComplexVectorDataAccess() [1/2]

void sysc::SystemCoupling::registerInputComplexVectorDataAccess ( InputComplexVectorDataAccess * dataAccess )

Provide a function to register input complex vector data access.

Parameters

dataAccess - a pointer to the function that conforms to InputComplexVectorDataAccess prototype.

◆ registerInputComplexVectorDataAccess() [2/2]

void sysc::SystemCoupling::registerInputComplexVectorDataAccess	(	OpaqueDataAccess	opaqueDataAccess,
		InputComplexVectorDataAccessWithPointer *	dataAccess
	)

Provide a function to register input complex vector data access.

Parameters

opaqueDataAccess	- a pointer that is passed into the callback function.
dataAccess	- a pointer to the function that conforms to InputComplexVectorDataAccess prototype.

◆ registerInputScalarDataAccess() [1/2]

void sysc::SystemCoupling::registerInputScalarDataAccess ( InputScalarDataAccess * dataAccess )

Provide a function to register input scalar data access.

Parameters

dataAccess - a pointer to the function that conforms to sysc::InputScalarDataAccess prototype.

◆ registerInputScalarDataAccess() [2/2]

void sysc::SystemCoupling::registerInputScalarDataAccess	(	OpaqueDataAccess	opaqueDataAccess,
		InputScalarDataAccessWithPointer *	dataAccess
	)

Provide a function to register input scalar data access.

Parameters

opaqueDataAccess	- a pointer that is passed into the callback function.
dataAccess	- a pointer to the function that conforms to sysc::InputScalarDataAccessWithPointer prototype.

◆ registerInputVectorDataAccess() [1/2]

void sysc::SystemCoupling::registerInputVectorDataAccess ( InputVectorDataAccess * dataAccess )

Provide a function to register input vector data access.

Parameters

dataAccess - a pointer to the function that conforms to sysc::InputVectorDataAccess function prototype.

◆ registerInputVectorDataAccess() [2/2]

void sysc::SystemCoupling::registerInputVectorDataAccess	(	OpaqueDataAccess	opaqueDataAccess,
		InputVectorDataAccessWithPointer *	dataAccess
	)

Provide a function to register input vector data access.

Parameters

opaqueDataAccess	- a pointer that is passed into the callback function.
dataAccess	- a pointer to the function that conforms to sysc::InputVectorDataAccessWithPointer prototype.

◆ registerOutputComplexScalarDataAccess() [1/2]

void sysc::SystemCoupling::registerOutputComplexScalarDataAccess	(	OpaqueDataAccess	opaqueDataAccess,
		OutputComplexScalarDataAccessWithPointer *	dataAccess
	)

Provide a function to register output complex scalar data access.

Parameters

opaqueDataAccess	- a pointer that is passed into the callback function.
dataAccess	- a pointer to the function that conforms to OutputComplexScalarDataAccess prototype.

◆ registerOutputComplexScalarDataAccess() [2/2]

void sysc::SystemCoupling::registerOutputComplexScalarDataAccess ( OutputComplexScalarDataAccess * dataAccess )

Provide a function to register output complex scalar data access.

Parameters

dataAccess - a pointer to the function that conforms to OutputComplexScalarDataAccess prototype.

◆ registerOutputComplexVectorDataAccess() [1/2]

void sysc::SystemCoupling::registerOutputComplexVectorDataAccess	(	OpaqueDataAccess	opaqueDataAccess,
		OutputComplexVectorDataAccessWithPointer *	dataAccess
	)

Provide a function to register output complex vector data access.

Parameters

opaqueDataAccess	- a pointer that is passed into the callback function.
dataAccess	- a pointer to the function that conforms to OutputComplexVectorDataAccess prototype.

◆ registerOutputComplexVectorDataAccess() [2/2]

void sysc::SystemCoupling::registerOutputComplexVectorDataAccess ( OutputComplexVectorDataAccess * dataAccess )

Provide a function to register output complex vector data access.

Parameters

dataAccess - a pointer to the function that conforms to OutputComplexVectorDataAccess prototype.

◆ registerOutputScalarDataAccess() [1/2]

void sysc::SystemCoupling::registerOutputScalarDataAccess	(	OpaqueDataAccess	opaqueDataAccess,
		OutputScalarDataAccessWithPointer *	dataAccess
	)

Provide a function to register output scalar data access.

Parameters

opaqueDataAccess	- a pointer that is passed into the callback function.
dataAccess	- a pointer to the function that conforms to sysc::OutputScalarDataAccessWithPointer prototype.

◆ registerOutputScalarDataAccess() [2/2]

void sysc::SystemCoupling::registerOutputScalarDataAccess ( OutputScalarDataAccess * dataAccess )

Provide a function to register output scalar data access.

Parameters

dataAccess - a pointer to the function that conforms to sysc::OutputScalarDataAccess function prototype.

◆ registerOutputVectorDataAccess() [1/3]

void sysc::SystemCoupling::registerOutputVectorDataAccess	(	OpaqueDataAccess	opaqueDataAccess,
		OutputVectorDataAccessWithPointer *	dataAccess
	)

Provide a function to register output vector data access.

Parameters

opaqueDataAccess	- a pointer that is passed into the callback function.
dataAccess	- a pointer to the function that conforms to sysc::OutputVectorDataAccessWithPointer prototype.

◆ registerOutputVectorDataAccess() [2/3]

void sysc::SystemCoupling::registerOutputVectorDataAccess	(	OpaqueDataAccess	opaqueDataAccess,
		OutputVectorDataMultiZoneAccess *	dataAccess
	)

Provide a function to register output vector data access.

Parameters

opaqueDataAccess	- a pointer that is passed into the callback function.
dataAccess	- a pointer to the function that conforms to sysc::OutputVectorDataMultiZoneAccess prototype.

◆ registerOutputVectorDataAccess() [3/3]

void sysc::SystemCoupling::registerOutputVectorDataAccess ( OutputVectorDataAccess * dataAccess )

Provide a function to register output vector data access.

Parameters

dataAccess - a pointer to the function that conforms to sysc::OutputVectorDataAccess function prototype.

◆ registerPointCloudAccess() [1/3]

void sysc::SystemCoupling::registerPointCloudAccess	(	OpaqueDataAccess	opaqueDataAccess,
		PointCloudAccessWithPointer *	pointCloudAccess
	)

Provide a function to register point cloud access.

Parameters

[in]	opaqueDataAccess	- a pointer that is passed into the callback function.
[in]	pointCloudAccess	- a pointer to the function that conforms to PointCloudAccessWithPointer function prototype.

◆ registerPointCloudAccess() [2/3]

void sysc::SystemCoupling::registerPointCloudAccess	(	OpaqueDataAccess	opaqueDataAccess,
		PointCloudMultiZoneAccess *	pointCloudAccess
	)

Provide a function to register point cloud access.

Parameters

[in]	opaqueDataAccess	- a pointer that is passed into the callback function.
[in]	pointCloudAccess	- a pointer to the function that conforms to PointCloudMultiZoneAccess function prototype.

◆ registerPointCloudAccess() [3/3]

void sysc::SystemCoupling::registerPointCloudAccess ( PointCloudAccess * pointCloudAccess )

Provide a function to register point cloud access.

Parameters

[in] pointCloudAccess - a pointer to the function that conforms to PointCloudAccess function prototype. See PointCloudAccess for details.

◆ registerRestartPointCreation()

void sysc::SystemCoupling::registerRestartPointCreation ( RestartPointCreation * restartPointCreation )

Provide a function to register a restart point creation callback.

Parameters

restartPointCreation - a pointer to the function that conforms to RestartPointCreation function prototype. See RestartPointCreation for details.

◆ registerSurfaceMeshAccess() [1/2]

void sysc::SystemCoupling::registerSurfaceMeshAccess	(	OpaqueDataAccess	opaqueDataAccess,
		SurfaceMeshAccessWithPointer *	meshAccess
	)

Provide a function to register surface mesh access.

Parameters

opaqueDataAccess	- a pointer that is passed into the callback function.
meshAccess	- a pointer to the function that conforms to SurfaceMeshAccessWithPointer function prototype. See SurfaceMeshAccessWithPointer for details.

◆ registerSurfaceMeshAccess() [2/2]

void sysc::SystemCoupling::registerSurfaceMeshAccess ( SurfaceMeshAccess * meshAccess )

Provide a function to register surface mesh access.

Parameters

[in] meshAccess - a pointer to the function that conforms to SurfaceMeshAccess function prototype. See SurfaceMeshAccess for details.

◆ registerTargetDataCreation() [1/2]

void sysc::SystemCoupling::registerTargetDataCreation	(	OpaqueDataAccess	opaqueDataAccess,
		TargetDataCreationWithPointer *	targetDataCreation
	)

Provide a function to register a target data creation callback.

Parameters

opaqueDataAccess	a pointer that is passed into the callback function.
targetDataCreation	a pointer to the function that conforms to TargetDataCreationWithPointer function prototype.

◆ registerTargetDataCreation() [2/2]

void sysc::SystemCoupling::registerTargetDataCreation ( TargetDataCreation * targetDataCreation )

Provide a function to register a target data creation callback.

Parameters

targetDataCreation - a pointer to the function that conforms to TargetDataCreation function prototype. See TargetDataCreation for details.

◆ registerVolumeMeshAccess() [1/2]

void sysc::SystemCoupling::registerVolumeMeshAccess	(	OpaqueDataAccess	opaqueDataAccess,
		VolumeMeshAccessWithPointer *	meshAccess
	)

Provide a function to register volume mesh access.

Parameters

opaqueDataAccess	- a pointer that is passed into the callback function.
meshAccess	- a pointer to the function that conforms to VolumeMeshAccessWithPointer function prototype. See VolumeMeshAccessWithPointer for details.

◆ registerVolumeMeshAccess() [2/2]

void sysc::SystemCoupling::registerVolumeMeshAccess ( VolumeMeshAccess * meshAccess )

Provide a function to register volume mesh access.

Parameters

meshAccess - a pointer to the function that conforms to VolumeMeshAccess function prototype. See VolumeMeshAccess for details.

◆ setParameterValue()

void sysc::SystemCoupling::setParameterValue	(	const ParameterName &	parameterName,
		double	value
	)

Provide a function to set a Parameter value.

Parameters

[in]	parameterName	- name of the parameter.
[in]	value	- value of the parameter.

◆ updateInputs()

void sysc::SystemCoupling::updateInputs ( )

Provide a function to update the participants input variables.

Solution data for all input variables will be updated. Depending on the defined interfaces, data will be transferred from another coupling participant solver, or from the opposite side of the same-participant coupling interface.

When doing cosimulation, this function must be called from inside the coupled analysis loop. It tells System Coupling that the participant is about to begin its solver iterations. All input variable data will be up-to-date after returning from this function. If any local coupling interfaces are defined, all corresponding input variable data will also be updated.

When doing same-participant mapping only (without cosimulation), this function should be called whenever input data needs to be brought up-to-date.

◆ updateOutputs()

void sysc::SystemCoupling::updateOutputs ( ConvergenceStatus status )

Provide a function to update the participants output variables.

This function must be called from inside the coupled analysis loop. It tells System Coupling that the participant has finished performing its solver iterations.

Parameters

[in] status Status of participant solver after its solver iteration(s). See ConvergenceStatus for details

◆ writeSetupFile()

bool sysc::SystemCoupling::writeSetupFile ( const SetupFileInfo & setupFileInfo ) const

Provide a function to write the setup file.

This function can be used to generate a System Coupling setup file, which contains participant's setup information. It should be called after calling completeSetup.

Parameters

[in] setupFileInfo - struct containing the setup file info.

Returns: True if the setup file was successfully written, and false otherwise.

sysc::SystemCoupling Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SystemCoupling() [1/6]

◆ SystemCoupling() [2/6]

◆ SystemCoupling() [3/6]

◆ SystemCoupling() [4/6]

◆ SystemCoupling() [5/6]

◆ SystemCoupling() [6/6]

Member Function Documentation

◆ addCouplingInterface() [1/2]

◆ addCouplingInterface() [2/2]

◆ addInputParameter()

◆ addIntegerAttribute()

◆ addOutputParameter()

◆ addRealAttribute()

◆ addRegion()

◆ completeSetup()

◆ doIteration()

◆ doTimeStep()

◆ getAddedCouplingInterface()

◆ getAddedRegion()

◆ getCurrentTimeStep()

◆ getInputParameter()

◆ getIntegerAttribute()

◆ getIntegerAttributeValue()

◆ getNumCouplingInterfaces()

◆ getNumInputParameters()

◆ getNumIntegerAttributes()

◆ getNumOutputParameters()

◆ getNumRealAttributes()

◆ getNumRegions()

◆ getOutputParameter()

◆ getParameterValue()

◆ getRealAttribute()

◆ getRealAttributeValue()

◆ initializeAnalysis()

◆ registerInputComplexScalarDataAccess() [1/2]

◆ registerInputComplexScalarDataAccess() [2/2]

◆ registerInputComplexVectorDataAccess() [1/2]

◆ registerInputComplexVectorDataAccess() [2/2]

◆ registerInputScalarDataAccess() [1/2]

◆ registerInputScalarDataAccess() [2/2]

◆ registerInputVectorDataAccess() [1/2]

◆ registerInputVectorDataAccess() [2/2]

◆ registerOutputComplexScalarDataAccess() [1/2]

◆ registerOutputComplexScalarDataAccess() [2/2]

◆ registerOutputComplexVectorDataAccess() [1/2]

◆ registerOutputComplexVectorDataAccess() [2/2]

◆ registerOutputScalarDataAccess() [1/2]

◆ registerOutputScalarDataAccess() [2/2]

◆ registerOutputVectorDataAccess() [1/3]

◆ registerOutputVectorDataAccess() [2/3]

◆ registerOutputVectorDataAccess() [3/3]

◆ registerPointCloudAccess() [1/3]

◆ registerPointCloudAccess() [2/3]

◆ registerPointCloudAccess() [3/3]

◆ registerRestartPointCreation()

◆ registerSurfaceMeshAccess() [1/2]

◆ registerSurfaceMeshAccess() [2/2]

◆ registerTargetDataCreation() [1/2]

◆ registerTargetDataCreation() [2/2]

◆ registerVolumeMeshAccess() [1/2]

◆ registerVolumeMeshAccess() [2/2]

◆ setParameterValue()

◆ updateInputs()

◆ updateOutputs()

◆ writeSetupFile()

Connect with Ansys