src/sampling/boundField/boundField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 Class
  26     boundField
  27
  28 Description
  29     FunctionObject reports min and max of a volScalarField and bounds it
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  33
  34 SourceFiles
  35     boundField.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef boundField_H
  40 #define boundField_H
  41
  42 #include "functionObject.H"
  43 #include "dictionary.H"
  44 #include "fvMesh.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                         Class boundField Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class boundField
  56 :
  57     public functionObject
  58 {
  59     // Private data
  60
  61         //- Name
  62         const word name_;
  63
  64         //- Reference to main object registry
  65         const Time& time_;
  66
  67         //- Region name
  68         word regionName_;
  69
  70         //- Field name
  71         word fieldName_;
  72
  73         //- Min value
  74         scalar minValue_;
  75
  76         //- Max value
  77         scalar maxValue_;
  78
  79
  80     // Private Member Functions
  81
  82         //- Disallow default bitwise copy construct
  83         boundField
  84         (
  85             const boundField&
  86         );
  87
  88         //- Disallow default bitwise assignment
  89         void operator=(const boundField&);
  90
  91
  92 public:
  93
  94     //- Runtime type information
  95     TypeName("boundField");
  96
  97
  98     // Constructors
  99
 100         //- Construct from components
 101         boundField
 102         (
 103             const word& name,
 104             const Time&,
 105             const dictionary&
 106         );
 107
 108
 109     // Member Functions
 110
 111         //- start is called at the start of the time-loop
 112         virtual bool start();
 113
 114         //- execute is called at each ++ or += of the time-loop
 115         virtual bool execute();
 116
 117         //- Read and set the function object if its data has changed
 118         virtual bool read(const dictionary& dict);
 119 };
 120
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 } // End namespace Foam
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 #endif
 129
 130 // ************************************************************************* //