tem_abortCriteria_module Module

This module provides the definition of various abort criteria upon which a simulation should be stopped. Note that solvers may extend this table and have their own set of addititonal abort parameters to be set in this table.

There are two primary options that may be set:

• stop_file this denotes a file that will be checked for existence in the current working directory. If it exists the simulation will be stopped (if restarts are active, a restart will be written). If the file is empty the file will be deleted upon completion of the application. Otherwise, if the file is not empty it will be kept around.
• steady_state this is a boolean to indicate whether the simulation is to halt when a steady state is reached. If this is true a convergence table, where the condition for a steady state may be defined, is read. See tem_convergence_module for details.

If the abort criteria table is not provided, the defaults for both settings will be used, which is equivalent to the following definition:

  abort_criteria = {stop_file = '', steady_state = false}

That is, no stop files to look for, and no check whether a steady state is reached.

A more complete example with a check for steady state and a convergence table (more details in tem_convergence_module could look like this:

  abort_criteria = {
    stop_file = 'stop',
    steady_state = true,
    convergence = {
      variable = {'pressure', 'velocity'},
      shape = {kind = 'all'},
      time_control = {
        min = {iter = 0},
        max = {iter = tmax},
        interval = {iter = 10}
      },
      reduction = { 'average', 'average' },
      norm = 'average',
      nvals = 100,
      absolute = true,
      condition = {
         { threshold = 1.e-15, operator = '<=' },
         { threshold = 1.e-12, operator = '<=' }
      }
    }
  }

This results in the application to look for a file named stop in the working directory and will abort the run if it is found to exist. The application will check for a steady state, where a steady state is assumed when the average of pressure and velocity across the complete domain does not deviate by more of 1.e-15 for pressure and not more than 1.e-12 for the velocity.