StateWriteSpecification Properties

Properties

EndTime End Time, state will not be outputted after this time

Set to MaxValue to write for the entire simulation period.

StartTime Start Time, first time of state output

Set to MinValue to use start-of-simulation time.

To store one state at a specific time, set the StartTime to the time to store the state, and leave TimeStep to zero.

TemplateFilePath Template file path, used when creating state file names.

Typically it should have the form TemplateFilePath.Path = "myFolder\MyStateFileName_{0}.sta1d" where the placeholder is replaced with the simulation date and time for that state.

If the TemplateFilePath does not contain any placeholder, one is inserted automatically as the last part of the filename.

TimeStep Timespan between writing of states.

Set to zero to disable writing of state on a regular basis.

See Also