From ac4ac230a9ba81d46a9426111c6df503f0bba18e Mon Sep 17 00:00:00 2001 From: wolf Date: Tue, 31 May 2005 18:57:33 +0000 Subject: [PATCH] Augment documentation. git-svn-id: https://svn.dealii.org/trunk@10795 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/numerics/data_out.h | 52 +++++++++++++++------ 1 file changed, 39 insertions(+), 13 deletions(-) diff --git a/deal.II/deal.II/include/numerics/data_out.h b/deal.II/deal.II/include/numerics/data_out.h index 29dfdc3e2d..433d4f514b 100644 --- a/deal.II/deal.II/include/numerics/data_out.h +++ b/deal.II/deal.II/include/numerics/data_out.h @@ -821,23 +821,49 @@ class DataOut : public DataOut_DoFData * threads to be used to build * the patches is set to * multithread_info.n_default_threads. - * - * The optional parameter - * defining a mapping is especially - * intended for the Eulerian mapping. - * It offers an opportunity to - * watch the solution on the - * deformed triangulational on which - * the computation was actually carried - * out. */ - virtual void build_patches (const Mapping &mapping, - const unsigned int n_subdivisions = 1, - const unsigned int n_threads = multithread_info.n_default_threads); - virtual void build_patches (const unsigned int n_subdivisions = 1, const unsigned int n_threads = multithread_info.n_default_threads); + /** + * Same as above, except that the + * additional first parameter + * defines a mapping that is to + * be used in the generation of + * output. For internal reasons, + * even if + * n_subdivisions>1, the + * points interior of subdivided + * patches are still computed + * from the vertices of the cell, + * i.e. even a higher order + * mapping does not lead to a + * representation of a curved + * boundary by using more + * subdivisions. However, the + * mapping argument can be used + * for the Eulerian mappings (see + * class MappingQ1Eulerian) where + * a mapping is used not only to + * determine the position of + * points interior to a cell, but + * also of the vertices. It + * offers an opportunity to watch + * the solution on a deformed + * triangulation on which the + * computation was actually + * carried out, even if the mesh + * is internally stored in its + * undeformed configuration and + * the deformation is only + * tracked by an additional + * vector that holds the + * deformation of each vertex. + */ + virtual void build_patches (const Mapping &mapping, + const unsigned int n_subdivisions = 1, + const unsigned int n_threads = multithread_info.n_default_threads); + /** * Return the first cell which we * want output for. The default -- 2.39.5