meshSearchMeshObject.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) 2011-2013 OpenFOAM Foundation
9  Copyright (C) 2019 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::meshSearchMeshObject
29 
30 Description
31  MeshObject wrapper around meshSearch(mesh).
32 
33 SourceFiles
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef meshSearchMeshObject_H
38 #define meshSearchMeshObject_H
39 
40 #include "MeshObject.H"
41 #include "meshSearch.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class meshSearchMeshObject Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public MeshObject<polyMesh, GeometricMeshObject, meshSearchMeshObject>,
55  public meshSearch
56 {
57 
58 public:
59 
60  // Declare name of the class and its debug switch
61  TypeName("meshSearchMeshObject");
62 
63 
64  // Constructors
65 
66  //- Constructor given polyMesh
67  explicit meshSearchMeshObject(const polyMesh& mesh);
68 
69  //- Destructor
70  virtual ~meshSearchMeshObject() = default;
71 };
72 
73 
74 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
75 
76 } // End namespace Foam
77 
78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
79 
80 #endif
81 
82 // ************************************************************************* //
Foam::meshSearch
Various (local, not parallel) searches on polyMesh; uses (demand driven) octree to search.
Definition: meshSearch.H:60
Foam::meshSearchMeshObject::~meshSearchMeshObject
virtual ~meshSearchMeshObject()=default
Destructor.
Foam::polyMesh
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:77
Foam::meshSearchMeshObject
MeshObject wrapper around meshSearch(mesh).
Definition: meshSearchMeshObject.H:51
Foam::meshSearchMeshObject::TypeName
TypeName("meshSearchMeshObject")
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
meshSearch.H
Foam::meshSearchMeshObject::meshSearchMeshObject
meshSearchMeshObject(const polyMesh &mesh)
Constructor given polyMesh.
Definition: meshSearchMeshObject.C:40
Foam::meshSearch::mesh
const polyMesh & mesh() const
Definition: meshSearch.H:195
MeshObject.H
Foam::MeshObject
Templated abstract base-class for optional mesh objects used to automate their allocation to the mesh...
Definition: MeshObject.H:88