From: Reza Rastak Date: Thu, 25 Apr 2019 08:01:30 +0000 (-0700) Subject: Documentation added so that the using statements are properly shown in the manual X-Git-Tag: v9.1.0-rc1~176^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=10df27db18d6216e1c706f48de55e4fc432c1026;p=dealii.git Documentation added so that the using statements are properly shown in the manual --- diff --git a/include/deal.II/lac/generic_linear_algebra.h b/include/deal.II/lac/generic_linear_algebra.h index a2c76f5481..e3974dfa11 100644 --- a/include/deal.II/lac/generic_linear_algebra.h +++ b/include/deal.II/lac/generic_linear_algebra.h @@ -35,11 +35,24 @@ DEAL_II_NAMESPACE_OPEN */ namespace LinearAlgebraDealII { - using Vector = Vector; + /** + * Typedef for the vector type used + */ + using Vector = Vector; + + /** + * Typedef for the block-vector type used + */ using BlockVector = BlockVector; + /** + * Typedef for sparse matrix type used + */ using SparseMatrix = SparseMatrix; + /** + * Typedef for the SSOR preconditioner used + */ using PreconditionSSOR = PreconditionSSOR; } // namespace LinearAlgebraDealII @@ -65,7 +78,14 @@ DEAL_II_NAMESPACE_OPEN */ namespace LinearAlgebraPETSc { - using SolverCG = PETScWrappers::SolverCG; + /** + * Typedef for the CG solver type used. + */ + using SolverCG = PETScWrappers::SolverCG; + + /** + * Typedef for the GMRES solver type used. + */ using SolverGMRES = PETScWrappers::SolverGMRES; /** @@ -96,6 +116,9 @@ namespace LinearAlgebraPETSc */ using BlockSparseMatrix = PETScWrappers::MPI::BlockSparseMatrix; + /** + * Typedef for the compressed block sparsity pattern used. + */ using BlockCompressedSparsityPattern = dealii::BlockDynamicSparsityPattern; /** @@ -149,7 +172,14 @@ DEAL_II_NAMESPACE_OPEN */ namespace LinearAlgebraTrilinos { - using SolverCG = TrilinosWrappers::SolverCG; + /** + * Typedef for the CG solver type used. + */ + using SolverCG = TrilinosWrappers::SolverCG; + + /** + * Typdef for the GMRES solver type used. + */ using SolverGMRES = TrilinosWrappers::SolverGMRES; /** @@ -180,6 +210,9 @@ namespace LinearAlgebraTrilinos */ using BlockSparseMatrix = TrilinosWrappers::BlockSparseMatrix; + /** + * Typedef for thei type used for compressed block sparsity pattern. + */ using BlockCompressedSparsityPattern = TrilinosWrappers::BlockSparsityPattern;