src/sampling/boundField/boundField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     boundField
  26
  27 Description
  28     FunctionObject reports min and max of a volScalarField and bounds it
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 SourceFiles
  34     boundField.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef boundField_H
  39 #define boundField_H
  40
  41 #include "functionObject.H"
  42 #include "dictionary.H"
  43 #include "fvMesh.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                         Class boundField Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class boundField
  55 :
  56     public functionObject
  57 {
  58     // Private data
  59
  60         //- Name
  61         const word name_;
  62
  63         //- Reference to main object registry
  64         const Time& time_;
  65
  66         //- Region name
  67         word regionName_;
  68
  69         //- Field name
  70         word fieldName_;
  71
  72         //- Min value
  73         scalar minValue_;
  74
  75         //- Max value
  76         scalar maxValue_;
  77
  78
  79     // Private Member Functions
  80
  81         //- Disallow default bitwise copy construct
  82         boundField
  83         (
  84             const boundField&
  85         );
  86
  87         //- Disallow default bitwise assignment
  88         void operator=(const boundField&);
  89
  90
  91 public:
  92
  93     //- Runtime type information
  94     TypeName("boundField");
  95
  96
  97     // Constructors
  98
  99         //- Construct from components
 100         boundField
 101         (
 102             const word& name,
 103             const Time&,
 104             const dictionary&
 105         );
 106
 107
 108     // Member Functions
 109
 110         //- start is called at the start of the time-loop
 111         virtual bool start();
 112
 113         //- execute is called at each ++ or += of the time-loop
 114         virtual bool execute();
 115
 116         //- Read and set the function object if its data has changed
 117         virtual bool read(const dictionary& dict);
 118 };
 119
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 } // End namespace Foam
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 #endif
 128
 129 // ************************************************************************* //