boundaryToFace.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011 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 data
54 
55  //- Add usage string
56  static addToUsageTable usage_;
57 
58 
59  // Private Member Functions
60 
61  void combine(topoSet& set, const bool add) const;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("boundaryToFace");
68 
69  // Constructors
70 
71  //- Construct from components
72  boundaryToFace(const polyMesh&);
73 
74  //- Construct from dictionary
76  (
77  const polyMesh& mesh,
78  const dictionary& dict
79  );
80 
81  //- Construct from Istream
83  (
84  const polyMesh& mesh,
85  Istream&
86  );
87 
88 
89  //- Destructor
90  virtual ~boundaryToFace();
91 
92 
93  // Member Functions
94 
95  virtual sourceType setType() const
96  {
97  return FACESETSOURCE;
98  }
99 
100  virtual void applyToSet
101  (
102  const topoSetSource::setAction action,
103  topoSet&
104  ) const;
105 
106 };
107 
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 } // End namespace Foam
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
dictionary dict
TypeName("boundaryToFace")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
boundaryToFace(const polyMesh &)
Construct from components.
virtual sourceType setType() const
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
const polyMesh & mesh() const
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
Class with constructor to add usage string to table.
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
A topoSetSource to select all external (boundary) faces.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
Namespace for OpenFOAM.
virtual ~boundaryToFace()
Destructor.