1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.math.ode;
19
20
21 /** This interface represents a second order integrator for
22 * differential equations.
23 *
24 * <p>The classes which are devoted to solve second order differential
25 * equations should implement this interface. The problems which can
26 * be handled should implement the {@link
27 * SecondOrderDifferentialEquations} interface.</p>
28 *
29 * @see SecondOrderDifferentialEquations
30 * @version $Revision: 674820 $ $Date: 2008-07-08 09:37:09 -0400 (Tue, 08 Jul 2008) $
31 * @since 1.2
32 */
33
34 public interface SecondOrderIntegrator extends ODEIntegrator {
35
36 /** Integrate the differential equations up to the given time
37 * @param equations differential equations to integrate
38 * @param t0 initial time
39 * @param y0 initial value of the state vector at t0
40 * @param yDot0 initial value of the first derivative of the state
41 * vector at t0
42 * @param t target time for the integration
43 * (can be set to a value smaller thant <code>t0</code> for backward integration)
44 * @param y placeholder where to put the state vector at each
45 * successful step (and hence at the end of integration), can be the
46 * same object as y0
47 * @param yDot placeholder where to put the first derivative of
48 * the state vector at time t, can be the same object as yDot0
49 * @throws IntegratorException if the integrator cannot perform integration
50 * @throws DerivativeException this exception is propagated to the caller if the
51 * underlying user function triggers one
52 */
53 public void integrate(SecondOrderDifferentialEquations equations,
54 double t0, double[] y0, double[] yDot0,
55 double t, double[] y, double[] yDot)
56 throws DerivativeException, IntegratorException;
57
58 }