ExitReason

class pylimer_tools_cpp.ExitReason(self: pylimer_tools_cpp.ExitReason, value: int)

Bases: pybind11_object

An enum representing the reason for exiting the simulation or optimization procedure.

Members:

UNSET : Exit reason: “Unset”.

F_TOLERANCE : Exit reason: “F (force) tolerance reached”.

X_TOLERANCE : Exit reason: “X (displacement) tolerance reached”.

MAX_STEPS : Exit reason: “Maximum number of steps reached”.

NO_STEPS_POSSIBLE : Exit reason: “No (more) steps possible”.

FAILURE : Exit reason: “Failure”.

INTERRUPT : Exit reason: “Interrupt”.

OTHER : Exit reason: “Other”.

Attributes Summary

FAILURE
F_TOLERANCE
INTERRUPT
MAX_STEPS
NO_STEPS_POSSIBLE
OTHER
UNSET
X_TOLERANCE
name
value

Attributes Documentation

FAILURE = <ExitReason.FAILURE: 5>

F_TOLERANCE = <ExitReason.F_TOLERANCE: 1>

INTERRUPT = <ExitReason.INTERRUPT: 6>

MAX_STEPS = <ExitReason.MAX_STEPS: 3>

NO_STEPS_POSSIBLE = <ExitReason.NO_STEPS_POSSIBLE: 4>

OTHER = <ExitReason.OTHER: 7>

UNSET = <ExitReason.UNSET: 0>

X_TOLERANCE = <ExitReason.X_TOLERANCE: 2>

name

value