searchableBoxFeatures.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) 2013-2020 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::searchableBoxFeatures
26 
27 Description
28 
29 SourceFiles
30  searchableBoxFeatures.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef searchableBoxFeatures_H
35 #define searchableBoxFeatures_H
36 
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 /*---------------------------------------------------------------------------*\
45  Class searchableBoxFeatures Declaration
46 \*---------------------------------------------------------------------------*/
47 
49 :
51 {
52 private:
53 
54  // Private Member Data
55 
56  //- Which side of the box to mesh
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("searchableBoxFeatures");
64 
65 
66  // Constructors
67 
68  //- Construct from searchable surface and dictionary
70  (
72  const dictionary& dict
73  );
74 
75  //- Disallow default bitwise copy construction
77 
78 
79  //- Destructor
80  virtual ~searchableBoxFeatures();
81 
82 
83  // Member Functions
84 
85  //- Return true for a searchable box having features
86  virtual bool hasFeatures() const
87  {
88  return true;
89  }
90 
91  //- Return an extendedFeatureEdgeMesh containing the features
93 
94 
95  // Member Operators
96 
97  //- Disallow default bitwise assignment
98  void operator=(const searchableBoxFeatures&) = delete;
99 };
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
searchableBoxFeatures(const searchableSurface &surface, const dictionary &dict)
Construct from searchable surface and dictionary.
const searchableSurface & surface() const
Return a reference to the searchable surface.
Decorator that returns the features of a searchable surface.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
Base class of (analytical or triangulated) surface. Encapsulates all the search routines. WIP.
virtual bool hasFeatures() const
Return true for a searchable box having features.
const dictionary & dict() const
Return a reference to the dictionary.
void operator=(const searchableBoxFeatures &)=delete
Disallow default bitwise assignment.
virtual autoPtr< extendedFeatureEdgeMesh > features() const
Return an extendedFeatureEdgeMesh containing the features.
sideVolumeType
Normals point to the outside.
virtual ~searchableBoxFeatures()
Destructor.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
TypeName("searchableBoxFeatures")
Runtime type information.
Namespace for OpenFOAM.