Skip to content
Snippets Groups Projects
Commit 2514121d authored by mattijs's avatar mattijs
Browse files

STYLE: mappedPatchFieldBase: added comment

parent e2e20fe8
Branches
Tags
No related merge requests found
...@@ -25,7 +25,18 @@ Class ...@@ -25,7 +25,18 @@ Class
Foam::mappedPatchFieldBase Foam::mappedPatchFieldBase
Description 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 SourceFiles
mappedPatchFieldBase.C mappedPatchFieldBase.C
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment