]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Some last bits of the documentation
authormaier <maier@0785d39b-7218-0410-832d-ea1e28bc413d>
Sun, 18 Nov 2012 21:37:45 +0000 (21:37 +0000)
committermaier <maier@0785d39b-7218-0410-832d-ea1e28bc413d>
Sun, 18 Nov 2012 21:37:45 +0000 (21:37 +0000)
git-svn-id: https://svn.dealii.org/branches/branch_cmake@27568 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/doc/external-libs/arpack.html
deal.II/doc/external-libs/hdf5.html
deal.II/doc/external-libs/hsl.html [deleted file]
deal.II/doc/external-libs/mumps.html

index b8b9c9443c93693f5b70b32fdf718e58fa5c3c0b..42d6f899a82967019d5832e8d0743d737ad2c185 100644 (file)
@@ -4,7 +4,7 @@
 <html>                                                                          
   <head>                            
     <title>The deal.II Readme on interfacing to ARPACK</title>
-    <link href="screen.css" rel="StyleSheet">
+    <link href="../screen.css" rel="StyleSheet">
     <meta name="author" content="the deal.II authors <authors @ dealii.org>"> 
     <meta name="copyright" content="Copyright (C) 2010 by the deal.II authors">
     <meta name="date" content="$Date: 2010-05-05 (Thu, 05 May 2010) $">
   <body> 
 
     
-    <h1>Using and Installing <acronym>ARPACK</acronym></h1>
-    <p> <a href="http://www.caam.rice.edu/software/ARPACK/">ARPACK</a> 
-    is a collection of Fortran77 subroutines designed to solve large
-    scale eigenvalue problems.
+    <h2>Installation of <acronym>ARPACK</acronym></h2>
 
-    After you downloaded the Fortran version of <acronym>ARPACK</acronym>
-    and the patch unzip the files you got. That will create a directory 
-    named <acronym>ARPACK</acronym>. If you need 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>.
+    <p>
+      <a href="http://www.caam.rice.edu/software/ARPACK/">ARPACK</a> 
+      is a collection of Fortran77 subroutines designed to solve large
+      scale eigenvalue problems.
+      <a href="http://www.caam.rice.edu/software/ARPACK/" target="_top">ARPACK</a>
+      should be readily packaged by most Linux distributions.
+      Don't forget to install a development version of the library.
+    </p>
+
+    <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).
+    </p>
+
+    <h3>How to compile and install <acronym>ARPACK</acronym> by hand</h3>
+
+    <p>
+      After you downloaded the Fortran version of <acronym>ARPACK</acronym>
+      and the patch, unzip the files you got. That will create
+      a directory named <acronym>ARPACK</acronym>. If you need
+      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>.
     </p>
 
     <ul>
-      <li>edit ARmake.inc</li>
+      <li>edit <code>ARmake.inc</code></li>
       <ul>
         <li>change home to the correct directory</li>
         <li>choose which <acronym>BLAS</acronym> and 
     <acronym>ARPACK</acronym>.
     </p>
 
-    <h1>Interfacing <acronym>deal.II</acronym>
-      to <acronym>ARPACK</acronym></h1>
+    <h2>Interfacing <acronym>deal.II</acronym>
+      to <acronym>ARPACK</acronym></h2>
+
+    <p>
+      Support for <acronym>ARPACK</acronym> will be
+      enabled automatically if a system wide installation of
+      <acronym>ARPACK</acronym> can be found.
+      To use a self compiled version, specify
+      <pre>
+
+    -DARPACK_DIR=/path/to/arpack
+      </pre>
+      when invoking <code>cmake</code>.
+    </p>
+    <p>
+      You can override the autodetection by manually setting
+      <pre>
 
-    <p> To be able to use the interface of <acronym>deal.II</acronym>
-    for <acronym>ARPACK</acronym> we then
-      configure <acronym>deal.II</acronym> with the following
-      additional option:
-       <code>--with-arpack=path/to/arpack</code>
+    -DDEAL_II_WITH_ARPACK=OFF|ON
+      </pre>.
     </p>
   </body>
 </html>
index e9e10181e4c969809de9e0d64c7d91a2aef5e8ce..61217db66af93f6681ae350d5ea3b9ee9f25d148 100644 (file)
@@ -4,7 +4,7 @@
 <html>                                                                          
   <head>                            
     <title>The deal.II Readme on interfacing to HDF5</title>
-    <link href="screen.css" rel="StyleSheet">
+    <link href="../screen.css" rel="StyleSheet">
     <meta name="author" content="the deal.II authors <authors @ dealii.org>"> 
     <meta name="copyright" content="Copyright (C) 2012 by the deal.II authors">
     <meta name="date" content="$Date: 2010-05-05 (Thu, 05 May 2010) $">
diff --git a/deal.II/doc/external-libs/hsl.html b/deal.II/doc/external-libs/hsl.html
deleted file mode 100644 (file)
index 1851c62..0000000
+++ /dev/null
@@ -1,122 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN"
-   "http://www.w3.org/TR/REC-html40/frameset.dtd">
-<html>
-  <head>
-    <link href="../screen.css" rel="StyleSheet" media="screen">
-    <title>The deal.II Readme</title>
-    <meta name="author" content="the deal.II authors <authors@dealii.org>">
-    <meta name="keywords" content="deal.II">
-  </head>
-
-  <body>
-
-
-    <h1>Using and installing instructions for functions from the
-    Harwell Subroutine Library (HSL)</h1>
-
-    <p>
-    The <a href="http://www.hsl.rl.ac.uk/"
-    target="_top">Harwell Subroutine Library (HSL)</a> is a collection of
-    Fortran77 files that implement various methods to solve linear
-    systems of equations, but also cover various other aspects of
-    mathematical algorithms. <acronym>deal.II</acronym> is presently
-    able to use two of the sparse direct solvers implemented in that
-    library:
-    <ul>
-    <li> <p> MA27: A modified Gauss elimination method for sparse
-         symmetric indefinite systems.</p>
-    <li> <p> MA47: A frontal elimination method for sparse symmetric
-         indefinite systems.</p>
-    </ul>
-    Within <acronym>deal.II</acronym>, they are used by the classes 
-    <code>SparseDirectMA27</code> and <code>SparseDirectMA47</code>
-    (see the online reference in the LAC sublibrary for more
-    information).
-    </p>
-
-    <p>
-    With respect to the integration of these functions into
-    <acronym>deal.II</acronym>, there are two problems: Firstly, for
-    license reasons, we can not, however, include these solvers in the
-    standard distribution of the library, so you have to download them
-    yourself, if you want to use them. Secondly, these functions are
-    usually downloaded as single files, rather than as a complete
-    library, so one does not usually build up a whole library against which
-    a <acronym>deal.II</acronym> program could be linked, but is left
-    with the individual files.
-    </p>
-
-    <p>
-    Our solution to this problem is as follows:
-    <ul>
-    <li> <p>
-         If you want to use any of these subroutines, then you have to
-         download them from the <a href="http://www.hsl.rl.ac.uk/"
-        target="_top">HSL server</a>. Note that the license is rather
-         restrictive.
-        </p>
-
-        <p>
-        For MA27, you have to have the main file, while for MA47
-        there are two files, one for the main algorithm and one with
-        support functions.
-        </p>
-
-    <li> <p>
-         Drop these files into the directory
-         <code>deal.II/contrib/hsl/source</code>, with names
-        <code>ma27.f</code> (for MA27), and <code>ma47.f</code> and
-         <code>ma47dep.f</code> (for MA47). There should already be a
-         file called <code>ma27sup.f</code>. Note that the exact names
-         (including letter case) of the files matter.
-        </p>
-
-    <li> <p>
-         Run (or re-run) the <code>./configure</code> script in the
-         top level directory of <acronym>deal.II</acronym>. It should,
-         at one point, print a message which functions from HSL it has
-         found. This sets some flags for subsequent compilations 
-        (preprocessor defines <code>HAVE_HSL_MA27,
-         HAVE_HSL_MA47</code> and Makefile variable
-         <code>USE_CONTRIB_HSL=yes</code>) that 
-         these functions have been found and can be used, rather than
-         dummy functions that only display an error and abort the
-         program if called.
-        <p>
-
-    <li> <p>
-         Compile the library (a description of how to do so is found
-         in the <a href="../readme.html" target="body">ReadMe</a>
-         file). If you had already made it, first clean the directory
-         by calling <code>make clean</code> in the top level directory.
-        </p>
-    </ul>
-    </p>
-
-    <p>
-    Note that if the respective functions have not been found at
-    configure time, then the classes using them are still available to
-    programs, but when called will issue an error message and abort
-    the program with an exception.
-    </p>
-
-    <p>
-    If HSL functions have been found, then we also have some Fortran77
-    code in the system. Of course, the requires that some F77 compiler
-    has been found at configure time, but note that this also changes
-    the libraries that need to be linked to the program. For example,
-    on Sun, these are the libraries <code>-lF77 -lsunmath
-    -lM77</code>. Usually, the right set of additional libraries
-    should be detected automatically at configure time, and the
-    respective flags should also be set correctly without user
-    interaction.
-    </p>
-
-    <hr>
-    
-    <address>
-      <a href="mail.html">The deal.II Group</a>
-      $Date$
-    </address>
-  </body>
-</html>
index 906c6732624580ac455a01519646605407d0366e..1c9e2ebd1dc1b697f43be935f1cb6c4d88586622 100644 (file)
@@ -4,7 +4,7 @@
 <html>                                                                          
   <head>                            
     <title>The deal.II Readme on interfacing to PETSc and Trilinos</title>
-    <link href="screen.css" rel="StyleSheet">
+    <link href="../screen.css" rel="StyleSheet">
     <meta name="author" content="the deal.II authors <authors @ dealii.org>"> 
     <meta name="copyright" content="Copyright (C) 2010, 2011 by the deal.II authors">
     <meta name="date" content="$Date: 2010-05-05 (Thu, 05 May 2010) $">
 
     <h1>Interfacing <acronym>deal.II</acronym>
       to <acronym>MUMPS</acronym></h1>
-    
-    <p> This documentation describes the compilation process
-      of <acronym>MUMPS</acronym> and its dependencies starting with
-      <acronym>BLACS</acronym> and following
-      with <acronym>SCALAPACK</acronym>. The compilation
-      of <acronym>MUMPS</acronym> and its dependencies is not as
-      straightforward is we would like, however, it is not so
-      difficult that we can not talk about it. That said, we cannot
+
+    <p>
+      <a href="http://mumps.enseeiht.fr" target="_top">MUMPS</a>
+      should be readily packaged by most Linux distributions.
+      Don't forget to install a develpment version of the library.
+    </p>
+
+    <p>
+      Below is a detailed instruction on how to compile and install
+      <acronym>MUMPS</acronym> and some of its dependencies by hand (for
+      the case you wish to do so).
+    </p>
+
+    <h2>How to compile and install <acronym>MUMPS</acronym> by hand</h2>
+
+    <p>
+      In the following, we describe the compilation process of
+      <acronym>MUMPS</acronym> and its dependencies starting
+      with <acronym>BLACS</acronym> and following with
+      <acronym>SCALAPACK</acronym>.
+
+      The compilation of <acronym>MUMPS</acronym> and its dependencies
+      is not as straightforward is we would like, however, it is not
+      so difficult that we can not talk about it. That said, we cannot
       discuss every possible choice of parameters, because this is too
       involved (and we would probably much rather be doing something
-      productive with the interface and
-      <acronym>deal.II</acronym>). Thus we give only a short
-      walk-through mentioning the most important parameters needed for
-      successful compliation and linking.
+      productive with the interface and <acronym>deal.II</acronym>). Thus
+      we give only a short walk-through mentioning the most important
+      parameters needed for successful compliation and linking.
     </p>
     
     <p> The compilation scheme involves repeating the same three steps
@@ -48,7 +63,7 @@
       of <acronym>BLACS</acronym>.
     </p>
     
-    <h2>1. BLACS</h2>
+    <h3>1. BLACS</h3>
     
     <p> The <a href="http://www.netlib.org/blacs/">BLACS</a> library
       provides basic linear algebra routines together with a
       library with the command <code>make mpi</code>.
     </p>
     
-    <h2>2. SCALAPACK</h2>
+    <h3>2. SCALAPACK</h3>
     
     <p> The <a href="http://www.netlib.org/scalapack">SCALAPACK</a>
       library provides high-performance linear algebra routines for
       command <code>make</code>.
     </p>
     
-    <h2>3. MUMPS</h2>
+    <h3>3. MUMPS</h3>
     
     <p> Now we come to the main program for which we are doing all
       this. We want to install the parallel sparse direct
       </ul>
     </p>
     
-    <p> Now we are done with configuration and can
+    <p>
+      Now we are done with configuration and can
       compile <acronym>MUMPS</acronym> with the
       command <code>make</code>.
     </p>
     
-    <h2>4. Linking with deal.II</h2>
-    
-    <p> To be able to use the interface of <acronym>deal.II</acronym>
-      for the MUMPS solver we then
-      configure <acronym>deal.II</acronym> with the following
-      additional options:
+    <h2>Linking with deal.II</h2>
+
+    <p>
+      Support for <acronym>MUMPS</acronym> will be enabled automatically
+      if a system wide installation of <acronym>MUMPS</acronym>
+      can be found.  To use a self compiled version, specify
+      <pre>
+
+    -DMUMPS_DIR=/path/to/mumps
+      </pre> on the command line when invoking <code>cmake</code>.
+    </p>
+
+    <p>
+      For <acronym>SCALAPACK</acronym> and <acronym>BLACS</acronym> a hint
+      - if necessary - may be given by
       <pre>
-       <code>
-          --with-mumps=path/to/mumps
-          --with-blacs=path/to/blacs
-          --with-scalapack=path/to/scalapack
-       </code>
+
+    -DSCALAPACK_DIR=/path/to/scalapack
+    -DBLACS_DIR=/path/to/blacs
       </pre>
     </p>
+
+    <p>
+      You can override the autodetection by manually specifying
+      <pre>
+    -DDEAL_II_WITH_MUMPS=OFF|ON
+      </pre>.
+    </p>
     
     <p>
-      Note: Throughout this description of the compilation process
-      of <acronym>MUMPS</acronym> we have emphasised 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.
+      <b>Note:</b> Throughout this description of the compilation process
+      of <acronym>MUMPS</acronym> we have emphasised 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>
 
   </body>

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.