| /* |
| * 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.ode.FirstOrderDifferentialEquations; |
| import org.apache.commons.math3.ode.events.EventHandler; |
| |
| /** |
| * This class is used as the base class of the problems that are |
| * integrated during the junit tests for the ODE integrators. |
| */ |
| public abstract class TestProblemAbstract |
| implements FirstOrderDifferentialEquations { |
| |
| /** Dimension of the problem. */ |
| private int n; |
| |
| /** Number of functions calls. */ |
| private int calls; |
| |
| /** Initial time */ |
| private double t0; |
| |
| /** Initial state */ |
| private double[] y0; |
| |
| /** Final time */ |
| private double t1; |
| |
| /** Error scale */ |
| private double[] errorScale; |
| |
| /** |
| * Simple constructor. |
| */ |
| protected TestProblemAbstract() { |
| n = 0; |
| calls = 0; |
| t0 = 0; |
| y0 = null; |
| t1 = 0; |
| errorScale = null; |
| } |
| |
| /** |
| * Set the initial conditions |
| * @param t0 initial time |
| * @param y0 initial state vector |
| */ |
| protected void setInitialConditions(double t0, double[] y0) { |
| calls = 0; |
| n = y0.length; |
| this.t0 = t0; |
| this.y0 = y0.clone(); |
| } |
| |
| /** |
| * Set the final conditions. |
| * @param t1 final time |
| */ |
| protected void setFinalConditions(double t1) { |
| this.t1 = t1; |
| } |
| |
| /** |
| * Set the error scale |
| * @param errorScale error scale |
| */ |
| protected void setErrorScale(double[] errorScale) { |
| this.errorScale = errorScale.clone(); |
| } |
| |
| public int getDimension() { |
| return n; |
| } |
| |
| /** |
| * Get the initial time. |
| * @return initial time |
| */ |
| public double getInitialTime() { |
| return t0; |
| } |
| |
| /** |
| * Get the initial state vector. |
| * @return initial state vector |
| */ |
| public double[] getInitialState() { |
| return y0; |
| } |
| |
| /** |
| * Get the final time. |
| * @return final time |
| */ |
| public double getFinalTime() { |
| return t1; |
| } |
| |
| /** |
| * Get the error scale. |
| * @return error scale |
| */ |
| public double[] getErrorScale() { |
| return errorScale; |
| } |
| |
| /** |
| * Get the events handlers. |
| * @return events handlers */ |
| public EventHandler[] getEventsHandlers() { |
| return new EventHandler[0]; |
| } |
| |
| /** |
| * Get the theoretical events times. |
| * @return theoretical events times |
| */ |
| public double[] getTheoreticalEventsTimes() { |
| return new double[0]; |
| } |
| |
| /** |
| * Get the number of calls. |
| * @return nuber of calls |
| */ |
| public int getCalls() { |
| return calls; |
| } |
| |
| public void computeDerivatives(double t, double[] y, double[] yDot) { |
| ++calls; |
| doComputeDerivatives(t, y, yDot); |
| } |
| |
| abstract public void doComputeDerivatives(double t, double[] y, double[] yDot); |
| |
| /** |
| * Compute the theoretical state at the specified time. |
| * @param t time at which the state is required |
| * @return state vector at time t |
| */ |
| abstract public double[] computeTheoreticalState(double t); |
| |
| } |