searchableSurfaceSelection.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2012-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::faceSelections::searchableSurfaceSelection
28 
29 Description
30  Selects all (internal or coupled) faces intersecting the searchableSurface.
31 
32 SourceFiles
33  searchableSurfaceSelection.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef searchableSurfaceSelection_H
38 #define searchableSurfaceSelection_H
39 
40 #include "faceSelection.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 class searchableSurface;
48 
49 namespace faceSelections
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class searchableSurfaceSelection Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
58  public faceSelection
59 {
60  // Private data
61 
62  autoPtr<searchableSurface> surfacePtr_;
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("searchableSurface");
68 
69 
70  // Constructors
71 
72  //- Construct from dictionary
74  (
75  const word& name,
76  const fvMesh& mesh,
77  const dictionary& dict
78  );
79 
80  //- Clone
82  {
84  return nullptr;
85  }
86 
87 
88  //- Destructor
90 
91 
92  // Member Functions
93 
94  virtual void select(const label zoneID, labelList&, boolList&) const;
95 
96 };
97 
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 } // End namespace faceSelections
102 } // End namespace Foam
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
Selects all (internal or coupled) faces intersecting the searchableSurface.
const dictionary & dict() const
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
const word & name() const
dynamicFvMesh & mesh
A class for handling words, derived from Foam::string.
Definition: word.H:63
Face selection method for createBaffles.
Definition: faceSelection.H:54
virtual void select(const label zoneID, labelList &, boolList &) const
TypeName("searchableSurface")
Runtime type information.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
searchableSurfaceSelection(const word &name, const fvMesh &mesh, const dictionary &dict)
Construct from dictionary.
Pointer management similar to std::unique_ptr, with some additional methods and type checking...
Definition: HashPtrTable.H:48
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:686
Namespace for OpenFOAM.