point_locator_base.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2026 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
 
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
 
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
 
#ifndef LIBMESH_POINT_LOCATOR_BASE_H
#define LIBMESH_POINT_LOCATOR_BASE_H
 
// Local Includes
#include "libmesh/reference_counted_object.h"
#include "libmesh/libmesh_common.h"
 
// C++ includes
#include <cstddef>
#include <memory>
#include <set>
#include <vector>
 
namespace libMesh
{
 
// Forward Declarations
class PointLocatorBase;
class MeshBase;
class Point;
class TreeBase;
class Elem;
class Node;
enum PointLocatorType : int;
 
 
class PointLocatorBase : public ReferenceCountedObject<PointLocatorBase>
{
protected:
  PointLocatorBase (const MeshBase & mesh,
                    const PointLocatorBase * master);
 
public:
  virtual ~PointLocatorBase ();
 
  static std::unique_ptr<PointLocatorBase> build (PointLocatorType t,
                                                  const MeshBase & mesh,
                                                  const PointLocatorBase * master = nullptr);
 
  virtual void clear() = 0;
 
  virtual void init() = 0;
 
  virtual const Elem * operator() (const Point & p,
                                   const std::set<subdomain_id_type> * allowed_subdomains = nullptr) const = 0;
 
  virtual void operator() (const Point & p,
                           std::set<const Elem *> & candidate_elements,
                           const std::set<subdomain_id_type> * allowed_subdomains = nullptr) const = 0;
 
  virtual const Node *
  locate_node (const Point & p,
               const std::set<subdomain_id_type> * allowed_subdomains = nullptr,
               Real tol = TOLERANCE) const;
 
  bool initialized () const;
 
  virtual void enable_out_of_mesh_mode () = 0;
 
  virtual void disable_out_of_mesh_mode () = 0;
 
  Real get_close_to_point_tol() const;
 
  virtual void set_close_to_point_tol(Real close_to_point_tol);
 
  virtual void unset_close_to_point_tol();
 
  virtual void set_contains_point_tol(Real contains_point_tol);
 
  virtual void unset_contains_point_tol();
 
  virtual Real get_contains_point_tol() const;
 
  bool get_use_contains_point_tol() const { return _use_contains_point_tol; }
 
  const MeshBase & get_mesh() const;
 
  bool get_verbose() const { return _verbose; }
 
  void set_verbose(bool verbosity) { _verbose = verbosity; }
 
#ifndef NDEBUG
  void libmesh_assert_valid_point_locator ();
#endif
 
 
#ifndef LIBMESH_ENABLE_DEPRECATED
protected:
#endif
 
  bool _verbose;
 
protected:
  const PointLocatorBase * _master;
 
  const MeshBase & _mesh;
 
  bool _initialized;
 
  bool _use_close_to_point_tol;
 
  Real _close_to_point_tol;
 
  bool _use_contains_point_tol;
 
  Real _contains_point_tol;
};
 
} // namespace libMesh
 
#endif // LIBMESH_POINT_LOCATOR_BASE_H