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