src/sampling/probes/probesFunctionObject/probesFunctionObject.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Typedef
  25     Foam::probesFunctionObject
  26
  27 Description
  28     FunctionObject wrapper around probes to allow them to be created via the
  29     functions entry within controlDict.
  30
  31 SourceFiles
  32     probesFunctionObject.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef probesFunctionObject_H
  37 #define probesFunctionObject_H
  38
  39 #include "probes.H"
  40 #include "patchProbes.H"
  41 #include "OutputFilterFunctionObject.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47     typedef OutputFilterFunctionObject<probes> probesFunctionObject;
  48     typedef OutputFilterFunctionObject<patchProbes> patchProbesFunctionObject;
  49 }
  50
  51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  52
  53 #endif
  54
  55 // ************************************************************************* //