From 76b7f38eb8f1398c61c15b8d6ec4be4407da04d0 Mon Sep 17 00:00:00 2001 From: Martin Kronbichler Date: Fri, 31 Jul 2015 08:58:37 +0200 Subject: [PATCH] List deprecated interfaces also in the doxygen documentation --- include/deal.II/lac/block_sparsity_pattern.h | 4 ++ .../lac/trilinos_block_sparse_matrix.h | 8 ++++ include/deal.II/lac/trilinos_sparse_matrix.h | 25 +++++++++++ .../deal.II/lac/trilinos_sparsity_pattern.h | 42 ++++++++++++++++--- 4 files changed, 74 insertions(+), 5 deletions(-) diff --git a/include/deal.II/lac/block_sparsity_pattern.h b/include/deal.II/lac/block_sparsity_pattern.h index e07bdab617..c7f916bbc3 100644 --- a/include/deal.II/lac/block_sparsity_pattern.h +++ b/include/deal.II/lac/block_sparsity_pattern.h @@ -653,6 +653,8 @@ namespace TrilinosWrappers * the degrees of freedom on the individual block. This function is * equivalent to calling the second constructor with the length of the * mapping vector and then entering the index values. + * + * @deprecated Use the respective method with IndexSet arguments instead. */ BlockSparsityPattern (const std::vector ¶llel_partitioning) DEAL_II_DEPRECATED; @@ -698,6 +700,8 @@ namespace TrilinosWrappers * Resize the matrix to a square tensor product of matrices with parallel * distribution according to the specifications in the array of * Epetra_Maps. + * + * @deprecated Use the respective method with IndexSet arguments instead. */ void reinit (const std::vector ¶llel_partitioning) DEAL_II_DEPRECATED; diff --git a/include/deal.II/lac/trilinos_block_sparse_matrix.h b/include/deal.II/lac/trilinos_block_sparse_matrix.h index 0db7629e8f..3f9cb6e5a7 100644 --- a/include/deal.II/lac/trilinos_block_sparse_matrix.h +++ b/include/deal.II/lac/trilinos_block_sparse_matrix.h @@ -182,6 +182,8 @@ namespace TrilinosWrappers * matrix and the entries stored therein. It uses a threshold to copy only * elements whose modulus is larger than the threshold (so zeros in the * deal.II matrix can be filtered away). + * + * @deprecated Use the respective method with IndexSet arguments instead. */ void reinit (const std::vector &input_maps, const ::dealii::BlockSparseMatrix &deal_ii_sparse_matrix, @@ -228,6 +230,9 @@ namespace TrilinosWrappers * partitioning of the domain space of this block matrix, i.e., the * partitioning of the individual block vectors this matrix has to be * multiplied with. + * + * @deprecated Use the methods of the individual matrices based on + * IndexSet arguments. */ std::vector domain_partitioner () const DEAL_II_DEPRECATED; @@ -236,6 +241,9 @@ namespace TrilinosWrappers * partitioning of the range space of this block matrix, i.e., the * partitioning of the individual block vectors that are the result from * matrix-vector products. + * + * @deprecated Use the methods of the individual matrices based on + * IndexSet arguments. */ std::vector range_partitioner () const DEAL_II_DEPRECATED; diff --git a/include/deal.II/lac/trilinos_sparse_matrix.h b/include/deal.II/lac/trilinos_sparse_matrix.h index 1096be7f08..ee6390f618 100644 --- a/include/deal.II/lac/trilinos_sparse_matrix.h +++ b/include/deal.II/lac/trilinos_sparse_matrix.h @@ -660,6 +660,8 @@ namespace TrilinosWrappers * However, there is no effect in the performance of matrix-vector * products, since Trilinos reorganizes the matrix memory prior to use (in * the compress() step). + * + * @deprecated Use the respective method with IndexSet argument instead. */ SparseMatrix (const Epetra_Map ¶llel_partitioning, const size_type n_max_entries_per_row = 0) DEAL_II_DEPRECATED; @@ -670,6 +672,8 @@ namespace TrilinosWrappers * case, we can already allocate the right amount of memory, which makes * the creation process including the insertion of nonzero elements by the * respective SparseMatrix::reinit call considerably faster. + * + * @deprecated Use the respective method with IndexSet argument instead. */ SparseMatrix (const Epetra_Map ¶llel_partitioning, const std::vector &n_entries_per_row) DEAL_II_DEPRECATED; @@ -689,6 +693,8 @@ namespace TrilinosWrappers * * The integer input @p n_max_entries_per_row defines the number of * columns entries per row that will be allocated. + * + * @deprecated Use the respective method with IndexSet argument instead. */ SparseMatrix (const Epetra_Map &row_parallel_partitioning, const Epetra_Map &col_parallel_partitioning, @@ -707,6 +713,8 @@ namespace TrilinosWrappers * rather, all column elements of a row are stored on the same processor * in any case. The vector n_entries_per_row specifies the number * of entries in each row of the newly generated matrix. + * + * @deprecated Use the respective method with IndexSet argument instead. */ SparseMatrix (const Epetra_Map &row_parallel_partitioning, const Epetra_Map &col_parallel_partitioning, @@ -735,6 +743,8 @@ namespace TrilinosWrappers * * This is a collective operation that needs to be called on all * processors in order to avoid a dead lock. + * + * @deprecated Use the respective method with IndexSet argument instead. */ template void reinit (const Epetra_Map ¶llel_partitioning, @@ -752,6 +762,8 @@ namespace TrilinosWrappers * * This is a collective operation that needs to be called on all * processors in order to avoid a dead lock. + * + * @deprecated Use the respective method with IndexSet argument instead. */ template void reinit (const Epetra_Map &row_parallel_partitioning, @@ -774,6 +786,8 @@ namespace TrilinosWrappers * * This is a collective operation that needs to be called on all * processors in order to avoid a dead lock. + * + * @deprecated Use the respective method with IndexSet argument instead. */ template void reinit (const Epetra_Map ¶llel_partitioning, @@ -794,6 +808,8 @@ namespace TrilinosWrappers * * This is a collective operation that needs to be called on all * processors in order to avoid a dead lock. + * + * @deprecated Use the respective method with IndexSet argument instead. */ template void reinit (const Epetra_Map &row_parallel_partitioning, @@ -1668,6 +1684,8 @@ namespace TrilinosWrappers * Return a const reference to the underlying Trilinos Epetra_Map that * sets the partitioning of the domain space of this matrix, i.e., the * partitioning of the vectors this matrix has to be multiplied with. + * + * @deprecated Use locally_owned_domain_indices() instead. */ const Epetra_Map &domain_partitioner () const DEAL_II_DEPRECATED; @@ -1676,6 +1694,8 @@ namespace TrilinosWrappers * sets the partitioning of the range space of this matrix, i.e., the * partitioning of the vectors that are result from matrix-vector * products. + * + * @deprecated Use locally_owned_range_indices() instead. */ const Epetra_Map &range_partitioner () const DEAL_II_DEPRECATED; @@ -1683,6 +1703,8 @@ namespace TrilinosWrappers * Return a const reference to the underlying Trilinos Epetra_Map that * sets the partitioning of the matrix rows. Equal to the partitioning of * the range. + * + * @deprecated Use locally_owned_range_indices() instead. */ const Epetra_Map &row_partitioner () const DEAL_II_DEPRECATED; @@ -1691,6 +1713,9 @@ namespace TrilinosWrappers * sets the partitioning of the matrix columns. This is in general not * equal to the partitioner Epetra_Map for the domain because of overlap * in the matrix. + * + * @deprecated Usually not necessary. If desired, access it via the + * Epetra_CrsMatrix. */ const Epetra_Map &col_partitioner () const DEAL_II_DEPRECATED; //@} diff --git a/include/deal.II/lac/trilinos_sparsity_pattern.h b/include/deal.II/lac/trilinos_sparsity_pattern.h index e0287e3042..9474c8b465 100644 --- a/include/deal.II/lac/trilinos_sparsity_pattern.h +++ b/include/deal.II/lac/trilinos_sparsity_pattern.h @@ -421,6 +421,8 @@ namespace TrilinosWrappers * advantageous to provide good estimates here since a good value will * avoid repeated allocation of memory, which considerably increases the * performance when creating the sparsity pattern. + * + * @deprecated Use the respective method with IndexSet argument instead. */ SparsityPattern (const Epetra_Map ¶llel_partitioning, const size_type n_entries_per_row = 0) DEAL_II_DEPRECATED; @@ -434,6 +436,8 @@ namespace TrilinosWrappers * since knowing the number of entries in each row is usually connected to * knowing the indices of nonzero entries, which the sparsity pattern is * designed to describe. + * + * @deprecated Use the respective method with IndexSet argument instead. */ SparsityPattern (const Epetra_Map ¶llel_partitioning, const std::vector &n_entries_per_row) DEAL_II_DEPRECATED; @@ -453,6 +457,8 @@ namespace TrilinosWrappers * * The number of columns entries per row is specified as the maximum * number of entries argument. + * + * @deprecated Use the respective method with IndexSet argument instead. */ SparsityPattern (const Epetra_Map &row_parallel_partitioning, const Epetra_Map &col_parallel_partitioning, @@ -468,6 +474,8 @@ namespace TrilinosWrappers * themselves – rather, all column elements of a row are stored on * the same processor. The vector n_entries_per_row specifies the * number of entries in each row of the newly generated matrix. + * + * @deprecated Use the respective method with IndexSet argument instead. */ SparsityPattern (const Epetra_Map &row_parallel_partitioning, const Epetra_Map &col_parallel_partitioning, @@ -486,6 +494,8 @@ namespace TrilinosWrappers * This function does not create any entries by itself, but provides the * correct data structures that can be used by the respective add() * function. + * + * @deprecated Use the respective method with IndexSet argument instead. */ void reinit (const Epetra_Map ¶llel_partitioning, @@ -500,6 +510,8 @@ namespace TrilinosWrappers * number of entries in each row is usually connected to knowing the * indices of nonzero entries, which the sparsity pattern is designed to * describe. + * + * @deprecated Use the respective method with IndexSet argument instead. */ void reinit (const Epetra_Map ¶llel_partitioning, @@ -520,6 +532,8 @@ namespace TrilinosWrappers * * The number of columns entries per row is specified by the argument * n_entries_per_row. + * + * @deprecated Use the respective method with IndexSet argument instead. */ void reinit (const Epetra_Map &row_parallel_partitioning, @@ -536,6 +550,8 @@ namespace TrilinosWrappers * themselves – rather, all column elements of a row are stored on * the same processor. The vector n_entries_per_row specifies the * number of entries in each row of the newly generated matrix. + * + * @deprecated Use the respective method with IndexSet argument instead. */ void reinit (const Epetra_Map &row_parallel_partitioning, @@ -549,6 +565,8 @@ namespace TrilinosWrappers * exchange_data can be used for reinitialization with a sparsity pattern * that is not fully constructed. This feature is only implemented for * input sparsity patterns of type DynamicSparsityPattern. + * + * @deprecated Use the respective method with IndexSet argument instead. */ template void @@ -564,6 +582,8 @@ namespace TrilinosWrappers * exchange_data can be used for reinitialization with a sparsity pattern * that is not fully constructed. This feature is only implemented for * input sparsity patterns of type DynamicSparsityPattern. + * + * @deprecated Use the respective method with IndexSet argument instead. */ template void @@ -931,6 +951,8 @@ namespace TrilinosWrappers * sets the parallel partitioning of the domain space of this sparsity * pattern, i.e., the partitioning of the vectors matrices based on this * sparsity pattern are multiplied with. + * + * @deprecated Use locally_owned_domain_indices() instead. */ const Epetra_Map &domain_partitioner () const DEAL_II_DEPRECATED; @@ -939,6 +961,8 @@ namespace TrilinosWrappers * sets the partitioning of the range space of this sparsity pattern, * i.e., the partitioning of the vectors that are result from matrix- * vector products. + * + * @deprecated Use locally_owned_range_indices() instead. */ const Epetra_Map &range_partitioner () const DEAL_II_DEPRECATED; @@ -946,6 +970,8 @@ namespace TrilinosWrappers * Return a const reference to the underlying Trilinos Epetra_Map that * sets the partitioning of the sparsity pattern rows. Equal to the * partitioning of the range. + * + * @deprecated Use locally_owned_range_indices() instead. */ const Epetra_Map &row_partitioner () const DEAL_II_DEPRECATED; @@ -954,11 +980,16 @@ namespace TrilinosWrappers * sets the partitioning of the sparsity pattern columns. This is in * general not equal to the partitioner Epetra_Map for the domain because * of overlap in the matrix. + * + * @deprecated Usually not necessary. If desired, access via the + * Epetra_FECrsGraph. */ const Epetra_Map &col_partitioner () const DEAL_II_DEPRECATED; /** * Return a const reference to the communicator used for this object. + * + * @deprecated Use get_mpi_communicator instead. */ const Epetra_Comm &trilinos_communicator () const DEAL_II_DEPRECATED; @@ -974,15 +1005,16 @@ namespace TrilinosWrappers //@{ /** - * Return the partitioning of the domain space of this matrix, i.e., the - * partitioning of the vectors this matrix has to be multiplied with. + * Return the partitioning of the domain space of this pattern, i.e., the + * partitioning of the vectors a matrix based on this sparsity pattern has + * to be multiplied with. */ IndexSet locally_owned_domain_indices() const; /** - * Return the partitioning of the range space of this matrix, i.e., the - * partitioning of the vectors that are result from matrix-vector - * products. + * Return the partitioning of the range space of this pattern, i.e., the + * partitioning of the vectors that are the result from matrix-vector + * products from a matrix based on this pattern. */ IndexSet locally_owned_range_indices() const; -- 2.39.5