Migrating Command-Line System Coupling Scripts

System Coupling 2024 R2 contains changes that can impact existing coupling scripts.

Existing coupling cases (that is, that have been saved to a Settings.h5 file) will be migrated automatically when you re-open them with the most recent release of System Coupling. If you have existing coupling scripts, however, you may need to update them so they will continue to work with the current and later releases.

The following sections contain information on changes introduced in the 2024 R2 release which may affect existing scripts, as well as instructions on how to migrate scripts when necessary:

Changes to the Data Model

The following table lists changes to the data model in the 2024 R2 release of System Coupling.

Data Model ItemChangeRecommendation
CouplingParticipant.Region.RegionDiscretizationTypeNew settingSee RegionDiscretizationType.
CouplingParticipant.Properties.AcceptsNewInputsNew settingSee AcceptsNewInputs.
AnalysisControl.GlobalStabilization.MaximumRetainedIterationsNew settingSee MaximumRetainedIterations.
CouplingParticipant.PropertiesNew singletonSee Properties
CouplingParticipant.Properties.TimeIntegrationNew settingSee TimeIntegration.
CouplingParticipant.UpdateControl.Option.FirstCouplingIterationRemoved 
AnalysisControl.GlobalStabalization.Option.MaximumRetainedTimeStepsNew behaviorSee MaximumRetainedTimeSteps.

Changes to Commands

The following table lists changes to commands in the 2024 R2 release of System Coupling.

CommandChangeRecommendation
GetSupportedParticipantTypesAddedFor details, see GetSupportedParticipantTypes.
SetStateBehavior changedFor details, see SetState
AddParticipantBehavior changesFor details, see AddParticipant.