Package org.hipparchus.migration.ode

Interface SecondaryEquations

All Superinterfaces:
SecondaryODE
@Deprecated public interface SecondaryEquations extends SecondaryODE
Deprecated.
as of 1.0, replaced with SecondaryODE
This interface allows users to add secondary differential equations to a primary set of differential equations.

In some cases users may need to integrate some problem-specific equations along with a primary set of differential equations. One example is optimal control where adjoined parameters linked to the minimized hamiltonian must be integrated.

This interface allows users to add such equations to a primary set of first order differential equations thanks to the ExpandableODE.addSecondaryEquations(SecondaryODE) method.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default double[]
    computeDerivatives(double t, double[] primary, double[] primaryDot, double[] secondary)
    Deprecated.
    Compute the derivatives related to the secondary state parameters.
    void
    computeDerivatives(double t, double[] primary, double[] primaryDot, double[] secondary, double[] secondaryDot)
    Deprecated.
    Compute the derivatives related to the secondary state parameters.

    Methods inherited from interface org.hipparchus.ode.SecondaryODE

    getDimension, init

  • Method Details

    • computeDerivatives

      default double[] computeDerivatives(double t, double[] primary, double[] primaryDot, double[] secondary) throws MathIllegalArgumentException, MathIllegalStateException
      Deprecated.
      Compute the derivatives related to the secondary state parameters.

      The default implementation calls computeDerivatives(double, double[], double[], double[], double[]).

      Specified by:
      computeDerivatives in interface SecondaryODE
      Parameters:
      t - current value of the independent time variable
      primary - array containing the current value of the primary state vector
      primaryDot - array containing the derivative of the primary state vector
      secondary - array containing the current value of the secondary state vector
      Returns:
      derivative of the secondary state vector
      Throws:
      MathIllegalStateException - if the number of functions evaluations is exceeded
      MathIllegalArgumentException - if arrays dimensions do not match equations settings

    • computeDerivatives

      void computeDerivatives(double t, double[] primary, double[] primaryDot, double[] secondary, double[] secondaryDot) throws MathIllegalArgumentException, MathIllegalStateException
      Deprecated.
      Compute the derivatives related to the secondary state parameters.
      Parameters:
      t - current value of the independent time variable
      primary - array containing the current value of the primary state vector
      primaryDot - array containing the derivative of the primary state vector
      secondary - array containing the current value of the secondary state vector
      secondaryDot - placeholder array where to put the derivative of the secondary state vector
      Throws:
      MathIllegalStateException - if the number of functions evaluations is exceeded
      MathIllegalArgumentException - if arrays dimensions do not match equations settings