]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Slightly reword DataOutResample's documentation. 14042/head
authorDavid Wells <drwells@email.unc.edu>
Fri, 24 Jun 2022 13:55:18 +0000 (09:55 -0400)
committerDavid Wells <drwells@email.unc.edu>
Fri, 24 Jun 2022 13:55:18 +0000 (09:55 -0400)
It is better to start with what a class does than what it does not.

include/deal.II/numerics/data_out_resample.h

index b87305191d116fbe404124a11ad24534349ad325..05402c0077ce556c93c2f19a95c6c89c1b4be04c 100644 (file)
 DEAL_II_NAMESPACE_OPEN
 
 /**
- * A DataOut-like class that does not output a numerical solution on
- * the cells of the original triangulation but interpolates the result onto a
- * second triangulation (that can be completely unrelated).
- * By using this class, one can output the result obtained on an unstructured
- * mesh onto a structured one or one can create a slice in 3D.
+ * A DataOut-like class which interpolates values defined on one Triangulation
+ * onto a second potentially unrelated Triangulation. By using this class,
+ * one can output the result obtained on an unstructured mesh onto a
+ * structured one or one can create a slice in 3D.
  *
  * The following code snippet shows the steps how to use the class when the
  * solution is given for a three dimensional triangulation and the result

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.