cellToFace.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::cellToFace
26 
27 Description
28  A topoSetSource to select a faceSet from cells.
29 
30  Either all faces of cell or some other criterion.
31  See implementation.
32  Note: when picking up coupled faces uses cells on neighbouring processors.
33 
34 SourceFiles
35  cellToFace.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef cellToFace_H
40 #define cellToFace_H
41 
42 #include "topoSetSource.H"
43 #include "NamedEnum.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class cellToFace Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class cellToFace
55 :
56  public topoSetSource
57 {
58 public:
59 
60  // Public Enumerations
61 
62  //- Enumeration defining the valid options
63  enum cellAction
64  {
65  ALL,
67  };
68 
69  //- Names of the valid options
71 
72 
73 private:
74 
75  // Private Data
76 
77  //- Name of set to use
78  word setName_;
79 
80  //- Option
81  cellAction option_;
82 
83 
84  // Private Member Functions
85 
86  //- Depending on face to cell option add to or delete from cellSet.
87  void combine(topoSet& set, const bool add) const;
88 
89 
90 public:
91 
92  //- Runtime type information
93  TypeName("cellToFace");
94 
95 
96  // Constructors
97 
98  //- Construct from components
100  (
101  const polyMesh& mesh,
102  const word& setName,
103  const cellAction option
104  );
105 
106  //- Construct from dictionary
107  cellToFace
108  (
109  const polyMesh& mesh,
110  const dictionary& dict
111  );
112 
113 
114  //- Destructor
115  virtual ~cellToFace();
116 
117 
118  // Member Functions
119 
120  virtual sourceType setType() const
121  {
122  return FACESETSOURCE;
123  }
124 
125  virtual void applyToSet
126  (
127  const topoSetSource::setAction action,
128  topoSet&
129  ) const;
130 };
131 
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 } // End namespace Foam
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 #endif
140 
141 // ************************************************************************* //
A topoSetSource to select a faceSet from cells.
Definition: cellToFace.H:56
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: cellToFace.C:183
cellToFace(const polyMesh &mesh, const word &setName, const cellAction option)
Construct from components.
Definition: cellToFace.C:150
virtual sourceType setType() const
Definition: cellToFace.H:119
cellAction
Enumeration defining the valid options.
Definition: cellToFace.H:63
TypeName("cellToFace")
Runtime type information.
static const NamedEnum< cellAction, 2 > cellActionNames_
Names of the valid options.
Definition: cellToFace.H:69
virtual ~cellToFace()
Destructor.
Definition: cellToFace.C:176
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