]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Make doxygen happy.
authorhartmann <hartmann@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 17 Mar 2004 12:47:50 +0000 (12:47 +0000)
committerhartmann <hartmann@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 17 Mar 2004 12:47:50 +0000 (12:47 +0000)
git-svn-id: https://svn.dealii.org/trunk@8801 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/fe/fe_update_flags.h

index 2610c0cc8c99d5557bea751251907db362b3349f..22c04806dbed8f06a4e536c74bcda74c91446575 100644 (file)
 /*@{*/
 
 /**
- * Provide a set of flags which tells the @p{FEValues<>::reinit}
+ * Provide a set of flags which tells the FEValues::reinit
  * function, which fields are to be updated for each cell. E.g. if you
  * do not need the gradients since you want to assemble the mass
  * matrix, you can switch that off. By default, all flags are off,
  * i.e. no reinitialization will be done.
  *
  * A variable of this type has to be passed to the constructor of the
- * @p{FEValues} object. You can select more than one flag by
- * concatenation using the @p{|} (bitwise @p{or}) operator.
+ * FEValues object. You can select more than one flag by concatenation
+ * using the <tt>|</tt> (bitwise <tt>or</tt>) operator.
  *
  *
  * @sect2{Description of Flags}
  *
  * The following flags are declared:
  * @begin{itemize}
- * @item @p{update_default}: Default: update nothing.
- * @item @p{update_values}: Compute the values of the shape
- *     functions at the quadrature points on the real space cell. For the
- *     usual Lagrange elements, these values are equal to the values of
- *     the shape functions at the quadrature points on the unit cell, but
- *     they are different for more complicated elements, such as BDM or
- *     Raviart-Thomas elements.
- * @item @p{update_gradients}: Transform gradients on unit cell to
- *     gradients on real cell.
- * @item @p{update_second_derivatives}: Update the second derivatives of the
- *     shape functions on the real cell.
- * @item @p{update_boundary_forms}: Update boundary forms on the face.
- *     This flag is only evaluated by the @ref{FEFaceValues} class.
- *     Giving this flag to the @ref{FEValues} class will result in an
- *     error, since boundary forms only exist on the boundary.
- * @item @p{update_q_points}: Compute quadrature points in real
+ * @item <tt>update_default</tt>: Default: update nothing.
+ * @item <tt>update_values</tt>: Compute the values of the shape
+ *     functions at the quadrature points on the real space cell. For
+ *     the usual Lagrange elements, these values are equal to the
+ *     values of the shape functions at the quadrature points on the
+ *     unit cell, but they are different for more complicated
+ *     elements, such as BDM or Raviart-Thomas elements.
+ * @item <tt>update_gradients</tt>: Transform gradients on unit cell
+ *     to gradients on real cell.
+ * @item <tt>update_second_derivatives</tt>: Update the second
+ *     derivatives of the shape functions on the real cell.
+ * @item <tt>update_boundary_forms</tt>: Update boundary forms on the
+ *     face.  This flag is only evaluated by the FEFaceValues class.
+ *     Giving this flag to the FEValues class will result in an error,
+ *     since boundary forms only exist on the boundary.
+ * @item <tt>update_q_points</tt>: Compute quadrature points in real
  *     space (not on unit cell).
- * @item @p{update_JxW_values}: Compute the JxW values (Jacobian
- *     determinant at the quadrature point
- *     times the weight of this point).
- * @item @p{update_normal_vectors}: Update the outward normal vectors
- *     to the face relative to this cell.  This flag is only evaluated
- *     by the @p{FEFaceValues} class.  Giving this flag to the
- *     @p{FEValues} class will result in an error, since normal
- *     vectors are not useful in that case.
- * @item @p{update_jacobians}: Compute jacobian matrices of the
- *     transform between unit and real cell
- *     in the evaluation points.
- * @item @p{update_jacobian_grads}: Update gradients of the jacobian.  These
- *     are used to compute second derivatives.
- * @item @p{update_covariant_transformation}: Update co-variant
+ * @item <tt>update_JxW_values</tt>: Compute the JxW values (Jacobian
+ *     determinant at the quadrature point times the weight of this
+ *     point).
+ * @item <tt>update_normal_vectors</tt>: Update the outward normal
+ *     vectors to the face relative to this cell.  This flag is only
+ *     evaluated by the FEFaceValues class.  Giving this flag to the
+ *     FEValues class will result in an error, since normal vectors
+ *     are not useful in that case.
+ * @item <tt>update_jacobians</tt>: Compute jacobian matrices of the
+ *     transform between unit and real cell in the evaluation points.
+ * @item <tt>update_jacobian_grads</tt>: Update gradients of the
+ *     jacobian. These are used to compute second derivatives.
+ * @item <tt>update_covariant_transformation</tt>: Update co-variant
  *     transformation.  This flag is used internally to tell Mapping
  *     objects to compute the transformation matrices for co-variant
  *     vectors.
- * @item @p{update_contravariant_transformation}: Update contra-variant
- *     transformation.  This flag is used internally to tell Mapping
- *     objects to compute the transformation matrices for contra-variant
- *     vectors.
- * @item @p{update_transformation_values}: Update the shape function values
- *     of the transformation.
- * @item @p{update_transformation_gradients}: Update the gradients of the shape
- *     functions of the transformation.
+ * @item <tt>update_contravariant_transformation</tt>: Update
+ *     contra-variant transformation.  This flag is used internally to
+ *     tell Mapping objects to compute the transformation matrices for
+ *     contra-variant vectors.
+ * @item <tt>update_transformation_values</tt>: Update the shape
+ *     function values of the transformation.
+ * @item <tt>update_transformation_gradients</tt>: Update the
+ *     gradients of the shape functions of the transformation.
  * @end{itemize}
  *
- * @author Wolfgang Bangerth, Guido Kanschat, 1998, 1999, 2000, 2001
+ * @author Wolfgang Bangerth, Guido Kanschat, 1998, 1999, 2000, 2001, Ralf Hartmann 2004
  */
 enum UpdateFlags
 {
@@ -125,9 +124,9 @@ enum UpdateFlags
  * Global operator which returns an object in which all bits are set
  * which are either set in the first or the second argument. This
  * operator exists since if it did not then the result of the bit-or
- * @p{operator |} would be an integer which would in turn trigger a
- * compiler warning when we tried to assign it to an object of type
- * @ref{UpdateFlags}.
+ * <tt>operator |</tt> would be an integer which would in turn trigger
+ * compiler warning when we tried to assign it to an object of type
+ * UpdateFlags.
  */
 inline
 UpdateFlags
@@ -158,9 +157,9 @@ operator |= (UpdateFlags &f1, UpdateFlags f2)
  * Global operator which returns an object in which all bits are set
  * which are set in the first as well as the second argument. This
  * operator exists since if it did not then the result of the bit-and
- * @p{operator &} would be an integer which would in turn trigger a
- * compiler warning when we tried to assign it to an object of type
- * @ref{UpdateFlags}.
+ * <tt>operator &</tt> would be an integer which would in turn trigger
+ * compiler warning when we tried to assign it to an object of type
+ * UpdateFlags.
  */
 inline
 UpdateFlags

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.