/* * 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.math.ode; import java.util.Collection; import org.apache.commons.math.ode.events.EventHandler; import org.apache.commons.math.ode.sampling.StepHandler; /** * This interface defines the common parts shared by integrators * for first and second order differential equations. * @see FirstOrderIntegrator * @see SecondOrderIntegrator * @version $Revision: 1061507 $ $Date: 2011-01-20 21:55:00 +0100 (jeu. 20 janv. 2011) $ * @since 2.0 */ public interface ODEIntegrator { /** Get the name of the method. * @return name of the method */ String getName(); /** Add a step handler to this integrator. *
The handler will be called by the integrator for each accepted * step.
* @param handler handler for the accepted steps * @see #getStepHandlers() * @see #clearStepHandlers() * @since 2.0 */ void addStepHandler(StepHandler handler); /** Get all the step handlers that have been added to the integrator. * @return an unmodifiable collection of the added events handlers * @see #addStepHandler(StepHandler) * @see #clearStepHandlers() * @since 2.0 */ CollectionThis method can be called during integration (typically by * the object implementing the {@link FirstOrderDifferentialEquations * differential equations} problem) if the value of the current step that * is attempted is needed.
*The result is undefined if the method is called outside of
* calls to integrate
.
This method can be called during integration (typically by * the object implementing the {@link FirstOrderDifferentialEquations * differential equations} problem) if the signed value of the current stepsize * that is tried is needed.
*The result is undefined if the method is called outside of
* calls to integrate
.
The purpose of this method is to avoid infinite loops which can occur * for example when stringent error constraints are set or when lots of * discrete events are triggered, thus leading to many rejected steps.
* @param maxEvaluations maximal number of function evaluations (negative * values are silently converted to maximal integer value, thus representing * almost unlimited evaluations) */ void setMaxEvaluations(int maxEvaluations); /** Get the maximal number of functions evaluations. * @return maximal number of functions evaluations */ int getMaxEvaluations(); /** Get the number of evaluations of the differential equations function. *
* The number of evaluations corresponds to the last call to the
* integrate
method. It is 0 if the method has not been called yet.
*