blob: 95fed2cd59742d4098dc039e026d16d55676967f (
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
64
65
66
|
/*
* 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 allows users to add secondary differential equations to a primary set of
* differential equations.
*
* <p>In some cases users may need to integrate some problem-specific equations along with a primary
* set of differential equations. One example is optimal control where adjoined parameters linked to
* the minimized hamiltonian must be integrated.
*
* <p>This interface allows users to add such equations to a primary set of {@link
* FirstOrderDifferentialEquations first order differential equations} thanks to the {@link
* ExpandableStatefulODE#addSecondaryEquations(SecondaryEquations)} method.
*
* @see ExpandableStatefulODE
* @since 3.0
*/
public interface SecondaryEquations {
/**
* Get the dimension of the secondary state parameters.
*
* @return dimension of the secondary state parameters
*/
int getDimension();
/**
* Compute the derivatives related to the secondary state parameters.
*
* @param t current value of the independent <I>time</I> variable
* @param primary array containing the current value of the primary state vector
* @param primaryDot array containing the derivative of the primary state vector
* @param secondary array containing the current value of the secondary state vector
* @param secondaryDot placeholder array where to put the derivative of the secondary 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[] primary,
double[] primaryDot,
double[] secondary,
double[] secondaryDot)
throws MaxCountExceededException, DimensionMismatchException;
}
|
