FreeFOAM The Cross-Platform CFD Toolkit
faceToPoint.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::faceToPoint
26 
27 Description
28  A topoSetSource to select points based on usage in faces.
29 
30 SourceFiles
31  faceToPoint.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef faceToPoint_H
36 #define faceToPoint_H
37 
39 #include <OpenFOAM/NamedEnum.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class faceToPoint Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public topoSetSource
53 {
54 
55 public:
56  //- Enumeration defining the valid options
58  {
60  };
61 
62 private:
63 
64  //- Add usage string
65  static addToUsageTable usage_;
66 
67  static const NamedEnum<faceAction, 1> faceActionNames_;
68 
69  //- Name of set to use
70  word setName_;
71 
72  //- Option
73  faceAction option_;
74 
75 
76  // Private Member Functions
77 
78  //- Depending on face to cell option add to or delete from cellSet.
79  void combine(topoSet& set, const bool add) const;
80 
81 
82 public:
83 
84  //- Runtime type information
85  TypeName("faceToPoint");
86 
87  // Constructors
88 
89  //- Construct from components
91  (
92  const polyMesh& mesh,
93  const word& setName,
94  const faceAction option
95  );
96 
97  //- Construct from dictionary
99  (
100  const polyMesh& mesh,
101  const dictionary& dict
102  );
103 
104  //- Construct from Istream
106  (
107  const polyMesh& mesh,
108  Istream&
109  );
110 
111 
112  // Destructor
113 
114  virtual ~faceToPoint();
115 
116 
117  // Member Functions
118 
119  virtual void applyToSet
120  (
121  const topoSetSource::setAction action,
122  topoSet&
123  ) const;
124 
125 };
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 } // End namespace Foam
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 #endif
135 
136 // ************************ vim: set sw=4 sts=4 et: ************************ //