From b23d0d8d1448d033c3709f421448b9960d78be63 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Mon, 13 Apr 2015 20:56:35 -0500 Subject: [PATCH] Provide documentation to the various namespaces in generic_linear_algebra.h. --- include/deal.II/lac/generic_linear_algebra.h | 33 +++++++++++++++++--- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/include/deal.II/lac/generic_linear_algebra.h b/include/deal.II/lac/generic_linear_algebra.h index 12f319eab4..e33a5c23c4 100644 --- a/include/deal.II/lac/generic_linear_algebra.h +++ b/include/deal.II/lac/generic_linear_algebra.h @@ -1,6 +1,6 @@ // --------------------------------------------------------------------- // -// Copyright (C) 2008 - 2014 by the deal.II authors +// Copyright (C) 2008 - 2015 by the deal.II authors // // This file is part of the deal.II library. // @@ -23,9 +23,17 @@ #include #include #include + + DEAL_II_NAMESPACE_OPEN +/** + * A namespace in which the deal.II linear algebra classes are typedef'ed to + * generic names. There are similar namespaces LinearAlgebraPETSc and + * LinearAlgebraTrilinos for typedefs to classes that interface with the PETSc + * and Trilinos libraries. + */ namespace LinearAlgebraDealII { typedef Vector Vector; @@ -34,7 +42,6 @@ namespace LinearAlgebraDealII typedef SparseMatrix SparseMatrix; typedef PreconditionSSOR PreconditionSSOR; - } @@ -54,6 +61,12 @@ DEAL_II_NAMESPACE_CLOSE DEAL_II_NAMESPACE_OPEN +/** + * A namespace in which the wrappers to the PETSc linear algebra classes are + * typedef'ed to generic names. There are similar namespaces + * LinearAlgebraDealII and LinearAlgebraTrilinos for typedefs to deal.II's own + * classes and classes that interface with Trilinos. + */ namespace LinearAlgebraPETSc { using namespace dealii; @@ -66,9 +79,12 @@ namespace LinearAlgebraPETSc typedef PETScWrappers::SolverCG SolverCG; typedef PETScWrappers::SolverGMRES SolverGMRES; + /** + * A namespace with typedefs to generic names for parallel PETSc linear + * algebra objects. + */ namespace MPI { - /** * Typedef for the vector type used. */ @@ -138,6 +154,12 @@ DEAL_II_NAMESPACE_CLOSE DEAL_II_NAMESPACE_OPEN +/** + * A namespace in which the wrappers to the Trilinos linear algebra classes are + * typedef'ed to generic names. There are similar namespaces + * LinearAlgebraDealII and LinearAlgebraPETSc for typedefs to deal.II's own + * classes and classes that interface with PETSc. + */ namespace LinearAlgebraTrilinos { using namespace dealii; @@ -147,9 +169,12 @@ namespace LinearAlgebraTrilinos typedef TrilinosWrappers::SolverCG SolverCG; typedef TrilinosWrappers::SolverGMRES SolverGMRES; + /** + * A namespace with typedefs to generic names for parallel Trilinos linear + * algebra objects. + */ namespace MPI { - /** * Typedef for the vector type used. */ -- 2.39.5