001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.math3.ode;
018
019
020/** Interface to compute by finite difference Jacobian matrix for some parameter
021 *  when computing {@link JacobianMatrices partial derivatives equations}.
022 *
023 * @since 3.0
024 */
025
026public interface ParameterizedODE extends Parameterizable {
027
028    /** Get parameter value from its name.
029     * @param name parameter name
030     * @return parameter value
031     * @exception UnknownParameterException if parameter is not supported
032     */
033    double getParameter(String name) throws UnknownParameterException;
034
035    /** Set the value for a given parameter.
036     * @param name parameter name
037     * @param value parameter value
038     * @exception UnknownParameterException if parameter is not supported
039     */
040    void setParameter(String name, double value) throws UnknownParameterException;
041
042}