From fba69f360faa2310fa6ecd6b267408d99645be5a Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Wed, 9 Nov 2022 17:22:52 -0700 Subject: [PATCH] Add a documentation note. --- include/deal.II/numerics/data_postprocessor.h | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/include/deal.II/numerics/data_postprocessor.h b/include/deal.II/numerics/data_postprocessor.h index ea67c6f89a..2188864ab4 100644 --- a/include/deal.II/numerics/data_postprocessor.h +++ b/include/deal.II/numerics/data_postprocessor.h @@ -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é 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 -- 2.39.5