FreeFOAM The Cross-Platform CFD Toolkit
setToFaceZone.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) 1991-2010 OpenCFD Ltd.
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::setToFaceZone
26 
27 Description
28  A topoSetSource to select faces based on usage in a faceSet. Sets flipMap
29  to true.
30 
31 SourceFiles
32  setToFaceZone.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef setToFaceZone_H
37 #define setToFaceZone_H
38 
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class setToFaceZone Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public topoSetSource
53 {
54  // Private data
55 
56  //- Add usage string
57  static addToUsageTable usage_;
58 
59  //- Name of set to use
60  word setName_;
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("setToFaceZone");
66 
67  // Constructors
68 
69  //- Construct from components
71  (
72  const polyMesh& mesh,
73  const word& setName
74  );
75 
76  //- Construct from dictionary
78  (
79  const polyMesh& mesh,
80  const dictionary& dict
81  );
82 
83  //- Construct from Istream
85  (
86  const polyMesh& mesh,
87  Istream&
88  );
89 
90 
91  // Destructor
92 
93  virtual ~setToFaceZone();
94 
95 
96  // Member Functions
97 
98  virtual void applyToSet
99  (
100  const topoSetSource::setAction action,
101  topoSet&
102  ) const;
103 
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************ vim: set sw=4 sts=4 et: ************************ //