Packaged function objects: added a Description entry

This commit is contained in:
Chris Greenshields
2016-06-11 08:53:04 +01:00
parent 9cf8bd8313
commit 605c489d5f
48 changed files with 454 additions and 241 deletions

View File

@ -1,14 +1,17 @@
/*--------------------------------*- C++ -*----------------------------------*\
| ========= | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox |
| \\ / O peration | Version: dev |
| \\ / A nd | Web: www.OpenFOAM.org |
| \\/ M anipulation | |
\*---------------------------------------------------------------------------*/
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Web: www.OpenFOAM.org
\\/ M anipulation |
-------------------------------------------------------------------------------
Description
Calculates volumetric flow rate through a specified triangulated surface
by interpolating velocity onto the triangles and integrating over the
surface area. Triangles need to be small (<= cell size) for an accurate
result.
// This packaged function object interpolates velocity U onto triangles in
// triSurface file and integrates over the surface area. Triangles need to
// be small (<= cell size) for an accurate integration.
\*---------------------------------------------------------------------------*/
volFlowRateSurface
{