From 5378fd5b71e17d2154008da26466274a0845b8d6 Mon Sep 17 00:00:00 2001
From: Simon Praetorius <simon.praetorius@tu-dresden.de>
Date: Mon, 27 Aug 2018 23:20:04 +0200
Subject: [PATCH] Cleanup of some documentation
---
dune/vtk/datacollector.hh | 16 +++++++++++++++-
dune/vtk/writers/vtkimagedatawriter.hh | 6 +++++-
dune/vtk/writers/vtkrectilineargridwriter.hh | 6 +++++-
dune/vtk/writers/vtkstructuredgridwriter.hh | 6 +++++-
dune/vtk/writers/vtkunstructuredgridwriter.hh | 4 ++++
5 files changed, 34 insertions(+), 4 deletions(-)
diff --git a/dune/vtk/datacollector.hh b/dune/vtk/datacollector.hh
index a5bd9fc..6c384f0 100644
--- a/dune/vtk/datacollector.hh
+++ b/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>
diff --git a/dune/vtk/writers/vtkimagedatawriter.hh b/dune/vtk/writers/vtkimagedatawriter.hh
index 43bed33..ada9fd9 100644
--- a/dune/vtk/writers/vtkimagedatawriter.hh
+++ b/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>
diff --git a/dune/vtk/writers/vtkrectilineargridwriter.hh b/dune/vtk/writers/vtkrectilineargridwriter.hh
index 3c7c62e..d92f41b 100644
--- a/dune/vtk/writers/vtkrectilineargridwriter.hh
+++ b/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>
diff --git a/dune/vtk/writers/vtkstructuredgridwriter.hh b/dune/vtk/writers/vtkstructuredgridwriter.hh
index 8fcd788..0a0d476 100644
--- a/dune/vtk/writers/vtkstructuredgridwriter.hh
+++ b/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>
diff --git a/dune/vtk/writers/vtkunstructuredgridwriter.hh b/dune/vtk/writers/vtkunstructuredgridwriter.hh
index 44a4aa8..049a495 100644
--- a/dune/vtk/writers/vtkunstructuredgridwriter.hh
+++ b/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>
--
GitLab