From: Martin Kronbichler Date: Mon, 6 Aug 2018 09:01:54 +0000 (+0200) Subject: Document new feature in matrix-free module. X-Git-Tag: v9.1.0-rc1~806^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0720bb8707ae202c0eb8a75a42064dccbcd1e48d;p=dealii.git Document new feature in matrix-free module. --- diff --git a/doc/doxygen/headers/matrixfree.h b/doc/doxygen/headers/matrixfree.h index f8e1ee7e23..9b29f9298b 100644 --- a/doc/doxygen/headers/matrixfree.h +++ b/doc/doxygen/headers/matrixfree.h @@ -83,7 +83,7 @@ * where also preconditioning can be done in a matrix-free way, as * demonstrated in the step-37 and step-59 tutorial programs. * - *

Internal layout of matrix-free infrastructure

+ *

The matrix-free evaluation infrastructure

* * The top level interface is provided by the FEEvaluation class, which also * contains an extensive description of different use cases. @@ -171,7 +171,7 @@ * by somewhat increased compile times because the compiler needs to generate * code for all paths, though). * - *

The data storage in MatrixFree

+ *

The data storage through the MatrixFree class

* * The tasks performed by FEEvaluation and FEFaceEvaluation can be split into * the three categories index access into vectors, evaluation and @@ -260,7 +260,11 @@ * access patterns and the data in this special case is small, we are better * off storing 3 such vectors, one for the faces decorated as `interior` * (index 0), one for the faces decorated as `exterior` (index 1), and one for - * the cells (index 2), rather than using the indirection through FaceInfo. + * the cells (index 2), rather than using the indirection through + * FaceInfo. There is a series of additional special storage formats available + * in DoFInfo. We refer to the documentation of the struct + * internal::MatrixFreeFunctions::DoFInfo::IndexStorageVariants for the + * options implemented in deal.II and their motivation. * * Finally, the DoFInfo class also holds a shared pointer describing the * parallel partitioning of the vectors. Due to the restriction of