update options docu and changelog

coin-or · Nov 27, 2024 · 7d667c6 · 7d667c6
1 parent 33a2fed
commit 7d667c6
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -15,6 +15,8 @@ More detailed information about incremental changes can be found in the
   to enable check for interrupt signal in `intermediate_callback`.
 - The `ipopt` and `ipopt_sens` executables can now be interrupted by SIGINT/SIGHUP
   (POSIX systems) or SIGINT/SIGTERM/SIGABRT (Windows systems).
+- New option `mumps_mpi_communicator` to specify the MPI communicator when using
+  an MPI-enabled build of MUMPS [#790, by Alex Tyler Chapman].
 
 ### 3.14.16 (2024-04-22)
 

diff --git a/doc/options.dox b/doc/options.dox
@@ -2473,6 +2473,12 @@ Possible values:
  This is CNTL(3) in MUMPS. The valid range for this real option is unrestricted and its default value is 0.
 </blockquote>
 
+\anchor OPT_mumps_mpi_communicator
+<strong>mumps_mpi_communicator</strong> (<em>advanced</em>): MPI communicator used for matrix operations
+<blockquote>
+ This sets the MPI communicator. MPI_COMM_WORLD is the default. Any other value should be the return value from MPI_Comm_c2f. The valid range for this integer option is unrestricted and its default value is -987654.
+</blockquote>
+
 
 \subsection OPT_MA28_Linear_Solver MA28 Linear Solver
 

diff --git a/src/Algorithm/LinearSolvers/IpMumpsSolverInterface.cpp b/src/Algorithm/LinearSolvers/IpMumpsSolverInterface.cpp
@@ -176,7 +176,7 @@ void MumpsSolverInterface::RegisterOptions(
       "mumps_mpi_communicator",
       "MPI communicator used for matrix operations",
       USE_COMM_WORLD,
-      "This sets the MPI communicator. MPI_COMM_WORLD is the default. Any other value should be the return value from MPI_Comm_c2f", true);
+      "This sets the MPI communicator. MPI_COMM_WORLD is the default. Any other value should be the return value from MPI_Comm_c2f.", true);
 }
 
 /// give name of MUMPS with version info