]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
more doxygen documentation fixed
authorguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 30 Jan 2004 15:57:59 +0000 (15:57 +0000)
committerguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 30 Jan 2004 15:57:59 +0000 (15:57 +0000)
git-svn-id: https://svn.dealii.org/trunk@8373 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/fe/fe_dgp_nonparametric.h
deal.II/deal.II/include/fe/fe_raviart_thomas.h
deal.II/deal.II/include/fe/mapping_c1.h
deal.II/deal.II/include/fe/mapping_q.h
deal.II/deal.II/include/fe/mapping_q1.h
deal.II/deal.II/include/grid/geometry_info.h
deal.II/deal.II/include/multigrid/mg_dof_handler.h

index a3b93be36902e0a5247d94dfce8d530e3e55964b..f1fbe682fd488a668c6449e8055cd581c96b57b0 100644 (file)
@@ -440,9 +440,9 @@ class FE_DGPNonparametric : public FiniteElement<dim>
     friend class MappingQ<dim>;
 };
 
-/*@}
- @if NoDoc
-*/
+/*@}*/
+
+/// @if NoDoc
 
 // declaration of explicit specializations of member variables, if the
 // compiler allows us to do that (the standard says we must)
@@ -485,4 +485,5 @@ const unsigned int FE_DGPNonparametric<3>::Matrices::n_projection_matrices;
 #endif
 
 /// @endif
+
 #endif
index 795cdba4257b4843f6b068536b3fbb7093e06027..6ce814a42d98861b6aeec893c1aa886c225f0288 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 2002, 2003 by the deal.II authors
+//    Copyright (C) 2002, 2003, 2004 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -574,6 +574,8 @@ class FE_RaviartThomas : public FiniteElement<dim>
 
 /* -------------- declaration of explicit specializations ------------- */
 
+/// @if NoDoc
+
 template <>
 void FE_RaviartThomas<1>::initialize_unit_face_support_points ();
 
@@ -638,4 +640,6 @@ FE_RaviartThomas<1>::
 get_interpolation_matrix (const FiniteElementBase<1> &,
                          FullMatrix<double>         &) const;
 
+/// @endif
+
 #endif
index 35a48508dd8bbbd282ef20a735698bed45ab7c41..e6f9c00dfea1146f206231a1628e0d88853854f9 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 2000, 2001, 2002, 2003 by the deal.II authors
+//    Copyright (C) 2000, 2001, 2002, 2003, 2004 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -108,6 +108,8 @@ class MappingC1 : public MappingQ<dim>
 
 /* -------------- declaration of explicit specializations ------------- */
 
+/// @if NoDoc
+
 template <> void MappingC1<1>::add_line_support_points (
   const Triangulation<1>::cell_iterator &,
   std::vector<Point<1> > &) const;
@@ -123,6 +125,6 @@ template <> void MappingC1<2>::add_quad_support_points (
   std::vector<Point<2> > &) const;
 
 
-
+/// @endif
 
 #endif
index b94e1fb9d0fa96c5b631fec921bcee101f4b16dd..a77ef51377bef30dd9a70e5d7018dbabce8fe02a 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 2000, 2001, 2002, 2003 by the deal.II authors
+//    Copyright (C) 2000, 2001, 2002, 2003, 2004 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -518,6 +518,7 @@ class MappingQ : public MappingQ1<dim>
 
 /* -------------- declaration of explicit specializations ------------- */
 
+/// @if NoDoc
 
 template<> MappingQ<1>::MappingQ (const unsigned int);
 template<> MappingQ<1>::~MappingQ ();
@@ -537,6 +538,6 @@ template<> void MappingQ<3>::add_quad_support_points(
   const Triangulation<3>::cell_iterator &cell,
   std::vector<Point<3> >                &a) const;
 
-
+/// @endif
 
 #endif
index f3dce621a59d2a9b4aee8f54fa24be1c659e3885..55154001c613beab8be829c58d7f04d406db81b0 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 2000, 2001, 2002, 2003 by the deal.II authors
+//    Copyright (C) 2000, 2001, 2002, 2003, 2004 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -670,6 +670,7 @@ MappingQ1<dim>::InternalData::derivative (const unsigned int qpoint,
 
 /* -------------- declaration of explicit specializations ------------- */
 
+/// @if NoDoc
 
 // declaration of explicit specializations of member variables, if the
 // compiler allows us to do that (the standard says we must)
@@ -729,5 +730,6 @@ template <> void MappingQ1<1>::fill_fe_subface_values (
   std::vector<Tensor<1,1> >&,
   std::vector<Point<1> >&) const;
 
+/// @endif
 
 #endif
index 0c06597f590ab38179dd99d57bfb066335b9a1b5..2303ba6dce8375207bcfff3fa7321fe7a4eaf8cf 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 by the deal.II authors
+//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -294,7 +294,6 @@ struct GeometryInfo
 
 
 /**
- * @internal
  * Topological description of zero dimensional cells,
  * i.e. points. This class might not look too useful but often is if
  * in a certain dimension we would like to enquire information about
@@ -385,7 +384,6 @@ struct GeometryInfo<0>
 
 
 /**
- * @internal
  * Topological description of one dimensional cells.
  *
  * This class contains as static members information on vertices and
@@ -671,7 +669,6 @@ struct GeometryInfo<1>
 
 
 /**
- * @internal
  * Topological description of two dimensional cells.
  *
  * This class contains as static members information on vertices and
@@ -958,7 +955,6 @@ struct GeometryInfo<2>
 
 
 /**
- * @internal
  * Topological description of three dimensional cells.
  *
  * This class contains as static members information on vertices and
@@ -1242,7 +1238,6 @@ struct GeometryInfo<3>
 
 
 /**
- * @internal
  * Topological description of four dimensional cells. This class is
  * required in some exotic cases where we compute information in a
  * one-larger dimension than the present, and do so also in 3d (for
index dd8385e26a16ade7a0632ab252254ebe2da0c687..ec86cf3b9cab92ce95ef6c00e0b4edfa27a46dc5 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 by the deal.II authors
+//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -28,24 +28,83 @@ template <int dim>              class MGDoFObjectAccessor<2, dim>;
 template <int dim>              class MGDoFObjectAccessor<3, dim>;
 
 /**
- * Define some types which differ between the dimensions. This class
- * is analogous to the @ref{TriaDimensionInfo} class hierarchy.
- * 
- * @ref MGDoFDimensionInfo<1>
- * @ref MGDoFDimensionInfo<2>
+ * @brief Iterators for MDDoFHandler
+ *
+ * Depending on the dimension, this class defines the iterator types for
+ * MGDoFHandler objects.
+ *
+ * @note The typedefs in this class are only for reference. Their real
+ * values are to be found in the specializations for different
+ * dimensions.
  */
 template <int dim>
 class MGDoFDimensionInfo
 {
+                                    /// Line iterator for internal use
+    typedef void * raw_line_iterator;
+                                    /// Line iterator for all lines of hierarchy
+    typedef void * line_iterator;
+                                    /// Iterator for active lines
+    typedef void * active_line_iterator;
+    
+                                    /// Quad iterator for internal use
+    typedef void * raw_quad_iterator;
+                                    /// Quad iterator for all quadrilaterals of hierarchy
+    typedef void * quad_iterator;
+                                    /// Iterator for active quadrilaterals
+    typedef void * active_quad_iterator;
+
+                                    /// Hex iterator for internal use
+    typedef void * raw_hex_iterator;
+                                    /// Hex iterator for all hexahedra of hierarchy
+    typedef void * hex_iterator;
+                                    /// Iterator for active hexahedra
+    typedef void * active_hex_iterator;
+
+                                    /** Cell iterator for internal
+                                     * use. It is defined as one of
+                                     * the raw iterators above,
+                                     * depending on the dimension.
+                                     */
+    typedef void * raw_cell_iterator;
+                                    /** Cell iterator for all cells
+                                     * of hierarchy. It is defined as
+                                     * one of the iterators above,
+                                     * depending on the dimension.
+                                     */
+    typedef void * cell_iterator;
+                                    /** Iterator for active cells. It
+                                     * is defined as one of the
+                                     * active iterators above,
+                                     * depending on the dimension.
+                                     */
+    typedef void * active_cell_iterator;
+
+                                    /** Face iterator for internal
+                                     * use. It is defined as one of
+                                     * the raw iterators above,
+                                     * depending on the dimension.
+                                     */
+   typedef void * raw_face_iterator;
+                                    /** Face iterator for all faces
+                                     * of hierarchy. It is defined as
+                                     * one of the iterators above,
+                                     * depending on the dimension.
+                                     */
+    typedef void * face_iterator;
+                                    /** Iterator for active faces. It
+                                     * is defined as one of the
+                                     * active iterators above,
+                                     * depending on the dimension.
+                                     */
+    typedef void * active_face_iterator;
 };
 
 
 
 /**
- * Define some types for the DoF handling in one dimension.
- *
- * The types have the same meaning as those declared in
- * @ref{TriaDimensionInfo<2>}.
+ * Iterators for MGDofHandler in one dimension. See the template
+ * MGDoFDimensionInfo for further explanation.
  */
 template <>
 class MGDoFDimensionInfo<1>
@@ -75,10 +134,8 @@ class MGDoFDimensionInfo<1>
 
 
 /**
- * Define some types for the DoF handling in two dimensions.
- *
- * The types have the same meaning as those declared in
- * @ref{TriaDimensionInfo<2>}.
+ * Iterators for MGDofHandler in one dimension. See the template
+ * MGDoFDimensionInfo for further explanation.
  */
 template <>
 class MGDoFDimensionInfo<2>
@@ -108,10 +165,8 @@ class MGDoFDimensionInfo<2>
 
 
 /**
- * Define some types for the DoF handling in two dimensions.
- *
- * The types have the same meaning as those declared in
- * @ref{TriaDimensionInfo<2>}.
+ * Iterators for MGDofHandler in one dimension. See the template
+ * MGDoFDimensionInfo for further explanation.
  */
 template <>
 class MGDoFDimensionInfo<3>

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.