src/postProcessing/functionObjects/field/minMaxField/minMaxField.C

   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 Author
  26     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  27
  28 \*---------------------------------------------------------------------------*/
  29
  30 #include "minMaxField.H"
  31 #include "addToRunTimeSelectionTable.H"
  32 #include "volFields.H"
  33
  34 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  35
  36 namespace Foam
  37 {
  38     defineTypeNameAndDebug(minMaxField, 0);
  39
  40     addToRunTimeSelectionTable
  41     (
  42         functionObject,
  43         minMaxField,
  44         dictionary
  45     );
  46 }
  47
  48
  49 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
  50
  51
  52 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  53
  54 Foam::minMaxField::minMaxField
  55 (
  56     const word& name,
  57     const Time& t,
  58     const dictionary& dict
  59 )
  60 :
  61     functionObject(name),
  62     time_(t),
  63     regionName_(polyMesh::defaultRegion),
  64     fieldName_(dict.lookup("name"))
  65 {
  66     if (dict.found("region"))
  67     {
  68         dict.lookup("region") >> regionName_;
  69     }
  70
  71     Info<< "Creating minMaxField for field "
  72         << fieldName_ << endl;
  73 }
  74
  75
  76 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  77
  78 bool Foam::minMaxField::start()
  79 {
  80     return true;
  81 }
  82
  83
  84 bool Foam::minMaxField::execute()
  85 {
  86     const fvMesh& mesh =
  87         time_.lookupObject<fvMesh>(regionName_);
  88
  89     if (mesh.foundObject<volScalarField>(fieldName_))
  90     {
  91         const volScalarField& f = mesh.lookupObject<volScalarField>
  92         (
  93             fieldName_
  94         );
  95
  96         Info<< "Field " << fieldName_ << " min = " << Foam::min(f).value()
  97             << " max = " << Foam::max(f).value() << endl;
  98
  99         return true;
 100     }
 101     else if (mesh.foundObject<volVectorField>(fieldName_))
 102     {
 103         const volVectorField& f = mesh.lookupObject<volVectorField>(fieldName_);
 104
 105         volScalarField magF = mag(f);
 106
 107         Info<< "Field " << fieldName_ << " magnitude min = "
 108             << Foam::min(magF).value()
 109             << " max = " << Foam::max(magF).value() << endl;
 110
 111         return true;
 112     }
 113     else
 114     {
 115         Info<< "Field "  << fieldName_ << " not found.  Skipping." << endl;
 116
 117         return false;
 118     }
 119 }
 120
 121
 122 bool Foam::minMaxField::read(const dictionary& dict)
 123 {
 124     fieldName_ = word(dict.lookup("name"));
 125
 126     if (dict.found("region"))
 127     {
 128         dict.lookup("region") >> regionName_;
 129     }
 130
 131     return false;
 132 }
 133
 134 // ************************************************************************* //