Documentation refinement. Added main doc file.

doc/doxygen/Doxylocal

@@ -0,0 +1,25 @@
+# This file contains local changes to the doxygen configuration
+# please us '+=' to add file/directories to the lists
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT                 += @abs_top_srcdir@/opm/
+
+# see e.g. dune-grid for the examples of mainpage and modules
+# INPUT                 += @abs_top_srcdir@/doc/doxygen/mainpage #                          @srcdir@/modules
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+
+# EXCLUDE               += @abs_top_srcdir@/tests/
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+# EXAMPLE_PATH          += @abs_top_srcdir@/examples/
+

opm/autodiff/AutoDiffBlock.hpp

@@ -45,8 +45,8 @@ namespace Opm
     /// The class is built on the Eigen library, using an Eigen array
     /// type to contain the values and Eigen sparse matrices for the
     /// jacobians. The overloaded operators are intended to behave in
-    /// a similar way to Eigen arrays, meaning that the '*' operator
-    /// is elementwise multiplication. The only exception is
+    /// a similar way to Eigen arrays, meaning for example that the *
+    /// operator is elementwise multiplication. The only exception is
     /// multiplication with a sparse matrix from the left, which is
     /// treated as an Eigen matrix operation.
     ///
@@ -63,10 +63,10 @@ namespace Opm
     /// elements in p, and 20 in each of r and s, the block pattern is
     /// { 10, 20, 20 }. When creating the variables p, r and s in your
     /// program you have two options:
-    ///    a) Use the variable() constructor three times, passing the
+    ///     - Use the variable() constructor three times, passing the
     ///       index (0 for p, 1 for r and 2 for s), initial value of
     ///       each variable and the block pattern.
-    ///    b) Use the variables() constructor passing only the initial
+    ///     - Use the variables() constructor passing only the initial
     ///       values of each variable. The block pattern will be
     ///       inferred from the size of the initial value vectors.
     ///       This is usually the simplest option if you have multiple
@@ -74,6 +74,7 @@ namespace Opm
     ///       of all three variables, so you need to use index access
     ///       (operator[]) to get the individual variables (that is p,
     ///       r and s).
+    ///
     /// After this, the r variable for example will have a size() of
     /// 20 and three jacobian matrices. The first is a 20 by 10 zero
     /// matrix, the second is a 20 by 20 identity matrix, and the

opm/autodiff/opm-autodiff_doxygen_main.hpp

@@ -0,0 +1,49 @@
+/*
+  Copyright 2013 SINTEF ICT, Applied Mathematics.
+
+  This file is part of the Open Porous Media project (OPM).
+
+  OPM is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  OPM is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with OPM.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef OPM_OPM-AUTODIFF_DOXYGEN_MAIN_HEADER_INCLUDED
+#define OPM_OPM-AUTODIFF_DOXYGEN_MAIN_HEADER_INCLUDED
+
+
+/** \mainpage Documentation for the opm-autodiff library.
+
+<h3>Automatic differentiation</h3>
+
+This library implements automatic differentiation for vector data with
+multiple blocks of sparse jacobians. This is contained in the class
+Opm::AutoDiffBlock. Also available is Opm::AutoDiff, a much simpler
+single-value single-derivative AD class.
+
+There are also some helper classes and functions that are intended to
+aid in the development of solvers and simulators with AD, these
+include Opm::HelperOps, Opm::UpwindSelector, Opm::subset,
+Opm::superset, Opm::Selector, Opm::collapseJacs, Opm::vertcat,
+Opm::Span and Opm::sign.
+
+<h3>Solvers and simulators</h3>
+
+There are some solvers and simulators in opm-autodiff. They should all
+be considered experimental prototypes at this point. Notable simulator
+prototypes include
+- examples/sim_fibo_ad.cpp, a fully implicit black-oil simulator.
+- examples/sim_2p_incomp_ad.cpp, a sequential incompressible 2-phase simulator.
+
+*/
+
+#endif // OPM_OPM-AUTODIFF_DOXYGEN_MAIN_HEADER_INCLUDED