]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix some Doxygen warnings 9845/head
authorReza Rastak <rastak@stanford.edu>
Tue, 7 Apr 2020 02:14:27 +0000 (19:14 -0700)
committerReza Rastak <rastak@stanford.edu>
Tue, 7 Apr 2020 04:26:48 +0000 (21:26 -0700)
14 files changed:
include/deal.II/base/discrete_time.h
include/deal.II/base/quadrature_lib.h
include/deal.II/base/tensor.h
include/deal.II/distributed/cell_weights.h
include/deal.II/grid/grid_out.h
include/deal.II/hp/fe_values.h
include/deal.II/opencascade/manifold_lib.h
source/base/polynomial.cc
source/differentiation/sd/symengine_number_types.cc
source/distributed/cell_weights.cc
source/grid/grid_out.cc
source/hp/fe_values.cc
source/lac/block_vector.cc
source/lac/chunk_sparsity_pattern.cc

index e1b9ca7adabee6fec40412df6578add9ddab8435..409face8a20f421a1bc65e356aa66b99e1f1058a 100644 (file)
@@ -35,7 +35,7 @@ DEAL_II_NAMESPACE_OPEN
  *   {
  *     // Insert simulation code here
  *   }
- * @code
+ * @endcode
  *
  * In the above example the time starts at $t = 0$. Assuming the time step
  * $dt = 0.3$ is not modified inside the loop, the time is advanced to
index 03d71c2906c54a88efb46411d0c2a011c1d55671..7679316c3671fb6d06ee2dfd5ce38762b4a77dc1 100644 (file)
@@ -805,6 +805,7 @@ public:
 
 /* -------------- declaration of explicit specializations ------------- */
 
+#ifndef DOXYGEN
 template <>
 QGauss<1>::QGauss(const unsigned int n);
 template <>
@@ -841,9 +842,9 @@ QGaussOneOverR<2>::QGaussOneOverR(const unsigned int n,
 template <>
 QTelles<1>::QTelles(const Quadrature<1> &base_quad,
                     const Point<1> &     singularity);
+#endif // DOXYGEN
 
 
 
 DEAL_II_NAMESPACE_CLOSE
-
 #endif
index 3f1844d1f4ee28251384b98910b15b3bd3292ac4..d938de5a688aa931ac73957a7a99416daa0c630e 100644 (file)
@@ -1582,8 +1582,8 @@ Tensor<rank_, dim, Number>::serialize(Archive &ar, const unsigned int)
 }
 
 
-template <int rank, int dim, typename Number>
-constexpr unsigned int Tensor<rank, dim, Number>::n_independent_components;
+template <int rank_, int dim, typename Number>
+constexpr unsigned int Tensor<rank_, dim, Number>::n_independent_components;
 
 
 /* ----------------- Non-member functions operating on tensors. ------------ */
index 4ccd92b51c43ebaaa7dc586f3f39715e7f6a454b..924d6fc7f1ca0bae4d9d49dde06b5f36ff2ed1c9 100644 (file)
@@ -109,8 +109,8 @@ namespace parallel
      * @param[in] weighting_function The function that determines each
      *    cell's weight during load balancing.
      */
-    CellWeights(const dealii::hp::DoFHandler<dim, spacedim> &dof_handler,
-                const WeightingFunction &weighting_function);
+    CellWeights(const hp::DoFHandler<dim, spacedim> &dof_handler,
+                const WeightingFunction &            weighting_function);
 
     /**
      * Destructor.
@@ -194,7 +194,7 @@ namespace parallel
      *    determine each cell's finite element.
      */
     DEAL_II_DEPRECATED
-    CellWeights(const dealii::hp::DoFHandler<dim, spacedim> &dof_handler);
+    CellWeights(const hp::DoFHandler<dim, spacedim> &dof_handler);
 
     /**
      * @copydoc CellWeights::constant_weighting()
index 667cba0e9078c61cb848e304bb6329907fe1c46b..22c8472c725c483c5f8e4168530d6f7361975337 100644 (file)
@@ -1685,6 +1685,11 @@ private:
   write_msh_lines(const Triangulation<1, 2> &tria,
                   const unsigned int         next_element_index,
                   std::ostream &             out) const;
+
+  /**
+   * Declaration of the specialization of above function for 1d, 3sd. Does
+   * nothing.
+   */
   unsigned int
   write_msh_lines(const Triangulation<1, 3> &tria,
                   const unsigned int         next_element_index,
@@ -1804,6 +1809,10 @@ private:
   write_ucd_lines(const Triangulation<1, 2> &tria,
                   const unsigned int         next_element_index,
                   std::ostream &             out) const;
+  /**
+   * Declaration of the specialization of above function for 1d, 3sd. Does
+   * nothing.
+   */
   unsigned int
   write_ucd_lines(const Triangulation<1, 3> &tria,
                   const unsigned int         next_element_index,
@@ -1856,6 +1865,11 @@ private:
    */
   unsigned int
   n_boundary_faces(const Triangulation<1, 2> &tria) const;
+
+  /**
+   * Declaration of the specialization of above function for 1d, 3sd. Simply
+   * returns zero.
+   */
   unsigned int
   n_boundary_faces(const Triangulation<1, 3> &tria) const;
 
@@ -1888,6 +1902,11 @@ private:
    */
   unsigned int
   n_boundary_lines(const Triangulation<1, 2> &tria) const;
+
+  /**
+   * Declaration of the specialization of above function for 1d, 3sd. Simply
+   * returns zero.
+   */
   unsigned int
   n_boundary_lines(const Triangulation<1, 3> &tria) const;
 
index 2f08cc6f4bb06a73c1d698430683405d270ceaf7..44b56c85e79484af020c53b22803befad1fa603d 100644 (file)
@@ -242,11 +242,10 @@ namespace hp
     /**
      * Constructor. Initialize this object with the given parameters.
      */
-    FEValues(
-      const dealii::hp::MappingCollection<dim, spacedim> &mapping_collection,
-      const dealii::hp::FECollection<dim, spacedim> &     fe_collection,
-      const dealii::hp::QCollection<dim> &                q_collection,
-      const UpdateFlags                                   update_flags);
+    FEValues(const MappingCollection<dim, spacedim> &mapping_collection,
+             const FECollection<dim, spacedim> &     fe_collection,
+             const QCollection<dim> &                q_collection,
+             const UpdateFlags                       update_flags);
 
 
     /**
@@ -254,9 +253,9 @@ namespace hp
      * that it makes the object use a $Q_1$ mapping (i.e., an object of type
      * MappingQGeneric(1)) implicitly.
      */
-    FEValues(const hp::FECollection<dim, spacedim> &fe_collection,
-             const hp::QCollection<dim> &           q_collection,
-             const UpdateFlags                      update_flags);
+    FEValues(const FECollection<dim, spacedim> &fe_collection,
+             const QCollection<dim> &           q_collection,
+             const UpdateFlags                  update_flags);
 
 
     /**
index 4b617a63ba4ba6045b882748cf5fd64edf8bc30c..223964090f07f1c3c84bd31d6a0bec5422c5bf22 100644 (file)
@@ -360,8 +360,8 @@ namespace OpenCASCADE
   public:
     /**
      * The constructor takes an OpenCASCADE TopoDS_Face @p face and an optional
-     * @p tolerance. This class uses the interval OpenCASCADE variables @var u,
-     * @var v to describe the manifold.
+     * @p tolerance. This class uses the interval OpenCASCADE variables u, v
+     * to describe the manifold.
      */
     NURBSPatchManifold(const TopoDS_Face &face, const double tolerance = 1e-7);
 
index 1820829b2e40c064a62d991c1c95eba18fd6134b..fde08725cbb7826621527b7e089e6aef69ea7eed 100644 (file)
@@ -1548,6 +1548,7 @@ namespace Polynomials
 
 // ------------------ explicit instantiations --------------- //
 
+#ifndef DOXYGEN
 namespace Polynomials
 {
   template class Polynomial<float>;
@@ -1571,5 +1572,6 @@ namespace Polynomials
   template class Monomial<double>;
   template class Monomial<long double>;
 } // namespace Polynomials
+#endif // DOXYGEN
 
 DEAL_II_NAMESPACE_CLOSE
index f4ff2f12066d84100ab166302c08d6de8f86172c..051771555e568cab7580d4ceb9c5f502f77ee48f 100644 (file)
@@ -55,12 +55,12 @@ namespace Differentiation
     {}
 
 
-    Expression::Expression(const SE::integer_class &value)
+    Expression::Expression(const SymEngine::integer_class &value)
       : expression(value)
     {}
 
 
-    Expression::Expression(const SE::rational_class &value)
+    Expression::Expression(const SymEngine::rational_class &value)
       : expression(value)
     {}
 
@@ -150,17 +150,17 @@ namespace Differentiation
     {}
 
 
-    Expression::Expression(const SE::Expression &rhs)
+    Expression::Expression(const SymEngine::Expression &rhs)
       : expression(rhs)
     {}
 
 
-    Expression::Expression(const SE::RCP<const SE::Basic> &rhs)
+    Expression::Expression(const SymEngine::RCP<const SymEngine::Basic> &rhs)
       : expression(rhs)
     {}
 
 
-    Expression::Expression(SE::RCP<const SE::Basic> &&rhs)
+    Expression::Expression(SymEngine::RCP<const SymEngine::Basic> &&rhs)
       : expression(rhs)
     {}
 
@@ -241,14 +241,16 @@ namespace Differentiation
 
 
     Expression
-    Expression::differentiate(const SE::RCP<const SE::Symbol> &symbol) const
+    Expression::differentiate(
+      const SymEngine::RCP<const SymEngine::Symbol> &symbol) const
     {
       return Expression(SE::diff(get_RCP(), symbol));
     }
 
 
     Expression
-    Expression::differentiate(const SE::RCP<const SE::Basic> &symbol) const
+    Expression::differentiate(
+      const SymEngine::RCP<const SymEngine::Basic> &symbol) const
     {
       // Potential symbol
       return Expression(SE::sdiff(get_RCP(), symbol));
@@ -265,13 +267,13 @@ namespace Differentiation
     /* ------------- Conversion operators ------------------------- */
 
 
-    Expression::operator const SE::Expression &() const
+    Expression::operator const SymEngine::Expression &() const
     {
       return get_expression();
     }
 
 
-    Expression::operator const SE::RCP<const SE::Basic> &() const
+    Expression::operator const SymEngine::RCP<const SymEngine::Basic> &() const
     {
       return get_expression().get_basic();
     }
index c6c796695c067c0330d5387b5b3fb30f6d516c4d..9b27ba16b2ecd8c95d508f7644f3c53b616d21f0 100644 (file)
@@ -27,8 +27,7 @@ namespace parallel
   template <int dim, int spacedim>
   CellWeights<dim, spacedim>::CellWeights(
     const hp::DoFHandler<dim, spacedim> &dof_handler,
-    const typename CellWeights<dim, spacedim>::WeightingFunction
-      &weighting_function)
+    const WeightingFunction &            weighting_function)
   {
     reinit(dof_handler, weighting_function);
   }
index 5532c7b8e325bda14c0779ab1063a642e7ba2ceb..e2f173a744aabcfb394a907bafb319704bdd4b15 100644 (file)
@@ -3516,13 +3516,13 @@ GridOut::write_mesh_per_processor_as_vtu(
 
 
 unsigned int
-GridOut::n_boundary_faces(const Triangulation<1> &) const
+GridOut::n_boundary_faces(const Triangulation<1, 1> &) const
 {
   return 0;
 }
 
 unsigned int
-GridOut::n_boundary_lines(const Triangulation<1> &) const
+GridOut::n_boundary_lines(const Triangulation<1, 1> &) const
 {
   return 0;
 }
@@ -3669,7 +3669,7 @@ GridOut::write_msh_lines(const Triangulation<1, 3> &,
 
 
 unsigned int
-GridOut::write_msh_lines(const Triangulation<2> &,
+GridOut::write_msh_lines(const Triangulation<2, 2> &,
                          const unsigned int next_element_index,
                          std::ostream &) const
 {
@@ -3830,7 +3830,7 @@ GridOut::write_ucd_lines(const Triangulation<1, 3> &,
 
 
 unsigned int
-GridOut::write_ucd_lines(const Triangulation<2> &,
+GridOut::write_ucd_lines(const Triangulation<2, 2> &,
                          const unsigned int next_element_index,
                          std::ostream &) const
 {
index 1832bb4a2ed011a057dfe458331c69048184bc8d..e980cbe931bb8690a7113c2032554c5a1a609835 100644 (file)
@@ -25,12 +25,11 @@ namespace hp
 
   template <int dim, int q_dim, class FEValuesType>
   FEValuesBase<dim, q_dim, FEValuesType>::FEValuesBase(
-    const dealii::hp::MappingCollection<dim, FEValuesType::space_dimension>
-      &mapping_collection,
-    const dealii::hp::FECollection<dim, FEValuesType::space_dimension>
-      &                                   fe_collection,
-    const dealii::hp::QCollection<q_dim> &q_collection,
-    const UpdateFlags                     update_flags)
+    const MappingCollection<dim, FEValuesType::space_dimension>
+      &                                                     mapping_collection,
+    const FECollection<dim, FEValuesType::space_dimension> &fe_collection,
+    const QCollection<q_dim> &                              q_collection,
+    const UpdateFlags                                       update_flags)
     : fe_collection(&fe_collection)
     , mapping_collection(&mapping_collection)
     , q_collection(q_collection)
@@ -46,10 +45,9 @@ namespace hp
 
   template <int dim, int q_dim, class FEValuesType>
   FEValuesBase<dim, q_dim, FEValuesType>::FEValuesBase(
-    const dealii::hp::FECollection<dim, FEValuesType::space_dimension>
-      &                                   fe_collection,
-    const dealii::hp::QCollection<q_dim> &q_collection,
-    const UpdateFlags                     update_flags)
+    const FECollection<dim, FEValuesType::space_dimension> &fe_collection,
+    const QCollection<q_dim> &                              q_collection,
+    const UpdateFlags                                       update_flags)
     : fe_collection(&fe_collection)
     , mapping_collection(
         &dealii::hp::StaticMappingQ1<dim, FEValuesType::space_dimension>::
@@ -104,10 +102,10 @@ namespace hp
 
   template <int dim, int spacedim>
   FEValues<dim, spacedim>::FEValues(
-    const hp::MappingCollection<dim, spacedim> &mapping,
-    const hp::FECollection<dim, spacedim> &     fe_collection,
-    const hp::QCollection<dim> &                q_collection,
-    const UpdateFlags                           update_flags)
+    const MappingCollection<dim, spacedim> &mapping,
+    const FECollection<dim, spacedim> &     fe_collection,
+    const QCollection<dim> &                q_collection,
+    const UpdateFlags                       update_flags)
     : hp::FEValuesBase<dim, dim, dealii::FEValues<dim, spacedim>>(mapping,
                                                                   fe_collection,
                                                                   q_collection,
@@ -117,9 +115,9 @@ namespace hp
 
   template <int dim, int spacedim>
   FEValues<dim, spacedim>::FEValues(
-    const hp::FECollection<dim, spacedim> &fe_collection,
-    const hp::QCollection<dim> &           q_collection,
-    const UpdateFlags                      update_flags)
+    const FECollection<dim, spacedim> &fe_collection,
+    const QCollection<dim> &           q_collection,
+    const UpdateFlags                  update_flags)
     : hp::FEValuesBase<dim, dim, dealii::FEValues<dim, spacedim>>(fe_collection,
                                                                   q_collection,
                                                                   update_flags)
index 037f586a2117c30df524b10c189010857f871653..6ddf62f7c3d5a87603047416abd093291c5d943c 100644 (file)
@@ -20,16 +20,18 @@ DEAL_II_NAMESPACE_OPEN
 
 #include "block_vector.inst"
 
+#ifndef DOXYGEN
 // these functions can't be generated by the preprocessor since
 // the template arguments need to be different
 template BlockVector<double>::BlockVector(const BlockVector<float> &);
 template BlockVector<float>::BlockVector(const BlockVector<double> &);
 
-#ifdef DEAL_II_WITH_COMPLEX_VALUES
+#  ifdef DEAL_II_WITH_COMPLEX_VALUES
 template BlockVector<std::complex<double>>::BlockVector(
   const BlockVector<std::complex<float>> &);
 template BlockVector<std::complex<float>>::BlockVector(
   const BlockVector<std::complex<double>> &);
+#  endif
 #endif
 
 DEAL_II_NAMESPACE_CLOSE
index fd7fc16258058ea68d6942c7bcb6f28173ac152c..9f5cb6e7ccb742169cd37240e34772e8fd955c4f 100644 (file)
@@ -592,6 +592,7 @@ ChunkSparsityPattern::memory_consumption() const
 
 
 
+#ifndef DOXYGEN
 // explicit instantiations
 template void
 ChunkSparsityPattern::copy_from<DynamicSparsityPattern>(
@@ -616,5 +617,6 @@ ChunkSparsityPattern::copy_from<float>(const FullMatrix<float> &,
 template void
 ChunkSparsityPattern::copy_from<double>(const FullMatrix<double> &,
                                         const size_type);
+#endif
 
 DEAL_II_NAMESPACE_CLOSE

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.