Cleanup of some documentation

dune/vtk/datacollector.hh

@@ -42,6 +42,12 @@ public:
     asDerived().updateImpl();
   }
 
+  /// Return the number of overlapping elements
+  int ghostLevel () const
+  {
+    return asDerived().ghostLevelImpl();
+  }
+
   /// \brief Return a flat vector of point coordinates
   /**
    * All coordinates are extended to 3 components and concatenated.
@@ -104,7 +110,15 @@ protected: // default implementations
     return gridView_.size(0);
   }
 
-  void updateImpl () { /* do nothing */ }
+  void updateImpl ()
+  {
+    /* do nothing */
+  }
+
+  int ghostLevelImpl () const
+  {
+    return gridView_.overlapSize(0);
+  }
 
   // Evaluate `fct` in center of cell
   template <class T, class GlobalFunction>

dune/vtk/writers/vtkimagedatawriter.hh

@@ -14,7 +14,11 @@
 
 namespace Dune { namespace experimental
 {
-  /// File-Writer for VTK .vtu files
+  /// File-Writer for ImageData VTK .vti files
+  /**
+   * Requirement:
+   * - DataCollector must be a model of \ref StructuredDataCollector
+   **/
   template <class GridView, class DataCollector = StructuredDataCollector<GridView>>
   class VtkImageDataWriter
       : public VtkWriterInterface<GridView, DataCollector>

dune/vtk/writers/vtkrectilineargridwriter.hh

@@ -14,7 +14,11 @@
 
 namespace Dune { namespace experimental
 {
-  /// File-Writer for VTK .vtu files
+  /// File-Writer for RectilinearGrid VTK .vtr files
+  /**
+   * Requirement:
+   * - DataCollector must be a model of \ref StructuredDataCollector
+   **/
   template <class GridView, class DataCollector = StructuredDataCollector<GridView>>
   class VtkRectilinearGridWriter
       : public VtkWriterInterface<GridView, DataCollector>

dune/vtk/writers/vtkstructuredgridwriter.hh

@@ -14,7 +14,11 @@
 
 namespace Dune { namespace experimental
 {
-  /// File-Writer for VTK .vtu files
+  /// File-Writer for StructuredGrid VTK .vts files
+  /**
+   * Requirement:
+   * - DataCollector must be a model of \ref StructuredDataCollector
+   **/
   template <class GridView, class DataCollector = StructuredDataCollector<GridView>>
   class VtkStructuredGridWriter
       : public VtkWriterInterface<GridView, DataCollector>

dune/vtk/writers/vtkunstructuredgridwriter.hh

@@ -15,6 +15,10 @@
 namespace Dune { namespace experimental
 {
   /// File-Writer for VTK .vtu files
+  /**
+   * Requirement:
+   * - DataCollector must be a model of \ref DataCollector
+   **/
   template <class GridView, class DataCollector = DefaultDataCollector<GridView>>
   class VtkUnstructuredGridWriter
       : public VtkWriterInterface<GridView, DataCollector>