support reuse of Gurobi environment for multistage models

GenXProject · Nov 2, 2024 · 1620708 · 1620708
1 parent 73ab92d
commit 1620708
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/docs/src/User_Guide/model_configuration.md b/docs/src/User_Guide/model_configuration.md
@@ -125,6 +125,7 @@ The following tables summarize the model settings parameters and their default/p
 
 |**Parameter** | **Description**|
 | :------------ | :-----------|
+|Solver | OPTIONAL name of solver. Default is "HiGHS" effectively. It is necessary to set `Solver: "Gurobi"` when [reusing the same gurobi environment for multiple solves](https://github.com/jump-dev/Gurobi.jl?tab=readme-ov-file#reusing-the-same-gurobi-environment-for-multiple-solves).
 |EnableJuMPStringNames | Flag to enable/disable JuMP string names to improve the performance.|
 ||1 = enable JuMP string names.|
 ||0 = disable JuMP string names.|

diff --git a/src/case_runners/case_runner.jl b/src/case_runners/case_runner.jl
@@ -65,7 +65,8 @@ function run_genx_case_simple!(case::AbstractString, mysetup::Dict, optimizer::A
 
     ### Configure solver
     println("Configuring Solver")
-    OPTIMIZER = configure_solver(settings_path, optimizer)
+    solver_name = lowercase(get(mysetup, "Solver", ""))
+    OPTIMIZER = configure_solver(settings_path, optimizer; solver_name=solver_name)
 
     #### Running a case
 
@@ -137,7 +138,8 @@ function run_genx_case_multistage!(case::AbstractString, mysetup::Dict, optimize
 
     ### Configure solver
     println("Configuring Solver")
-    OPTIMIZER = configure_solver(settings_path, optimizer)
+    solver_name = lowercase(get(mysetup, "Solver", ""))
+    OPTIMIZER = configure_solver(settings_path, optimizer; solver_name=solver_name)
 
     model_dict = Dict()
     inputs_dict = Dict()

diff --git a/src/configure_solver/configure_solver.jl b/src/configure_solver/configure_solver.jl
@@ -19,8 +19,10 @@ Currently supported solvers include: "Gurobi", "CPLEX", "Clp", "Cbc", or "SCIP"
 # Returns
 - `optimizer::MathOptInterface.OptimizerWithAttributes`: the configured optimizer instance.
 """
-function configure_solver(solver_settings_path::String, optimizer::Any)
-    solver_name = infer_solver(optimizer)
+function configure_solver(solver_settings_path::String, optimizer::Any; solver_name::String="")
+    if isempty(solver_name)
+        solver_name = infer_solver(optimizer)
+    end
     path = joinpath(solver_settings_path, solver_name * "_settings.yml")
 
     configure_functions = Dict("highs" => configure_highs,