blob: 28bf16974856a6e3a0e1e46d0a5fae053d417e8c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.math3.ode;
import org.apache.commons.math3.exception.DimensionMismatchException;
import org.apache.commons.math3.exception.MaxCountExceededException;
/**
* This interface represents a first order differential equations set.
*
* <p>This interface should be implemented by all real first order differential equation problems
* before they can be handled by the integrators {@link FirstOrderIntegrator#integrate} method.
*
* <p>A first order differential equations problem, as seen by an integrator is the time derivative
* <code>dY/dt</code> of a state vector <code>Y</code>, both being one dimensional arrays. From the
* integrator point of view, this derivative depends only on the current time <code>t</code> and on
* the state vector <code>Y</code>.
*
* <p>For real problems, the derivative depends also on parameters that do not belong to the state
* vector (dynamical model constants for example). These constants are completely outside of the
* scope of this interface, the classes that implement it are allowed to handle them as they want.
*
* @see FirstOrderIntegrator
* @see FirstOrderConverter
* @see SecondOrderDifferentialEquations
* @since 1.2
*/
public interface FirstOrderDifferentialEquations {
/**
* Get the dimension of the problem.
*
* @return dimension of the problem
*/
int getDimension();
/**
* Get the current time derivative of the state vector.
*
* @param t current value of the independent <I>time</I> variable
* @param y array containing the current value of the state vector
* @param yDot placeholder array where to put the time derivative of the state vector
* @exception MaxCountExceededException if the number of functions evaluations is exceeded
* @exception DimensionMismatchException if arrays dimensions do not match equations settings
*/
void computeDerivatives(double t, double[] y, double[] yDot)
throws MaxCountExceededException, DimensionMismatchException;
}
|
