OOF2: The Manual

OOF.Mesh.Scheduled_Output.Schedule.Set
Prev  6.2.173. OOF.Mesh.Scheduled_Output.Schedule Commands  Next

Name

OOF.Mesh.Scheduled_Output.Schedule.Set — Assign a schedule to an output operation.

Synopsis

OOF.Mesh.Scheduled_Output.Schedule.Set(mesh,output,scheduletype,schedule)

Details

  • Parent Menu: OOF.Mesh.Scheduled_Output.Schedule
  • Callback: function _setSchedule in module ooflib.engine.IO.scheduledoutputmenu

  • Parameters:

    mesh
    Type: The path to an existing Mesh object.
    output
    Name of the output being scheduled. Type: A character string.
    scheduletype
    How to interpret the schedule. Type: An object of the ScheduleType class.
    schedule
    When to produce the output. Type: An object of the Schedule class.

Description

This command sets the Schedule for a Scheduled Output. The Schedule determines when the output operation will be performed during a time evolution computation. In the GUI, schedules are listed and manipulated in the Schedule column of the Scheduled Output page.

The scheduletype parameter indicates whether the given schedule is to be interpreted as absolute, relative, or conditional. See ScheduleType for details.

The schedule determines how the output times are computed. Different types of Schedule objects can be used to produce outputs at a single specified time, at a number of uniformly spaced times, etc.

The schedules for all active Scheduled Outputs in a Mesh determine the times during a time evolution calculation at which output will be produced. Because the time stepper chooses step sizes so as to exactly end a step at each scheduled output time, the choice of schedules can affect the results of the calculation. The choice of schedule does not determine the start or end times of the evolution. Those are determined by the Solver page.

Prev  Up  Next
OOF.Mesh.Scheduled_Output.Schedule.Delete  Home  OOF.Mesh.Scheduled_Output.Copy