point_locator_base.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2014 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
3 
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License, or (at your option) any later version.
8 
9 // This library is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // Lesser General Public License for more details.
13 
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 
18 
19 
20 #ifndef LIBMESH_POINT_LOCATOR_BASE_H
21 #define LIBMESH_POINT_LOCATOR_BASE_H
22 
23 // Local Includes
25 #include "libmesh/libmesh_common.h"
26 #include "libmesh/auto_ptr.h"
28 
29 // C++ includes
30 #include <cstddef>
31 #include <vector>
32 
33 namespace libMesh
34 {
35 
36 
37 
38 // Forward Declarations
39 class PointLocatorBase;
40 class MeshBase;
41 class Point;
42 class TreeBase;
43 class Elem;
44 
45 
46 
55 // ------------------------------------------------------------
56 // PointLocatorBase class definition
57 class PointLocatorBase : public ReferenceCountedObject<PointLocatorBase>
58 {
59 protected:
60 
67  const PointLocatorBase* master);
68 
69 
70 public:
71 
75  virtual ~PointLocatorBase ();
76 
84  const MeshBase& mesh,
85  const PointLocatorBase* master = NULL);
86 
90  virtual void clear() = 0;
91 
96  virtual void init() = 0;
97 
102  virtual const Elem* operator() (const Point& p) const = 0;
103 
108  bool initialized () const;
109 
116  virtual void enable_out_of_mesh_mode (void) = 0;
117 
123  virtual void disable_out_of_mesh_mode (void) = 0;
124 
125 protected:
126 
133 
137  const MeshBase& _mesh;
138 
143 
144 };
145 
146 
147 // ------------------------------------------------------------
148 // PointLocatorBase inline methods
149 inline
151 {
152  return (this->_initialized);
153 }
154 
155 } // namespace libMesh
156 
157 #endif // LIBMESH_POINT_LOCATOR_BASE_H

Site Created By: libMesh Developers
Last modified: February 07 2014 16:57:06 UTC

Hosted By:
SourceForge.net Logo