libMesh
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
libMesh::Tree< N > Class Template Reference

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

#include <tree.h>

Inheritance diagram for libMesh::Tree< N >:
[legend]

Public Member Functions

 Tree (const MeshBase &m, unsigned int target_bin_size, Trees::BuildType bt=Trees::NODES)
 Constructor. More...
 
 Tree (const Tree< N > &other_tree)
 Copy-constructor. More...
 
 ~Tree ()
 Destructor. More...
 
virtual void print_nodes (std::ostream &my_out=libMesh::out) const override
 Prints the nodes. More...
 
virtual void print_elements (std::ostream &my_out=libMesh::out) const override
 Prints the nodes. More...
 
virtual unsigned int n_active_bins () const override
 
virtual const Elemfind_element (const Point &p, const std::set< subdomain_id_type > *allowed_subdomains=nullptr, Real relative_tol=TOLERANCE) const override
 
const Elemoperator() (const Point &p, const std::set< subdomain_id_type > *allowed_subdomains=nullptr, Real relative_tol=TOLERANCE) const
 

Static Public Member Functions

static std::string get_info ()
 Gets a string containing the reference information. More...
 
static void print_info (std::ostream &out=libMesh::out)
 Prints the reference information, by default to libMesh::out. More...
 
static unsigned int n_objects ()
 Prints the number of outstanding (created, but not yet destroyed) objects. More...
 
static void enable_print_counter_info ()
 Methods to enable/disable the reference counter output from print_info() More...
 
static void disable_print_counter_info ()
 

Protected Types

typedef std::map< std::string, std::pair< unsigned int, unsigned int > > Counts
 Data structure to log the information. More...
 

Protected Member Functions

void increment_constructor_count (const std::string &name)
 Increments the construction counter. More...
 
void increment_destructor_count (const std::string &name)
 Increments the destruction counter. More...
 

Protected Attributes

const MeshBasemesh
 Constant reference to a mesh. More...
 

Static Protected Attributes

static Counts _counts
 Actually holds the data. More...
 
static Threads::atomic< unsigned int > _n_objects
 The number of objects. More...
 
static Threads::spin_mutex _mutex
 Mutual exclusion object to enable thread-safe reference counting. More...
 
static bool _enable_print_counter
 Flag to control whether reference count information is printed when print_info is called. More...
 

Private Attributes

TreeNode< N > root
 The tree root. More...
 
const Trees::BuildType build_type
 How the tree is built. More...
 

Detailed Description

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

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

Author
Benjamin S. Kirk
Date
2002 Tree class templated on the number of leaves on each node.

Definition at line 44 of file tree.h.

Member Typedef Documentation

◆ Counts

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 117 of file reference_counter.h.

Constructor & Destructor Documentation

◆ Tree() [1/2]

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.

◆ Tree() [2/2]

template<unsigned int N>
libMesh::Tree< N >::Tree ( const Tree< N > &  other_tree)

Copy-constructor.

Not currently implemented.

◆ ~Tree()

template<unsigned int N>
libMesh::Tree< N >::~Tree ( )

Destructor.

Definition at line 62 of file tree.h.

62 {}

Member Function Documentation

◆ disable_print_counter_info()

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

◆ enable_print_counter_info()

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

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

◆ find_element()

template<unsigned int N>
virtual const Elem* libMesh::Tree< N >::find_element ( const Point p,
const std::set< subdomain_id_type > *  allowed_subdomains = nullptr,
Real  relative_tol = TOLERANCE 
) const
overridevirtual
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.

◆ get_info()

static std::string libMesh::ReferenceCounter::get_info ( )
staticinherited

Gets a string containing the reference information.

◆ increment_constructor_count()

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string &  name)
protectedinherited

Increments the construction counter.

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

Definition at line 181 of file reference_counter.h.

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

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::ReferenceCountedObject().

182 {
183  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
184  std::pair<unsigned int, unsigned int> & p = _counts[name];
185 
186  p.first++;
187 }
std::string name(const ElemQuality q)
static Counts _counts
Actually holds the data.
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.

◆ increment_destructor_count()

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string &  name)
protectedinherited

Increments the destruction counter.

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

Definition at line 194 of file reference_counter.h.

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

Referenced by libMesh::ReferenceCountedObject< RBParametrized >::~ReferenceCountedObject().

195 {
196  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
197  std::pair<unsigned int, unsigned int> & p = _counts[name];
198 
199  p.second++;
200 }
std::string name(const ElemQuality q)
static Counts _counts
Actually holds the data.
spin_mutex spin_mtx
A convenient spin mutex object which can be used for obtaining locks.

◆ n_active_bins()

template<unsigned int N>
virtual unsigned int libMesh::Tree< N >::n_active_bins ( ) const
overridevirtual
Returns
The number of active bins.

Implements libMesh::TreeBase.

Definition at line 77 of file tree.h.

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

78  { return root.n_active_bins(); }
TreeNode< N > root
The tree root.
Definition: tree.h:102

◆ n_objects()

static unsigned int libMesh::ReferenceCounter::n_objects ( )
staticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 83 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

84  { return _n_objects; }
static Threads::atomic< unsigned int > _n_objects
The number of objects.

◆ operator()()

template<unsigned int N>
const Elem* libMesh::Tree< N >::operator() ( const Point p,
const std::set< subdomain_id_type > *  allowed_subdomains = 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.

◆ print_elements()

template<unsigned int N>
virtual void libMesh::Tree< N >::print_elements ( std::ostream &  my_out = libMesh::out) const
overridevirtual

Prints the nodes.

Implements libMesh::TreeBase.

◆ print_info()

static void libMesh::ReferenceCounter::print_info ( std::ostream &  out = libMesh::out)
staticinherited

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

◆ print_nodes()

template<unsigned int N>
virtual void libMesh::Tree< N >::print_nodes ( std::ostream &  my_out = libMesh::out) const
overridevirtual

Prints the nodes.

Implements libMesh::TreeBase.

Member Data Documentation

◆ _counts

Counts libMesh::ReferenceCounter::_counts
staticprotectedinherited

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter
staticprotectedinherited

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

Definition at line 141 of file reference_counter.h.

◆ _mutex

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

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _n_objects

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 130 of file reference_counter.h.

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

◆ build_type

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.

◆ mesh

const MeshBase& libMesh::TreeBase::mesh
protectedinherited

Constant reference to a mesh.

Declared at construction.

Definition at line 110 of file tree_base.h.

◆ root

template<unsigned int N>
TreeNode<N> libMesh::Tree< N >::root
private

The tree root.

Definition at line 102 of file tree.h.

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


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