patchToFace.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::patchToFace
26 
27 Description
28  A topoSetSource to select faces based on usage in patches.
29 
30 SourceFiles
31  patchToFace.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef patchToFace_H
36 #define patchToFace_H
37 
38 #include "topoSetSource.H"
39 #include "wordRe.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class patchToFace Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class patchToFace
51 :
52  public topoSetSource
53 {
54 
55  // Private data
56 
57  //- Add usage string
58  static addToUsageTable usage_;
59 
60  //- Name/regular expression of patch
61  wordRe patchName_;
62 
63 
64  // Private Member Functions
65 
66  void combine(topoSet& set, const bool add) const;
67 
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("patchToFace");
73 
74  // Constructors
75 
76  //- Construct from components
78  (
79  const polyMesh& mesh,
80  const word& patchName
81  );
82 
83  //- Construct from dictionary
85  (
86  const polyMesh& mesh,
87  const dictionary& dict
88  );
89 
90  //- Construct from Istream
92  (
93  const polyMesh& mesh,
94  Istream&
95  );
96 
97 
98  //- Destructor
99  virtual ~patchToFace();
100 
101 
102  // Member Functions
104  virtual sourceType setType() const
105  {
106  return FACESETSOURCE;
107  }
108 
109  virtual void applyToSet
110  (
111  const topoSetSource::setAction action,
112  topoSet&
113  ) const;
114 
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace Foam
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #endif
125 
126 // ************************************************************************* //
virtual ~patchToFace()
Destructor.
Definition: patchToFace.C:133
A topoSetSource to select faces based on usage in patches.
Definition: patchToFace.H:49
TypeName("patchToFace")
Runtime type information.
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
virtual sourceType setType() const
Definition: patchToFace.H:103
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
A class for handling words, derived from string.
Definition: word.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
dictionary dict
Combine operator for AMIInterpolation.
Definition: FaceCellWave.C:54
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Definition: patchToFace.C:140
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
const polyMesh & mesh() const
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
Class with constructor to add usage string to table.
A wordRe is a word, but can also have a regular expression for matching words.
Definition: wordRe.H:74
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
patchToFace(const polyMesh &mesh, const word &patchName)
Construct from components.
Definition: patchToFace.C:97