From: maier Date: Mon, 26 Nov 2012 14:48:34 +0000 (+0000) Subject: Reindent the comments in fe_update_flags.h X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0df09c5fd16fd808824a282780f3a7266da04e13;p=dealii-svn.git Reindent the comments in fe_update_flags.h git-svn-id: https://svn.dealii.org/trunk@27688 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/fe/fe_update_flags.h b/deal.II/include/deal.II/fe/fe_update_flags.h index 6b357da64f..4b07fbc4e1 100644 --- a/deal.II/include/deal.II/fe/fe_update_flags.h +++ b/deal.II/include/deal.II/fe/fe_update_flags.h @@ -78,190 +78,135 @@ DEAL_II_NAMESPACE_OPEN enum UpdateFlags { //! No update - update_default = 0, + update_default = 0, //! Shape function 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 FE_RaviartThomas - * elements. + * 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 FE_RaviartThomas elements. */ - update_values = 0x0001, + update_values = 0x0001, //! Shape function gradients /** - * Compute the gradients of the - * shape functions in - * coordinates of the real - * cell. + * Compute the gradients of the shape functions in coordinates of the + * real cell. */ - update_gradients = 0x0002, + update_gradients = 0x0002, //! Second derivatives of shape functions /** - * Compute the second - * derivatives of the shape - * functions in coordinates of - * the real cell. + * Compute the second derivatives of the shape functions in coordinates + * of the real cell. */ - update_hessians = 0x0004, + update_hessians = 0x0004, //! Outer normal vector, not normalized /** - * Vector product of tangential - * vectors, yielding a normal - * vector with a length - * corresponding to the surface - * element; may be more - * efficient than computing - * both. + * Vector product of tangential vectors, yielding a normal vector with + * a length corresponding to the surface element; may be more efficient + * than computing both. */ - update_boundary_forms = 0x0008, + update_boundary_forms = 0x0008, //! Transformed quadrature points /** - * Compute the quadrature - * points transformed into real - * cell coordinates. + * Compute the quadrature points transformed into real cell coordinates. */ - update_quadrature_points = 0x0010, + update_quadrature_points = 0x0010, //! Transformed quadrature weights /** - * Compute the quadrature - * weights on the real cell, - * i.e. the weights of the - * quadrature rule multiplied - * with the determinant of the - * Jacoian of the - * transformation from - * reference to realcell. + * Compute the quadrature weights on the real cell, i.e. the weights + * of the quadrature rule multiplied with the determinant of the Jacoian + * of the transformation from reference to realcell. */ - update_JxW_values = 0x0020, + update_JxW_values = 0x0020, //! Normal vectors /** - * Compute the normal vectors, - * either for a face or for a - * cell of codimension - * one. Setting this flag for - * any other object will raise + * Compute the normal vectors, either for a face or for a cell of + * codimension one. Setting this flag for any other object will raise * an error. */ - update_normal_vectors = 0x0040, + update_normal_vectors = 0x0040, /** * @deprecated Use #update_normal_vectors */ - update_face_normal_vectors = update_normal_vectors, + update_face_normal_vectors = update_normal_vectors, /** * @deprecated Use #update_normal_vectors */ - update_cell_normal_vectors = update_normal_vectors, + update_cell_normal_vectors = update_normal_vectors, //! Volume element /** - * Compute the Jacobian of the - * transformation from the - * reference cell to the real - * cell. + * Compute the Jacobian of the transformation from the reference cell + * to the real cell. */ - update_jacobians = 0x0080, + update_jacobians = 0x0080, //! Gradient of volume element /** - * Compute the dervatives of - * the Jacobian of the - * transformation. + * Compute the dervatives of the Jacobian of the transformation. */ - update_jacobian_grads = 0x0100, + update_jacobian_grads = 0x0100, //! Volume element /** - * Compute the inverse - * Jacobian of the - * transformation from the - * reference cell to the real - * cell. + * Compute the inverse Jacobian of the transformation from the reference + * cell to the real cell. */ - update_inverse_jacobians = 0x0200, + update_inverse_jacobians = 0x0200, //! Covariant transformation /** - * Compute all values the - * Mapping needs to perform a - * contravariant transformation of - * vectors. For special - * mappings like - * MappingCartesian this may be - * simpler than - * #update_inverse_jacobians. + * Compute all values the Mapping needs to perform a contravariant + * transformation of vectors. For special mappings like MappingCartesian + * this may be simpler than #update_inverse_jacobians. */ - update_covariant_transformation = 0x0400, + update_covariant_transformation = 0x0400, //! Contravariant transformation /** - * Compute all values the - * Mapping needs to perform a - * contravariant transformation of - * vectors. For special - * mappings like - * MappingCartesian this may be - * simpler than - * #update_jacobians. + * Compute all values the Mapping needs to perform a contravariant + * transformation of vectors. For special mappings like MappingCartesian + * this may be simpler than #update_jacobians. */ update_contravariant_transformation = 0x0800, //! Shape function values of transformation /** - * Compute the shape function - * values of the transformation - * defined by the Mapping. + * Compute the shape function values of the transformation defined by + * the Mapping. */ - update_transformation_values = 0x1000, + update_transformation_values = 0x1000, //! Shape function gradients of transformation /** - * Compute the shape function - * gradients of the - * transformation defined by - * the Mapping. + * Compute the shape function gradients of the transformation defined + * by the Mapping. */ - update_transformation_gradients = 0x2000, + update_transformation_gradients = 0x2000, //! Determinant of the Jacobian /** - * Compute the volume element - * in each quadrature point. + * Compute the volume element in each quadrature point. */ - update_volume_elements = 0x4000, + update_volume_elements = 0x4000, /** - * Update the location of the - * mapped generalized support - * points of the element. + * Update the location of the mapped generalized support points of + * the element. */ - update_support_points = 0x10000, + update_support_points = 0x10000, /** - * Update the Jacobian of the - * mapping in generalized - * support points. + * Update the Jacobian of the mapping in generalized support points. */ - update_support_jacobians = 0x20000, + update_support_jacobians = 0x20000, /** - * Update the inverse Jacobian - * of the mapping in - * generalized support points. + * Update the inverse Jacobian of the mapping in generalized support + * points. */ - update_support_inverse_jacobians = 0x40000, + update_support_inverse_jacobians = 0x40000, /** - * @deprecated Update - * quadrature points + * @deprecated Update quadrature points */ update_q_points = update_quadrature_points, /** - * @deprecated Update second - * derivatives. + * @deprecated Update second derivatives. */ update_second_derivatives = update_hessians, //! Values needed for Piola transform /** - * Combination of the flags - * needed for Piola transform - * of Hdiv elements. + * Combination of the flags needed for Piola transform of Hdiv elements. */ update_piola = update_volume_elements | update_contravariant_transformation };