src/postProcessing/functionObjects/field/minMaxField/minMaxField.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     minMaxField
  26
  27 Description
  28     FunctionObject reports min and max of a volField
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 SourceFiles
  34     minMaxField.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef minMaxField_H
  39 #define minMaxField_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 minMaxField Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class minMaxField
  55 :
  56     public functionObject
  57 {
  58     // Private data
  59
  60         //- Reference to main object registry
  61         const Time& time_;
  62
  63         //- Region name
  64         word regionName_;
  65
  66         //- Field name
  67         word fieldName_;
  68
  69
  70     // Private Member Functions
  71
  72         //- Disallow default bitwise copy construct
  73         minMaxField
  74         (
  75             const minMaxField&
  76         );
  77
  78         //- Disallow default bitwise assignment
  79         void operator=(const minMaxField&);
  80
  81
  82 public:
  83
  84     //- Runtime type information
  85     TypeName("minMaxField");
  86
  87
  88     // Constructors
  89
  90         //- Construct from components
  91         minMaxField
  92         (
  93             const word& name,
  94             const Time&,
  95             const dictionary&
  96         );
  97
  98
  99     // Member Functions
 100
 101         //- start is called at the start of the time-loop
 102         virtual bool start();
 103
 104         //- execute is called at each ++ or += of the time-loop
 105         virtual bool execute();
 106
 107         //- Read and set the function object if its data has changed
 108         virtual bool read(const dictionary& dict);
 109 };
 110
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 } // End namespace Foam
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 #endif
 119
 120 // ************************************************************************* //