From a48897c558b9628dffccee3551467408f6f09750 Mon Sep 17 00:00:00 2001
From: mattijs <mattijs>
Date: Fri, 15 Oct 2010 10:43:18 +0100
Subject: [PATCH] STYLE: directMapped : updated comment

---
 .../directMappedFixedValueFvPatchField.H                  | 8 +++++++-
 .../directMappedVelocityFluxFixedValueFvPatchField.H      | 5 +++++
 .../directMappedPolyPatch/directMappedPatchBase.H         | 8 ++++----
 3 files changed, 16 insertions(+), 5 deletions(-)

diff --git a/src/finiteVolume/fields/fvPatchFields/derived/directMappedFixedValue/directMappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/directMappedFixedValue/directMappedFixedValueFvPatchField.H
index e672c07e926..8d6038913ed 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/directMappedFixedValue/directMappedFixedValueFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/directMappedFixedValue/directMappedFixedValueFvPatchField.H
@@ -25,7 +25,13 @@ Class
     Foam::directMappedFixedValueFvPatchField
 
 Description
-    Recycles the value at a set of internal faces back to *this.
+    Recycles the value at a set of cells or patch faces back to *this. Can not
+    sample internal faces (since volField not defined on faces).
+
+    mode = NEARESTCELL : sample nearest cell
+    mode = NEARESTPATCHFACE : sample nearest face on selected patch
+    mode = NEARESTFACE : sample nearest face on any patch. Note: does not
+                         warn if nearest actually is on internal face!
 
 SourceFiles
     directMappedFixedValueFvPatchField.C
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/directMappedVelocityFluxFixedValue/directMappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/directMappedVelocityFluxFixedValue/directMappedVelocityFluxFixedValueFvPatchField.H
index 95f3954a1ad..3aecda00c0d 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/directMappedVelocityFluxFixedValue/directMappedVelocityFluxFixedValueFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/directMappedVelocityFluxFixedValue/directMappedVelocityFluxFixedValueFvPatchField.H
@@ -27,6 +27,11 @@ Class
 Description
     Recycles the velocity and flux at a patch to this patch
 
+    mode = NEARESTCELL : sample nearest cell
+    mode = NEARESTPATCHFACE : sample nearest face on selected patch
+    mode = NEARESTFACE : sample nearest face on any patch. Note: does not
+                         warn if nearest actually is on internal face!
+
 SourceFiles
     directMappedVelocityFluxFixedValueFvPatchField.C
 
diff --git a/src/meshTools/directMapped/directMappedPolyPatch/directMappedPatchBase.H b/src/meshTools/directMapped/directMappedPolyPatch/directMappedPatchBase.H
index 9d3fd3a6229..577f014dee7 100644
--- a/src/meshTools/directMapped/directMappedPolyPatch/directMappedPatchBase.H
+++ b/src/meshTools/directMapped/directMappedPolyPatch/directMappedPatchBase.H
@@ -66,9 +66,9 @@ public:
         //- Mesh items to sample
         enum sampleMode
         {
-            NEARESTCELL,
-            NEARESTPATCHFACE,
-            NEARESTFACE
+            NEARESTCELL,        // nearest cell
+            NEARESTPATCHFACE,   // faces on selected patch
+            NEARESTFACE         // nearest face
         };
 
 private:
@@ -201,7 +201,7 @@ public:
             return sampleRegion_;
         }
 
-        //- Patch (only if NEARESTBOUNDARY)
+        //- Patch (only if NEARESTPATCHFACE)
         const word& samplePatch() const
         {
             return samplePatch_;
-- 
GitLab