setToCellZone.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::setToCellZone
26 
27 Description
28  A topoSetSource to select cells based on usage in a cellSet.
29 
30 SourceFiles
31  setToCellZone.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef setToCellZone_H
36 #define setToCellZone_H
37 
38 #include "topoSetSource.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class setToCellZone Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class setToCellZone
50 :
51  public topoSetSource
52 {
53  // Private Data
54 
55  //- Name of set to use
56  word setName_;
57 
58 
59 public:
60 
61  //- Runtime type information
62  TypeName("setToCellZone");
63 
64 
65  // Constructors
66 
67  //- Construct from components
69  (
70  const polyMesh& mesh,
71  const word& setName
72  );
73 
74  //- Construct from dictionary
76  (
77  const polyMesh& mesh,
78  const dictionary& dict
79  );
80 
81 
82  //- Destructor
83  virtual ~setToCellZone();
84 
85 
86  // Member Functions
87 
88  virtual sourceType setType() const
89  {
90  return CELLZONESOURCE;
91  }
92 
93  virtual void applyToSet
94  (
95  const topoSetSource::setAction action,
96  topoSet&
97  ) const;
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************************************************************* //
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
A topoSetSource to select cells based on usage in a cellSet.
Definition: setToCellZone.H:51
virtual ~setToCellZone()
Destructor.
Definition: setToCellZone.C:66
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: setToCellZone.C:73
setToCellZone(const polyMesh &mesh, const word &setName)
Construct from components.
Definition: setToCellZone.C:43
virtual sourceType setType() const
Definition: setToCellZone.H:87
TypeName("setToCellZone")
Runtime type information.
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.
dictionary dict