libMesh::Tree< N > Class Template Reference

Tree class templated on the number of leaves on each node. More...

#include <tree.h>

Inheritance diagram for libMesh::Tree< N >:

Public Member Functions

 Tree (const MeshBase &m, unsigned int target_bin_size, Trees::BuildType bt=Trees::NODES)
 
 Tree (const Tree< N > &other_tree)
 
 ~Tree ()
 
virtual void print_nodes (std::ostream &my_out=libMesh::out) const libmesh_override
 
virtual void print_elements (std::ostream &my_out=libMesh::out) const libmesh_override
 
virtual unsigned int n_active_bins () const libmesh_override
 
virtual const Elemfind_element (const Point &p, const std::set< subdomain_id_type > *allowed_subdomains=libmesh_nullptr, Real relative_tol=TOLERANCE) const libmesh_override
 
const Elemoperator() (const Point &p, const std::set< subdomain_id_type > *allowed_subdomains=libmesh_nullptr, Real relative_tol=TOLERANCE) const
 

Static Public Member Functions

static std::string get_info ()
 
static void print_info (std::ostream &out=libMesh::out)
 
static unsigned int n_objects ()
 
static void enable_print_counter_info ()
 
static void disable_print_counter_info ()
 

Protected Types

typedef std::map< std::string, std::pair< unsigned int, unsigned int > > Counts
 

Protected Member Functions

void increment_constructor_count (const std::string &name)
 
void increment_destructor_count (const std::string &name)
 

Protected Attributes

const MeshBasemesh
 

Static Protected Attributes

static Counts _counts
 
static Threads::atomic< unsigned int > _n_objects
 
static Threads::spin_mutex _mutex
 
static bool _enable_print_counter = true
 

Private Attributes

TreeNode< N > root
 
const Trees::BuildType build_type
 

Detailed Description

template<unsigned int N>
class libMesh::Tree< N >

Tree class templated on the number of leaves on each node.

This class defines a tree that may be used for fast point location in space.

Author
Benjamin S. Kirk
Date
2002

Definition at line 44 of file tree.h.

Member Typedef Documentation

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts
protectedinherited

Data structure to log the information. The log is identified by the class name.

Definition at line 119 of file reference_counter.h.

Constructor & Destructor Documentation

template<unsigned int N>
libMesh::Tree< N >::Tree ( const MeshBase m,
unsigned int  target_bin_size,
Trees::BuildType  bt = Trees::NODES 
)

Constructor. Requires a mesh and the target bin size. Optionally takes the build method.

Definition at line 37 of file tree.C.

References libMesh::MeshBase::active_elements_begin(), libMesh::MeshBase::active_elements_end(), libMesh::MeshBase::active_local_elements_begin(), libMesh::MeshBase::active_local_elements_end(), libMesh::MeshTools::build_nodes_to_elem_map(), libMesh::Tree< N >::build_type, libMesh::MeshTools::create_bounding_box(), libMesh::Trees::ELEMENTS, end, libMesh::libmesh_assert(), libMesh::Trees::LOCAL_ELEMENTS, libMesh::TreeBase::mesh, libMesh::Trees::NODES, libMesh::MeshBase::nodes_begin(), libMesh::MeshBase::nodes_end(), and libMesh::Tree< N >::root.

39  :
40  TreeBase(m),
41  root(m,target_bin_size),
42  build_type(bt)
43 {
44  // Set the root node bounding box equal to the bounding
45  // box for the entire domain.
46  root.set_bounding_box (MeshTools::create_bounding_box(mesh));
47 
48  if (build_type == Trees::NODES)
49  {
50  // Add all the nodes to the root node. It will
51  // automagically build the tree for us.
52  MeshBase::const_node_iterator it = mesh.nodes_begin();
53  const MeshBase::const_node_iterator end = mesh.nodes_end();
54 
55  for (; it != end; ++it)
56  {
57 #ifndef NDEBUG
58  bool node_was_inserted =
59 #endif
60  root.insert (*it);
61  libmesh_assert(node_was_inserted);
62  }
63 
64  // Now the tree contains the nodes.
65  // However, we want element pointers, so here we
66  // convert between the two.
67  std::vector<std::vector<const Elem *> > nodes_to_elem;
68 
70  root.transform_nodes_to_elements (nodes_to_elem);
71  }
72 
73  else if (build_type == Trees::ELEMENTS)
74  {
75  // Add all active elements to the root node. It will
76  // automatically build the tree for us.
77  MeshBase::const_element_iterator it = mesh.active_elements_begin();
78  const MeshBase::const_element_iterator end = mesh.active_elements_end();
79 
80  for (; it != end; ++it)
81  {
82 #ifndef NDEBUG
83  bool elem_was_inserted =
84 #endif
85  root.insert (*it);
86  libmesh_assert(elem_was_inserted);
87  }
88  }
89 
91  {
92  // Add all active, local elements to the root node. It will
93  // automatically build the tree for us.
94  MeshBase::const_element_iterator it = mesh.active_local_elements_begin();
95  const MeshBase::const_element_iterator end = mesh.active_local_elements_end();
96 
97  for (; it != end; ++it)
98  {
99 #ifndef NDEBUG
100  bool elem_was_inserted =
101 #endif
102  root.insert (*it);
103  libmesh_assert(elem_was_inserted);
104  }
105  }
106 
107  else
108  libmesh_error_msg("Unknown build_type = " << build_type);
109 }
TreeNode< N > root
Definition: tree.h:102
void build_nodes_to_elem_map(const MeshBase &mesh, std::vector< std::vector< dof_id_type > > &nodes_to_elem_map)
Definition: mesh_tools.C:258
libMesh::BoundingBox create_bounding_box(const MeshBase &mesh)
Definition: mesh_tools.C:341
TreeBase(const MeshBase &m)
Definition: tree_base.h:118
IterBase * end
libmesh_assert(j)
const MeshBase & mesh
Definition: tree_base.h:110
virtual node_iterator nodes_begin()=0
virtual element_iterator active_local_elements_begin()=0
virtual element_iterator active_elements_begin()=0
virtual element_iterator active_elements_end()=0
virtual node_iterator nodes_end()=0
virtual element_iterator active_local_elements_end()=0
const Trees::BuildType build_type
Definition: tree.h:107
template<unsigned int N>
libMesh::Tree< N >::Tree ( const Tree< N > &  other_tree)

Copy-constructor. Not currently implemented.

Definition at line 115 of file tree.C.

115  :
116  TreeBase (other_tree),
117  root (other_tree.root),
118  build_type (other_tree.build_type)
119 {
120  libmesh_not_implemented();
121 }
TreeNode< N > root
Definition: tree.h:102
TreeBase(const MeshBase &m)
Definition: tree_base.h:118
const Trees::BuildType build_type
Definition: tree.h:107
template<unsigned int N>
libMesh::Tree< N >::~Tree ( )
inline

Destructor.

Definition at line 62 of file tree.h.

References libMesh::out, libMesh::Tree< N >::print_elements(), and libMesh::Tree< N >::print_nodes().

62 {}

Member Function Documentation

void libMesh::ReferenceCounter::disable_print_counter_info ( )
staticinherited
void libMesh::ReferenceCounter::enable_print_counter_info ( )
staticinherited

Methods to enable/disable the reference counter output from print_info()

Definition at line 101 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

Referenced by libMesh::ReferenceCounter::n_objects().

102 {
103  _enable_print_counter = true;
104  return;
105 }
template<unsigned int N>
const Elem * libMesh::Tree< N >::find_element ( const Point p,
const std::set< subdomain_id_type > *  allowed_subdomains = libmesh_nullptr,
Real  relative_tol = TOLERANCE 
) const
virtual
Returns
A pointer to the element containing point p, optionally restricted to a set of allowed subdomains, optionally using a non-zero relative tolerance for searches.

Implements libMesh::TreeBase.

Definition at line 148 of file tree.C.

References libMesh::Tree< N >::root.

Referenced by libMesh::Tree< N >::n_active_bins(), and libMesh::Tree< N >::operator()().

151 {
152  return root.find_element(p, allowed_subdomains, relative_tol);
153 }
TreeNode< N > root
Definition: tree.h:102
std::string libMesh::ReferenceCounter::get_info ( )
staticinherited

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

References libMesh::ReferenceCounter::_counts, and libMesh::Quality::name().

Referenced by libMesh::ReferenceCounter::print_info().

48 {
49 #if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)
50 
51  std::ostringstream oss;
52 
53  oss << '\n'
54  << " ---------------------------------------------------------------------------- \n"
55  << "| Reference count information |\n"
56  << " ---------------------------------------------------------------------------- \n";
57 
58  for (Counts::iterator it = _counts.begin();
59  it != _counts.end(); ++it)
60  {
61  const std::string name(it->first);
62  const unsigned int creations = it->second.first;
63  const unsigned int destructions = it->second.second;
64 
65  oss << "| " << name << " reference count information:\n"
66  << "| Creations: " << creations << '\n'
67  << "| Destructions: " << destructions << '\n';
68  }
69 
70  oss << " ---------------------------------------------------------------------------- \n";
71 
72  return oss.str();
73 
74 #else
75 
76  return "";
77 
78 #endif
79 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:39
void libMesh::ReferenceCounter::increment_constructor_count ( const std::string &  name)
inlineprotectedinherited

Increments the construction counter. Should be called in the constructor of any derived class that will be reference counted.

Definition at line 185 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCounter::n_objects(), and libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

186 {
187  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
188  std::pair<unsigned int, unsigned int> & p = _counts[name];
189 
190  p.first++;
191 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:39
spin_mutex spin_mtx
Definition: threads.C:29
void libMesh::ReferenceCounter::increment_destructor_count ( const std::string &  name)
inlineprotectedinherited

Increments the destruction counter. Should be called in the destructor of any derived class that will be reference counted.

Definition at line 198 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, libMesh::Quality::name(), and libMesh::Threads::spin_mtx.

Referenced by libMesh::ReferenceCounter::n_objects(), and libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().

199 {
200  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
201  std::pair<unsigned int, unsigned int> & p = _counts[name];
202 
203  p.second++;
204 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:39
spin_mutex spin_mtx
Definition: threads.C:29
template<unsigned int N>
virtual unsigned int libMesh::Tree< N >::n_active_bins ( ) const
inlinevirtual
Returns
The number of active bins.

Implements libMesh::TreeBase.

Definition at line 77 of file tree.h.

References libMesh::Tree< N >::find_element(), libmesh_nullptr, libMesh::Tree< N >::operator()(), libMesh::Real, libMesh::Tree< N >::root, and libMesh::TOLERANCE.

78  { return root.n_active_bins(); }
TreeNode< N > root
Definition: tree.h:102
static unsigned int libMesh::ReferenceCounter::n_objects ( )
inlinestaticinherited
template<unsigned int N>
const Elem * libMesh::Tree< N >::operator() ( const Point p,
const std::set< subdomain_id_type > *  allowed_subdomains = libmesh_nullptr,
Real  relative_tol = TOLERANCE 
) const
Returns
A pointer to the element containing point p, optionally restricted to a set of allowed subdomains, optionally using a non-zero relative tolerance for searches.

Definition at line 159 of file tree.C.

References libMesh::Tree< N >::find_element().

Referenced by libMesh::Tree< N >::n_active_bins().

162 {
163  return this->find_element(p, allowed_subdomains, relative_tol);
164 }
virtual const Elem * find_element(const Point &p, const std::set< subdomain_id_type > *allowed_subdomains=libmesh_nullptr, Real relative_tol=TOLERANCE) const libmesh_override
Definition: tree.C:148
template<unsigned int N>
void libMesh::Tree< N >::print_elements ( std::ostream &  my_out = libMesh::out) const
virtual

Prints the nodes.

Implements libMesh::TreeBase.

Definition at line 138 of file tree.C.

References libMesh::Tree< N >::root.

Referenced by libMesh::Tree< N >::~Tree().

139 {
140  my_out << "Printing elements...\n";
141  root.print_elements(my_out);
142 }
TreeNode< N > root
Definition: tree.h:102
void libMesh::ReferenceCounter::print_info ( std::ostream &  out = libMesh::out)
staticinherited

Prints the reference information, by default to libMesh::out.

Definition at line 88 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter, and libMesh::ReferenceCounter::get_info().

Referenced by libMesh::LibMeshInit::LibMeshInit().

89 {
91  out_stream << ReferenceCounter::get_info();
92 }
static std::string get_info()
template<unsigned int N>
void libMesh::Tree< N >::print_nodes ( std::ostream &  my_out = libMesh::out) const
virtual

Prints the nodes.

Implements libMesh::TreeBase.

Definition at line 129 of file tree.C.

References libMesh::Tree< N >::root.

Referenced by libMesh::Tree< N >::~Tree().

130 {
131  my_out << "Printing nodes...\n";
132  root.print_nodes(my_out);
133 }
TreeNode< N > root
Definition: tree.h:102

Member Data Documentation

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts
staticprotectedinherited
bool libMesh::ReferenceCounter::_enable_print_counter = true
staticprotectedinherited

Flag to control whether reference count information is printed when print_info is called.

Definition at line 143 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().

Threads::spin_mutex libMesh::ReferenceCounter::_mutex
staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 137 of file reference_counter.h.

Threads::atomic< unsigned int > libMesh::ReferenceCounter::_n_objects
staticprotectedinherited

The number of objects. Print the reference count information when the number returns to 0.

Definition at line 132 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

template<unsigned int N>
const Trees::BuildType libMesh::Tree< N >::build_type
private

How the tree is built.

Definition at line 107 of file tree.h.

Referenced by libMesh::Tree< N >::Tree().

const MeshBase& libMesh::TreeBase::mesh
protectedinherited

Constant reference to a mesh. Declared at construction.

Definition at line 110 of file tree_base.h.

Referenced by libMesh::Tree< N >::Tree().


The documentation for this class was generated from the following files: