summaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/math3/ode/ParameterizedODE.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/org/apache/commons/math3/ode/ParameterizedODE.java')
-rw-r--r--src/main/java/org/apache/commons/math3/ode/ParameterizedODE.java44
1 files changed, 44 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/ode/ParameterizedODE.java b/src/main/java/org/apache/commons/math3/ode/ParameterizedODE.java
new file mode 100644
index 0000000..ab597c6
--- /dev/null
+++ b/src/main/java/org/apache/commons/math3/ode/ParameterizedODE.java
@@ -0,0 +1,44 @@
+/*
+ * 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;
+
+/**
+ * Interface to compute by finite difference Jacobian matrix for some parameter when computing
+ * {@link JacobianMatrices partial derivatives equations}.
+ *
+ * @since 3.0
+ */
+public interface ParameterizedODE extends Parameterizable {
+
+ /**
+ * Get parameter value from its name.
+ *
+ * @param name parameter name
+ * @return parameter value
+ * @exception UnknownParameterException if parameter is not supported
+ */
+ double getParameter(String name) throws UnknownParameterException;
+
+ /**
+ * Set the value for a given parameter.
+ *
+ * @param name parameter name
+ * @param value parameter value
+ * @exception UnknownParameterException if parameter is not supported
+ */
+ void setParameter(String name, double value) throws UnknownParameterException;
+}