src/meshTools/sets/cellSources/fieldToCell/fieldToCell.H

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