Enum Action

java.lang.Object
java.lang.Enum<Action>
org.apache.commons.math3.ode.events.Action
All Implemented Interfaces:
Serializable, Comparable<Action>
public enum Action extends Enum<Action>
Enumerate for actions to be performed when an event occurs during ODE integration.
Since:
3.6

  • Enum Constant Details

    • STOP

      public static final Action STOP
      Stop indicator.

      This value should be used as the return value of the eventOccurred method when the integration should be stopped after the event ending the current step.

    • RESET_STATE

      public static final Action RESET_STATE
      Reset state indicator.

      This value should be used as the return value of the eventOccurred} method when the integration should go on after the event ending the current step, with a new state vector (which will be retrieved thanks to the resetState method).

    • RESET_DERIVATIVES

      public static final Action RESET_DERIVATIVES
      Reset derivatives indicator.

      This value should be used as the return value of the eventOccurred method when the integration should go on after the event ending the current step, with a new derivatives vector.

    • CONTINUE

      public static final Action CONTINUE
      Continue indicator.

      This value should be used as the return value of the eventOccurred method when the integration should go on after the event ending the current step.

  • Method Details

    • values

      public static Action[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Action valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null