src/meshTools/sets/cellSources/fieldToCell/fieldToCell.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     Foam::fieldToCell
  26
  27 Description
  28     A topoSetSource to select cells based on field values.
  29
  30 SourceFiles
  31     fieldToCell.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef fieldToCell_H
  36 #define fieldToCell_H
  37
  38 #include "topoSetSource.H"
  39 #include "scalarField.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class fieldToCell Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class fieldToCell
  51 :
  52     public topoSetSource
  53 {
  54
  55     // Private data
  56
  57         //- Add usage string
  58         static addToUsageTable usage_;
  59
  60
  61         //- Name of volScalarField
  62         word fieldName_;
  63
  64         //- min to subset field values with
  65         scalar min_;
  66
  67         //- max ,,
  68         scalar max_;
  69
  70
  71     // Private Member Functions
  72
  73         //- Depending on field values add to or delete from cellSet.
  74         void applyToSet
  75         (
  76             const topoSetSource::setAction action,
  77             const scalarField& field,
  78             topoSet& set
  79         ) const;
  80
  81 public:
  82
  83     //- Runtime type information
  84     TypeName("fieldToCell");
  85
  86     // Constructors
  87
  88         //- Construct from components
  89         fieldToCell
  90         (
  91             const polyMesh& mesh,
  92             const word& fieldName,
  93             const scalar min,
  94             const scalar max
  95         );
  96
  97         //- Construct from dictionary
  98         fieldToCell
  99         (
 100             const polyMesh& mesh,
 101             const dictionary& dict
 102         );
 103
 104         //- Construct from Istream
 105         fieldToCell
 106         (
 107             const polyMesh& mesh,
 108             Istream&
 109         );
 110
 111
 112     // Destructor
 113
 114         virtual ~fieldToCell();
 115
 116
 117     // Member Functions
 118
 119         virtual void applyToSet
 120         (
 121             const topoSetSource::setAction action,
 122             topoSet&
 123         ) const;
 124
 125 };
 126
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 } // End namespace Foam
 131
 132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 133
 134 #endif
 135
 136 // ************************************************************************* //