Given the name of a server participant defined for the analysis, updates the state of the participant. As part of the update, System Coupling updates any existing variable attributes. Variables and regions may be added to the participant but may not be removed.
Available for server participants. Currently, only DEFAULT-SRV, CFD-SRV, and MECH-SRV participants may be updated.
You may specify an input file using an optional argument. If an input file is not provided, then the original input file will be reimported.
If the participant cannot be updated, then the state does not change.
If the update process fails, then System Coupling displays an error. In this case, you can either update the setup in the participant application to remove any issues with the update process or delete the participant from the analysis and then re-add it using the updated input file.
Note: For cases created before the 2024 R2 release, cases 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.
Essential Keyword Arguments
- ParticipantName : string
Participant name. Must be the name of an existing participant.
Participant type can be DEFAULT-SRV, MECH-SRV, or CFD-SRV.
Optional Keyword Arguments
- InputFile : string
Name of the input file for the participant to be updated.
Currently supported formats are SCP files, Forte input (*.ftsimM) files, Mechanical server (*.rst) files, CFD server (*.csv) files, and FMU (.fmu) files (Beta).
Participant type can be DEFAULT-SRV, MECH-SRV, or CFD-SRV.
Return Type
None