AutoCheckpointAction

Action to create shortcut syntax-specified checkpoints and automatic checkpoints.

Overview

An action, that acts when the [Outputs] block exists. It adds the "checkpoint" and "wall_time_checkpoint" short-cut syntax parameters. For example, the following enables time_step_interval based checkpoints while disabling wall time based checkpoints.


[Outputs]
  checkpoint = true
  wall_time_checkpoint = false
[]

Please refer to the Output System for more information.

Input Parameters

  • active__all__ If specified only the blocks named will be visited and made active

    Default:__all__

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

    Description:If specified only the blocks named will be visited and made active

  • checkpointFalseCreate checkpoint files using the default options.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Create checkpoint files using the default options.

  • inactiveIf specified blocks matching these identifiers will be skipped.

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

    Description:If specified blocks matching these identifiers will be skipped.

  • wall_time_checkpointTrueEnables the output of checkpoints based on elapsed wall time.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Enables the output of checkpoints based on elapsed wall time.

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

Advanced Parameters