src/sampling/boundField/boundField.C

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