faceZoneToCell.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::faceZoneToCell
26 
27 Description
28  A topoSetSource to select cells based on side of faceZone.
29 
30 SourceFiles
31  faceZoneToCell.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef faceZoneToCell_H
36 #define faceZoneToCell_H
37 
38 #include "topoSetSource.H"
39 #include "wordRe.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class faceZoneToCell Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class faceZoneToCell
51 :
52  public topoSetSource
53 {
54 public:
55 
56  // Public Enumerations
57 
58  //- Enumeration defining the valid options
59  enum faceAction
60  {
61  MASTER,
63  };
64 
65  //- Names of the valid options
67 
68 
69 private:
70 
71  // Private Data
72 
73  //- Name/regular expression of faceZone
74  wordRe zoneName_;
75 
76  //- Option
77  faceAction option_;
78 
79 
80  // Private Member Functions
81 
82  void combine(topoSet& set, const bool add) const;
83 
84 
85 public:
86 
87  //- Runtime type information
88  TypeName("faceZoneToCell");
89 
90 
91  // Constructors
92 
93  //- Construct from components
95  (
96  const polyMesh& mesh,
97  const word& zoneName,
98  const faceAction option
99  );
100 
101  //- Construct from dictionary
103  (
104  const polyMesh& mesh,
105  const dictionary& dict
106  );
107 
108 
109  //- Destructor
110  virtual ~faceZoneToCell();
111 
112 
113  // Member Functions
114 
115  virtual sourceType setType() const
116  {
117  return CELLSETSOURCE;
118  }
119 
120  virtual void applyToSet
121  (
122  const topoSetSource::setAction action,
123  topoSet&
124  ) const;
125 };
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 } // End namespace Foam
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 #endif
135 
136 // ************************************************************************* //
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 side of faceZone.
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
virtual sourceType setType() const
virtual ~faceZoneToCell()
Destructor.
faceZoneToCell(const polyMesh &mesh, const word &zoneName, const faceAction option)
Construct from components.
static const NamedEnum< faceAction, 2 > faceActionNames_
Names of the valid options.
TypeName("faceZoneToCell")
Runtime type information.
faceAction
Enumeration defining the valid options.
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 wordRe is a word, but can also have a regular expression for matching words.
Definition: wordRe.H:77
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