From: Martin Kronbichler Date: Sun, 9 Dec 2012 09:57:03 +0000 (+0000) Subject: One more reindentation/refill of comments. X-Git-Tag: v8.0.0~1717 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b975c4c35dbcfdd3f26fbcc57b3a8a1ee60c5664;p=dealii.git One more reindentation/refill of comments. git-svn-id: https://svn.dealii.org/trunk@27785 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/fe/fe_base.h b/deal.II/include/deal.II/fe/fe_base.h index f40b303b3e..4c9e71463c 100644 --- a/deal.II/include/deal.II/fe/fe_base.h +++ b/deal.II/include/deal.II/fe/fe_base.h @@ -39,91 +39,53 @@ template class FESystem; namespace FiniteElementDomination { /** - * An enum that describes the - * outcome of comparing two elements for - * mutual domination. If one element - * dominates another, then the - * restriction of the space described by - * the dominated element to a face of the - * cell is strictly larger than that of - * the dominating element. For example, - * in 2-d Q(2) elements dominate Q(4) - * elements, because the traces of Q(4) - * elements are quartic polynomials which - * is a space strictly larger than the - * quadratic polynomials (the restriction - * of the Q(2) element). In general, Q(k) - * dominates Q(k') if $k\le k'$. + * An enum that describes the outcome of comparing two elements for mutual + * domination. If one element dominates another, then the restriction of the + * space described by the dominated element to a face of the cell is + * strictly larger than that of the dominating element. For example, in 2-d + * Q(2) elements dominate Q(4) elements, because the traces of Q(4) elements + * are quartic polynomials which is a space strictly larger than the + * quadratic polynomials (the restriction of the Q(2) element). In general, + * Q(k) dominates Q(k') if $k\le k'$. * - * This enum is used in the - * FiniteElement::compare_for_face_domination() - * function that is used in the context - * of hp finite element methods when - * determining what to do at faces where - * two different finite elements meet - * (see the @ref hp_paper "hp paper" for a more detailed - * description of the following). In that - * case, the degrees of freedom of one - * side need to be constrained to those - * on the other side. The determination - * which side is which is based on the - * outcome of a comparison for mutual - * domination: the dominated side is - * constrained to the dominating one. + * This enum is used in the FiniteElement::compare_for_face_domination() + * function that is used in the context of hp finite element methods when + * determining what to do at faces where two different finite elements meet + * (see the @ref hp_paper "hp paper" for a more detailed description of the + * following). In that case, the degrees of freedom of one side need to be + * constrained to those on the other side. The determination which side is + * which is based on the outcome of a comparison for mutual domination: the + * dominated side is constrained to the dominating one. * - * A similar situation happens in 3d, where - * we have to consider different elements - * meeting at only an edge, not an entire - * face. Such comparisons are then - * implemented in the - * FiniteElement::compare_for_line_domination() + * A similar situation happens in 3d, where we have to consider different + * elements meeting at only an edge, not an entire face. Such comparisons + * are then implemented in the FiniteElement::compare_for_line_domination() * function. * - * Note that there are situations where - * neither side dominates. The @ref hp_paper "hp paper" - * lists two case, with the simpler one - * being that a $Q_2\times Q_1$ - * vector-valued element (i.e. a - * FESystem(FE_Q(2),1,FE_Q(1),1)) - * meets a $Q_1\times Q_2$ element: here, - * for each of the two vector-components, - * we can define a domination - * relationship, but it is different for - * the two components. + * Note that there are situations where neither side dominates. The @ref + * hp_paper "hp paper" lists two case, with the simpler one being that a + * $Q_2\times Q_1$ vector-valued element (i.e. a + * FESystem(FE_Q(2),1,FE_Q(1),1)) meets a $Q_1\times Q_2$ + * element: here, for each of the two vector-components, we can define a + * domination relationship, but it is different for the two components. * - * It is clear that the concept of - * domination doesn't matter for - * discontinuous elements. However, - * discontinuous elements may be part of - * vector-valued elements and may - * therefore be compared against each - * other for domination. They should - * return - * either_element_can_dominate - * in that case. Likewise, when comparing - * two identical finite elements, they - * should return this code; the reason is - * that we can not decide which element - * will dominate at the time we look at - * the first component of, for example, - * two $Q_2\times Q_1$ and $Q_2\times - * Q_2$ elements, and have to keep our - * options open until we get to the - * second base element. + * It is clear that the concept of domination doesn't matter for + * discontinuous elements. However, discontinuous elements may be part of + * vector-valued elements and may therefore be compared against each other + * for domination. They should return + * either_element_can_dominate in that case. Likewise, when + * comparing two identical finite elements, they should return this code; + * the reason is that we can not decide which element will dominate at the + * time we look at the first component of, for example, two $Q_2\times Q_1$ + * and $Q_2\times Q_2$ elements, and have to keep our options open until we + * get to the second base element. * - * Finally, the code - * no_requirements exists for cases - * where elements impose no - * continuity requirements. The - * case is primarily meant for - * FE_Nothing which is an element - * that has no degrees of freedom - * in a subdomain. It could also be - * used by discontinuous elements, - * for example. + * Finally, the code no_requirements exists for cases where elements impose + * no continuity requirements. The case is primarily meant for FE_Nothing + * which is an element that has no degrees of freedom in a subdomain. It + * could also be used by discontinuous elements, for example. * - * More details on domination can be found - * in the @ref hp_paper "hp paper". + * More details on domination can be found in the @ref hp_paper "hp paper". */ enum Domination { @@ -136,31 +98,21 @@ namespace FiniteElementDomination /** - * A generalization of the binary - * and operator to a comparison - * relationship. The way this works is - * pretty much as when you would want to - * define a comparison relationship for - * vectors: either all elements of the - * first vector are smaller, equal, or - * larger than those of the second vector, - * or some are and some are not. + * A generalization of the binary and operator to a comparison + * relationship. The way this works is pretty much as when you would want to + * define a comparison relationship for vectors: either all elements of the + * first vector are smaller, equal, or larger than those of the second + * vector, or some are and some are not. * - * This operator is pretty much the same: - * if both arguments are + * This operator is pretty much the same: if both arguments are * this_element_dominates or - * other_element_dominates, - * then the returned value is that - * value. On the other hand, if one of the - * values is - * either_element_can_dominate, - * then the returned value is that of the - * other argument. If either argument is - * neither_element_dominates, - * or if the two arguments are + * other_element_dominates, then the returned value is that + * value. On the other hand, if one of the values is + * either_element_can_dominate, then the returned value is that + * of the other argument. If either argument is + * neither_element_dominates, or if the two arguments are * this_element_dominates and - * other_element_dominates, - * then the returned value is + * other_element_dominates, then the returned value is * neither_element_dominates. */ inline Domination operator & (const Domination d1, @@ -169,10 +121,9 @@ namespace FiniteElementDomination /** - * Dimension independent data for finite elements. See the derived - * class FiniteElement class for information on its use. All - * its data are available to the implementation in a concrete finite - * element class. + * Dimension independent data for finite elements. See the derived class + * FiniteElement class for information on its use. All its data are available + * to the implementation in a concrete finite element class. * * @ingroup febase * @author Wolfgang Bangerth, Guido Kanschat, 1998, 1999, 2000, 2001, 2003, 2005 @@ -182,147 +133,96 @@ class FiniteElementData { public: /** - * Enumerator for the different - * types of continuity a finite - * element may have. Continuity - * is measured by the Sobolev - * space containing the - * constructed finite element - * space and is also called this - * way. + * Enumerator for the different types of continuity a finite element may + * have. Continuity is measured by the Sobolev space containing the + * constructed finite element space and is also called this way. * - * Note that certain continuities - * may imply others. For - * instance, a function in - * H1 is in - * Hcurl and - * Hdiv as - * well. + * Note that certain continuities may imply others. For instance, a function + * in H1 is in Hcurl and + * Hdiv as well. * - * If you are interested in - * continuity in the classical - * sense, then the following - * relations hold: + * If you are interested in continuity in the classical sense, then the + * following relations hold: * *
    * - *
  1. H1 - * implies that the function is - * continuous over cell - * boundaries. + *
  2. H1 implies that the function is continuous over + * cell boundaries. * - *
  3. H2 - * implies that the function is - * continuously differentiable - * over cell boundaries. + *
  4. H2 implies that the function is continuously + * differentiable over cell boundaries. * - *
  5. L2 - * indicates that the element is - * discontinuous. Since - * discontinuous elements have no - * topological couplings between - * grid cells and code may - * actually depend on this - * property, L2 - * conformity is handled in a - * special way in the sense that - * it is not implied by - * any higher conformity. - *
+ *
  • L2 indicates that the element is + * discontinuous. Since discontinuous elements have no topological couplings + * between grid cells and code may actually depend on this property, + * L2 conformity is handled in a special way in the sense + * that it is not implied by any higher conformity. * - * In order to test if a finite - * element conforms to a certain - * space, use + * In order to test if a finite element conforms to a certain space, use * FiniteElementData::conforms(). */ enum Conformity { /** - * Indicates incompatible - * continuities of a - * system. + * Indicates incompatible continuities of a system. */ unknown = 0x00, /** - * Discontinuous - * elements. See above! + * Discontinuous elements. See above! */ L2 = 0x01, /** - * Conformity with the - * space - * Hcurl - * (continuous tangential - * component of a vector - * field) + * Conformity with the space Hcurl (continuous + * tangential component of a vector field) */ Hcurl = 0x02, /** - * Conformity with the - * space - * Hdiv - * (continuous normal - * component of a vector - * field) + * Conformity with the space Hdiv (continuous normal + * component of a vector field) */ Hdiv = 0x04, /** - * Conformity with the - * space - * H1 - * (continuous) + * Conformity with the space H1 (continuous) */ H1 = Hcurl | Hdiv, /** - * Conformity with the - * space - * H2 - * (continuously + * Conformity with the space H2 (continuously * differentiable) */ H2 = 0x0e }; /** - * The dimension of the finite - * element, which is the template - * parameter dim + * The dimension of the finite element, which is the template parameter + * dim */ static const unsigned int dimension = dim; /** - * Number of degrees of freedom on - * a vertex. + * Number of degrees of freedom on a vertex. */ const unsigned int dofs_per_vertex; - /** Number of degrees of freedom - * in a line; not including the - * degrees of freedom on the - * vertices of the line. + /** + * Number of degrees of freedom in a line; not including the degrees of + * freedom on the vertices of the line. */ const unsigned int dofs_per_line; - /** Number of degrees of freedom - * in a quadrilateral; not - * including the degrees of - * freedom on the lines and - * vertices of the - * quadrilateral. + /** + * Number of degrees of freedom in a quadrilateral; not including the + * degrees of freedom on the lines and vertices of the quadrilateral. */ const unsigned int dofs_per_quad; - /** Number of degrees of freedom - * in a hexahedron; not - * including the degrees of - * freedom on the - * quadrilaterals, lines and - * vertices of the hecahedron. + /** + * Number of degrees of freedom in a hexahedron; not including the degrees + * of freedom on the quadrilaterals, lines and vertices of the hecahedron. */ const unsigned int dofs_per_hex; @@ -352,51 +252,32 @@ public: const unsigned int first_face_quad_index; /** - * Number of degrees of freedom - * on a face. This is the - * accumulated number of degrees - * of freedom on all the objects - * of dimension up to - * dim-1 constituting a - * face. + * Number of degrees of freedom on a face. This is the accumulated number of + * degrees of freedom on all the objects of dimension up to dim-1 + * constituting a face. */ const unsigned int dofs_per_face; /** - * Total number of degrees of freedom - * on a cell. This is the - * accumulated number of degrees - * of freedom on all the objects - * of dimension up to - * dim constituting a - * cell. + * Total number of degrees of freedom on a cell. This is the accumulated + * number of degrees of freedom on all the objects of dimension up to + * dim constituting a cell. */ const unsigned int dofs_per_cell; /** - * Number of vector components of - * this finite element, and - * dimension of the image - * space. For vector-valued - * finite elements (i.e. when - * this number is greater than - * one), the number of vector - * components is in many cases - * equal to the number of base - * elements glued together with - * the help of the FESystem - * class. However, for elements - * like the Nedelec element, the - * number is greater than one - * even though we only have one - * base element. + * Number of vector components of this finite element, and dimension of the + * image space. For vector-valued finite elements (i.e. when this number is + * greater than one), the number of vector components is in many cases equal + * to the number of base elements glued together with the help of the + * FESystem class. However, for elements like the Nedelec element, the + * number is greater than one even though we only have one base element. */ const unsigned int components; /** - * Maximal polynomial degree of a - * shape function in a single - * coordinate direction. + * Maximal polynomial degree of a shape function in a single coordinate + * direction. */ const unsigned int degree; @@ -406,49 +287,30 @@ public: const Conformity conforming_space; /** - * Storage for an object - * describing the sizes of each - * block of a compound - * element. For an element which - * is not an FESystem, this - * contains only a single block - * with length #dofs_per_cell. + * Storage for an object describing the sizes of each block of a compound + * element. For an element which is not an FESystem, this contains only a + * single block with length #dofs_per_cell. */ BlockIndices block_indices_data; /** - * Default - * constructor. Constructs an - * element with no dofs. Checking - * n_dofs_per_cell() is therefore - * a good way to check if - * something went wrong. + * Default constructor. Constructs an element with no dofs. Checking + * n_dofs_per_cell() is therefore a good way to check if something went + * wrong. */ FiniteElementData (); /** - * Constructor, computing all - * necessary values from the - * distribution of dofs to - * geometrcal objects. + * Constructor, computing all necessary values from the distribution of dofs + * to geometrcal objects. * - * @param dofs_per_object Number - * of dofs on geometrical objects - * for each dimension. In this - * vector, entry 0 refers to dofs - * on vertices, entry 1 on lines - * and so on. Its length must be - * dim+1. - * @param n_components Number of - * vector components of the - * element. - * @param degree - * Maximal polynomial degree in a - * single direction. - * @param conformity The finite - * element space has continuity - * of this Sobolev space. - * @param n_blocks obsolete and ignored. + * @param dofs_per_object Number of dofs on geometrical objects for each + * dimension. In this vector, entry 0 refers to dofs on vertices, entry 1 on + * lines and so on. Its length must be dim+1. @param n_components + * Number of vector components of the element. @param degree Maximal + * polynomial degree in a single direction. @param conformity The finite + * element space has continuity of this Sobolev space. @param n_blocks + * obsolete and ignored. */ FiniteElementData (const std::vector &dofs_per_object, const unsigned int n_components, @@ -462,72 +324,52 @@ public: unsigned int n_dofs_per_vertex () const; /** - * Number of dofs per line. Not - * including dofs on lower - * dimensional objects. + * Number of dofs per line. Not including dofs on lower dimensional objects. */ unsigned int n_dofs_per_line () const; /** - * Number of dofs per quad. Not - * including dofs on lower - * dimensional objects. + * Number of dofs per quad. Not including dofs on lower dimensional objects. */ unsigned int n_dofs_per_quad () const; /** - * Number of dofs per hex. Not - * including dofs on lower - * dimensional objects. + * Number of dofs per hex. Not including dofs on lower dimensional objects. */ unsigned int n_dofs_per_hex () const; /** - * Number of dofs per face, - * accumulating degrees of - * freedom of all lower + * Number of dofs per face, accumulating degrees of freedom of all lower * dimensional objects. */ unsigned int n_dofs_per_face () const; /** - * Number of dofs per cell, - * accumulating degrees of - * freedom of all lower + * Number of dofs per cell, accumulating degrees of freedom of all lower * dimensional objects. */ unsigned int n_dofs_per_cell () const; /** - * Return the number of degrees - * per structdim-dimensional - * object. For structdim==0, the - * function therefore returns - * dofs_per_vertex, for - * structdim==1 dofs_per_line, - * etc. This function is mostly - * used to allow some template - * trickery for functions that - * should work on all sorts of - * objects without wanting to use - * the different names (vertex, - * line, ...) associated with - * these objects. + * Return the number of degrees per structdim-dimensional object. For + * structdim==0, the function therefore returns dofs_per_vertex, for + * structdim==1 dofs_per_line, etc. This function is mostly used to allow + * some template trickery for functions that should work on all sorts of + * objects without wanting to use the different names (vertex, line, ...) + * associated with these objects. */ template unsigned int n_dofs_per_object () const; /** - * Number of components. See - * @ref GlossComponent "the glossary" - * for more information. + * Number of components. See @ref GlossComponent "the glossary" for more + * information. */ unsigned int n_components () const; /** - * Number of blocks. See - * @ref GlossBlock "the glossary" - * for more information. + * Number of blocks. See @ref GlossBlock "the glossary" for more + * information. */ unsigned int n_blocks () const; @@ -537,52 +379,34 @@ public: const BlockIndices &block_indices() const; /** - * Return whether the entire - * finite element is primitive, - * in the sense that all its - * shape functions are - * primitive. If the finite - * element is scalar, then this - * is always the case. + * Return whether the entire finite element is primitive, in the sense that + * all its shape functions are primitive. If the finite element is scalar, + * then this is always the case. * - * Since this is an extremely - * common operation, the result - * is cached in the - * #cached_primitivity - * variable which is computed in - * the constructor. + * Since this is an extremely common operation, the result is cached in the + * #cached_primitivity variable which is computed in the constructor. */ bool is_primitive () const; /** - * Maximal polynomial degree of a - * shape function in a single - * coordinate direction. + * Maximal polynomial degree of a shape function in a single coordinate + * direction. * - * This function can be used to - * determine the optimal - * quadrature rule. + * This function can be used to determine the optimal quadrature rule. */ unsigned int tensor_degree () const; /** - * Test whether a finite element - * space conforms to a certain - * Sobolev space. + * Test whether a finite element space conforms to a certain Sobolev space. * - * @note This function will - * return a true value even if - * the finite element space has - * higher regularity than asked - * for. + * @note This function will return a true value even if the finite element + * space has higher regularity than asked for. */ bool conforms (const Conformity) const; /** - * Given an index in the natural - * ordering of indices on a face, - * return the index of the same - * degree of freedom on the cell. + * Given an index in the natural ordering of indices on a face, return the + * index of the same degree of freedom on the cell. * * @param face_index The index of the degree of freedom on a face. * This index must be between zero and dofs_per_face. @@ -605,36 +429,20 @@ public: const bool face_rotation = false) const; /** - * @deprecated This function is - * just a special version of - * face_to_cell_index for the face - * zero. It is therefore of - * limited use in aplications and - * most of the time, the other - * function is what is required. + * @deprecated This function is just a special version of face_to_cell_index + * for the face zero. It is therefore of limited use in aplications and most + * of the time, the other function is what is required. * - * Given an index in the natural - * ordering of indices on a face, - * return the index of an - * equivalent degree of freedom - * on the cell. + * Given an index in the natural ordering of indices on a face, return the + * index of an equivalent degree of freedom on the cell. * - * To explain the concept, - * consider the case where we - * would like to know whether a - * degree of freedom on a face is - * primitive. Unfortunately, the - * is_primitive() function in the - * FiniteElement class takes a - * cell index, so we would need - * to find the cell index of the - * shape function that - * corresponds to the present - * face index. This function does - * that. + * To explain the concept, consider the case where we would like to know + * whether a degree of freedom on a face is primitive. Unfortunately, the + * is_primitive() function in the FiniteElement class takes a cell index, so + * we would need to find the cell index of the shape function that + * corresponds to the present face index. This function does that. * - * Code implementing this would - * then look like this: + * Code implementing this would then look like this: * @code * for (i=0; idofs_per_vertex) return index + this->dofs_per_vertex; else - // this is a dof on line 0, so on the - // cell there are now 4 vertices instead - // of only 2 ahead of this one + // this is a dof on line 0, so on the cell there are now 4 vertices + // instead of only 2 ahead of this one return index + 2*this->dofs_per_vertex; } @@ -932,9 +727,7 @@ unsigned int FiniteElementData<3>:: face_to_equivalent_cell_index (const unsigned int index) const { - // this case is just way too - // complicated. fall back to - // face_to_cell_index + // this case is just way too complicated. fall back to face_to_cell_index return face_to_cell_index(index, 0, true); }