Package nl.tudelft.simulation.jstats.ode.integrators

Enum Class NumericalIntegratorType

java.lang.Object
java.lang.Enum<NumericalIntegratorType>
nl.tudelft.simulation.jstats.ode.integrators.NumericalIntegratorType
All Implemented Interfaces:
Serializable, Comparable<NumericalIntegratorType>, java.lang.constant.Constable
public enum NumericalIntegratorType extends Enum<NumericalIntegratorType>
NumericalIntegratorType is an enum with the currently implemented integrators.

Copyright (c) 2019-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

Author:
Alexander Verbraeck

  • Enum Constant Details

  • Method Details

    • values

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

    • valueOf

      public static NumericalIntegratorType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public int getValue()
      Returns the value from DSOL-1 before enum was introduced.
      Returns:
      int; the value from DSOL-1 before enum was introduced

    • getIntegratorClass

      public Class<? extends NumericalIntegrator> getIntegratorClass()
      Get the integrator class belonging to the name.
      Returns:
      Class<? extends NumericalIntegrator>; the class of the integrator

    • getInstance

      public NumericalIntegrator getInstance(double stepSize, DifferentialEquationInterface equation)
      Get an instance of the integrator.
      Parameters:
      stepSize - double; the starting step size to use
      equation - DifferentialEquationInterface; the differential equation
      Returns:
      the integrator