All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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-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::meshSearchMeshObject
26 
27 Description
28  MeshObject wrapper around meshSearch(mesh).
29 
30 SourceFiles
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef meshSearchMeshObject_H
35 #define meshSearchMeshObject_H
36 
37 #include "MeshObject.H"
38 #include "meshSearch.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class meshSearchMeshObject Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
51  public MeshObject<polyMesh, GeometricMeshObject, meshSearchMeshObject>,
52  public meshSearch
53 {
54 
55 public:
56 
57  // Declare name of the class and its debug switch
58  TypeName("meshSearchMeshObject");
59 
60 
61  // Constructors
62 
63  //- Constructor given polyMesh
64  explicit meshSearchMeshObject(const polyMesh& mesh);
65 
66  //- Destructor
67  virtual ~meshSearchMeshObject()
68  {}
69 };
70 
71 
72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
73 
74 } // End namespace Foam
75 
76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
77 
78 #endif
79 
80 // ************************************************************************* //
Various (local, not parallel) searches on polyMesh; uses (demand driven) octree to search...
Definition: meshSearch.H:57
MeshObject wrapper around meshSearch(mesh).
virtual ~meshSearchMeshObject()
Destructor.
const polyMesh & mesh() const
Definition: meshSearch.H:182
Templated abstract base-class for optional mesh objects used to automate their allocation to the mesh...
Definition: MeshObject.H:86
meshSearchMeshObject(const polyMesh &mesh)
Constructor given polyMesh.
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
TypeName("meshSearchMeshObject")
Namespace for OpenFOAM.