]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Mostly doc updates.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Thu, 4 Jun 1998 23:32:06 +0000 (23:32 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Thu, 4 Jun 1998 23:32:06 +0000 (23:32 +0000)
git-svn-id: https://svn.dealii.org/trunk@382 0785d39b-7218-0410-832d-ea1e28bc413d

17 files changed:
deal.II/base/include/base/quadrature.h
deal.II/deal.II/include/dofs/dof_accessor.h
deal.II/deal.II/include/dofs/dof_constraints.h
deal.II/deal.II/include/fe/fe.h
deal.II/deal.II/include/fe/fe_lib.lagrange.h
deal.II/deal.II/include/grid/point.h
deal.II/deal.II/include/grid/tria.h
deal.II/deal.II/include/grid/tria_accessor.h
deal.II/deal.II/include/grid/tria_boundary.h
deal.II/deal.II/include/grid/tria_iterator.h
deal.II/deal.II/include/grid/tria_line.h
deal.II/deal.II/include/grid/tria_quad.h
deal.II/deal.II/include/numerics/assembler.h
deal.II/deal.II/include/numerics/base.h
deal.II/deal.II/include/numerics/data_io.h
deal.II/deal.II/include/numerics/matrices.h
deal.II/deal.II/include/numerics/vectors.h

index efb29a54933c965114aba2a0b844737e18e73290..c2b6a5b88bc5337568fa0726e4d75343050c3489 100644 (file)
@@ -24,6 +24,8 @@
  * any dimension. Second order means that it integrates polynomials of
  * third order exact. In general, a formula of order #n# exactly
  * integrates polynomials of order #2n-1#.
+ *
+ * @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class Quadrature {
index 51cdeba8634a68cca5105551882247fe48ffd468..ae4f381f124800ffac4e205dc9b7410cc3ccc018 100644 (file)
@@ -36,6 +36,8 @@ class dVector;
  * that every iterator which is once assigned to is a valid
  * object. However, this assertion only holds in debug mode, when
  * the #Assert# macro is switched on.
+ *
+ * @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class DoFAccessor {
@@ -151,6 +153,8 @@ class DoFAccessor {
  * multiple inheritance of #DoFLineAccessor# and #CellAccessor<1>#.
  *
  * The same concept is used with #DoFQuadAccessor# classes etc.
+ *
+ * @author Wolfgang Bangerth, 1998
  */
 template <int dim, typename BaseClass>
 class DoFLineAccessor :  public DoFAccessor<dim>, public BaseClass {
@@ -438,6 +442,8 @@ class DoFSubstructAccessor<2> : public DoFQuadAccessor<2,CellAccessor<2> > {
  * access to the neighbors and children as #DoFCellAccessor# objects
  * rather than #CellAccessor# objects (the latter function was inherited
  * from the #CellAccessor<dim># class).
+ *
+ * @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class DoFCellAccessor :  public DoFSubstructAccessor<dim> {
index 91c32b1515016d7c5671cd2ed2422fa931219fed..c2bf2059831d251ee0be1af145d90cbecac3e9c9 100644 (file)
@@ -92,6 +92,8 @@ class dVector;
  * with two vectors, one working in-place. The operation of distribution undoes
  * the condensation process in some sense, but it should be noted that it is not
  * the inverse operation.
+ *
+ * @author Wolfgang Bangerth, 1998
  */
 class ConstraintMatrix {
   public:
index ad4212407d626278a56838a71feb4c739d9302ae..11df68192d40d69bd3d8528437ca51bf96f8d5c0 100644 (file)
@@ -417,12 +417,17 @@ struct FiniteElementBase : public FiniteElementData<dim> {
  *   function to the finite element space is applied. At present, only few
  *   places where this is used in the library come to mind to the author,
  *   namely the treating of boundary values in the #ProblemBase# class and
- *   the interpolation in the #VectorCreator# collection. You should also
+ *   the interpolation in the #VectorTools# collection. You should also
  *   look out for other places where explicit use of the ansatz points is
  *   made if you want to use elements of other classes. A hint may be the
  *   use of the #get_ansatz_points# and #get_face_ansatz_points# functions
  *   of this class.
  *
+ *   This also is used in some sense in the
+ *   #DoFHandler::distribute_cell_to_dof_vector# where it is assumed that
+ *   the degrees of freedom denote function values and not derivatives or
+ *   the like.
+ *
  * \item Vanishing of basis functions on faces: when projecting a function
  *   to the boundary, use if made of the assumption that all basis functions
  *   on a cell adjacent to the boundary vanish on the boundary except for those
index acb5c59cbd24478cd6d1bc4f770c75a48c81a607..dda7a467590710cf156ac40188a91e34906b539e 100644 (file)
@@ -21,6 +21,8 @@
  * real space and $N_j(\vec \xi)$ is the value of the basis function associated
  * with the $j$th corner point, on the unit cell at point $\vec \xi$. The sum
  * over $j$ runs over all corner points.
+ *
+ * @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class FELinear : public FiniteElement<dim> {
index d603d8632bdfa96ab69fa70d9cb44847f4e04a1b..709fbf908568c3bdd0f1aba795d77d543d8eb2b6 100644 (file)
@@ -26,6 +26,8 @@
  * gradient of a function be a #point# vector:
  * #Point<dim> gradient_of_f (const Point<dim> &x)#. #Point#s have all
  * functionality for this, e.g. scalar products, addition etc.
+ *
+ * @author Wolfgang Bangerth, 1997
  */
 template <int dim>
 class Point {
index 53474f58ea1de04694d30a7a997426e2a9d70a4b..9d62eb21468af34da50886fbaa0bacfc3869d00e 100644 (file)
@@ -922,7 +922,15 @@ enum MeshSmoothing {
  *     certain fraction of the total error. If this fraction is 50 per cent,
  *     for example, the threshold is computed such that the cells with a
  *     criterion greater than the threshold together account for half of the
- *     total error.
+ *     total error. The definition of the fraction is a bit unintuitive, since
+ *     the total error is the sum over all cells of the local contribution
+ *     squared. We define that the fraction $\alpha$ be such that those
+ *     elements with the greatest error are refined for which the condition
+ *     $\sum \eta_K^2 \le \alpha\eta^2$ holds. Note that $\alpha$ is not
+ *     squared. The sum runs over the mentioned
+ *     cells, $\eta_K$ are the local error indicators and $\eta$ is the global
+ *     indicator with $\eta^2 = \sum \eta_K^2$, with here the sum running over
+ *     all cells.
  *
  *     This strategy is more suited for singular functions and error
  *     functionals, but may lead to very slow convergence of the grid
index 042ea3a921c4abb3c27eb6daa5908945dbf9081f..20c1f5d3af08624fc303df13d48dc5c7ef99c157 100644 (file)
@@ -52,6 +52,8 @@ enum IteratorState { valid, past_the_end, invalid };
  *   data members, offers comparison operators and the like), but has no
  *   functionality to actually dereference data. This is done in the derived
  *   classes.
+ *
+ *   @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class TriaAccessor {
@@ -168,14 +170,6 @@ class TriaAccessor {
                                     /**
                                      *  Exception
                                      */
-    DeclException0 (ExcRefineCellNotUsed);
-                                    /**
-                                     *  Exception
-                                     */
-    DeclException0 (ExcRefineCellNotActive);
-                                    /**
-                                     *  Exception
-                                     */
     DeclException1 (ExcInvalidNeighbor,
                    int,
                    << "Neighbor indices must be between 0 and 2^dim-1, but "
@@ -269,6 +263,8 @@ class TriaAccessor {
  *   point to lines in #dim# space dimensions. There is a derived class
  *   for lines in one space dimension, in which case a line is also a cell
  *   and thus has much more functionality than in lower dimensions.
+ *
+ *   @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class LineAccessor :  public TriaAccessor<dim> {
@@ -487,6 +483,8 @@ class LineAccessor :  public TriaAccessor<dim> {
  *   to me). There is a derived class
  *   for quads in two space dimension, in which case a quad is also a cell
  *   and thus has much more functionality than in lower dimensions.
+ *
+ *   @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class QuadAccessor :  public TriaAccessor<dim> {
@@ -820,6 +818,8 @@ class TriaSubstructAccessor<2> : public QuadAccessor<2> {
  * example they can be flagged for refinement, they have neighbors, they have
  * the possibility to check whether they are at the boundary etc. This class
  * offers access to all this data.
+ *
+ * @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class CellAccessor :  public TriaSubstructAccessor<dim> {
@@ -948,6 +948,18 @@ class CellAccessor :  public TriaSubstructAccessor<dim> {
                                      */
     bool active () const;
     
+                                    /**
+                                     *  Exception
+                                     */
+    DeclException0 (ExcRefineCellNotActive);
+                                    /**
+                                     *  Exception
+                                     */
+    DeclException0 (ExcCellFlaggedForRefinement);
+                                    /**
+                                     *  Exception
+                                     */
+    DeclException0 (ExcCellFlaggedForCoarsening);    
   private:
                                     /**
                                      *  Copy operator. This is normally
index 17e57aba2dfc79d14490bdde989f5cbddc64e341..e2f5ab23244be18fe2b0ba4b81aa56b8b7fd37e1 100644 (file)
@@ -31,6 +31,8 @@
  *   the new point right into the middle of the given points, and
  *   #HyperBallBoundary<dim># creating a hyperball with given radius
  *   around a given center point.
+ *
+ *   @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class Boundary {
index a97716d9a48246a8367ff4eac0731bca92deadfd..ab6bf2bee8baa6b4f05beb3c905351b917011eb5 100644 (file)
@@ -127,16 +127,16 @@ template <int dim> class Triangulation;
  *   \begin{itemize}
  *     \item It must have two members named #present_level# and #present_index#
  *       storing the address of the element in the triangulation presently
- *pointed to. Furthermore, the three #Tria{Raw| |Active}Iterator# classes
- *have to be friends to the accessor or these data members must be public.
+ *       pointed to. Furthermore, the three #Tria{Raw| |Active}Iterator# classes
+ *       have to be friends to the accessor or these data members must be public.
  *     \item It must have a constructor which takes 1. a #Triangulation<dim>*#,
  *       2. and 3. and integer, denoting the initial level and index.
  *     \item For the #TriaIterator# and the #TriaActiveIterator# class, it must
  *       have a member function #bool used()#, for the latter a member function
- *#bool active()#.
+ *       #bool active()#.
  *     \item It should not modify the #present_level# and #present_index# fields,
  *       since this is what the iterator classes do, but it should use them to
- *dereference the data it points to.
+ *       dereference the data it points to.
  *     \item It must have void operators #++# and #--#.        
  *   \end{itemize}
  *   Then the iterator is able to do what it is supposed to. All of the necessary
index be519bbc11b8d70ecaa06648b9e26538f90e5ebe..d01ae811bd96b7628f02ec2669060958e0ff84f2 100644 (file)
@@ -15,6 +15,8 @@
  *   the triangulation is concerned: the index in the level
  *   it belongs to. The level index is implicitely given by the position
  *   in the #lines.lines# list attached to the information of each level.
+ *
+ *   @author Wolfgang Bangerth, 1998
  */
 class Line {
   public:
index 7d99563c7c350253035a0b6af77ebf4b0c695f41..80f7f1e8cdaef9b6cccf413242e63eab241e0d26 100644 (file)
@@ -17,6 +17,8 @@
  *   it belongs to. The level index is implicitely given by the position
  *   in the #quads.quads# list attached to the information of each level
  *   of the triangulation.
+ *
+ *   @author Wolfgang Bangerth, 1998
  */
 class Quad {
   public:
index a764d53ed4846c9e35fbd9e7fc221042a94051a4..d57d95b97e70c1a3f1b9ede037e0c37dd9406356 100644 (file)
@@ -28,6 +28,8 @@ class dVector;
  * Equation objects need only provide functions which set up the cell
  * matrices and the cell right hand side. These are then automatically inserted
  * into the global matrices and vectors.
+ *
+ * @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class Equation {
@@ -217,6 +219,8 @@ struct AssemblerData {
 /**
  * An #Assembler# is a specialized version of a #DoFCellAccessor# which adds
  * functionality to assemble global matrices and vectors from cell base ones.
+ *
+ * @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class Assembler : public DoFCellAccessor<dim> {
index 42c5fea0a5efcc396882dda3d941594082b2e0d7..5cdbc74f253269440e2a0e8c0dc00add92541461 100644 (file)
@@ -86,6 +86,8 @@ template <int dim> class Function;
  * the boundary_values using the #MatrixTool::interpolate_boundary_values#
  * function. See there for more information.
  *
+ *
+ * @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class ProblemBase {
index ff5ce2d836f9ae052ab6543ec8aff0f38eabde5a..773d4bfa681bc2acbd25243ec784deb378bd86b8 100644 (file)
@@ -194,6 +194,8 @@ struct SubCellData {
  * backtracking nor whether it can be done with a stopping algorithm, if
  * possible within polynomial time. This kind of numbering must be made
  * upon construction of the coarse grid, unfortunately.
+ *
+ * @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class DataIn {
@@ -317,6 +319,8 @@ class DataIn {
  * #set parametric# and #splot "filename" using 1:2:x# to get a 3d surface
  * plot of the (#x-2#)th data set. For example, using #x=4# would mean to
  * plot the second data set.
+ *
+ * @author Wolfgang Bangerth, 1998
  */
 template <int dim>  
 class DataOut {
index 01f5f127636fbad7933d8f30d08a26e7ec69c99e..d1350e51f8327b666fc40a65920dff8d8b1dfa49 100644 (file)
@@ -142,6 +142,9 @@ class dSMatrix;
  * once. If you only want to create a right hand side as above, there is
  * a function in the #VectorCreator# class. The use of the latter may be
  * useful if you want to create many right hand side vectors.
+ *
+ *
+ * @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class MatrixCreator {
index d1012878a9c4e0b62a71607516e6cbafc8b5c01c..28f1d06614593eb76c2b5834d66f250be5cb9d6b 100644 (file)
@@ -243,6 +243,9 @@ enum NormType {
  *   For the global $H_1$ norm and seminorm, the same rule applies as for the
  *   $L_2$ norm: compute the $l_2$ norm of the cell error vector.
  * \end{itemize}
+ *
+ *
+ * @author Wolfgang Bangerth, 1998
  */
 template <int dim>
 class VectorTools {

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.