]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add a documentation note. 14407/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Thu, 10 Nov 2022 00:22:52 +0000 (17:22 -0700)
committerWolfgang Bangerth <bangerth@colostate.edu>
Thu, 10 Nov 2022 00:22:52 +0000 (17:22 -0700)
include/deal.II/numerics/data_postprocessor.h

index ea67c6f89a77566d4c0d83d95bc086eae09dfeec..2188864ab42f0274a6afadab49d8255035107241 100644 (file)
@@ -1120,7 +1120,7 @@ private:
  *                               data_component_interpretation);
  *     data_out.add_data_vector (solution, grad_u);
  *     data_out.build_patches ();
- *     data_out.write_vtk (output);
+ *     data_out.write_vtu (output);
  * @endcode
  *
  * This leads to the following output for the displacement field (i.e., the
@@ -1187,6 +1187,16 @@ private:
  * strain by multiplication with either the strain-stress tensor or,
  * in simple cases, the Lam&eacute; constants.
  *
+ * @note Not all graphical output formats support writing tensor data. For
+ *   example, the VTU file format used above when calling `data_out.write_vtu()`
+ *   does, but the original VTK file format does not (or at least
+ *   deal.II's output function does not support writing tensors at
+ *   the time of writing). If the file format you want to output does not
+ *   support writing tensor data, you will get an error. Since most
+ *   visualization programs today support VTU format, and since the
+ *   VTU writer supports writing tensor data, there should always be
+ *   a way for you to output tensor data that you can visualize.
+ *
  * @ingroup output
  */
 template <int dim>

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.