diff options
author | Karl Shaffer <karlshaffer@google.com> | 2023-08-11 00:04:18 +0000 |
---|---|---|
committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | 2023-08-11 00:04:18 +0000 |
commit | d3fac44428dd0296a04a50c6827e3205b8dbea8a (patch) | |
tree | ace24ba4307d4978ee3134f7da671a77ad172da0 /src/main/java/org/apache/commons/math3/ode/FirstOrderDifferentialEquations.java | |
parent | 5df6e262b13a4e2a008638ceea2b1f99db0d2331 (diff) | |
parent | 029d049e490dcd5fa609bb7632b0262d95f1bcce (diff) | |
download | apache-commons-math-master.tar.gz |
Check-in commons-math 3.6.1 am: 1354beaf45 am: 0018f64b87 am: b3715644fb am: 5484895ffd am: 029d049e49HEADandroid-14.0.0_r37android-14.0.0_r36android-14.0.0_r35android-14.0.0_r34android-14.0.0_r33android-14.0.0_r32android-14.0.0_r31android-14.0.0_r30android-14.0.0_r29mastermainandroid14-qpr2-s5-releaseandroid14-qpr2-s4-releaseandroid14-qpr2-s3-releaseandroid14-qpr2-s2-releaseandroid14-qpr2-s1-releaseandroid14-qpr2-release
Original change: https://android-review.googlesource.com/c/platform/external/apache-commons-math/+/2702413
Change-Id: I6451550459c6d42417e3214f1db820289d799bc7
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
Diffstat (limited to 'src/main/java/org/apache/commons/math3/ode/FirstOrderDifferentialEquations.java')
-rw-r--r-- | src/main/java/org/apache/commons/math3/ode/FirstOrderDifferentialEquations.java | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/ode/FirstOrderDifferentialEquations.java b/src/main/java/org/apache/commons/math3/ode/FirstOrderDifferentialEquations.java new file mode 100644 index 0000000..28bf169 --- /dev/null +++ b/src/main/java/org/apache/commons/math3/ode/FirstOrderDifferentialEquations.java @@ -0,0 +1,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; +} |