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_TREE_H
#define LIBMESH_TREE_H
 
// Local includes
#include "libmesh/tree_node.h"
#include "libmesh/tree_base.h"
 
// C++ includes
 
namespace libMesh
{
 
// Forward Declarations
class MeshBase;
 
template <unsigned int N>
class Tree : public TreeBase
{
public:
  Tree (const MeshBase & m,
        unsigned int target_bin_size,
        Trees::BuildType bt = Trees::NODES);
 
  Tree (const Tree<N> &) = delete;
 
  ~Tree() = default;
 
  virtual void print_nodes(std::ostream & my_out=libMesh::out) const override;
 
  virtual void print_elements(std::ostream & my_out=libMesh::out) const override;
 
  virtual unsigned int n_active_bins() const override
  { return root.n_active_bins(); }
 
  virtual const Elem * find_element(const Point & p,
                                    const std::set<subdomain_id_type> * allowed_subdomains = nullptr,
                                    Real relative_tol = TOLERANCE) const override;
 
  virtual void find_elements(const Point & p,
                             std::set<const Elem *> & candidate_elements,
                             const std::set<subdomain_id_type> * allowed_subdomains = nullptr,
                             Real relative_tol = TOLERANCE) const override;
 
  const Elem * operator() (const Point & p,
                           const std::set<subdomain_id_type> * allowed_subdomains = nullptr,
                           Real relative_tol = TOLERANCE) const;
 
private:
  TreeNode<N> root;
 
  const Trees::BuildType build_type;
};
 
 
 
namespace Trees
{
typedef Tree<2> BinaryTree;
 
typedef Tree<4> QuadTree;
 
typedef Tree<8> OctTree;
}
 
} // namespace libMesh
 
 
#endif // LIBMESH_TREE_H