From: hartmann Date: Tue, 16 Mar 2004 18:50:47 +0000 (+0000) Subject: Doc update and fixes for doxygen. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3ae4b8277316f106205330aa9d83931e29e49940;p=dealii-svn.git Doc update and fixes for doxygen. git-svn-id: https://svn.dealii.org/trunk@8783 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/fe/fe_poly.h b/deal.II/deal.II/include/fe/fe_poly.h index 1bdb3860ee..be0f707c26 100644 --- a/deal.II/deal.II/include/fe/fe_poly.h +++ b/deal.II/deal.II/include/fe/fe_poly.h @@ -18,13 +18,12 @@ /** - * This class gives a unified framework for implementing a - * FiniteElement class based on a polynomial space like a - * @p TensorProductSpace or a @p PolynomialSpace. + * This class gives a unified framework for the implementation of + * FiniteElement classes based on a polynomial spaces like the + * TensorProductPolynomials or a PolynomialSpace classes. * * Every class that implements following functions can be used as - * template parameter @p POLY. Example classes are @p - * TensorProductSpace and @p PolynomialSpace. + * template parameter POLY. * * @code * double compute_value (const unsigned int i, @@ -36,6 +35,8 @@ * Tensor<2,dim> compute_grad_grad (const unsigned int i, * const Point &p) const; * @endcode + * Example classes are TensorProductPolynomials, PolynomialSpace or + * PolynomialsP. * * This class is not a fully implemented FiniteElement class. Instead * there are several pure virtual functions declared in the @@ -43,6 +44,13 @@ * implemented by this class but are left for implementation in * derived classes. * + * Furthermore, this class assumes that shape functions of the + * FiniteElement under consideration do not depend on the + * actual shape of the cells in real space, i.e. update_once() + * includes update_values. For FiniteElements whose shape functions + * depend on the cells in real space, the update_once() and + * update_each() functions must be overloaded. + * * Todos: * - checke dim of POLY * - templatisiere nur auf POLY, dim ergibt sich durch POLY::dim @@ -63,32 +71,30 @@ class FE_Poly : public FiniteElement /** * Return the value of the - * @p{i}th shape function at the - * point @p{p}. See the - * @ref{FiniteElementBase} base - * class for more information - * about the semantics of this - * function. + * ith shape function at + * the point p. See the + * FiniteElementBase base class + * for more information about the + * semantics of this function. */ virtual double shape_value (const unsigned int i, const Point &p) const; /** * Return the value of the - * @p{component}th vector - * component of the @p{i}th shape - * function at the point - * @p{p}. See the - * @ref{FiniteElementBase} base - * class for more information - * about the semantics of this - * function. + * componentth vector + * component of the ith + * shape function at the point + * p. See the + * FiniteElementBase base class + * for more information about the + * semantics of this function. * * Since this element is scalar, * the returned value is the same * as if the function without the - * @p{_component} suffix were - * called, provided that the + * _component suffix + * were called, provided that the * specified component is zero. */ virtual double shape_value_component (const unsigned int i, @@ -97,32 +103,30 @@ class FE_Poly : public FiniteElement /** * Return the gradient of the - * @p{i}th shape function at the - * point @p{p}. See the - * @ref{FiniteElementBase} base - * class for more information - * about the semantics of this - * function. + * ith shape function at + * the point p. See the + * FiniteElementBase base class + * for more information about the + * semantics of this function. */ virtual Tensor<1,dim> shape_grad (const unsigned int i, const Point &p) const; /** * Return the gradient of the - * @p{component}th vector - * component of the @p{i}th shape - * function at the point - * @p{p}. See the - * @ref{FiniteElementBase} base - * class for more information - * about the semantics of this - * function. + * componentth vector + * component of the ith + * shape function at the point + * p. See the + * FiniteElementBase base class + * for more information about the + * semantics of this function. * * Since this element is scalar, * the returned value is the same * as if the function without the - * @p{_component} suffix were - * called, provided that the + * _component suffix + * were called, provided that the * specified component is zero. */ virtual Tensor<1,dim> shape_grad_component (const unsigned int i, @@ -131,33 +135,32 @@ class FE_Poly : public FiniteElement /** * Return the tensor of second - * derivatives of the @p{i}th - * shape function at point @p{p} - * on the unit cell. See the - * @ref{FiniteElementBase} base - * class for more information - * about the semantics of this - * function. + * derivatives of the + * ith shape function at + * point p on the unit + * cell. See the + * FiniteElementBase base class + * for more information about the + * semantics of this function. */ virtual Tensor<2,dim> shape_grad_grad (const unsigned int i, const Point &p) const; /** * Return the second derivative - * of the @p{component}th vector - * component of the @p{i}th shape - * function at the point - * @p{p}. See the - * @ref{FiniteElementBase} base - * class for more information - * about the semantics of this - * function. + * of the componentth + * vector component of the + * ith shape function at + * the point p. See the + * FiniteElementBase base class + * for more information about the + * semantics of this function. * * Since this element is scalar, * the returned value is the same * as if the function without the - * @p{_component} suffix were - * called, provided that the + * _component suffix + * were called, provided that the * specified component is zero. */ virtual Tensor<2,dim> shape_grad_grad_component (const unsigned int i, @@ -175,8 +178,9 @@ class FE_Poly : public FiniteElement /** * Access to base element * objects. Since this element is - * scalar, @p{base_element(0)} is - * @p{this}, and all other + * scalar, + * base_element(0) is + * this, and all other * indices throw an error. */ virtual const FiniteElement & @@ -184,9 +188,9 @@ class FE_Poly : public FiniteElement /** * Multiplicity of base element - * @p{index}. Since this is a - * scalar element, - * @p{element_multiplicity(0)} + * index. Since this is + * a scalar element, + * element_multiplicity(0) * returns one, and all other * indices will throw an error. */ @@ -208,8 +212,7 @@ class FE_Poly : public FiniteElement /** * Implementation of the same - * function in - * @ref{FiniteElement}. + * function in FiniteElement. */ virtual void fill_fe_values (const Mapping &mapping, @@ -221,8 +224,7 @@ class FE_Poly : public FiniteElement /** * Implementation of the same - * function in - * @ref{FiniteElement}. + * function in FiniteElement. */ virtual void fill_fe_face_values (const Mapping &mapping, @@ -235,8 +237,7 @@ class FE_Poly : public FiniteElement /** * Implementation of the same - * function in - * @ref{FiniteElement}. + * function in FiniteElement. */ virtual void fill_fe_subface_values (const Mapping &mapping, @@ -253,60 +254,74 @@ class FE_Poly : public FiniteElement * Determine the values that need * to be computed on the unit * cell to be able to compute all - * values required by @p{flags}. + * values required by + * flags. * * For the purpuse of this * function, refer to the * documentation in - * @p{FiniteElement}. + * FiniteElement. * - * The effect in this element is - * as follows: if - * @p{update_values} is set in - * @p{flags}, copy it to the - * result. All other flags of the - * result are cleared, since - * everything else must be + * This class assumes that shape + * functions of this + * FiniteElement do not + * depend on the actual shape of + * the cells in real + * space. Therefore, the effect + * in this element is as follows: + * if update_values is + * set in flags, copy it + * to the result. All other flags + * of the result are cleared, + * since everything else must be * computed for each cell. */ virtual UpdateFlags update_once (const UpdateFlags flags) const; /** * Determine the values that need - * to be computed on every - * cell to be able to compute all - * values required by @p{flags}. + * to be computed on every cell + * to be able to compute all + * values required by + * flags. * * For the purpuse of this * function, refer to the * documentation in - * @p{FiniteElement}. + * FiniteElement. + * + * This class assumes that shape + * functions of this + * FiniteElement do not + * depend on the actual shape of + * the cells in real + * space. * * The effect in this element is * as follows: * @begin{itemize} - * @item if @p{update_gradients} - * is set, the result will - * contain @p{update_gradients} - * and - * @p{update_covariant_transformation}. + + * @item if + * update_gradients is + * set, the result will contain + * update_gradients and + * update_covariant_transformation. * The latter is required to * transform the gradient on the * unit cell to the real * cell. Remark, that the action * required by - * @p{update_covariant_transformation} + * update_covariant_transformation * is actually performed by the - * @p{Mapping} object used in + * Mapping object used in * conjunction with this finite - * element. - * @item if - * @p{update_second_derivatives} + * element. @item if + * update_second_derivatives * is set, the result will * contain - * @p{update_second_derivatives} + * update_second_derivatives * and - * @p{update_covariant_transformation}. + * update_covariant_transformation. * The rationale is the same as * above and no higher * derivatives of the @@ -314,6 +329,7 @@ class FE_Poly : public FiniteElement * since we use difference * quotients for the actual * computation. + * * @end{itemize} */ virtual UpdateFlags update_each (const UpdateFlags flags) const; @@ -374,7 +390,9 @@ class FE_Poly : public FiniteElement }; /** - * The polynomial space. + * The polynomial space. Its type + * is given by the template + * parameter POLY. */ POLY poly_space; };