]> https://gitweb.dealii.org/ - dealii.git/commitdiff
add documentation to deprecated functions in PETSc::MPI::Vector 242/head
authorTimo Heister <timo.heister@gmail.com>
Tue, 11 Nov 2014 19:56:53 +0000 (14:56 -0500)
committerTimo Heister <timo.heister@gmail.com>
Tue, 11 Nov 2014 22:03:57 +0000 (17:03 -0500)
include/deal.II/lac/petsc_parallel_vector.h

index 5c5461d8c992ee141c91c81556ea9706b3404804..98f37face1a732b467cf7111c3a6eaba59723848 100644 (file)
@@ -271,6 +271,8 @@ namespace PETScWrappers
        * the set of locally relevant
        * degrees of freedom, see step-32.
        *
+       * @deprecated Use Vector::Vector(const IndexSet &,const IndexSet &,const MPI_Comm &) instead.
+       *
        * @note This operation always creates a ghosted
        * vector.
        *
@@ -311,6 +313,8 @@ namespace PETScWrappers
        * Constructs a new parallel PETSc
        * vector from an IndexSet. This creates a non
        * ghosted vector.
+       *
+       * @deprecated Use Vector::Vector(const IndexSet &,const MPI_Comm &) instead.
        */
       explicit Vector (const MPI_Comm &communicator,
                        const IndexSet &local) DEAL_II_DEPRECATED;
@@ -451,6 +455,8 @@ namespace PETScWrappers
        * constructor with same signature
        * for more details.
        *
+       * @deprecated Use Vector::reinit(const IndexSet &, const IndexSet &, const MPI_Comm &) instead.
+       *
        * @see @ref GlossGhostedVector "vectors with ghost elements"
        */
       void reinit (const MPI_Comm     &communicator,
@@ -459,7 +465,7 @@ namespace PETScWrappers
       /**
        * Reinit as a vector without ghost elements. See
        * the constructor with same signature
-       * for more detais.
+       * for more details.
        *
        * @see @ref GlossGhostedVector "vectors with ghost elements"
        */
@@ -470,7 +476,9 @@ namespace PETScWrappers
       /**
        * Reinit as a vector without ghost elements. See
        * constructor with same signature
-       * for more detais.
+       * for more details.
+       *
+       * @deprecated Use Vector::reinit(const IndexSet &, const MPI_Comm &) instead.
        */
       void reinit (const MPI_Comm     &communicator,
                    const IndexSet   &local) DEAL_II_DEPRECATED;
@@ -478,7 +486,7 @@ namespace PETScWrappers
       /**
        * Reinit as a vector without ghost elements. See
        * constructor with same signature
-       * for more detais.
+       * for more details.
        *
        * @see @ref GlossGhostedVector "vectors with ghost elements"
        */

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.