pointToCell.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-2012 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::pointToCell
26 
27 Description
28  A topoSetSource to select cells based on usage of points.
29 
30 SourceFiles
31  pointToCell.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef pointToCell_H
36 #define pointToCell_H
37 
38 #include "topoSetSource.H"
39 #include "NamedEnum.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class pointToCell Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class pointToCell
51 :
52  public topoSetSource
53 {
54 public:
55  //- Enumeration defining the valid options
56  enum pointAction
57  {
58  ANY, // Cells using any point in set
59  EDGE // Cells using an edge with both points in set
60  //ALL // Possible extension: cells whose all points are in set
61  };
62 
63 private:
64 
65  //- Add usage string
66  static addToUsageTable usage_;
67 
68  static const NamedEnum<pointAction, 2> pointActionNames_;
69 
70  //- Name of set to use
71  word setName_;
72 
73  //- Option
74  pointAction option_;
75 
76 
77  // Private Member Functions
78 
79  //- Depending on point-to-cell option add to or delete from cellSet.
80  void combine(topoSet& set, const bool add) const;
81 
82 
83 public:
84 
85  //- Runtime type information
86  TypeName("pointToCell");
87 
88  // Constructors
89 
90  //- Construct from components
92  (
93  const polyMesh& mesh,
94  const word& setName,
95  const pointAction option
96  );
97 
98  //- Construct from dictionary
100  (
101  const polyMesh& mesh,
102  const dictionary& dict
103  );
104 
105  //- Construct from Istream
107  (
108  const polyMesh& mesh,
109  Istream&
110  );
111 
112 
113  //- Destructor
114  virtual ~pointToCell();
115 
116 
117  // Member Functions
119  virtual sourceType setType() const
120  {
121  return CELLSETSOURCE;
122  }
123 
124  virtual void applyToSet
125  (
126  const topoSetSource::setAction action,
127  topoSet&
128  ) const;
129 
130 };
131 
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 } // End namespace Foam
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 #endif
140 
141 // ************************************************************************* //
dictionary dict
virtual ~pointToCell()
Destructor.
Definition: pointToCell.C:154
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
virtual sourceType setType() const
Definition: pointToCell.H:118
TypeName("pointToCell")
Runtime type information.
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
const polyMesh & mesh() const
A class for handling words, derived from string.
Definition: word.H:59
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
pointAction
Enumeration defining the valid options.
Definition: pointToCell.H:55
A topoSetSource to select cells based on usage of points.
Definition: pointToCell.H:49
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: pointToCell.C:161
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
Class with constructor to add usage string to table.
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
pointToCell(const polyMesh &mesh, const word &setName, const pointAction option)
Construct from components.
Definition: pointToCell.C:114
Namespace for OpenFOAM.