Stepper

class Stepper

Perform an action (update or write) every so many trials. This action could be read-only (see Analyze) or not (see Modify). Write to screen if file name is not provided.

Subclassed by feasst::Analyze, feasst::Modify

Arguments

Stepper(argtype args = argtype())

args:

  • trials_per_write: Set the number of trials per write (default: 1). Disabled if negative value is provided.

  • trials_per_update: Set the number of trials per update (default: 1). Disabled if negative value is provided.

  • output_file: Set the file name to write output (default: empty).

  • append: append file output if set to true. Do not append if false (default: “false”).

  • clear_file: set true to clear contents of output_file, if exists. (default: false).

  • stop_after_phase: stop when simulation reaches this phase index. If -1, never stop (default: -1).

  • start_after_phase: start when simulation reaches this phase index. If -1, start at beginning (default: -1).

  • output_file_append_phase: append phase to file name (default: false)

  • multistate: set “true” to copy for each state (default: false)

  • multistate_aggregate: aggregate the writing of all states, only when multistate is enabled (default: true). Thus, trials_per_write refers now to the writing of all states. Individual states no longer write.

  • stop_after_iteration: stop when Criteria reaches this iteration. If -1, never stop (default: -1).

  • start_after_iteration: start when Criteria reaches this iteration. If -1, start at beginning (default: -1).

  • rewrite_header: set true to rewrite header every write (default: true). If multistate_aggregate, automatically set to false.

  • Accumulator arguments.

  • configuration_index: index of configuration (default: 0)