diff options
Diffstat (limited to 'src/main/java/org/apache/commons/math3/ode/ParameterizedWrapper.java')
-rw-r--r-- | src/main/java/org/apache/commons/math3/ode/ParameterizedWrapper.java | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/ode/ParameterizedWrapper.java b/src/main/java/org/apache/commons/math3/ode/ParameterizedWrapper.java new file mode 100644 index 0000000..601ce5f --- /dev/null +++ b/src/main/java/org/apache/commons/math3/ode/ParameterizedWrapper.java @@ -0,0 +1,88 @@ +/* + * 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; + +import java.util.ArrayList; +import java.util.Collection; + +/** + * Wrapper class enabling {@link FirstOrderDifferentialEquations basic simple} ODE instances to be + * used when processing {@link JacobianMatrices}. + * + * @since 3.0 + */ +class ParameterizedWrapper implements ParameterizedODE { + + /** Basic FODE without parameter. */ + private final FirstOrderDifferentialEquations fode; + + /** + * Simple constructor. + * + * @param ode original first order differential equations + */ + ParameterizedWrapper(final FirstOrderDifferentialEquations ode) { + this.fode = ode; + } + + /** + * Get the dimension of the underlying FODE. + * + * @return dimension of the underlying FODE + */ + public int getDimension() { + return fode.getDimension(); + } + + /** + * Get the current time derivative of the state vector of the underlying FODE. + * + * @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 + */ + public void computeDerivatives(double t, double[] y, double[] yDot) + throws MaxCountExceededException, DimensionMismatchException { + fode.computeDerivatives(t, y, yDot); + } + + /** {@inheritDoc} */ + public Collection<String> getParametersNames() { + return new ArrayList<String>(); + } + + /** {@inheritDoc} */ + public boolean isSupported(String name) { + return false; + } + + /** {@inheritDoc} */ + public double getParameter(String name) throws UnknownParameterException { + if (!isSupported(name)) { + throw new UnknownParameterException(name); + } + return Double.NaN; + } + + /** {@inheritDoc} */ + public void setParameter(String name, double value) {} +} |