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     */
017    package 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     * @version $Id: ParameterizedODE.java 1416643 2012-12-03 19:37:14Z tn $
024     * @since 3.0
025     */
026    
027    public interface ParameterizedODE extends Parameterizable {
028    
029        /** Get parameter value from its name.
030         * @param name parameter name
031         * @return parameter value
032         * @exception UnknownParameterException if parameter is not supported
033         */
034        double getParameter(String name) throws UnknownParameterException;
035    
036        /** Set the value for a given parameter.
037         * @param name parameter name
038         * @param value parameter value
039         * @exception UnknownParameterException if parameter is not supported
040         */
041        void setParameter(String name, double value) throws UnknownParameterException;
042    
043    }