]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Provide more cross-references.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 30 May 2012 13:46:22 +0000 (13:46 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 30 May 2012 13:46:22 +0000 (13:46 +0000)
git-svn-id: https://svn.dealii.org/trunk@25571 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/include/deal.II/base/data_out_base.h

index a79adf59a721a58b7969fa1f48b71e9bbc93dc6b..0c732bd7f7cc2ac0efefcfab81f58c4f134c2865 100644 (file)
@@ -1715,6 +1715,8 @@ class DataOutBase
  * a group. The DataOutInterface::write_pvtu_record() function can
  * generate such a master record. Likewise,
  * DataOutInterface::write_visit_record() does the same for VisIt.
+ * Finally, for time dependent problems, you may also want to look
+ * at DataOutInterface::write_pvd_record()
  *
  * The use of this function is explained in step-40.
  */
@@ -2282,7 +2284,11 @@ class DataOutInterface : private DataOutBase
                                       * function can generate such a
                                       * master record. Likewise,
                                       * DataOutInterface::write_visit_record()
-                                      * does the same for VisIt.
+                                      * does the same for VisIt. Finally,
+                                      * DataOutInterface::write_pvd_record()
+                                     * can be used to group together
+                                     * the files that jointly make up
+                                     * a time dependent simulation.
                                       */
     void write_vtu (std::ostream &out) const;
 
@@ -2336,6 +2342,14 @@ class DataOutInterface : private DataOutBase
                                       * @note The use of this function is
                                       * explained in step-40.
                                       *
+                                     * @note In order to tell Paraview to
+                                     * group together multiple <code>pvtu</code>
+                                     * files that each describe one time
+                                     * step of a time dependent simulation,
+                                     * see the
+                                      * DataOutInterface::write_pvd_record()
+                                     * function.
+                                     *
                                       * @note At the time of writing,
                                       * the other big VTK-based
                                       * visualization program, VisIt,

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.