From aa2bc1745a386ba64cd709a2674bc1c25ea477ee Mon Sep 17 00:00:00 2001
From: andy <andy>
Date: Thu, 8 Dec 2011 12:03:32 +0000
Subject: [PATCH] STYLE: Added description to oscillatingFixedValue BC header

---
 .../oscillatingFixedValueFvPatchField.H       | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H
index 9a3120a69d..ba84bc1c26 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H
@@ -25,7 +25,24 @@ Class
     Foam::oscillatingFixedValueFvPatchField
 
 Description
-    Foam::oscillatingFixedValueFvPatchField
+    Describes an oscillating boundary condition in terms of amplitude and
+    frequency.
+
+    Example of the boundary condition specification:
+    \verbatim
+    inlet
+    {
+        type            oscillatingFixedValue;
+        refValue        uniform 5.0;
+        offset          0.0;                    // optional
+        amplitude       constant 0.5;
+        frequency       constant 10;
+    }
+    \endverbatim
+
+    The amplitude and frequency entries are DataEntry types, able to describe
+    time varying functions.  The example above gives the usage for supplying
+    constant values.
 
 SourceFiles
     oscillatingFixedValueFvPatchField.C