From 6cd46362b61c9b57825b2f20f293cf38bc661283 Mon Sep 17 00:00:00 2001 From: guido Date: Fri, 30 Jan 2004 15:57:59 +0000 Subject: [PATCH] more doxygen documentation fixed git-svn-id: https://svn.dealii.org/trunk@8373 0785d39b-7218-0410-832d-ea1e28bc413d --- .../deal.II/include/fe/fe_dgp_nonparametric.h | 7 +- .../deal.II/include/fe/fe_raviart_thomas.h | 6 +- deal.II/deal.II/include/fe/mapping_c1.h | 6 +- deal.II/deal.II/include/fe/mapping_q.h | 5 +- deal.II/deal.II/include/fe/mapping_q1.h | 4 +- deal.II/deal.II/include/grid/geometry_info.h | 7 +- .../include/multigrid/mg_dof_handler.h | 91 +++++++++++++++---- 7 files changed, 93 insertions(+), 33 deletions(-) diff --git a/deal.II/deal.II/include/fe/fe_dgp_nonparametric.h b/deal.II/deal.II/include/fe/fe_dgp_nonparametric.h index a3b93be369..f1fbe682fd 100644 --- a/deal.II/deal.II/include/fe/fe_dgp_nonparametric.h +++ b/deal.II/deal.II/include/fe/fe_dgp_nonparametric.h @@ -440,9 +440,9 @@ class FE_DGPNonparametric : public FiniteElement friend class MappingQ; }; -/*@} - @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 diff --git a/deal.II/deal.II/include/fe/fe_raviart_thomas.h b/deal.II/deal.II/include/fe/fe_raviart_thomas.h index 795cdba425..6ce814a42d 100644 --- a/deal.II/deal.II/include/fe/fe_raviart_thomas.h +++ b/deal.II/deal.II/include/fe/fe_raviart_thomas.h @@ -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 /* -------------- 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 &) const; +/// @endif + #endif diff --git a/deal.II/deal.II/include/fe/mapping_c1.h b/deal.II/deal.II/include/fe/mapping_c1.h index 35a48508dd..e6f9c00dfe 100644 --- a/deal.II/deal.II/include/fe/mapping_c1.h +++ b/deal.II/deal.II/include/fe/mapping_c1.h @@ -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 /* -------------- declaration of explicit specializations ------------- */ +/// @if NoDoc + template <> void MappingC1<1>::add_line_support_points ( const Triangulation<1>::cell_iterator &, std::vector > &) const; @@ -123,6 +125,6 @@ template <> void MappingC1<2>::add_quad_support_points ( std::vector > &) const; - +/// @endif #endif diff --git a/deal.II/deal.II/include/fe/mapping_q.h b/deal.II/deal.II/include/fe/mapping_q.h index b94e1fb9d0..a77ef51377 100644 --- a/deal.II/deal.II/include/fe/mapping_q.h +++ b/deal.II/deal.II/include/fe/mapping_q.h @@ -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 /* -------------- 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 > &a) const; - +/// @endif #endif diff --git a/deal.II/deal.II/include/fe/mapping_q1.h b/deal.II/deal.II/include/fe/mapping_q1.h index f3dce621a5..55154001c6 100644 --- a/deal.II/deal.II/include/fe/mapping_q1.h +++ b/deal.II/deal.II/include/fe/mapping_q1.h @@ -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::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 >&, std::vector >&) const; +/// @endif #endif diff --git a/deal.II/deal.II/include/grid/geometry_info.h b/deal.II/deal.II/include/grid/geometry_info.h index 0c06597f59..2303ba6dce 100644 --- a/deal.II/deal.II/include/grid/geometry_info.h +++ b/deal.II/deal.II/include/grid/geometry_info.h @@ -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 diff --git a/deal.II/deal.II/include/multigrid/mg_dof_handler.h b/deal.II/deal.II/include/multigrid/mg_dof_handler.h index dd8385e26a..ec86cf3b9c 100644 --- a/deal.II/deal.II/include/multigrid/mg_dof_handler.h +++ b/deal.II/deal.II/include/multigrid/mg_dof_handler.h @@ -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 class MGDoFObjectAccessor<2, dim>; template 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 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> -- 2.39.5