From 0d19fb613c93d17a9a6ced50930e04c3f431f44c Mon Sep 17 00:00:00 2001
From: Daniel Arndt <daniel.arndt@iwr.uni-heidelberg.de>
Date: Sat, 8 Apr 2017 23:04:24 +0200
Subject: [PATCH] Add ARPACK-NG information

---
 doc/external-libs/arpack.html | 65 ++++++++++++++++++++++++++---------
 1 file changed, 48 insertions(+), 17 deletions(-)

diff --git a/doc/external-libs/arpack.html b/doc/external-libs/arpack.html
index 346158b8d4..7f261ec1a4 100644
--- a/doc/external-libs/arpack.html
+++ b/doc/external-libs/arpack.html
@@ -24,7 +24,9 @@
 
     <p>
       Below is a short summary of instructions on how to compile and install
-      <acronym>ARPACK</acronym> by hand (for the case you wish to do so).
+      <acronym>ARPACK</acronym> by hand (for the case you wish to do so)
+      or using <a href="https://github.com/opencollab/arpack-ng">ARPACK-NG</a>
+      that equips <acronym>ARPACK</acronym> with a CMake build system.
     </p>
 
     <h3>How to compile and install <acronym>ARPACK</acronym> by hand</h3>
@@ -36,8 +38,7 @@
       further instructions please read the README file or the
       <a href="http://www.caam.rice.edu/software/ARPACK/SRC/instruction.arpack">instructions</a>.
       We will explain here in a few steps what has to be done to be able
-      to compile
-      <acronym>ARPACK</acronym>.
+      to compile <acronym>ARPACK</acronym>.
     </p>
 
     <ul>
@@ -54,26 +55,56 @@
     </ul>
 
     <p>
-    Note: For compilation of <acronym>ARPACK</acronym> we emphasise
-    adding the compiler flag <code>-fPIC</code>. This is a definite
-    requirement if we are compiling <acronym>deal.II</acronym> with
-    shared libraries (which is the default). If we had preferred to be
-    compiling <acronym>deal.II</acronym> without shared libraries,
-    that's ok too; in that case we would do exactly the same thing
-    as described above, but this time omitting
-    the <code>-fPIC</code> flag from the scheme.
+      Note: For compilation of <acronym>ARPACK</acronym> we emphasise
+      adding the compiler flag <code>-fPIC</code>. This is a definite
+      requirement if we are compiling <acronym>deal.II</acronym> with
+      shared libraries (which is the default). If we had preferred to be
+      compiling <acronym>deal.II</acronym> without shared libraries,
+      that's ok too; in that case we would do exactly the same thing
+      as described above, but this time omitting
+      the <code>-fPIC</code> flag from the scheme.
     </p>
 
+    <h3>How to compile and install <acronym>ARPACK-NG</acronym></h3>
+
     <p>
-    Try to run one of the examples and compare the output.
-    How the output should look like is stated in the README
-    that can be found in the <code>EXAMPLES</code> directory.
+      First clone the <a href="https://github.com/opencollab/arpack-ng">ARPACK-NG</a>
+      repository. The following commands will set up an appropriate configuration:
+
+      <pre>
+        cd arpack-ng
+        mkdir build
+        cd build
+
+        cmake                                       \
+        -DEXAMPLES=ON                               \
+        -DMPI=ON                                    \
+        -DBUILD_SHARED_LIBS=ON                      \
+        -DCMAKE_INSTALL_PREFIX:PATH=$HOME/ARPACK-NG \
+        ../
+
+        make
+        make install
+      </pre>
+
+      You will need to adjust the path into which you want to install ARPACK-NG
+      in the CMAKE_INSTALL_PREFIX line. If you do not have MPI installed you
+      should use <code>-DMPI=OFF</code> instead.
     </p>
 
+    <h3>Test the installation</h3>
+
     <p>
-    If that output you produced looks like it should you can
-    proceed to compile <acronym>deal.II</acronym> with
-    <acronym>ARPACK</acronym>.
+      After installing <acronym>ARPACK</acronym> or <acronym>ARPACK-NG</acronym>
+      try to run one of the examples and compare the output.
+      How the output should look like is stated in the README
+      that can be found in the <code>EXAMPLES</code> directory.
+    </p>
+
+    <p>
+      If that output you produced looks like it should you can
+      proceed to compile <acronym>deal.II</acronym> with
+      <acronym>ARPACK</acronym>.
     </p>
 
     <h2>Interfacing <acronym>deal.II</acronym>
-- 
2.39.5