| Raymond | dee0849 | 2015-04-02 10:43:13 -0700 | [diff] [blame^] | 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 | import org.apache.commons.math.ode.DerivativeException; |
| 21 | |
| 22 | |
| 23 | /** This interface represents a second order integrator for |
| 24 | * differential equations. |
| 25 | * |
| 26 | * <p>The classes which are devoted to solve second order differential |
| 27 | * equations should implement this interface. The problems which can |
| 28 | * be handled should implement the {@link |
| 29 | * SecondOrderDifferentialEquations} interface.</p> |
| 30 | * |
| 31 | * @see SecondOrderDifferentialEquations |
| 32 | * @version $Revision: 1073158 $ $Date: 2011-02-21 22:46:52 +0100 (lun. 21 févr. 2011) $ |
| 33 | * @since 1.2 |
| 34 | */ |
| 35 | |
| 36 | public interface SecondOrderIntegrator extends ODEIntegrator { |
| 37 | |
| 38 | /** Integrate the differential equations up to the given time |
| 39 | * @param equations differential equations to integrate |
| 40 | * @param t0 initial time |
| 41 | * @param y0 initial value of the state vector at t0 |
| 42 | * @param yDot0 initial value of the first derivative of the state |
| 43 | * vector at t0 |
| 44 | * @param t target time for the integration |
| 45 | * (can be set to a value smaller thant <code>t0</code> for backward integration) |
| 46 | * @param y placeholder where to put the state vector at each |
| 47 | * successful step (and hence at the end of integration), can be the |
| 48 | * same object as y0 |
| 49 | * @param yDot placeholder where to put the first derivative of |
| 50 | * the state vector at time t, can be the same object as yDot0 |
| 51 | * @throws IntegratorException if the integrator cannot perform integration |
| 52 | * @throws DerivativeException this exception is propagated to the caller if the |
| 53 | * underlying user function triggers one |
| 54 | */ |
| 55 | void integrate(SecondOrderDifferentialEquations equations, |
| 56 | double t0, double[] y0, double[] yDot0, |
| 57 | double t, double[] y, double[] yDot) |
| 58 | throws DerivativeException, IntegratorException; |
| 59 | |
| 60 | } |