All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
cellToPoint.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::cellToPoint
26 
27 Description
28  A topoSetSource to select points based on usage in cells.
29 
30 SourceFiles
31  cellToPoint.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cellToPoint_H
36 #define cellToPoint_H
37 
38 #include "topoSetSource.H"
39 #include "NamedEnum.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class cellToPoint Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class cellToPoint
51 :
52  public topoSetSource
53 {
54 public:
55 
56  // Public Enumerations
57 
58  //- Enumeration defining the valid options
59  enum cellAction
60  {
62  };
63 
64  //- Names of the valid options
66 
67 
68 private:
69 
70  //- Name of set to use
71  word setName_;
72 
73  //- Option
74  cellAction option_;
75 
76 
77  // Private Member Functions
78 
79  //- Depending on face 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("cellToPoint");
87 
88 
89  // Constructors
90 
91  //- Construct from components
93  (
94  const polyMesh& mesh,
95  const word& setName,
96  const cellAction option
97  );
98 
99  //- Construct from dictionary
101  (
102  const polyMesh& mesh,
103  const dictionary& dict
104  );
105 
106 
107  //- Destructor
108  virtual ~cellToPoint();
109 
110 
111  // Member Functions
112 
113  virtual sourceType setType() const
114  {
115  return POINTSETSOURCE;
116  }
117 
118  virtual void applyToSet
119  (
120  const topoSetSource::setAction action,
121  topoSet&
122  ) const;
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace Foam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
A topoSetSource to select points based on usage in cells.
Definition: cellToPoint.H:52
static const NamedEnum< cellAction, 1 > cellActionNames_
Names of the valid options.
Definition: cellToPoint.H:64
TypeName("cellToPoint")
Runtime type information.
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: cellToPoint.C:116
virtual sourceType setType() const
Definition: cellToPoint.H:112
cellToPoint(const polyMesh &mesh, const word &setName, const cellAction option)
Construct from components.
Definition: cellToPoint.C:83
virtual ~cellToPoint()
Destructor.
Definition: cellToPoint.C:109
cellAction
Enumeration defining the valid options.
Definition: cellToPoint.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
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