From 12cef5bf9ac01f33d736198b24691f798a2342ec Mon Sep 17 00:00:00 2001 From: bangerth Date: Wed, 1 May 2013 12:35:10 +0000 Subject: [PATCH] Comment on the fact that VTK is a legacy format. People should be using VTU instead. git-svn-id: https://svn.dealii.org/trunk@29417 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/base/data_out_base.h | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/deal.II/include/deal.II/base/data_out_base.h b/deal.II/include/deal.II/base/data_out_base.h index a8124528fc..14ea5b84d4 100644 --- a/deal.II/include/deal.II/base/data_out_base.h +++ b/deal.II/include/deal.II/base/data_out_base.h @@ -1693,6 +1693,13 @@ public: * provisions that allow these components to be output by a single * name rather than having to group several scalar fields into a * vector later on in the visualization program. + * + * @note VTK is a legacy format and has largely been supplanted by the VTU + * format (an XML-structured version of VTK). In particular, VTU allows for + * the compression of data and consequently leads to much smaller file + * sizes that equivalent VTK files for large files. Since all visualization + * programs that support VTK also support VTU, you should consider using the + * latter file format instead, by using the write_vtu() function. */ template static void write_vtk (const std::vector > &patches, @@ -1703,7 +1710,7 @@ public: /** - * Write the given list of patches to the output stream in VTK + * Write the given list of patches to the output stream in VTU * format. The data is written in the XML-based VTK format as opposed to the * traditional format that write_vtk() produces. * @@ -2290,6 +2297,13 @@ public: * and write it to out * in Vtk format. See * DataOutBase::write_vtk. + * + * @note VTK is a legacy format and has largely been supplanted by the VTU + * format (an XML-structured version of VTK). In particular, VTU allows for + * the compression of data and consequently leads to much smaller file + * sizes that equivalent VTK files for large files. Since all visualization + * programs that support VTK also support VTU, you should consider using the + * latter file format instead, by using the write_vtu() function. */ void write_vtk (std::ostream &out) const; -- 2.39.5