Termination criteria#

Subsection: Termination criteria#

Parameter name: Checkpoint on termination#

Default value: false

Pattern: [Bool]

Documentation: Whether to checkpoint the simulation right before termination.

Parameter name: End step#

Default value: 100

Pattern: [Integer range 0…2147483647 (inclusive)]

Documentation: Terminate the simulation once the specified timestep has been reached.

Parameter name: Termination criteria#

Default value: end time

Pattern: [MultipleSelection end step|end time|steady state heat flux|steady state temperature|steady state velocity|user request|wall time ]

Documentation: A comma separated list of termination criteria that will determine when the simulation should end. Whether explicitly stated or not, the “end time” termination criterion will always be used.The following termination criteria are available:

‘end step’: Terminate the simulation once the specified timestep has been reached.

‘end time’: Terminate the simulation once the end time specified in the input file has been reached. Unlike all other termination criteria, this criterion is always active, whether it has been explicitly selected or not in the input file (this is done to preserve historical behavior of ASPECT, but it also likely does not inconvenience anyone since it is what would be selected in most cases anyway).

‘steady state heat flux’: A criterion that terminates the simulation when the integrated heat flux over a given list of boundaries stays within a certain range for a specified period of time.

The criterion considers the total heat flux over all boundaries listed by their boundary indicators, rather than each boundary separately. As a consequence, if the sum of heat fluxes over individual parts of the boundary no longer changes, then this criterion recommends termination, even if the heat flux over individual parts of the boundary continues to change.

‘steady state temperature’: A criterion that terminates the simulation when the global integral of the temperature field stays within a certain range for a specified period of time.

‘steady state velocity’: A criterion that terminates the simulation when the RMS of the velocity field stays within a certain range for a specified period of time.

‘user request’: Terminate the simulation gracefully when a file with a specified name appears in the output directory. This allows the user to gracefully exit the simulation at any time by simply creating such a file using, for example, touch output/terminate. The file’s location is chosen to be in the output directory, rather than in a generic location such as the ASPECT directory, so that one can run multiple simulations at the same time (which presumably write to different output directories) and can selectively terminate a particular one.

‘wall time’: Terminate the simulation once the wall time limit has reached.

Parameter name: Wall time#

Default value: 24.

Pattern: [Double 0…MAX_DOUBLE (inclusive)]

Documentation: The wall time of the simulation. Unit: hours.

Subsection: Termination criteria / Steady state heat flux#

Parameter name: Boundary indicators#

Default value:

Pattern: [List of <[Anything]> of length 0…4294967295 (inclusive)]

Documentation: A comma separated list of names denoting those boundaries that should be taken into account for integrating the heat flux. Note that the plugin will compute the integrated heat flux over these boundaries (instead of taking them into account individually).

The names of the boundaries listed here can either be numbers (in which case they correspond to the numerical boundary indicators assigned by the geometry object), or they can correspond to any of the symbolic names the geometry object may have provided for each part of the boundary. You may want to compare this with the documentation of the geometry model you use in your model.

Parameter name: Maximum relative deviation#

Default value: 0.05

Pattern: [Double 0…MAX_DOUBLE (inclusive)]

Documentation: The maximum relative deviation of the heat flux in recent simulation time for the system to be considered in steady state. If the actual deviation is smaller than this number, then the simulation will be terminated.

Parameter name: Time in steady state#

Default value: 1e7

Pattern: [Double 0…MAX_DOUBLE (inclusive)]

Documentation: The minimum length of simulation time that the system should be in steady state before termination. Note that if the time step size is similar to or larger than this value, the termination criterion will only have very few (in the most extreme case, just two) heat flux values to check. To ensure that a larger number of time steps are included in the check for steady state, this value should be much larger than the time step size. Units: years if the ’Use years in output instead of seconds’ parameter is set; seconds otherwise.

Subsection: Termination criteria / Steady state temperature#

Parameter name: Maximum relative deviation#

Default value: 0.05

Pattern: [Double 0…MAX_DOUBLE (inclusive)]

Documentation: The maximum relative deviation of the temperature in recent simulation time for the system to be considered in steady state. If the actual deviation is smaller than this number, then the simulation will be terminated.

Parameter name: Time in steady state#

Default value: 1e7

Pattern: [Double 0…MAX_DOUBLE (inclusive)]

Documentation: The minimum length of simulation time that the system should be in steady state before termination.Units: years if the ’Use years in output instead of seconds’ parameter is set; seconds otherwise.

Subsection: Termination criteria / Steady state velocity#

Parameter name: Maximum relative deviation#

Default value: 0.05

Pattern: [Double 0…MAX_DOUBLE (inclusive)]

Documentation: The maximum relative deviation of the RMS in recent simulation time for the system to be considered in steady state. If the actual deviation is smaller than this number, then the simulation will be terminated.

Parameter name: Time in steady state#

Default value: 1e7

Pattern: [Double 0…MAX_DOUBLE (inclusive)]

Documentation: The minimum length of simulation time that the system should be in steady state before termination.Units: years if the ’Use years in output instead of seconds’ parameter is set; seconds otherwise.

Subsection: Termination criteria / User request#

Parameter name: File name#

Default value: terminate-aspect

Pattern: [FileName (Type: input)]

Documentation: The name of a file that, if it exists in the output directory (whose name is also specified in the input file) will lead to termination of the simulation. The file’s location is chosen to be in the output directory, rather than in a generic location such as the ASPECT directory, so that one can run multiple simulations at the same time (which presumably write to different output directories) and can selectively terminate a particular one.