STYLE: mappedPatchFieldBase: added comment

This commit is contained in:
mattijs
2013-04-11 15:12:29 +01:00
parent e2e20fe87e
commit 2514121d78

View File

@ -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