From 2514121d78e5903706e1cc20c13144600bc34ce8 Mon Sep 17 00:00:00 2001
From: mattijs <mattijs>
Date: Thu, 11 Apr 2013 15:12:29 +0100
Subject: [PATCH] STYLE: mappedPatchFieldBase: added comment
---
.../derived/mappedField/mappedPatchFieldBase.H | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedPatchFieldBase.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedPatchFieldBase.H
index 50728410949..22a3872effe 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedPatchFieldBase.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedPatchFieldBase.H
@@ -25,7 +25,18 @@ Class
Foam::mappedPatchFieldBase
Description
- Functionality for sampling fields using mappedPatchBase.
+ Functionality for sampling fields using mappedPatchBase. Every call to
+ mappedField() returns a sampled field, optionally scaled to maintain an
+ area-weighted average.
+
+ Example usage:
+
+ {
+ fieldName T; // default is same as fvPatchField
+ setAverage false;
+ average 1.0; // only if setAverage=true
+ interpolationScheme cellPoint; // default is cell
+ }
SourceFiles
mappedPatchFieldBase.C
--
GitLab