]> https://gitweb.dealii.org/ - dealii.git/commitdiff
unused flags in GnuplotFlags removed
authorGuido Kanschat <dr.guido.kanschat@gmail.com>
Mon, 10 Apr 2000 20:27:57 +0000 (20:27 +0000)
committerGuido Kanschat <dr.guido.kanschat@gmail.com>
Mon, 10 Apr 2000 20:27:57 +0000 (20:27 +0000)
git-svn-id: https://svn.dealii.org/trunk@2698 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/grid/grid_out.h
deal.II/deal.II/source/grid/grid_out.all_dimensions.cc

index ed2904c498f9484088dcbb0d31ca11a21aef62e3..7e98495b3d3eb625e3716e98e60deed3f128dd49 100644 (file)
  * with actual data vectors and that no #DoFHandler# object is needed to
  * write the pure geometrical information involved here.
  *
- *
- * \subsection{UCD format}
- * UCD (unstructured cell data) is the format used by AVS and some other
- * programs. It is described in the AVS developer's guide. Besides the usual
- * output of the grid only, you can decide through additional flags (see
- * below, and the documentation of the #GridOut::UcdFlags# class) whether
- * boundary faces with non-zero boundary indicator shall be written to the
- * file explicitely. This is useful, if you want to re-read the grid later
- * on, since #deal.II# sets the boundary indicator to zero by default;
- * therefore, to obtain the same triangulation as before, you have to specify
- * faces with differing boundary indicators explicitely, which is done by
- * this flag.
- *
- * Names and values of further flags controlling the output can be found
- * in the documentation of the #GridOut::UcdFlags# class.
- *
- *
- * \subsection{GNUPLOT format}
- * In GNUPLOT format, each cell is written as a sequence of lines. There is not
- * much more to be said here since the actual representation as well as the
- * viewing angle (for 3d plots) is done by GNUPLOT itself.
- *
- * One additional feature, however, is worth being mentioned: if
- * switched on by using the flags controlling GNUPLOT output (see
- * below on how to do this), after each point denoting one of the end
- * points of a line, the level of the respective cell is
- * written. Therefore, if you let GNUPLOT draw a 2d grid as a 3d plot,
- * you will see more refined cells being raised against cells with
- * less refinement.  Also, if you draw a cut through a 3d grid, you
- * can extrude the refinement level in the direction orthogonal to the
- * cut plane. The same can be done with the material id, which is plotted
- * after the level.
- *
- * A more useful application of this feature is the following: if you use the
- * GNUPLOT command (for a 2d grid here)
- * \begin{verbatim}
- *   splot [:][:][2.5:3.5] "grid_file.gnuplot"
- * \end{verbatim}
- * then the whole x- and y-range will be plotted, i.e. the whole grid, but
- * only those lines with a z-value between 2.5 and 3.5. Since the z-values
- * were chosen to be the level to which a cell belongs, this results in a
- * plot of those cells only that belong to level 3 in this example. This
- * way, it is easy to produce plots of the different levels of grid.
- *
- * Names and values of additional flags controlling the output can be found
- * in the documentation of the #GridOut::GnuplotFlags# class.
- *
- *
- * \subsection{Encapsulated postscript format}
- * In this format, each line of the triangulation is written separately. We
- * scale the picture such that either x-values or y-values range between zero and
- * a fixed size. The other axis is scaled by the same factor. Which axis is
- * taken to compute the scale and the size of the box it shall fit into is
- * determined by the output flags (see below, and the documentation of the
- * #GridOut::EpsFlags# class).
- *
- * The bounding box is close to the triangulation on all four sides, without an
- * extra frame. The line width is chosen to be 0.5 by default, but can be
- * changed. The line width is to be compared with the extension of the picture,
- * of which the default is 300.
- *
- * The flag @p color_lines_on_user_flag# allows to draw lines with th
- * #user_flag# set to be drawn in red. The colors black and red are
- * defined as #b# and #r# in the preamble of the output file and can
- * be changed there according to need.
- *
- * Names and values of additional flags controlling the output can be found
- * in the documentation of the #GridOut::EpsFlags# class. Especially
- * the viewpoint for three dimensional grids is of importance here.
- * 
+ * Available output formats can be found in the functions with names #write_...#
  *
  * \subsection{Usage}
  * Usage is simple: either you use the direct form
@@ -241,37 +172,10 @@ class GridOut
                                          * Default: #false#.
                                          */
        bool write_cell_numbers;
-
-                                        /**
-                                         * Write the level of a cell as
-                                         * an additional column after the
-                                         * coordinates. See the general
-                                         * documentation of this class
-                                         * for an example of the use
-                                         * of this feature.
-                                         *
-                                         * Default: #false#.
-                                         */
-       bool write_level;
-
-                                        /**
-                                         * Write the material of a cell as
-                                         * an additional column after the
-                                         * coordinates. See the general
-                                         * documentation of this class
-                                         * for an example of the use
-                                         * of this feature.
-                                         *
-                                         * Default: #false#.
-                                         */
-       bool write_material;
-       
                                         /**
                                          * Constructor.
                                          */
-       GnuplotFlags (const bool write_cell_number = false,
-                     const bool write_level       = false,
-                     const bool write_material    = false);
+       GnuplotFlags (const bool write_cell_number = false);
     };
 
                                     /**
@@ -405,9 +309,56 @@ class GridOut
 
                                     /**
                                      * Write the triangulation in the
-                                     * gnuplot format. See the general
-                                     * documentation for a description
-                                     * of what happens here.
+                                     * gnuplot format.
+                                     *
+                                     * In GNUPLOT format, each cell
+                                     * is written as a sequence of
+                                     * its confining lines. Apart
+                                     * from the coordinates of the
+                                     * line's end points, the level
+                                     * and the material of the cell
+                                     * are appended to each line of
+                                     * output. Therefore, if you let
+                                     * GNUPLOT draw a 2d grid as a 3d
+                                     * plot, you will see more
+                                     * refined cells being raised
+                                     * against cells with less
+                                     * refinement.  Also, if you draw
+                                     * a cut through a 3d grid, you
+                                     * can extrude the refinement
+                                     * level in the direction
+                                     * orthogonal to the cut
+                                     * plane. The same can be done
+                                     * with the material id, which is
+                                     * plotted after the level.
+                                     *
+                                     * A more useful application of
+                                     * this feature is the following:
+                                     * if you use the GNUPLOT
+                                     * command (for a 2d grid here)
+                                     * \begin{verbatim}
+                                     * splot [:][:][2.5:3.5] "grid_file.gnuplot" *
+                                     * \end{verbatim}
+                                     * then the
+                                     * whole x- and y-range will be
+                                     * plotted, i.e. the whole grid,
+                                     * but only those lines with a
+                                     * z-value between 2.5 and
+                                     * 3.5. Since the z-values were
+                                     * chosen to be the level to
+                                     * which a cell belongs, this
+                                     * results in a plot of those
+                                     * cells only that belong to
+                                     * level 3 in this example. This
+                                     * way, it is easy to produce
+                                     * plots of the different levels
+                                     * of grid.
+                                     *
+                                     * Names and values of additional
+                                     * flags controlling the output
+                                     * can be found in the
+                                     * documentation of the
+                                     * #GridOut::GnuplotFlags# class.
                                      */
     template <int dim>
     void write_gnuplot (const Triangulation<dim> &tria,
@@ -415,9 +366,38 @@ class GridOut
 
                                     /**
                                      * Write the triangulation in the
-                                     * ucd format. See the general
-                                     * documentation for a description
-                                     * of what happens here.
+                                     * ucd format.
+                                     *
+                                     * UCD (unstructured cell data)
+                                     * is the format used by AVS and
+                                     * some other programs. It is
+                                     * described in the AVS
+                                     * developer's guide. Besides the
+                                     * usual output of the grid
+                                     * only, you can decide through
+                                     * additional flags (see below,
+                                     * and the documentation of the
+                                     * #GridOut::UcdFlags# class)
+                                     * whether boundary faces with
+                                     * non-zero boundary indicator
+                                     * shall be written to the file
+                                     * explicitely. This is useful,
+                                     * if you want to re-read the
+                                     * grid later on, since
+                                     * #deal.II# sets the boundary
+                                     * indicator to zero by default;
+                                     * therefore, to obtain the
+                                     * same triangulation as before,
+                                     * you have to specify faces
+                                     * with differing boundary
+                                     * indicators explicitely, which
+                                     * is done by this flag.
+                                     *
+                                     * Names and values of further
+                                     * flags controlling the output
+                                     * can be found in the
+                                     * documentation of the
+                                     * #GridOut::UcdFlags# class.
                                      */
     template <int dim>
     void write_ucd (const Triangulation<dim> &tria,
@@ -425,9 +405,53 @@ class GridOut
 
                                     /**
                                      * Write the triangulation in the
-                                     * encapsulated postscript format. See the
-                                     * general documentation for a description
-                                     * of what happens here.
+                                     * encapsulated postscript format.
+                                     *
+                                     * In this format, each line of
+                                     * the triangulation is written
+                                     * separately. We scale the
+                                     * picture such that either
+                                     * x-values or y-values range
+                                     * between zero and a fixed
+                                     * size. The other axis is scaled
+                                     * by the same factor. Which axis
+                                     * is taken to compute the scale
+                                     * and the size of the box it
+                                     * shall fit into is determined
+                                     * by the output flags (see
+                                     * below, and the documentation
+                                     * of the #GridOut::EpsFlags#
+                                     * class).
+                                     *
+                                     * The bounding box is close to
+                                     * the triangulation on all four
+                                     * sides, without an extra
+                                     * frame. The line width is
+                                     * chosen to be 0.5 by default,
+                                     * but can be changed. The line
+                                     * width is to be compared with
+                                     * the extension of the picture,
+                                     * of which the default is 300.
+                                     *
+                                     * The flag @p
+                                     * color_lines_on_user_flag#
+                                     * allows to draw lines with the
+                                     * #user_flag# set to be drawn in
+                                     * red. The colors black and red
+                                     * are defined as #b# and #r# in
+                                     * the preamble of the output
+                                     * file and can be changed there
+                                     * according to need.
+                                     *
+                                     * Names and values of additional
+                                     * flags controlling the output
+                                     * can be found in the
+                                     * documentation of the
+                                     * #GridOut::EpsFlags#
+                                     * class. Especially the
+                                     * viewpoint for three
+                                     * dimensional grids is of
+                                     * importance here.
                                      */
     template <int dim>
     void write_eps (const Triangulation<dim> &tria,
index d0183a5c10651f8bbdedef2d0bd98fa0c4615209..983baaeb9bdc909c773867f5e462a0f8e9ceb121 100644 (file)
@@ -22,12 +22,8 @@ GridOut::UcdFlags::UcdFlags (const bool write_preamble,
 {}
 
 
-GridOut::GnuplotFlags::GnuplotFlags (const bool write_cell_numbers,
-                                    const bool write_level,
-                                    const bool write_material) :
-               write_cell_numbers (write_cell_numbers),
-               write_level (write_level),
-               write_material(write_material)
+GridOut::GnuplotFlags::GnuplotFlags (const bool write_cell_numbers) :
+               write_cell_numbers (write_cell_numbers)
 {}
 
 

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.