fieldToCell.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, 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
90  (
91  const polyMesh& mesh,
92  const word& fieldName,
93  const scalar min,
94  const scalar max
95  );
96 
97  //- Construct from dictionary
99  (
100  const polyMesh& mesh,
101  const dictionary& dict
102  );
103 
104  //- Construct from Istream
106  (
107  const polyMesh& mesh,
108  Istream&
109  );
110 
111 
112  //- Destructor
113  virtual ~fieldToCell();
114 
115 
116  // Member Functions
118  virtual sourceType setType() const
119  {
120  return CELLSETSOURCE;
121  }
122 
123  virtual void applyToSet
124  (
125  const topoSetSource::setAction action,
126  topoSet&
127  ) const;
128 
129 };
130 
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 } // End namespace Foam
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 #endif
139 
140 // ************************************************************************* //
virtual ~fieldToCell()
Destructor.
Definition: fieldToCell.C:146
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
A class for handling words, derived from string.
Definition: word.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
dictionary dict
TypeName("fieldToCell")
Runtime type information.
dimensioned< Type > max(const dimensioned< Type > &, const dimensioned< Type > &)
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
A topoSetSource to select cells based on field values.
Definition: fieldToCell.H:49
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
const polyMesh & mesh() const
virtual sourceType setType() const
Definition: fieldToCell.H:117
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
Class with constructor to add usage string to table.
fieldToCell(const polyMesh &mesh, const word &fieldName, const scalar min, const scalar max)
Construct from components.
Definition: fieldToCell.C:102
dimensioned< Type > min(const dimensioned< Type > &, const dimensioned< Type > &)