From 83a0935ae685f49a0ff58a2ecd79402f90e5ce10 Mon Sep 17 00:00:00 2001
From: Peter Bastian <peter@dune-project.org>
Date: Mon, 4 Oct 2004 15:14:13 +0000
Subject: [PATCH] started documentation article
[[Imported from SVN: r808]]
---
istl/doc/Makefile | 9 +++
istl/doc/istl.bib | 75 +++++++++++++++++++++++
istl/doc/istl.tex | 153 ++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 237 insertions(+)
create mode 100644 istl/doc/Makefile
create mode 100644 istl/doc/istl.bib
create mode 100644 istl/doc/istl.tex
diff --git a/istl/doc/Makefile b/istl/doc/Makefile
new file mode 100644
index 000000000..b1ae1460e
--- /dev/null
+++ b/istl/doc/Makefile
@@ -0,0 +1,9 @@
+all:
+ latex istl.tex
+ bibtex istl
+ latex istl.tex
+ latex istl.tex
+
+view: all
+ dvipdf istl
+ acroread istl.pdf
diff --git a/istl/doc/istl.bib b/istl/doc/istl.bib
new file mode 100644
index 000000000..001eeb568
--- /dev/null
+++ b/istl/doc/istl.bib
@@ -0,0 +1,75 @@
+@InProceedings{Dune,
+ author = "P. Bastian and M. Droske and C. Engwer and R. Klöfkorn and
+ T. Neubauer and M. Ohlberger and M. Rumpf",
+ editor = "R. Kornhuber and {R.H.W.} Hoppe and {D.E.} Keyes and J. Périaux
+ and O. Pironneau and J. Xu",
+ booktitle = "Proceedings of the 15th Conference on Domain Decomposition Methods",
+ title = "Towards a Unified Framework for Scientific Computing",
+ publisher = "Springer-Verlag",
+ series = {LNCSE},
+ note = "accepted for publication",
+ pages = "",
+ year = "2004",
+ pdf = "TM105.pdf"
+}
+
+@Misc{BLASTForum,
+ author = {{BLAST Forum}},
+ title = {Basic Linear Algebra Subprograms Technical ({BLAST}) Forum Standard},
+ year = {2001},
+ note = {\texttt{http://www.netlib.org/blas/blast-forum/}},
+}
+
+@Misc{MTL,
+ key = {MTL},
+ title = {Matrix Template Library},
+ note = {\texttt{http://www.osl.iu.edu/research/mtl/}},
+}
+
+@Misc{ITL,
+ key = {ITL},
+ title = {Iterative Template Library},
+ note = {\texttt{http://www.osl.iu.edu/research/itl/}},
+}
+
+@Misc{DuneWeb,
+ author = {DUNE},
+ note = {\texttt{http://www.dune.uni-hd.de/}}
+}
+
+@Misc{Blitz,
+ key = {Blitz++},
+ title = {Blitz++},
+ note = {\texttt{http://www.oonumerics.org/blitz/}},
+}
+
+@Misc{LALinks,
+ author = {Jack Dongarra},
+ title = {List of freely available software for linear algebra on the web},
+ year = {2004},
+ note = {\texttt{http://netlib.org/utk/people/JackDongarra/la-sw.html}}
+}
+
+@Book{Stroustrup,
+ author = {B. Stroustrup},
+ ALTeditor = {},
+ title = {The {C++} Programming Language},
+ publisher = {Addison-Wesley},
+ year = {1997}
+}
+
+@Book{BN,
+ author = {{J. J.} Barton and {L. R.} Nackman},
+ ALTeditor = {},
+ title = {Scientific and Engineering {C++}},
+ publisher = {Addison-Wesley},
+ year = {1994}
+}
+
+@TechReport{Veldhui99,
+ author = {T. Veldhuizen},
+ title = {Techniques for Scientific {C}++},
+ institution = {Indiana University},
+ year = {1999},
+ note = {Computer Science Department}
+}
diff --git a/istl/doc/istl.tex b/istl/doc/istl.tex
new file mode 100644
index 000000000..75708803e
--- /dev/null
+++ b/istl/doc/istl.tex
@@ -0,0 +1,153 @@
+\documentclass[11pt]{article}
+\usepackage{multicol}
+\usepackage{ifthen}
+%\usepackage{multitoc}
+%\usepackage{german}
+%\usepackage{bibgerm}
+\usepackage{amsmath}
+\usepackage{amsfonts}
+\usepackage{color}
+\usepackage{hyperref}
+\usepackage[dvips]{epsfig}
+\usepackage[dvips]{graphicx}
+\usepackage[a4paper,body={154mm,240mm,nohead}]{geometry}
+\usepackage[ansinew]{inputenc}
+\usepackage{listings}
+\lstset{language=C++, indent=20pt, basicstyle=\small\ttfamily,
+ stringstyle=\ttfamily, commentstyle=\it, extendedchars=true}
+
+\newif\ifpdf
+\ifx\pdfoutput\undefined
+\pdffalse % we are not running PDFLaTeX
+\else
+\pdfoutput=1 % we are running PDFLaTeX
+\pdftrue
+\fi
+
+\ifpdf
+\usepackage[pdftex]{graphicx}
+\else
+\usepackage{graphicx}
+\fi
+
+\ifpdf
+\DeclareGraphicsExtensions{.pdf, .jpg, .tif}
+\else
+\DeclareGraphicsExtensions{.eps, .jpg}
+\fi
+
+\newcommand{\C}{\mathbb{C}}
+\newcommand{\R}{\mathbb{R}}
+\newcommand{\N}{\mathbb{N}}
+\newcommand{\Z}{\mathbb{Z}}
+\newcommand{\Q}{\mathbb{Q}}
+\newcommand{\K}{\mathbb{K}}
+
+
+\title{Iterative Solver Template Library\thanks{Part of the
+ Distributed and Unified Numerics Environment (DUNE) which is
+ available from the site
+ \texttt{http://www.dune.uni-hd.de/}}}
+
+\author{%
+Peter Bastian\\
+Interdisziplinäres Zentrum für Wissenschaftliches Rechnen,\\
+Universität Heidelberg, Im Neuenheimer Feld 368, D-69120 Heidelberg, \\
+email: \texttt{Peter.Bastian@iwr.uni-heidelberg.de}}
+
+\date{\today}
+
+\begin{document}
+
+\maketitle
+
+\begin{abstract}
+This document describes the rationale behind and use of the Iterative
+Solver Template Library (ISTL) which provides a set of C++
+templates to represent vectors, (sparse) matrices and some generic
+algorithms based on these. The most prominent features of the
+matrix/vector classes is that they support a recursive block structure
+in a bottom up way. The classes can be used, e.~g., to efficiently implement
+block preconditioners for $hp$-finite elements.
+\end{abstract}
+
+\begin{multicols}{2}
+{\small\tableofcontents}
+\end{multicols}
+
+\section{Introduction}
+
+The numerical solution of partial differential equations frequently requires the
+solution of large and sparse linear systems. Naturally,
+there are many libraries available on the internet for doing sparse matrix/vector
+computations. A comprehensive overview is given in \cite{LALinks}.
+
+The
+widely availably Basic Linear Algebra Subprograms (BLAS) standard has
+been extended to cover als sparse matrices \cite{BLASTForum}. BLAS
+divides the available functions into level 1 (vector operations),
+level 2 (vector/matrix operations) and level 3 (matrix/matrix
+operations). BLAS for sparse matrices contains only level 1 and 2
+functionality and is quite different to the standard for dense
+matrices. The standard uses procedural programming style and offers
+only a FORTRAN and C interface. As a consequence, the interface is
+``coarse grained'', meaning that ``small'' functions such as access to
+individual matrix elements is relatively slow.
+
+Generic programming techniqes in C++ offer the possibility to combine
+flexibility and reuse (``efficiency of the programmer'') with fast
+execution (``efficieny of the program'') as has been demonstrated with
+the Standard Template Library (STL), \cite{Stroustrup} or the Blitz++
+library for multidimensional arrays \cite{Blitz}. A variety of
+template programming techniques such as traits, template metaprograms,
+expression templates or the Barton-Nackman trick are used in the
+implementations, see \cite{BN,Veldhui99} for an introduction.
+Application of these ideas to matrix/vector operations is available
+with the Matrix Template Library (MTL), \cite{MTL}. The Iterative
+Template Library (ITL), \cite{ITL}, implements iterative solvers for
+linear systems (mostly Krylov subspace methods) in a generic way based
+on MTL. The Distributed and Unified Numerics Environment (DUNE),
+\cite{Dune,DuneWeb}, applies the STL ideas to finite element
+computations.
+
+
+
+\section{Vectors}
+
+You can define a variable block size vector via
+\begin{lstlisting}{}
+const int N=1;
+typedef Dune::FieldVector<double,N> RN;
+
+typedef Dune::VariableBlockVector<RN> Vector;
+
+Vector x(20); // make a vector with 20 blocks
+
+for (Vector::CreateIterator i=x.createbegin(); i!=x.createend(); ++i)
+ i.setblocksize((i.index()%10)+1);
+\end{lstlisting}
+and then get the result
+\begin{lstlisting}{}
+... bla
+\end{lstlisting}
+
+\subsection{Making a vector from a field}
+
+\section{Matrices}
+
+\section{Algorithms}
+
+% bibtex bibliography
+\bibliographystyle{plain}
+\bibliography{istl.bib}
+
+% some links
+% http://www.netlib.org/blas/blast-forum/
+% http://www.osl.iu.edu/research/mtl/
+% http://www.osl.iu.edu/research/itl/ (based on MTL, mostly Krylov)
+% http://netlib.org/utk/people/JackDongarra/la-sw.html
+% the last one: FREELY AVAILABLE SOFTWARE FOR
+% LINEAR ALGEBRA ON THE WEB (May 2004) by Jack Dongarra
+% http://www.oonumerics.org/blitz/
+
+\end{document}
--
GitLab