Step()

Available only for step-based analyses. (For more information on iteration-based vs. step-based steady analyses, see Steady Analysis Type in the System Coupling User's Guide.)

Interactive command that initializes the analysis and starts participants (if necessary), and then runs the specified number of coupling steps before pausing the coupled analysis.

Disabled when a solution is already in progress. This command will raise an exception if another instance of System Coupling is solving in the current working directory.

By default, runs a single step. If given the optional Count argument, then runs the specified number of steps.

For restarts, the Open() command must be run before the Step() command.

For analyses with differently oriented models, geometry transformations must be defined before running the Step() command.

When you run this command, System Coupling initializes the analysis if needed and then begins the solution. When the specified number of coupling steps has been run, the solution is paused, providing you with an opportunity to interact with the analysis.

When you resume the solution, either by reissuing this command or by running the Solve() command, System Coupling restarts the analysis at the point it left off and continues the solution with the next step.


Note:  If the ExecutionControl|Option for a participant is set to ExternallyManaged, then System Coupling will not start the participant using either this command or any of the other commands that automatically start participants.


Optional Keyword Arguments

Count : int

Integer specifying the number of steps to be run. Defaults to 1.

Return Type

None

Examples

Example 62: Use the default (the analysis runs one coupling step)


Step()


Example 63: Specify that the analysis runs three coupling steps


Step(Count = 3)