applications/utilities/postProcessing/patch/patchAverage/patchAverage.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Application
  26     patchAverage
  27
  28 Description
  29     Calculates the average of the specified field over the specified patch.
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #include "fvCFD.H"
  34
  35 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  36 // Main program:
  37
  38 int main(int argc, char *argv[])
  39 {
  40     timeSelector::addOptions();
  41     argList::validArgs.append("fieldName");
  42     argList::validArgs.append("patchName");
  43 #   include "setRootCase.H"
  44 #   include "createTime.H"
  45     instantList timeDirs = timeSelector::select0(runTime, args);
  46 #   include "createMesh.H"
  47
  48     word fieldName(args.additionalArgs()[0]);
  49     word patchName(args.additionalArgs()[1]);
  50
  51     forAll(timeDirs, timeI)
  52     {
  53         runTime.setTime(timeDirs[timeI], timeI);
  54         Info<< "Time = " << runTime.timeName() << endl;
  55
  56         IOobject fieldHeader
  57         (
  58             fieldName,
  59             runTime.timeName(),
  60             mesh,
  61             IOobject::MUST_READ
  62         );
  63
  64         // Check field exists
  65         if (fieldHeader.headerOk())
  66         {
  67             mesh.readUpdate();
  68
  69             label patchi = mesh.boundaryMesh().findPatchID(patchName);
  70             if (patchi < 0)
  71             {
  72                 FatalError
  73                     << "Unable to find patch " << patchName << nl
  74                     << exit(FatalError);
  75             }
  76
  77             if (fieldHeader.headerClassName() == "volScalarField")
  78             {
  79                 Info<< "    Reading volScalarField " << fieldName << endl;
  80                 volScalarField field(fieldHeader, mesh);
  81
  82                 scalar area = gSum(mesh.magSf().boundaryField()[patchi]);
  83                 scalar sumField = 0;
  84
  85                 if (area > 0)
  86                 {
  87                     sumField = gSum
  88                     (
  89                         mesh.magSf().boundaryField()[patchi]
  90                       * field.boundaryField()[patchi]
  91                     ) / area;
  92                 }
  93
  94                 Info<< "    Average of " << fieldName << " over patch "
  95                     << patchName << '[' << patchi << ']' << " = "
  96                     << sumField << endl;
  97             }
  98             else
  99             {
 100                 FatalError
 101                     << "Only possible to average volScalarFields "
 102                     << nl << exit(FatalError);
 103             }
 104         }
 105         else
 106         {
 107             Info<< "    No field " << fieldName << endl;
 108         }
 109
 110         Info<< endl;
 111     }
 112
 113     Info<< "End\n" << endl;
 114
 115     return 0;
 116 }
 117
 118 // ************************************************************************* //