tree_base.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 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_BASE_H
#define LIBMESH_TREE_BASE_H

// Local includes
#include "libmesh/reference_counted_object.h"
#include "libmesh/id_types.h" // subdomain_id_type
#include "libmesh/libmesh_common.h" // TOLERANCE

// C++ includes
#include <set>
#include <ostream>

namespace libMesh
{


// Forward Declarations
class TreeBase;
class MeshBase;
class Point;
class Elem;


namespace Trees
{
enum BuildType : int {NODES=0,
                ELEMENTS,
                LOCAL_ELEMENTS,
                INVALID_BUILD_TYPE };
}

class TreeBase : public ReferenceCountedObject<TreeBase>
{
protected:
  explicit
  TreeBase (const MeshBase & m) : mesh(m) {}

public:
  virtual ~TreeBase() = default;

  virtual void print_nodes(std::ostream & out_stream=libMesh::out) const = 0;

  virtual void print_elements(std::ostream & out_stream=libMesh::out) const = 0;

  virtual unsigned int n_active_bins() const = 0;

  virtual const Elem * find_element(const Point & p,
                                    const std::set<subdomain_id_type> * allowed_subdomains = nullptr,
                                    Real relative_tol = TOLERANCE) const = 0;

  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 = 0;

protected:

  const MeshBase & mesh;
};

} // namespace libMesh


#endif // LIBMESH_TREE_BASE_H