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