open_snapshot

class ansys.systemcoupling.core.adaptor.api_23_1.open_snapshot.open_snapshot(name=None, parent=None)

Bases: Command

Opens a snapshot containing a previously saved state of the simulation. All state (files and directories) stored in the snapshot will be restored. If other state exists in the working directory, then it will not be modified by this command.

Note: Snapshot cannot be opened if participants have been started.

Parameters:

snapshot_namestr, optional

The name of the snapshot to be opened. This is optional if and only if there is only one snapshot available to be loaded. If multiple snapshots exist, then the snapshot name must be specified.

Included in:

Parent	Summary
case_root	‘root’ object