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-2021 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  //- Enumeration defining the valid options
56  enum faceAction
57  {
58  MASTER,
60  };
61 
62 private:
63 
64  // Private Data
65 
66  static const NamedEnum<faceAction, 2> faceActionNames_;
67 
68 
69  //- Name/regular expression of faceZone
70  wordRe zoneName_;
71 
72  //- Option
73  faceAction option_;
74 
75 
76  // Private Member Functions
77 
78  void combine(topoSet& set, const bool add) const;
79 
80 
81 public:
82 
83  //- Runtime type information
84  TypeName("faceZoneToCell");
85 
86  // Constructors
87 
88  //- Construct from components
90  (
91  const polyMesh& mesh,
92  const word& zoneName,
93  const faceAction option
94  );
95 
96  //- Construct from dictionary
98  (
99  const polyMesh& mesh,
100  const dictionary& dict
101  );
102 
103 
104  //- Destructor
105  virtual ~faceZoneToCell();
106 
107 
108  // Member Functions
109 
110  virtual sourceType setType() const
111  {
112  return CELLSETSOURCE;
113  }
114 
115  virtual void applyToSet
116  (
117  const topoSetSource::setAction action,
118  topoSet&
119  ) const;
120 
121 };
122 
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #endif
131 
132 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
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.
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