meshSearchMeshObject.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) 2011-2022 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::meshSearchMeshObject
26 
27 Description
28  DemandDrivenMeshObject wrapper around meshSearch(mesh).
29 
30 SourceFiles
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef meshSearchMeshObject_H
35 #define meshSearchMeshObject_H
36 
37 #include "DemandDrivenMeshObject.H"
38 #include "meshSearch.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class meshSearchMeshObject Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
52  <
53  polyMesh,
54  GeometricMeshObject,
55  meshSearchMeshObject
56  >,
57  public meshSearch
58 {
59 
60 protected:
61 
62  friend class DemandDrivenMeshObject
63  <
64  polyMesh,
67  >;
68 
69  // Protected Constructors
70 
71  //- Constructor from polyMesh
72  explicit meshSearchMeshObject(const polyMesh& mesh);
73 
74 
75 public:
76 
77  // Declare name of the class and its debug switch
78  TypeName("meshSearchMeshObject");
79 
80  //- Destructor
81  virtual ~meshSearchMeshObject()
82  {}
83 };
84 
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #endif
93 
94 // ************************************************************************* //
Templated abstract base-class for demand-driven mesh objects used to automate their allocation to the...
DemandDrivenMeshObject wrapper around meshSearch(mesh).
TypeName("meshSearchMeshObject")
virtual ~meshSearchMeshObject()
Destructor.
meshSearchMeshObject(const polyMesh &mesh)
Constructor from polyMesh.
Various (local, not parallel) searches on polyMesh; uses (demand driven) octree to search.
Definition: meshSearch.H:58
const polyMesh & mesh() const
Definition: meshSearch.H:182
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
Namespace for OpenFOAM.