]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Describe more about finite elements.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Sat, 14 Jan 2006 02:42:24 +0000 (02:42 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Sat, 14 Jan 2006 02:42:24 +0000 (02:42 +0000)
git-svn-id: https://svn.dealii.org/trunk@12025 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/fe/fe.h
deal.II/deal.II/include/fe/fe_system.h
deal.II/doc/doxygen/headers/fe.h

index d28a420a11d4bb4b7fdce3580ab80f00342bdd39..b77a4e2fe84202637e9479970b516490813e766c 100644 (file)
@@ -299,6 +299,8 @@ namespace hp
  * eliminating degrees of freedom on common vertices and edges as well
  * as on the coarse grid vertices. See the discussion above for details.
  *
+ * @ingroup febase fe
+ * 
  * @author Wolfgang Bangerth, Guido Kanschat, Ralf Hartmann, 1998, 2000, 2001, 2005
  */
 template <int dim>
index dc1ebaec35031470014af4c0eb61e89f8bd7e330..37b0248776c083ba88bba8a6f85d4655f6524737 100644 (file)
@@ -23,9 +23,6 @@
 #include <utility>
 
 
-/*!@addtogroup febase fe */
-/*@{*/
-
 /**
  * This class provides an interface to group several elements together
  * into one. To the outside world, the resulting object looks just
@@ -67,6 +64,8 @@
  * coupled to @p u at the vertices and the line on the larger cell next to this
  * vertex, there is no interaction with @p v and @p w of this or the other cell.
  *
+ * @ingroup febase fe
+ * 
  * @author Wolfgang Bangerth, Guido Kanschat, 1999, 2002, 2003, partial reimplementation Ralf Hartmann 2001.
  */
 template <int dim>
@@ -896,7 +895,6 @@ class FESystem : public FiniteElement<dim>
     };
 };
 
-/*@}*/
 
 /* -------------- declaration of explicit specializations ------------- */
 
index faa3da1e8bdede05ac8c944143e9b68e39349390..f0bf7ee1fda7d4e64f4baf4bd246b913ceec8af1 100644 (file)
 
 
 /**
- * @defgroup feaccess Finite element access classes (FEValues etc.)
+ * @defgroup feaccess Finite element access/FEValues classes
  *
  * @ingroup feall
  */
 
 
 /**
- * @defgroup fe Finite element shape functions
+ * @defgroup fe Finite element space descriptions
  *
+ * The classes here describe finite element spaces, such as the simplest Q1
+ * (bi-/trilinear) spaces, and higher order Lagrangian spaces Qp, but also
+ * more specialized spaces such as Nedelec or Raviart-Thomas ones. Concrete
+ * implementations are derived from the abstract FiniteElement base class.
+ *
+ * In essence, the functions these classes have to implement provide the
+ * ability to query the value or derivatives of a shape function at a given
+ * point on the unit cell. To be useful in integrating matrix and right hand
+ * side entries, one has to have the ability to map these shape functions and
+ * gradients to the real cell. This is done using classes derived from the
+ * Mapping base class (see the @ref mapping module) in conjunction with the
+ * FEValues class (see the @ref feaccess module).
+ *
+ * The FESystem class is different since it doesn't describe shape functions
+ * itself, but assembles a vector-valued finite element from other finite
+ * element objects. This functionality is described step-8, step-17 and other
+ * tutorial programs after that.
+ * 
  * @ingroup feall
  */
 
  * class that provides a Q1 (bi-/trilinear) mapping (i.e. a mapping that is
  * isoparametric for the usual Q1 elements). However, there are other classes
  * that implement higher-order mappings as well to provide for curvilinear
-$* elements.
+ * elements. These are discussed in the step-11 and step-12 tutorial programs.
  *
  * The MappingQ1Eulerian class is an extension to the MappingQ1 class in that
  * it accepts a vector that describes a displacement field for each position

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.