Handling Participant Setup Changes

Changes to a server participant's setup after the participant has been added to the co-simulation may cause errors. Although this is an uncommon occurrence, System Coupling minimizes the risk of such errors by checking the server input files against the initial input files. If System Coupling detects changes, it blocks mapping until the participant is updated.

If a participant input file has been updated, then System Coupling writes an error message (either to the Messages tab for the GUI or to the CLI console when you attempt to map the analysis) and blocks mapping until the participant is updated. To avoid this error, you can check for input changes before initiating a solve.

If an input file has been updated and no variables or regions have been removed from the original setup, you can update the participant.

Note:

Cases created before the 2024 R2 release could have input changes even if the HasInputFileChanged() command returns a false value. Therefore, Ansys recommends that you update the Mechanical server participant for all cases created before the 2024 R2 release.
If the participant can't be updated, then you must delete the participant from the analysis and then re-add it using the updated input file.

Handling participant setup changes in the GUI

The System Coupling GUI checks for participant setup changes automatically. If the Messages tab indicates that a participant input has been updated, update the participant by performing the following steps:

Right-click the server participant with the changed input file.
Select Update participant.
Right-click the Coupling Participants branch, select Add participant, and re-add the participant using the updated input file.

Handling participant setup changes in the CLI

The System Coupling CLI checks for participant setup changes at runtime. Before starting a solve, you may also check for changes manually and update the participant if needed. To do so, perform the following steps:

You may check for changes to the input file of a participant by running the HasInputFileChanged() command, adding the participant's name as an argument.
```
>>> HasInputFileChanged(ParticipantName="<participant_name>")

True
```
If the command returns a value of False, then you may start the solve. If it returns a value of True, then update the participant before proceeding.
Update the participant by running the UpdateParticipant() command with the participant's name as an argument. Optionally, you may also specify the name of the input file.
```
>>> UpdateParticipant(
	    ParticipantName="<participant_name>", 
	    InputFile="<input_file>"
    )
```