3.2.1. Save State Files

>savestate [mode=<none | overwrite>][filename=<filename>]

State files can be used to quickly load a previous state into Ansys TurboGrid. State files can be generated manually using a text editor, or from within Ansys TurboGrid by saving a state file. The >savestate command writes the current Ansys TurboGrid state to a file from the Command Editor dialog box.

>savestate supports the following options:

  • mode = <none | overwrite>

    If mode is none, the executor creates a new state file, and if the specified file exists, an error is raised. If mode is overwrite, the executor creates a new state file, and if the file exists, it is deleted and replaced with the latest state.

  • filename = <filename>

    Specifies the path and name of the file that the state is written to. If no filename is specified, the STATE singleton object is queried for the filename. If the STATE singleton does not exist, then an error is raised indicating that a filename must be specified.

3.2.1.1. savestate Command Examples

The following are example >savestate commands, and the expected results. If a STATE singleton exists, the values of the parameters listed after the >savestate command replace the values stored in the STATE singleton object. For this command, the filename command parameter value replaces the state filename parameter value in the STATE singleton, and the mode command parameter value replaces the savestate mode parameter value in the STATE singleton.

> savestate

This command writes the current state to the filename specified in the STATE singleton. If the mode in the STATE singleton is none, and the filename exists, an error is returned. If the mode in the STATE singleton is overwrite, and the filename exists, the existing file is deleted, and the state is written to the file. If the STATE singleton does not exist, an error is raised indicating that a filename must be specified.

> savestate mode = none

This command writes the current state to the file specified in the STATE singleton. If the file already exists, an error is raised. If the STATE singleton does not exist, an error is raised indicating that a filename must be specified.

> savestate mode = overwrite

This command writes the current state to the file specified in the STATE singleton. If the file already exists, it is deleted, and the current state is saved in its place. If the STATE singleton does not exist, an error is raised indicating that a filename must be specified.

> savestate filename = mystate.tst

This command writes the current state to the mystate.tst file. If the STATE singleton exists, and the savestate mode is set to none, and the file already exists, an error is raised. If the savestate mode is set to overwrite, and the file already exists, the file is deleted, and the current state is saved in its place. If the STATE singleton does not exist, then the system assumes a savestate mode of none, and behaves as described above.

> savestate mode = none, filename = mystate.tst

This command writes the current state to the mystate.tst file. If the file already exists, an error is raised.

> savestate mode = overwrite, filename = mystate.tst

This command writes the current state to the mystate.tst file. If the file already exists it is deleted, and the current state is saved in its place.