point_locator_tree.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_TREE_H
#define LIBMESH_POINT_LOCATOR_TREE_H
 
// Local Includes
#include "libmesh/point_locator_base.h"
#include "libmesh/tree_base.h"
 
// C++ includes
#include <cstddef>
#include <memory> // std::shared_ptr
 
namespace libMesh
{
 
// Forward Declarations
class MeshBase;
class Point;
class Elem;
 
class PointLocatorTree : public PointLocatorBase
{
public:
  PointLocatorTree (const MeshBase & mesh,
                    const PointLocatorBase * master = nullptr);
 
 
  PointLocatorTree (const MeshBase & mesh,
                    const Trees::BuildType build_type,
                    const PointLocatorBase * master = nullptr);
 
  ~PointLocatorTree ();
 
  virtual void clear() override final;
 
  void init(Trees::BuildType build_type);
 
  virtual void init() override final;
 
  virtual const Elem * operator() (const Point & p,
                                   const std::set<subdomain_id_type> * allowed_subdomains = nullptr) const override final;
 
  virtual void operator() (const Point & p,
                           std::set<const Elem *> & candidate_elements,
                           const std::set<subdomain_id_type> * allowed_subdomains = nullptr) const override final;
 
  const Elem * perform_linear_search(const Point & p,
                                     const std::set<subdomain_id_type> * allowed_subdomains,
                                     bool use_close_to_point,
                                     Real close_to_point_tolerance=TOLERANCE) const;
 
  std::set<const Elem *> perform_fuzzy_linear_search(const Point & p,
                                                     const std::set<subdomain_id_type> * allowed_subdomains,
                                                     Real close_to_point_tolerance=TOLERANCE) const;
 
  virtual void enable_out_of_mesh_mode () override final;
 
  virtual void disable_out_of_mesh_mode () override final;
 
  void set_target_bin_size(unsigned int target);
 
  unsigned int get_target_bin_size() const;
 
protected:
  std::shared_ptr<TreeBase> _tree;
 
  mutable const Elem * _element;
 
  bool _out_of_mesh_mode;
 
  unsigned int _target_bin_size;
 
  Trees::BuildType _build_type;
};
 
} // namespace libMesh
 
#endif // LIBMESH_POINT_LOCATOR_TREE_H