From 5842b48851f9a609de53e19ce9d6586baf90569c Mon Sep 17 00:00:00 2001 From: wolf Date: Mon, 25 Jul 2005 15:43:33 +0000 Subject: [PATCH] Add some better documentation. git-svn-id: https://svn.dealii.org/trunk@11192 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/numerics/data_out.h | 25 ++++++++++++------- .../deal.II/include/numerics/data_out_faces.h | 2 +- .../deal.II/include/numerics/data_out_stack.h | 2 +- 3 files changed, 18 insertions(+), 11 deletions(-) diff --git a/deal.II/deal.II/include/numerics/data_out.h b/deal.II/deal.II/include/numerics/data_out.h index 6796ebaaff..2c8aefc248 100644 --- a/deal.II/deal.II/include/numerics/data_out.h +++ b/deal.II/deal.II/include/numerics/data_out.h @@ -742,15 +742,22 @@ class DataOut_DoFData : public DataOutInterface * stored in the base class. Most of the interface and an example of its * use is described in the documentation of the base class. * - * The only thing this class offers is the function @p build_patches which - * loops over all cells of the triangulation stored by the @p attach_dof_handler - * function of the base class and convert the data on these to actual patches - * which are the objects that are later output by the functions of the - * base classes. You can give a parameter to the function which determines - * how many subdivisions in each coordinate direction are to be performed, - * i.e. of how many subcells each patch shall consist. Default is one, but - * for quadratic elements you may want to choose two, for cubic elements three, - * and so on. + * The only thing this class offers is the function build_patches() which + * loops over all cells of the triangulation stored by the + * attach_dof_handler() function of the base class and convert the data on + * these to actual patches which are the objects that are later output by the + * functions of the base classes. You can give a parameter to the function + * which determines how many subdivisions in each coordinate direction are to + * be performed, i.e. of how many subcells each patch shall consist. Default + * is one, but you may want to choose a higher number for higher order + * elements, so as two for quadratic elements, three for cubic elements three, + * and so on. The purpose of this parameter is because most graphics programs + * do not allow to specify higher order shape functions in the file formats: + * only data at vertices can be plotted and is then shown as a bilinear + * interpolation within the interior of cells. This may be insufficient if you + * have higher order finite elements, and the only way to achieve better + * output is to subdivide each cell of the mesh into several cells for + * graphical output. * * Note that after having called @p build_patches once, you can call one or * more of the write_* functions of the base classes. You can therefore diff --git a/deal.II/deal.II/include/numerics/data_out_faces.h b/deal.II/deal.II/include/numerics/data_out_faces.h index 894088dc1a..f8f582e415 100644 --- a/deal.II/deal.II/include/numerics/data_out_faces.h +++ b/deal.II/deal.II/include/numerics/data_out_faces.h @@ -38,7 +38,7 @@ template class DoFHandler; * * The interface of this class is copied from the DataOut * class. Furthermore, they share the common parent class - * DataOut_DoFData(). See the reference of these two classes for a + * DataOut_DoFData. See the reference of these two classes for a * discussion of the interface. * * diff --git a/deal.II/deal.II/include/numerics/data_out_stack.h b/deal.II/deal.II/include/numerics/data_out_stack.h index 3b364af796..62500f5d88 100644 --- a/deal.II/deal.II/include/numerics/data_out_stack.h +++ b/deal.II/deal.II/include/numerics/data_out_stack.h @@ -32,7 +32,7 @@ template class DoFHandler; * space-time output file, or for example to connect the results of * solutions of a parameter dependent equation for several parameter * value together into one. The interface is mostly modelled after the - * DataOut class. + * DataOut class, see there for some more documentation. * * We will explain the concept for a time dependent problem, but * instead of the time any parameter can be substituted. In our -- 2.39.5