searchableSurfaceSelection.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2012-2018 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::faceSelections::searchableSurfaceSelection
26 
27 Description
28  Selects all (internal or coupled) faces intersecting the searchableSurface.
29 
30 SourceFiles
31  searchableSurfaceSelection.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef searchableSurfaceSelection_H
36 #define searchableSurfaceSelection_H
37 
38 #include "faceSelection.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 class searchableSurface;
46 
47 namespace faceSelections
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class searchableSurfaceSelection Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
56  public faceSelection
57 {
58  // Private data
59 
60  autoPtr<searchableSurface> surfacePtr_;
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("searchableSurface");
66 
67 
68  // Constructors
69 
70  //- Construct from dictionary
72  (
73  const word& name,
74  const fvMesh& mesh,
75  const dictionary& dict
76  );
77 
78  //- Clone
80  {
82  return autoPtr<faceSelection>(nullptr);
83  }
84 
85 
86  //- Destructor
88 
89 
90  // Member Functions
91 
92  virtual void select(const label zoneID, labelList&, boolList&) const;
93 
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace faceSelections
100 } // End namespace Foam
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************************************************************* //
Selects all (internal or coupled) faces intersecting the searchableSurface.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
const dictionary & dict() const
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const word & name() const
dynamicFvMesh & mesh
A class for handling words, derived from string.
Definition: word.H:59
Face selection method for createBaffles.
Definition: faceSelection.H:57
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.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:366
Namespace for OpenFOAM.