From: bangerth Date: Thu, 21 Feb 2013 02:45:45 +0000 (+0000) Subject: Be consistent in what we deprecate and if it's deprecated in a comment then do so... X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8acf8e22b79c7d3dfe038d51fc46fd885f07d1f6;p=dealii-svn.git Be consistent in what we deprecate and if it's deprecated in a comment then do so as an attribute to the declaration as well. git-svn-id: https://svn.dealii.org/trunk@28504 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/base/logstream.h b/deal.II/include/deal.II/base/logstream.h index d4d47ef84b..22250dd146 100644 --- a/deal.II/include/deal.II/base/logstream.h +++ b/deal.II/include/deal.II/base/logstream.h @@ -208,8 +208,6 @@ public: const std::string &get_prefix () const; /** - * @deprecated Use Prefix instead - * * Push another prefix on the * stack. Prefixes are * automatically separated by a @@ -219,8 +217,6 @@ public: void push (const std::string &text); /** - * @deprecated Use Prefix instead - * * Remove the last prefix. */ void pop (); diff --git a/deal.II/include/deal.II/base/thread_management.h b/deal.II/include/deal.II/base/thread_management.h index c97ad381a5..9aa238ad48 100644 --- a/deal.II/include/deal.II/base/thread_management.h +++ b/deal.II/include/deal.II/base/thread_management.h @@ -1,7 +1,7 @@ //--------------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 by the deal.II authors +// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -2192,8 +2192,14 @@ namespace Threads * non-member or static member * functions with no arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,0> + spawn (RT (*fun_ptr)()) DEAL_II_DEPRECATED; + + template inline internal::fun_encapsulator,0> @@ -2208,8 +2214,14 @@ namespace Threads * function for member functions with * no arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,0> + spawn (C &c, RT (C::*fun_ptr)()) DEAL_II_DEPRECATED; + + template inline internal::fun_encapsulator,0> @@ -2225,8 +2237,14 @@ namespace Threads * const member functions with no * arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,0> + spawn (const C &c, RT (C::*fun_ptr)() const) DEAL_II_DEPRECATED; + + template inline internal::fun_encapsulator,0> @@ -2247,8 +2265,14 @@ namespace Threads * non-member or static member * functions with 1 argument. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,1> + spawn (RT (*fun_ptr)(Arg1)) DEAL_II_DEPRECATED; + + template inline internal::fun_encapsulator,1> @@ -2264,8 +2288,14 @@ namespace Threads * function for member functions with * 1 argument. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,1> + spawn (C &c, RT (C::*fun_ptr)(Arg1)) DEAL_II_DEPRECATED; + + template inline internal::fun_encapsulator,1> @@ -2281,8 +2311,14 @@ namespace Threads * const member functions with 1 * argument. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,1> + spawn (const C &c, RT (C::*fun_ptr)(Arg1) const) DEAL_II_DEPRECATED; + + template inline internal::fun_encapsulator,1> @@ -2301,8 +2337,14 @@ namespace Threads * non-member or static member * functions with 2 arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,2> + spawn (RT (*fun_ptr)(Arg1,Arg2)) DEAL_II_DEPRECATED; + + template inline internal::fun_encapsulator,2> @@ -2318,8 +2360,14 @@ namespace Threads * function for member functions with * 2 arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,2> + spawn (C &c, RT (C::*fun_ptr)(Arg1,Arg2)) DEAL_II_DEPRECATED; + + template inline internal::fun_encapsulator,2> @@ -2335,8 +2383,14 @@ namespace Threads * const member functions with 2 * arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,2> + spawn (const C &c, RT (C::*fun_ptr)(Arg1,Arg2) const) DEAL_II_DEPRECATED; + + template inline internal::fun_encapsulator,2> @@ -2355,8 +2409,15 @@ namespace Threads * non-member or static member * functions with 3 arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,3> + spawn (RT (*fun_ptr)(Arg1,Arg2,Arg3)) DEAL_II_DEPRECATED; + + template inline @@ -2373,8 +2434,15 @@ namespace Threads * function for member functions with * 3 arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,3> + spawn (C &c, RT (C::*fun_ptr)(Arg1,Arg2,Arg3)) DEAL_II_DEPRECATED; + + template inline @@ -2391,8 +2459,15 @@ namespace Threads * const member functions with 3 * arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,3> + spawn (const C &c, RT (C::*fun_ptr)(Arg1,Arg2,Arg3) const) DEAL_II_DEPRECATED; + + template inline @@ -2413,8 +2488,15 @@ namespace Threads * non-member or static member * functions with 4 arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,4> + spawn (RT (*fun_ptr)(Arg1,Arg2,Arg3,Arg4)) DEAL_II_DEPRECATED; + + template inline @@ -2431,8 +2513,15 @@ namespace Threads * function for member functions with * 4 arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,4> + spawn (C &c, RT (C::*fun_ptr)(Arg1,Arg2,Arg3,Arg4)) DEAL_II_DEPRECATED; + + template inline @@ -2449,8 +2538,15 @@ namespace Threads * const member functions with 4 * arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,4> + spawn (const C &c, RT (C::*fun_ptr)(Arg1,Arg2,Arg3,Arg4) const) DEAL_II_DEPRECATED; + + template inline @@ -2470,8 +2566,16 @@ namespace Threads * non-member or static member * functions with 5 arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,5> + spawn (RT (*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5)) DEAL_II_DEPRECATED; + + template @@ -2489,8 +2593,16 @@ namespace Threads * function for member functions with * 5 arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,5> + spawn (C &c, RT (C::*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5)) DEAL_II_DEPRECATED; + + template @@ -2508,8 +2620,16 @@ namespace Threads * const member functions with 5 * arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,5> + spawn (const C &c, RT (C::*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5) const) DEAL_II_DEPRECATED; + + template @@ -2530,8 +2650,16 @@ namespace Threads * non-member or static member * functions with 6 arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,6> + spawn (RT (*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5,Arg6)) DEAL_II_DEPRECATED; + + template @@ -2549,8 +2677,16 @@ namespace Threads * function for member functions with * 6 arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,6> + spawn (C &c, RT (C::*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5,Arg6)) DEAL_II_DEPRECATED; + + template @@ -2568,8 +2704,17 @@ namespace Threads * const member functions with 6 * arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,6> + spawn (const C &c, RT (C::*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5,Arg6) const) DEAL_II_DEPRECATED; + + template @@ -2591,8 +2736,18 @@ namespace Threads * non-member or static member * functions with 7 arguments. * - * @deprecated + * @deprecated Use new_thread() instead. */ + template + inline + internal::fun_encapsulator,7> + spawn (RT (*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5,Arg6,Arg7)) DEAL_II_DEPRECATED; + + template + inline + internal::fun_encapsulator,7> + spawn (C &c, RT (C::*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5,Arg6,Arg7)) DEAL_II_DEPRECATED; + + template + inline + internal::fun_encapsulator,7> + spawn (const C &c, RT (C::*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5,Arg6,Arg7) const) DEAL_II_DEPRECATED; + + template + inline + internal::fun_encapsulator,8> + spawn (RT (*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5, + Arg6,Arg7,Arg8)) DEAL_II_DEPRECATED; + + template + inline + internal::fun_encapsulator,8> + spawn (C &c, RT (C::*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5, + Arg6,Arg7,Arg8)) DEAL_II_DEPRECATED; + + template + inline + internal::fun_encapsulator,8> + spawn (const C &c, RT (C::*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5, + Arg6,Arg7,Arg8) const) DEAL_II_DEPRECATED; + + template + inline + internal::fun_encapsulator,9> + spawn (RT (*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5, + Arg6,Arg7,Arg8,Arg9)) DEAL_II_DEPRECATED; + + template + inline + internal::fun_encapsulator,9> + spawn (C &c, RT (C::*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5, + Arg6,Arg7,Arg8,Arg9)) DEAL_II_DEPRECATED; + + template + inline + internal::fun_encapsulator,9> + spawn (const C &c, RT (C::*fun_ptr)(Arg1,Arg2,Arg3,Arg4,Arg5, + Arg6,Arg7,Arg8,Arg9) const) DEAL_II_DEPRECATED; + + template &dof_indices) const; + /** * @deprecated Use get_active_or_mg_dof_indices() with level_cell_iterator returned from begin_mg(). * diff --git a/deal.II/include/deal.II/grid/grid_out.h b/deal.II/include/deal.II/grid/grid_out.h index 4e478cec99..910f47494c 100644 --- a/deal.II/include/deal.II/grid/grid_out.h +++ b/deal.II/include/deal.II/grid/grid_out.h @@ -640,15 +640,14 @@ namespace GridOutFlags } color_by; /** - * @deprecated Use the color_by enum instead. If color_by is different - * from material_id, this flag is ignored. + * @deprecated Use the color_by enum instead. * * Change color depending on * level. Default is false, therefore, * color is coded by material or * boundary id. */ - bool level_color; + bool level_color DEAL_II_DEPRECATED; /** * Code level to depth. Default is diff --git a/deal.II/include/deal.II/lac/parallel_vector.h b/deal.II/include/deal.II/lac/parallel_vector.h index a99f840b48..67ab392638 100644 --- a/deal.II/include/deal.II/lac/parallel_vector.h +++ b/deal.II/include/deal.II/lac/parallel_vector.h @@ -751,7 +751,7 @@ namespace parallel * Scale each element of the * vector by the given factor. * - * This function is deprecated + * @deprecated This function is deprecated * and will be removed in a * future version. Use * operator *= and diff --git a/deal.II/include/deal.II/lac/precondition.h b/deal.II/include/deal.II/lac/precondition.h index a2603c8498..e1d7f3dd2d 100644 --- a/deal.II/include/deal.II/lac/precondition.h +++ b/deal.II/include/deal.II/lac/precondition.h @@ -809,7 +809,7 @@ private: * The preconditioner to use. */ SmartPointer > precondition; -}; +} DEAL_II_DEPRECATED; @@ -870,7 +870,7 @@ private: * Memory pool for vectors. */ VectorMemory &mem; -}; +} DEAL_II_DEPRECATED; diff --git a/deal.II/include/deal.II/lac/solver_selector.h b/deal.II/include/deal.II/lac/solver_selector.h index a5a4c9ebd0..87cc26e6a6 100644 --- a/deal.II/include/deal.II/lac/solver_selector.h +++ b/deal.II/include/deal.II/lac/solver_selector.h @@ -103,8 +103,8 @@ public: SolverSelector (); /** - * @deprecated Use deafult - * constructor and select. + * @deprecated Use the default + * constructor, set_control() and select(). * * Constructor. Use the arguments * to initialize actual solver @@ -113,7 +113,7 @@ public: */ SolverSelector (const std::string &solvername, SolverControl &control, - VectorMemory &vector_memory); + VectorMemory &vector_memory) DEAL_II_DEPRECATED; /** * Destructor diff --git a/deal.II/include/deal.II/lac/sparse_ilu.h b/deal.II/include/deal.II/lac/sparse_ilu.h index ff12933dd7..ba745ccbbf 100644 --- a/deal.II/include/deal.II/lac/sparse_ilu.h +++ b/deal.II/include/deal.II/lac/sparse_ilu.h @@ -126,9 +126,9 @@ public: const double strengthen_diagonal=0.) DEAL_II_DEPRECATED; /** - * This method is deprecated, and + * @deprecated This method is deprecated, and * left for backward - * compability. It will be + * compatibility. It will be * removed in later versions. */ template diff --git a/deal.II/include/deal.II/lac/sparse_mic.h b/deal.II/include/deal.II/lac/sparse_mic.h index d3a963e685..fca18fafd6 100644 --- a/deal.II/include/deal.II/lac/sparse_mic.h +++ b/deal.II/include/deal.II/lac/sparse_mic.h @@ -80,9 +80,9 @@ public: AdditionalData; /** - * This method is deprecated, and + * @deprecated This method is deprecated, and * left for backward - * compability. It will be + * compatibility. It will be * removed in later versions. */ void reinit (const SparsityPattern &sparsity) DEAL_II_DEPRECATED; diff --git a/deal.II/include/deal.II/lac/vector.h b/deal.II/include/deal.II/lac/vector.h index bb109a84fb..7f3aa0508e 100644 --- a/deal.II/include/deal.II/lac/vector.h +++ b/deal.II/include/deal.II/lac/vector.h @@ -802,7 +802,7 @@ public: * Scale each element of the * vector by the given factor. * - * This function is deprecated + * @deprecated This function is deprecated * and will be removed in a * future version. Use * operator *= and diff --git a/deal.II/include/deal.II/meshworker/loop.h b/deal.II/include/deal.II/meshworker/loop.h index 1886062522..c8b9aac55f 100644 --- a/deal.II/include/deal.II/meshworker/loop.h +++ b/deal.II/include/deal.II/meshworker/loop.h @@ -1,7 +1,7 @@ //--------------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 by the deal.II authors +// Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -291,6 +291,20 @@ namespace MeshWorker * @ingroup MeshWorker * @author Guido Kanschat, 2009 */ + template + void integration_loop(ITERATOR begin, + typename identity::type end, + DoFInfo &dof_info, + IntegrationInfoBox &box, + const std_cxx1x::function&, IntegrationInfo&)> &cell_worker, + const std_cxx1x::function&, IntegrationInfo&)> &boundary_worker, + const std_cxx1x::function &, DoFInfo &, + IntegrationInfo &, + IntegrationInfo &)> &face_worker, + ASSEMBLER &assembler, + bool cells_first = true) DEAL_II_DEPRECATED; + + template void integration_loop(ITERATOR begin, typename identity::type end, diff --git a/deal.II/include/deal.II/multigrid/mg_dof_handler.h b/deal.II/include/deal.II/multigrid/mg_dof_handler.h index 37353b526d..24aa9000d6 100644 --- a/deal.II/include/deal.II/multigrid/mg_dof_handler.h +++ b/deal.II/include/deal.II/multigrid/mg_dof_handler.h @@ -148,7 +148,7 @@ public: //@} -}; +} DEAL_II_DEPRECATED; /*@}*/ diff --git a/deal.II/include/deal.II/multigrid/mg_smoother.h b/deal.II/include/deal.II/multigrid/mg_smoother.h index 866beb447e..bbfbfcedff 100644 --- a/deal.II/include/deal.II/multigrid/mg_smoother.h +++ b/deal.II/include/deal.II/multigrid/mg_smoother.h @@ -157,7 +157,6 @@ protected: * Memory for auxiliary vectors. */ SmartPointer, MGSmoother > mem; - }; @@ -354,15 +353,26 @@ template class MGSmootherRelaxation : public MGSmoother { public: + /** + * Constructor. Sets smoothing parameters. + */ + MGSmootherRelaxation(const unsigned int steps = 1, + const bool variable = false, + const bool symmetric = false, + const bool transpose = false); + /** * Constructor. Sets memory and * smoothing parameters. + * + * @deprecated Use the constructor without the vector memory + * object */ MGSmootherRelaxation(VectorMemory &mem, const unsigned int steps = 1, const bool variable = false, const bool symmetric = false, - const bool transpose = false); + const bool transpose = false) DEAL_II_DEPRECATED; /** * Initialize for matrices. This @@ -523,15 +533,26 @@ template class MGSmootherPrecondition : public MGSmoother { public: + /** + * Constructor. Sets smoothing parameters. + */ + MGSmootherPrecondition(const unsigned int steps = 1, + const bool variable = false, + const bool symmetric = false, + const bool transpose = false); + /** * Constructor. Sets memory and * smoothing parameters. + * + * @deprecated Use the constructor without the vector memory + * object */ MGSmootherPrecondition(VectorMemory &mem, const unsigned int steps = 1, const bool variable = false, const bool symmetric = false, - const bool transpose = false); + const bool transpose = false) DEAL_II_DEPRECATED; /** * Initialize for matrices. This @@ -866,6 +887,20 @@ MGSmootherRelaxation::MGSmootherRelaxation( {} + +template +inline +MGSmootherRelaxation::MGSmootherRelaxation( + const unsigned int steps, + const bool variable, + const bool symmetric, + const bool transpose) + : + MGSmoother(steps, variable, symmetric, transpose) +{} + + + template inline void MGSmootherRelaxation::clear () @@ -1035,6 +1070,19 @@ MGSmootherPrecondition::MGSmootherPrecondition( +template +inline +MGSmootherPrecondition::MGSmootherPrecondition( + const unsigned int steps, + const bool variable, + const bool symmetric, + const bool transpose) + : + MGSmoother(steps, variable, symmetric, transpose) +{} + + + template inline void MGSmootherPrecondition::clear () diff --git a/deal.II/include/deal.II/multigrid/mg_tools.h b/deal.II/include/deal.II/multigrid/mg_tools.h index a359d7139b..27df82e897 100644 --- a/deal.II/include/deal.II/multigrid/mg_tools.h +++ b/deal.II/include/deal.II/multigrid/mg_tools.h @@ -249,7 +249,7 @@ namespace MGTools const ComponentMask &component_mask = ComponentMask()); /** - * Maybe no longer needed. + * @deprecated */ template void @@ -258,6 +258,9 @@ namespace MGTools const bool preserve_symmetry, const bool ignore_zeros = false) DEAL_II_DEPRECATED; + /** + * @deprecated + */ template void apply_boundary_values (const std::set &boundary_dofs,