001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    
018    package org.apache.commons.math.ode;
019    
020    
021    /** This interface represents a second order integrator for
022     * differential equations.
023     *
024     * <p>The classes which are devoted to solve second order differential
025     * equations should implement this interface. The problems which can
026     * be handled should implement the {@link
027     * SecondOrderDifferentialEquations} interface.</p>
028     *
029     * @see SecondOrderDifferentialEquations
030     * @version $Revision: 811786 $ $Date: 2009-09-06 05:36:08 -0400 (Sun, 06 Sep 2009) $
031     * @since 1.2
032     */
033    
034    public interface SecondOrderIntegrator extends ODEIntegrator {
035    
036      /** Integrate the differential equations up to the given time
037       * @param equations differential equations to integrate
038       * @param t0 initial time
039       * @param y0 initial value of the state vector at t0
040       * @param yDot0 initial value of the first derivative of the state
041       * vector at t0
042       * @param t target time for the integration
043       * (can be set to a value smaller thant <code>t0</code> for backward integration)
044       * @param y placeholder where to put the state vector at each
045       * successful step (and hence at the end of integration), can be the
046       * same object as y0
047       * @param yDot placeholder where to put the first derivative of
048       * the state vector at time t, can be the same object as yDot0
049       * @throws IntegratorException if the integrator cannot perform integration
050       * @throws DerivativeException this exception is propagated to the caller if the
051       * underlying user function triggers one
052       */
053      void integrate(SecondOrderDifferentialEquations equations,
054                     double t0, double[] y0, double[] yDot0,
055                     double t, double[] y, double[] yDot)
056          throws DerivativeException, IntegratorException;
057    
058    }