All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pointToCell.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2024 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 
56  // Public Enumerations
57 
58  //- Enumeration defining the valid options
59  enum pointAction
60  {
61  ANY, // Cells using any point in set
62  EDGE // Cells using an edge with both points in set
63  // ALL // Possible extension: cells whose all points are in set
64  };
65 
66  //- Names of the valid options
68 
69 
70 private:
71 
72  // Private Data
73 
74  //- Name of set to use
75  word setName_;
76 
77  //- Option
78  pointAction option_;
79 
80 
81  // Private Member Functions
82 
83  //- Depending on point-to-cell option add to or delete from cellSet.
84  void combine(topoSet& set, const bool add) const;
85 
86 
87 public:
88 
89  //- Runtime type information
90  TypeName("pointToCell");
91 
92 
93  // Constructors
94 
95  //- Construct from components
97  (
98  const polyMesh& mesh,
99  const word& setName,
100  const pointAction option
101  );
102 
103  //- Construct from dictionary
105  (
106  const polyMesh& mesh,
107  const dictionary& dict
108  );
109 
110 
111  //- Destructor
112  virtual ~pointToCell();
113 
114 
115  // Member Functions
116 
117  virtual sourceType setType() const
118  {
119  return CELLSETSOURCE;
120  }
121 
122  virtual void applyToSet
123  (
124  const topoSetSource::setAction action,
125  topoSet&
126  ) const;
127 };
128 
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 } // End namespace Foam
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 #endif
137 
138 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
A topoSetSource to select cells based on usage of points.
Definition: pointToCell.H:52
pointAction
Enumeration defining the valid options.
Definition: pointToCell.H:59
static const NamedEnum< pointAction, 2 > pointActionNames_
Names of the valid options.
Definition: pointToCell.H:66
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: pointToCell.C:136
pointToCell(const polyMesh &mesh, const word &setName, const pointAction option)
Construct from components.
Definition: pointToCell.C:103
virtual sourceType setType() const
Definition: pointToCell.H:116
TypeName("pointToCell")
Runtime type information.
virtual ~pointToCell()
Destructor.
Definition: pointToCell.C:129
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
Base class of a source for a topoSet.
Definition: topoSetSource.H:64
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:71
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:83
const polyMesh & mesh() const
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:65
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
dictionary dict