From e7a4a3a73dd835dd8ea16c024680132ddde625b2 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@Germany>
Date: Wed, 14 Dec 2016 17:54:23 +0100
Subject: [PATCH] STYLE: some documentation for sampledSurfaces specification

---
 .../sampledSurfaces/sampledSurfaces.H         | 35 +++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/src/sampling/sampledSurface/sampledSurfaces/sampledSurfaces.H b/src/sampling/sampledSurface/sampledSurfaces/sampledSurfaces.H
index 8d610dbb59..aaa66caa13 100644
--- a/src/sampling/sampledSurface/sampledSurfaces/sampledSurfaces.H
+++ b/src/sampling/sampledSurface/sampledSurfaces/sampledSurfaces.H
@@ -29,6 +29,41 @@ Description
 
     The write() method is used to sample and write files.
 
+    Example of function object specification:
+
+    \verbatim
+    surfaces
+    {
+        type    surfaces;
+        libs    ("libsampling.so");
+
+        // Write at same frequency as fields
+        writeControl    outputTime;
+        writeInterval   1;
+
+        // Fields to be sampled
+        fields          (p U);
+
+        // Interpolation scheme to use
+        interpolationScheme cell;
+
+        // Output surface format
+        surfaceFormat   vtk;
+        formatOptions   {  }
+
+        surfaces
+        (
+            f0surf
+            {
+                type        sampledTriSurfaceMesh;
+                surface     f0surf.obj;
+                source      cells;
+                keepIds     true;
+            }
+        );
+    }
+    \endverbatim
+
 SourceFiles
     sampledSurfaces.C