searchableSurfaceToFaceZone.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) 2012 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::searchableSurfaceToFaceZone
26 
27 Description
28  A topoSetSource to select faces based on intersection (of cell-cell
29  vector) with a surface.
30 
31 SourceFiles
32  searchableSurfaceToFaceZone.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef searchableSurfaceToFaceZone_H
37 #define searchableSurfaceToFaceZone_H
38 
39 #include "topoSetSource.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 class searchableSurface;
47 
48 /*---------------------------------------------------------------------------*\
49  Class searchableSurfaceToFaceZone Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public topoSetSource
55 {
56  // Private data
57 
58  //- Add usage string
59  static addToUsageTable usage_;
60 
61  //- Surface
62  autoPtr<searchableSurface> surfacePtr_;
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("searchableSurfaceToFaceZone");
68 
69  // Constructors
70 
71  //- Construct from dictionary
73  (
74  const polyMesh& mesh,
75  const dictionary& dict
76  );
77 
78 
79  //- Destructor
81 
82 
83  // Member Functions
84 
85  virtual sourceType setType() const
86  {
87  return FACEZONESOURCE;
88  }
89 
90  virtual void applyToSet
91  (
92  const topoSetSource::setAction action,
93  topoSet&
94  ) const;
95 
96 };
97 
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 } // End namespace Foam
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #endif
106 
107 // ************************************************************************* //
const polyMesh & mesh() const
dictionary dict
TypeName("searchableSurfaceToFaceZone")
Runtime type information.
searchableSurfaceToFaceZone(const polyMesh &mesh, const dictionary &dict)
Construct from dictionary.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Base class of a source for a topoSet.
Definition: topoSetSource.H:63
A topoSetSource to select faces based on intersection (of cell-cell vector) with a surface...
setAction
Enumeration defining the valid actions.
Definition: topoSetSource.H:82
General set of labels of mesh quantity (points, cells, faces).
Definition: topoSet.H:61
Class with constructor to add usage string to table.
sourceType
Enumeration defining the types of sources.
Definition: topoSetSource.H:70
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
virtual void applyToSet(const topoSetSource::setAction action, topoSet &) const
Namespace for OpenFOAM.