]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
new doxygen module IO
authorguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 25 Jul 2005 14:49:26 +0000 (14:49 +0000)
committerguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 25 Jul 2005 14:49:26 +0000 (14:49 +0000)
git-svn-id: https://svn.dealii.org/trunk@11190 0785d39b-7218-0410-832d-ea1e28bc413d

20 files changed:
deal.II/base/include/base/data_out_base.h
deal.II/deal.II/include/grid/grid_in.h
deal.II/deal.II/include/grid/grid_out.h
deal.II/deal.II/include/grid/grid_reordering.h
deal.II/deal.II/include/grid/grid_tools.h
deal.II/deal.II/include/grid/persistent_tria.h
deal.II/deal.II/include/grid/tria.h
deal.II/deal.II/include/grid/tria_boundary.h
deal.II/deal.II/include/grid/tria_hex.h
deal.II/deal.II/include/grid/tria_iterator.h
deal.II/deal.II/include/grid/tria_iterator_base.h
deal.II/deal.II/include/grid/tria_levels.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/data_out.h
deal.II/deal.II/include/numerics/data_out_faces.h
deal.II/deal.II/include/numerics/data_out_rotation.h
deal.II/deal.II/include/numerics/data_out_stack.h
deal.II/deal.II/include/numerics/dof_print_solver_step.h
deal.II/doc/doxygen/headers/base/dox.h

index 1c6c1f9339a866adca9d3704831e322b34591e54..d7cbb95c1e23196672bf9441540764406a2a525e 100644 (file)
@@ -183,6 +183,7 @@ class ParameterHandler;
  *
  * </ul>
  *
+ * @ingroup IO
  * @author Wolfgang Bangerth, Guido Kanschat 1999, 2000, 2001, 2002, 2005.
  */
 class DataOutBase 
@@ -212,6 +213,7 @@ class DataOutBase
                                      * |  |  |  |  |
                                      * |__|__|__|__|
                                      * @endverbatim
+                                     * @ingroup IO
                                      * @author Wolfgang Bangerth
                                      */
     template <int dim, int spacedim=dim>
@@ -389,14 +391,23 @@ class DataOutBase
     };
 
                                     /**
-                                     * Flags describing the details of
-                                     * output in OpenDX format. At
-                                     * present no flags are implemented.
+                                     * Flags controlling the details of
+                                     * output in OpenDX format.
+                                     *
+                                     * @ingroup IO
                                      */
     struct DXFlags 
     {
                                         /**
-                                         * Write neighbor information.
+                                         * Write neighbor
+                                         * information. This
+                                         * information is necessary
+                                         * for instance, if OpenDX is
+                                         * supposed to compute
+                                         * integral curves
+                                         * (streamlines). If it is
+                                         * not present, streamlines
+                                         * end at cell boundaries.
                                          */
        bool write_neighbors;
 
@@ -433,8 +444,10 @@ class DataOutBase
     };
 
                                     /**
-                                     * Flags describing the details of
+                                     * Flags controlling the details of
                                      * output in UCD format.
+                                     *
+                                     * @ingroup IO
                                      */
     struct UcdFlags 
     {
@@ -495,9 +508,11 @@ class DataOutBase
     };
 
                                     /**
-                                     * Flags describing the details of
+                                     * Flags controlling the details of
                                      * output in Gnuplot format. At
                                      * present no flags are implemented.
+                                     *
+                                     * @ingroup IO
                                      */
     struct GnuplotFlags 
     {
@@ -551,11 +566,13 @@ class DataOutBase
     };
 
                                     /**
-                                     * Flags describing the details
+                                     * Flags controlling the details
                                      * of output in Povray
                                      * format. Several flags are
                                      * implemented, see their
                                      * respective documentation.
+                                     *
+                                     * @ingroup IO
                                      */
     struct PovrayFlags 
     {
@@ -631,9 +648,11 @@ class DataOutBase
 
 
                                     /**
-                                     * Flags describing the details of
+                                     * Flags controlling the details of
                                      * output in encapsulated postscript
                                      * format.
+                                     *
+                                     * @ingroup IO
                                      */
     struct EpsFlags 
     {
@@ -959,9 +978,11 @@ class DataOutBase
     };
 
                                     /**
-                                     * Flags describing the details of
+                                     * Flags controlling the details of
                                      * output in gmv format. At
                                      * present no flags are implemented.
+                                     *
+                                     * @ingroup IO
                                      */
     struct GmvFlags 
     {
@@ -1015,9 +1036,10 @@ class DataOutBase
     };
 
                                     /**
-                                     * Flags describing the details of
-                                     * output in Tecplot format. At
-                                     * present no flags are implemented.
+                                     * Flags controlling the details of
+                                     * output in Tecplot format.
+                                     *
+                                     * @ingroup IO
                                      */
     struct TecplotFlags 
     {
@@ -1078,10 +1100,12 @@ class DataOutBase
     };
 
                                     /**
-                                     * Flags describing the details
+                                     * Flags controlling the details
                                      * of output in VTK format. At
                                      * present no flags are
                                      * implemented.
+                                     *
+                                     * @ingroup IO
                                      */
     struct VtkFlags 
     {
@@ -1137,11 +1161,13 @@ class DataOutBase
 
 
                                     /**
-                                     * Flags describing the details
+                                     * Flags controlling the details
                                      * of output in deal.II
                                      * intermediate format. At
                                      * present no flags are
                                      * implemented.
+                                     *
+                                     * @ingroup IO
                                      */
     struct Deal_II_IntermediateFlags
     {
@@ -1885,6 +1911,7 @@ class DataOutBase
  * suffix for the output file name can be obtained by <tt>default_suffix</tt>
  * without arguments.
  *
+ * @ingroup IO
  * @author Wolfgang Bangerth, 1999
  */
 template <int dim, int spacedim=dim>
@@ -2316,6 +2343,7 @@ class DataOutInterface : private DataOutBase
  * function is explained in step-19.
  * 
  *
+ * @ingroup IO
  * @author Wolfgang Bangerth, 2005
  */
 template <int dim, int spacedim=dim>
index 55ed5dae009389589ad14fd9e16ad044a920d0e3..87adb544a2effd03be3e9b0a83a2f7ab0fc3bb75 100644 (file)
@@ -153,6 +153,8 @@ class SubCellData;
  * that class if you experience unexpected problems when reading grids
  * through this class.
  *
+ * @ingroup grid
+ * @ingroup IO
  * @author Wolfgang Bangerth, 1998, 2000, Luca Heltai, 2004
  */
 template <int dim>
index b88de93fe45201c43dc425c1decb8ed5bfa3baac..e3052793b14b12bbc4a3836ffabdc32c729f8c99 100644 (file)
@@ -30,11 +30,15 @@ template <int dim> class Mapping;
  * modify the default outfit of the grids written into a file. See the
  * different subclasses and the documentation of the GridOut
  * class for more details.
+ *
+ * @ingroup IO
  */
 namespace GridOutFlags
 {
                                   /**
                                    * Flags for grid output in OpenDX format.
+                                   *
+                                   * @ingroup IO
                                    */
   struct DX
   {
@@ -77,6 +81,8 @@ namespace GridOutFlags
                                   /**
                                    * Flags describing the details of
                                    * output in UCD format.
+                                   *
+                                   * @ingroup IO
                                    */
   struct Ucd 
   {
@@ -124,6 +130,8 @@ namespace GridOutFlags
                                   /**
                                    * Flags describing the details of
                                    * output in GNUPLOT format.
+                                   *
+                                   * @ingroup IO
                                    */
   struct Gnuplot
   {
@@ -175,6 +183,8 @@ namespace GridOutFlags
                                    * By default, the size of the picture
                                    * is scaled such that the width equals
                                    * 300 units.
+                                   *
+                                   * @ingroup IO
                                    */
   struct EpsFlagsBase
   {
@@ -271,7 +281,9 @@ namespace GridOutFlags
                                    * exist, we only here declare the
                                    * general template and declare
                                    * explicit specializations below.
-                                   */
+                                   *
+                                   * @ingroup IO
+                                  */
   template <int dim>
   struct Eps
   {};
@@ -279,6 +291,8 @@ namespace GridOutFlags
                                   /**
                                    * Flags specific to the output of
                                    * grids in one space dimensions.
+                                   *
+                                   * @ingroup IO
                                    */
   template <>
   struct Eps<1> : public EpsFlagsBase 
@@ -297,6 +311,8 @@ namespace GridOutFlags
                                   /**
                                    * Flags specific to the output of
                                    * grids in two space dimensions.
+                                   *
+                                   * @ingroup IO
                                    */
   template <>
   struct Eps<2> : public EpsFlagsBase 
@@ -359,6 +375,8 @@ namespace GridOutFlags
                                   /**
                                    * Flags specific to the output of
                                    * grids in three space dimensions.
+                                   *
+                                   * @ingroup IO
                                    */
   template <>
   struct Eps<3> : public EpsFlagsBase
@@ -400,6 +418,8 @@ namespace GridOutFlags
   };
                                   /**
                                    * Flags for XFig output.
+                                   *
+                                   * @ingroup IO
                                    */
   struct XFig
   {
@@ -496,7 +516,6 @@ namespace GridOutFlags
  * different formats. See the enum GridOut::OutputFormat for a list of formats
  * and the corresponding output function names.
  *
- * @sect3{Usage}
  * Usage is simple: either you use the direct form
  * @verbatim
  *   ofstream output_file("some_filename");
@@ -561,7 +580,8 @@ namespace GridOutFlags
  * dimensions supported by this class; they then have a template parameter,
  * as usual.
  *
- *
+ * @ingroup grid
+ * @ingroup IO
  * @author Wolfgang Bangerth, Guido Kanschat, 1999, 2003; postscript format based on an implementation by Stefan Nauber, 1999
  */
 class GridOut 
index 6ae4fea00285839fadaa6bdc17f989676188920d..01c0ebc809465f0314dba7b47ea7b823fb20d3eb 100644 (file)
  * the triangulation from this data using the
  * Triangulation::create_triangulation() function.
  *
+ * @ingroup grid
  * @author Wolfgang Bangerth, 2000, Michael Anderson 2003, Ralf Hartmann 2005
  */
 template <int dim>
index 102a2c91c2855078b1247cd0ed057d9eee3652a8..2155e25ac07895512026bea6b1cfbfd5dd9ca306 100644 (file)
@@ -28,6 +28,7 @@
  * cell that contains a given point. See the descriptions of the
  * individual functions for more information.
  *
+ * @ingroup grid
  * @author Wolfgang Bangerth, 2001, 2003, 2004
  */
 class GridTools
index 6eba8dc326f49e5a6dae43a4ab7339d89d268522..90bf4a8662d44650b62f7180b293be752f35f129 100644 (file)
@@ -96,6 +96,7 @@
  * later reconstruction and does also not touch the coarse grid which is
  * used within restore().
  *
+ * @ingroup grid
  * @author Wolfgang Bangerth, 1999
  */
 template <int dim>
index b7bad5a0758bbc2868de2e80eb6dbcdcd640b139..3559aad2655f37bbb7c4a7eb43207e9500b767f7 100644 (file)
@@ -39,6 +39,8 @@ template <int dim> class MGDoFHandler;
  *  <tt>Triangulation<dim>::create_triangulation</tt> function. It
  *  contains all data needed to construct a cell, namely the indices
  *  of the vertices and the material indicator.
+ *
+ * @ingroup grid
  */
 template <int dim>
 struct CellData
@@ -118,6 +120,8 @@ struct CellData
  *  (if in the interior). Explicitely giving a line the indicator 255
  *  will result in an error, as well as giving an interior line a boundary
  *  indicator.
+ *
+ * @ingroup grid
  */
 struct SubCellData
 {
@@ -171,6 +175,7 @@ struct SubCellData
  * Note: these class should be made local to the triangulation class
  * once the compiler supports that (gcc2.95 does not at present).
  *
+ * @ingroup grid
  * @author Wolfgang Bangerth, 1999
  */
 template <int dim>
@@ -192,6 +197,7 @@ struct TriaNumberCache
  * Note: these class should be made local to the triangulation class
  * once the compiler supports that (gcc2.95 does not at present).
  *
+ * @ingroup grid
  * @author Wolfgang Bangerth, 1999
  */
 template <>
@@ -252,6 +258,7 @@ struct TriaNumberCache<1>
  * Note: these class should be made local to the triangulation class
  * once the compiler supports that (gcc2.95 does not at present).
  *
+ * @ingroup grid
  * @author Wolfgang Bangerth, 1999
  */
 template <>
@@ -313,6 +320,7 @@ struct TriaNumberCache<2> : public TriaNumberCache<1>
  * Note: these class should be made local to the triangulation class
  * once the compiler supports that (gcc2.95 does not at present).
  *
+ * @ingroup grid
  * @author Wolfgang Bangerth, 1999
  */
 template <>
index 616ee960e10a0d7263b255affd61649b6d486414..5f499bbed95ed7fb0dad240c9f38aea09a28f1d2 100644 (file)
@@ -71,6 +71,7 @@ template <int dim> class Triangulation;
  *   HyperBallBoundary creating a hyperball with given radius
  *   around a given center point.
  *
+ * @ingroup grid
  *   @author Wolfgang Bangerth, 1999, 2001, Ralf Hartmann, 2001
  */
 template <int dim>
index 553b21a3969d4ef3a1b6be6a8da7df4c232c3e47..291d561e79dc99485431ca9d1ad3b437a02b5ee5 100644 (file)
@@ -32,6 +32,7 @@
  *   within a hexahedron, refer to the documentation of the
  *   Triangulation class.
  *
+ * @ingroup grid
  *   @author Wolfgang Bangerth, 1998
  */
 class Hexahedron
index 931f65ddc697c338ac49f8cd1d4ebe8590022278..9707388df16610b32ea9ebaa07cf5871840c25d5 100644 (file)
@@ -219,6 +219,7 @@ template <int dim> class Triangulation;
  * @ref TriaDimensionInfo<1>
  * @ref TriaDimensionInfo<2>
  * @ref TriaDimensionInfo<3>
+ * @ingroup grid
  * @ingroup Iterators
  * @author Wolfgang Bangerth, 1998
  * @author documentation update Guido Kanschat, 2004
@@ -548,6 +549,7 @@ class TriaRawIterator :
  *   This specialization of TriaRawIterator provides access only to
  *   the <em>used</em> lines, quads, cells, etc.
  *
+ * @ingroup grid
  * @ingroup Iterators
  */
 template <int dim, typename Accessor>
@@ -698,6 +700,7 @@ class TriaIterator : public TriaRawIterator<dim,Accessor>
  *   cell which is not refined and thus a cell on which calculations
  *   on the finest level are done.
  *
+ * @ingroup grid
  * @ingroup Iterators
  */
 template <int dim, typename Accessor>
index 1a1d784d97b26da9583d1ce87711f20a65b8eff3..82f815a14f1d4937ace6331872a8a664d6ae0c03 100644 (file)
@@ -20,6 +20,8 @@
 /**
  * Namespace in which an enumeration is declared that denotes the
  * states in which an iterator can be in.
+ *
+ * @ingroup Iterators
  */
 namespace IteratorState
 {
index 80c13b7775825d36d8473eaf27f7a80bb4ebdcaf..9a62590bb04ddf5f032dd3a63e27212c4173ce05 100644 (file)
@@ -26,6 +26,8 @@
  *  General template for information belonging to one level of a multilevel
  *  hierarchy of a triangulation. This template is only declared to allow
  *  specializations for different dimensions.
+ *
+ * @ingroup grid
  */
 template <int dim>
 class TriangulationLevel
@@ -50,6 +52,7 @@ class TriangulationLevel
  *  for the lines. Since we only store one byte per line, quad or hex,
  *  this is a minor loss and we can live with that.
  *
+ * @ingroup grid
  *  @author Wolfgang Bangerth, 1998
  */
 template <>
@@ -201,6 +204,7 @@ class TriangulationLevel<0>
  *  The TriangulationsLevel objects of higher dimensions are derived from
  *  this one.
  *
+ * @ingroup grid
  *  @author Wolfgang Bangerth, 1998
  */
 template <>
@@ -357,6 +361,7 @@ class TriangulationLevel<1> : public TriangulationLevel<0>
  *  The vector of lines and their children is derived from
  *  TriangulationLevel<1>.
  *
+ * @ingroup grid
  *  @author Wolfgang Bangerth, 1998
  */
 template <>
@@ -479,6 +484,7 @@ class TriangulationLevel<2> :  public TriangulationLevel<1>
  *  The vectors of lines and quads and their children are derived from
  *  TriangulationLevel<2>.
  *
+ * @ingroup grid
  *  @author Wolfgang Bangerth, 1998, 2003
  */
 template <>
index a5ec10ecdcb71ff49cf7259c1c22236ac49e2448..c5367b899919ea3b0ac4064be275a32411e2b2f1 100644 (file)
@@ -27,6 +27,7 @@
  *   it belongs to. The level index is implicitly given by the position
  *   in the <tt>lines.lines</tt> list attached to the information of each level.
  *
+ * @ingroup grid
  *   @author Wolfgang Bangerth, 1998
  */
 class Line
index b26ad6604e318b8af33f92a833b69d24676036bd..1bf0c903f71a2fc56c81872d4114aa87b6a3ec56 100644 (file)
@@ -29,6 +29,7 @@
  *   in the <tt>quads.quads</tt> list attached to the information of each level
  *   of the triangulation.
  *
+ * @ingroup grid
  *   @author Wolfgang Bangerth, 1998
  */
 class Quad
index 433d4f514b3dfdf157530e1f67a7920d85ef805d..6796ebaaffbb1d13cbe68eb3441612e73f434031 100644 (file)
@@ -36,7 +36,7 @@ template <int>      class FEValuesBase;
  * be written in any of the implemented data formats.
  *
  *
- * @sect3{User visible interface}
+ * <h3>User visible interface</h3>
  *
  * The user visible interface of this class consists of functions which allow
  * a user to make a DoFHandler object known to this class and to add data
@@ -154,6 +154,7 @@ template <int>      class FEValuesBase;
  * triangulation, so that the last template parameter has the same
  * value as the second one.
  *
+ * @ingroup IO
  * @author Wolfgang Bangerth, 1999
  */
 template <int dof_handler_dim, int patch_dim, int patch_space_dim=patch_dim>
@@ -757,7 +758,7 @@ class DataOut_DoFData : public DataOutInterface<patch_dim,patch_space_dim>
  * the patches.
  *
  *
- * @sect3{User interface information}
+ * <h3>User interface information</h3>
  *
  * The base classes of this class, DataOutBase, DataOutInterface and
  * DataOut_DoFData() offer several interfaces of their own. Refer to the
@@ -770,7 +771,7 @@ class DataOut_DoFData : public DataOutInterface<patch_dim,patch_space_dim>
  * output.
  *
  *
- * @sect3{Extensions}
+ * <h3>Extensions</h3>
  *
  * By default, this class produces patches for all active cells. Sometimes,
  * this is not what you want, maybe because they are simply too many (and too
@@ -798,6 +799,7 @@ class DataOut_DoFData : public DataOutInterface<patch_dim,patch_space_dim>
  * this pair of functions and they return a non-active cell, then an exception
  * will be thrown.
  * 
+ * @ingroup IO
  * @author Wolfgang Bangerth, 1999
  */
 template <int dim>
index d04e01c6c1366acc16763258c4b15680c8aac670..894088dc1abdfe68dbe0656cb3ea4cb5cf795dfe 100644 (file)
@@ -34,7 +34,7 @@ template <int dim> class DoFHandler;
  * be generated. These patches can then be written in several
  * graphical data formats by the functions of the underlying classes.
  *
- * @sect3{Interface}
+ * <h3>Interface</h3>
  *
  * The interface of this class is copied from the DataOut
  * class. Furthermore, they share the common parent class
@@ -42,7 +42,7 @@ template <int dim> class DoFHandler;
  * discussion of the interface.
  *
  *
- * @sect3{Extending this class}
+ * <h3>Extending this class</h3>
  *
  * The sequence of faces to generate patches from is generated in the
  * same way as in the DataOut class, see there for a description
@@ -75,6 +75,7 @@ template <int dim> class DoFHandler;
  * applications certainly exist, for which the author is not
  * imaginative enough.
  *
+ * @ingroup IO
  * @author Wolfgang Bangerth, 2000
  */
 template <int dim>
index 7115947aa3b61cdd823ff1ddb5138e7977ab9720..21eba0272cd1bbb1d816783afa278f89643becfe 100644 (file)
@@ -42,7 +42,7 @@ template <int dim> class DoFHandler;
  * produces <em>very</em> large output files.
  *
  *
- * @sect3{Interface}
+ * <h3>Interface</h3>
  *
  * The interface of this class is copied from the DataOut
  * class. Furthermore, they share the common parent class
@@ -51,7 +51,7 @@ template <int dim> class DoFHandler;
  * further classes from this class.
  *
  *
- * @sect3{Details for 1d computations}
+ * <h3>Details for 1d computations</h3>
  *
  * The one coordinate in the triangulation used by the
  * DoFHandler object passed to this class is taken as the radial
@@ -60,7 +60,7 @@ template <int dim> class DoFHandler;
  * radial coordinate only attains non-negative values.
  *
  *
- * @sect3{Details for 2d computations}
+ * <h3>Details for 2d computations</h3>
  *
  * We consider the computation (represented by the DoFHandler
  * object that is attached to this class) to have happened in the
@@ -77,6 +77,7 @@ template <int dim> class DoFHandler;
  * It is in the responsibility of the user to make sure that the
  * radial variable attains only non-negative values.
  *
+ * @ingroup IO
  * @author Wolfgang Bangerth, 2000
  */
 template <int dim>
index 5468376e7323acb7c2572ef56b635b99383de3f0..3b364af796025e9aaae43e19ea64ee0305d33c80 100644 (file)
@@ -52,7 +52,7 @@ template <int dim> class DoFHandler;
  * interpolations in time may be added in the future.
  *
  *
- * @sect2{Example of Use}
+ * <h3>Example of Use</h3>
  *
  * The following little example shall illustrate the different steps
  * of use of this class. It is assumed that the finite element used is
@@ -98,6 +98,7 @@ template <int dim> class DoFHandler;
  *     };
  * @endverbatim
  *
+ * @ingroup IO
  * @author Wolfgang Bangerth, 1999
  */
 template <int dim>
index 2a6756f7fc3390c25d2c67f120ce42e8213a8f10..89aeb710671e2f9e473ec68f58a705e687655cf2 100644 (file)
@@ -48,6 +48,7 @@
  * written as a finite element field using the DataOut class.
  * Please note that this class may produce enormous amounts of data!
  *
+ * @ingroup IO
  * @author Guido Kanschat, 2000
  */
 template<int dim, class SOLVER, class VECTOR = Vector<double> >
index 110868397d7f8cc9725685b83e4b84e70453fc5e..a2ec74c11faef2af83ed2a2fdc15e5cb6dbee866 100644 (file)
  * All other classes in this module actually implement quadrature
  * rules of different order and other characteristics.
  */
+
+/**
+ * @defgroup IO Input/Output
+ *
+ * This module collects the classes used for reading and writing
+ * meshes and data.
+ */

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.