From 325c3faf046949996180812b9686d994e8eea088 Mon Sep 17 00:00:00 2001
From: jarchambault <jeanne.archambault@artelys.com>
Date: Wed, 11 Dec 2024 12:18:52 +0100
Subject: [PATCH] Delete useless class for knitro stopping criteria

Signed-off-by: jarchambault <jeanne.archambault@artelys.com>
---
 pom.xml                                       |  2 +-
 .../DefaultKnitroSolverStoppingCriteria.java  | 29 -------------------
 .../solver/KnitroLoadFlowParameters.java      | 14 +++++----
 .../knitro/solver/KnitroSolver.java           |  3 +-
 .../knitro/solver/KnitroSolverFactory.java    |  8 ++---
 .../knitro/solver/KnitroSolverParameters.java | 25 ++++++++--------
 .../solver/KnitroSolverStoppingCriteria.java  | 17 -----------
 7 files changed, 26 insertions(+), 72 deletions(-)
 delete mode 100644 src/main/java/com/powsybl/openloadflow/knitro/solver/DefaultKnitroSolverStoppingCriteria.java
 delete mode 100644 src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolverStoppingCriteria.java

diff --git a/pom.xml b/pom.xml
index 497fb04..a7d1b2b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -45,7 +45,7 @@
         <java.version>17</java.version>
         <powsybl-core.version>6.6.0-RC1</powsybl-core.version>
         <powsybl-open-loadflow.version>1.14.0-SNAPSHOT</powsybl-open-loadflow.version>
-        <knitro-interfaces.version>14.1.0</knitro-interfaces.version>
+        <knitro-interfaces.version>14.0.0</knitro-interfaces.version>
         <bridj.version>0.7.0</bridj.version>
     </properties>
 
diff --git a/src/main/java/com/powsybl/openloadflow/knitro/solver/DefaultKnitroSolverStoppingCriteria.java b/src/main/java/com/powsybl/openloadflow/knitro/solver/DefaultKnitroSolverStoppingCriteria.java
deleted file mode 100644
index 930382f..0000000
--- a/src/main/java/com/powsybl/openloadflow/knitro/solver/DefaultKnitroSolverStoppingCriteria.java
+++ /dev/null
@@ -1,29 +0,0 @@
-/**
- * Copyright (c) 2024, Artelys (http://www.artelys.com/)
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- * SPDX-License-Identifier: MPL-2.0
- */
-package com.powsybl.openloadflow.knitro.solver;
-
-/**
- * @author Jeanne Archambault {@literal <jeanne.archambault at artelys.com>}
- */
-public class DefaultKnitroSolverStoppingCriteria implements KnitroSolverStoppingCriteria {
-
-    public final double convEpsPerEq;
-
-    public DefaultKnitroSolverStoppingCriteria() {
-        this(KnitroSolverStoppingCriteria.DEFAULT_CONV_EPS_PER_EQ);
-    }
-
-    public DefaultKnitroSolverStoppingCriteria(double convEpsPerEq) {
-        this.convEpsPerEq = convEpsPerEq;
-    }
-
-    public double getConvEpsPerEq() {
-        return convEpsPerEq;
-    }
-
-}
diff --git a/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroLoadFlowParameters.java b/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroLoadFlowParameters.java
index 3d666e4..03e90c6 100644
--- a/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroLoadFlowParameters.java
+++ b/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroLoadFlowParameters.java
@@ -21,8 +21,7 @@ public class KnitroLoadFlowParameters extends AbstractExtension<LoadFlowParamete
     private double lowerVoltageBound = KnitroSolverParameters.DEFAULT_LOWER_VOLTAGE_BOUND;
     private double upperVoltageBound = KnitroSolverParameters.DEFAULT_UPPER_VOLTAGE_BOUND;
     private int maxIterations = KnitroSolverParameters.DEFAULT_MAX_ITERATIONS;
-    private KnitroSolverStoppingCriteria stoppingCriteria = new KnitroSolverStoppingCriteria() {
-    };
+    private double convEps = KnitroSolverParameters.DEFAULT_STOPPING_CRITERIA;
 
     public int getGradientComputationMode() {
         return gradientComputationMode;
@@ -87,12 +86,15 @@ public KnitroLoadFlowParameters setMaxIterations(int maxIterations) {
         return this;
     }
 
-    public KnitroSolverStoppingCriteria getStoppingCriteria() {
-        return stoppingCriteria;
+    public double getConvEps() {
+        return convEps;
     }
 
-    public KnitroLoadFlowParameters setStoppingCriteria(KnitroSolverStoppingCriteria stoppingCriteria) {
-        this.stoppingCriteria = Objects.requireNonNull(stoppingCriteria);
+    public KnitroLoadFlowParameters setConvEps(double convEps) {
+        if (convEps < 0) {
+            throw new IllegalArgumentException("Convergence stopping criteria must be greater than 0");
+        }
+        this.convEps = convEps;
         return this;
     }
 
diff --git a/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolver.java b/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolver.java
index 81fa596..07431a6 100644
--- a/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolver.java
+++ b/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolver.java
@@ -509,8 +509,7 @@ private KnitroProblem(LfNetwork lfNetwork, EquationSystem<AcVariableType, AcEqua
 
     private void setSolverParameters(KNSolver solver, KnitroSolverParameters knitroParameters) throws KNException {
         solver.setParam(KNConstants.KN_PARAM_GRADOPT, knitroParameters.getGradientComputationMode());
-        DefaultKnitroSolverStoppingCriteria knitroSolverStoppingCriteria = (DefaultKnitroSolverStoppingCriteria) knitroParameters.getStoppingCriteria();
-        solver.setParam(KNConstants.KN_PARAM_FEASTOL, knitroSolverStoppingCriteria.convEpsPerEq);
+        solver.setParam(KNConstants.KN_PARAM_FEASTOL, knitroParameters.getConvEps());
         solver.setParam(KNConstants.KN_PARAM_MAXIT, knitroParameters.getMaxIterations());
     }
 
diff --git a/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolverFactory.java b/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolverFactory.java
index 33b793b..a49ea16 100644
--- a/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolverFactory.java
+++ b/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolverFactory.java
@@ -37,7 +37,6 @@ public String getName() {
     public AcSolverParameters createParameters(LoadFlowParameters parameters) {
         OpenLoadFlowParameters parametersExt = OpenLoadFlowParameters.get(parameters);
         KnitroSolverParameters knitroSolverParameters = new KnitroSolverParameters()
-                .setStoppingCriteria(createKnitroStoppingCriteria(parametersExt))
                 .setStateVectorScalingMode(parametersExt.getStateVectorScalingMode())
                 .setLineSearchStateVectorScalingMaxIteration(parametersExt.getLineSearchStateVectorScalingMaxIteration())
                 .setLineSearchStateVectorScalingStepFold(parametersExt.getLineSearchStateVectorScalingStepFold())
@@ -50,7 +49,9 @@ public AcSolverParameters createParameters(LoadFlowParameters parameters) {
                 .setGradientUserRoutine(parameters.getExtension(KnitroLoadFlowParameters.class).getGradientUserRoutine())
                 .setLowerVoltageBound(parameters.getExtension(KnitroLoadFlowParameters.class).getLowerVoltageBound())
                 .setUpperVoltageBound(parameters.getExtension(KnitroLoadFlowParameters.class).getUpperVoltageBound())
-                .setMaxIterations(parameters.getExtension(KnitroLoadFlowParameters.class).getMaxIterations());
+                .setMaxIterations(parameters.getExtension(KnitroLoadFlowParameters.class).getMaxIterations())
+                .setConvEps(parameters.getExtension(KnitroLoadFlowParameters.class).getConvEps());
+
         }
         return knitroSolverParameters;
     }
@@ -63,7 +64,4 @@ public AcSolver create(LfNetwork network, AcLoadFlowParameters parameters, Equat
                 j, targetVector, equationVector, parameters.isDetailedReport());
     }
 
-    private static KnitroSolverStoppingCriteria createKnitroStoppingCriteria(OpenLoadFlowParameters parametersExt) {
-        return new DefaultKnitroSolverStoppingCriteria();
-    }
 }
diff --git a/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolverParameters.java b/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolverParameters.java
index 9eff43a..d833bfe 100644
--- a/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolverParameters.java
+++ b/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolverParameters.java
@@ -23,6 +23,7 @@ public class KnitroSolverParameters implements AcSolverParameters {
     public static final double DEFAULT_LOWER_VOLTAGE_BOUND = 0.5; // Lower bound for voltage magnitude
     public static final double DEFAULT_UPPER_VOLTAGE_BOUND = 1.5; // Upper bound for voltage magnitude
     public static final int DEFAULT_MAX_ITERATIONS = 200;
+    public static final double DEFAULT_STOPPING_CRITERIA = Math.pow(10,-6);
     public static final StateVectorScalingMode DEFAULT_STATE_VECTOR_SCALING_MODE = StateVectorScalingMode.NONE;
     public static final boolean ALWAYS_UPDATE_NETWORK_DEFAULT_VALUE = false;
 
@@ -44,12 +45,12 @@ public class KnitroSolverParameters implements AcSolverParameters {
 
     private double upperVoltageBound = DEFAULT_UPPER_VOLTAGE_BOUND;
 
-    private KnitroSolverStoppingCriteria stoppingCriteria = new DefaultKnitroSolverStoppingCriteria();
-
     private boolean alwaysUpdateNetwork = ALWAYS_UPDATE_NETWORK_DEFAULT_VALUE;
 
     private int maxIterations = DEFAULT_MAX_ITERATIONS;
 
+    private double convEps = DEFAULT_STOPPING_CRITERIA;
+
     public int getGradientComputationMode() {
         return gradientComputationMode;
     }
@@ -101,15 +102,6 @@ public KnitroSolverParameters setUpperVoltageBound(double upperVoltageBound) {
         return this;
     }
 
-    public KnitroSolverStoppingCriteria getStoppingCriteria() {
-        return stoppingCriteria;
-    }
-
-    public KnitroSolverParameters setStoppingCriteria(KnitroSolverStoppingCriteria stoppingCriteria) {
-        this.stoppingCriteria = Objects.requireNonNull(stoppingCriteria);
-        return this;
-    }
-
     public StateVectorScalingMode getStateVectorScalingMode() {
         return stateVectorScalingMode;
     }
@@ -174,11 +166,20 @@ public KnitroSolverParameters setMaxIterations(int maxIterations) {
         return this;
     }
 
+    public double getConvEps() {
+        return convEps;
+    }
+
+    public KnitroSolverParameters setConvEps(double convEps) {
+        this.convEps = convEps;
+        return this;
+    }
+
     @Override
     public String toString() {
         return "KnitroSolverParameters(" +
                 "gradientComputationMode=" + gradientComputationMode +
-                ", stoppingCriteria=" + stoppingCriteria.getClass().getSimpleName() +
+                ", stoppingCriteria=" + convEps +
                 ", minRealisticVoltage=" + lowerVoltageBound +
                 ", maxRealisticVoltage=" + upperVoltageBound +
                 ", alwaysUpdateNetwork=" + alwaysUpdateNetwork +
diff --git a/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolverStoppingCriteria.java b/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolverStoppingCriteria.java
deleted file mode 100644
index b2fcafc..0000000
--- a/src/main/java/com/powsybl/openloadflow/knitro/solver/KnitroSolverStoppingCriteria.java
+++ /dev/null
@@ -1,17 +0,0 @@
-/**
- * Copyright (c) 2024, Artelys (http://www.artelys.com/)
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- * SPDX-License-Identifier: MPL-2.0
- */
-package com.powsybl.openloadflow.knitro.solver;
-
-/**
- * @author Jeanne Archambault {@literal <jeanne.archambault at artelys.com>}
- */
-public interface KnitroSolverStoppingCriteria {
-
-    double DEFAULT_CONV_EPS_PER_EQ = Math.pow(10, -6);
-
-}