libMesh::ReferenceCounter Class Reference

Common base for all objects whose creations/destructions are counted. More...

#include <reference_counter.h>

Inheritance diagram for libMesh::ReferenceCounter:

Public Member Functions

 ~ReferenceCounter ()
 

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

 ReferenceCounter ()
 
 ReferenceCounter (const ReferenceCounter &)
 
 ReferenceCounter (ReferenceCounter &&other) noexcept
 
void increment_constructor_count (const std::string &name)
 
void increment_destructor_count (const std::string &name)
 

Static Protected Attributes

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

Detailed Description

Common base for all objects whose creations/destructions are counted.

This is the base class for enabling reference counting. It should not be used by the user, thus it has a private constructor.

Author
Benjamin S. Kirk
Date
2002-2007

Definition at line 44 of file reference_counter.h.

Member Typedef Documentation

◆ Counts

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

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

◆ ReferenceCounter() [1/3]

libMesh::ReferenceCounter::ReferenceCounter ( )
inlineprotected

Constructors. Protected so that you cannot instantiate a ReferenceCounter, only derive from it.

Definition at line 148 of file reference_counter.h.

References _n_objects.

149 {
150  ++_n_objects;
151 }
static Threads::atomic< unsigned int > _n_objects

◆ ReferenceCounter() [2/3]

libMesh::ReferenceCounter::ReferenceCounter ( const ReferenceCounter )
inlineprotected

Definition at line 155 of file reference_counter.h.

References _n_objects.

156 {
157  ++_n_objects;
158 }
static Threads::atomic< unsigned int > _n_objects

◆ ReferenceCounter() [3/3]

libMesh::ReferenceCounter::ReferenceCounter ( ReferenceCounter &&  other)
inlineprotectednoexcept

Move constructor, must be declared noexcept.

Definition at line 162 of file reference_counter.h.

References _n_objects.

163 {
164  ++_n_objects;
165 }
static Threads::atomic< unsigned int > _n_objects

◆ ~ReferenceCounter()

libMesh::ReferenceCounter::~ReferenceCounter ( )
inline

Destructor.

Definition at line 169 of file reference_counter.h.

References _n_objects.

170 {
171  --_n_objects;
172 }
static Threads::atomic< unsigned int > _n_objects

Member Function Documentation

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )
static

Definition at line 106 of file reference_counter.C.

References _enable_print_counter.

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

107 {
108  _enable_print_counter = false;
109  return;
110 }

◆ enable_print_counter_info()

void libMesh::ReferenceCounter::enable_print_counter_info ( )
static

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

Definition at line 100 of file reference_counter.C.

References _enable_print_counter.

101 {
102  _enable_print_counter = true;
103  return;
104 }

◆ get_info()

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

Gets a string containing the reference information.

Definition at line 47 of file reference_counter.C.

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

Referenced by 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 (const auto & pr : _counts)
59  {
60  const std::string name(pr.first);
61  const unsigned int creations = pr.second.first;
62  const unsigned int destructions = pr.second.second;
63 
64  oss << "| " << name << " reference count information:\n"
65  << "| Creations: " << creations << '\n'
66  << "| Destructions: " << destructions << '\n';
67  }
68 
69  oss << " ---------------------------------------------------------------------------- \n";
70 
71  return oss.str();
72 
73 #else
74 
75  return "";
76 
77 #endif
78 }
std::string name(const ElemQuality q)
Definition: elem_quality.C:42

◆ increment_constructor_count()

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

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 _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)
Definition: elem_quality.C:42
spin_mutex spin_mtx
Definition: threads.C:29

◆ increment_destructor_count()

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

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 _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)
Definition: elem_quality.C:42
spin_mutex spin_mtx
Definition: threads.C:29

◆ n_objects()

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

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

Definition at line 83 of file reference_counter.h.

References _n_objects.

84  { return _n_objects; }
static Threads::atomic< unsigned int > _n_objects

◆ print_info()

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

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

Definition at line 87 of file reference_counter.C.

References _enable_print_counter, and get_info().

88 {
90  out_stream << ReferenceCounter::get_info();
91 }
static std::string get_info()

Member Data Documentation

◆ _counts

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts
staticprotected

Actually holds the data.

Definition at line 122 of file reference_counter.h.

Referenced by get_info(), increment_constructor_count(), and increment_destructor_count().

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter = true
staticprotected

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

Definition at line 141 of file reference_counter.h.

Referenced by disable_print_counter_info(), enable_print_counter_info(), and print_info().

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex
staticprotected

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
staticprotected

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 n_objects(), ReferenceCounter(), and ~ReferenceCounter().


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