libMesh
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
libMesh::SparseShellMatrix< T > Class Template Reference

This class allows to use any SparseMatrix object as a shell matrix. More...

#include <sparse_shell_matrix.h>

Inheritance diagram for libMesh::SparseShellMatrix< T >:
[legend]

Public Member Functions

 SparseShellMatrix (const SparseMatrix< T > &new_m)
 Constructor; takes references to the sparse matrix. More...
 
virtual ~SparseShellMatrix ()
 Destructor. More...
 
virtual numeric_index_type m () const override
 
virtual numeric_index_type n () const override
 
virtual void vector_mult (NumericVector< T > &dest, const NumericVector< T > &arg) const override
 Multiplies the matrix with arg and stores the result in dest. More...
 
virtual void vector_mult_add (NumericVector< T > &dest, const NumericVector< T > &arg) const override
 Multiplies the matrix with arg and adds the result to dest. More...
 
virtual void get_diagonal (NumericVector< T > &dest) const override
 Copies the diagonal part of the matrix into dest. More...
 
const Parallel::Communicatorcomm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () 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 SparseMatrix< T > & _m
 The sparse matrix. More...
 
const Parallel::Communicator_communicator
 

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...
 

Detailed Description

template<typename T>
class libMesh::SparseShellMatrix< T >

This class allows to use any SparseMatrix object as a shell matrix.

All overridden virtual functions are documented in shell_matrix.h.

Author
Tim Kroeger
Date
2008

Definition at line 43 of file sparse_shell_matrix.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

◆ SparseShellMatrix()

template<typename T >
libMesh::SparseShellMatrix< T >::SparseShellMatrix ( const SparseMatrix< T > &  new_m)
explicit

Constructor; takes references to the sparse matrix.

The sparse matrix itself has to be stored elsewhere.

Definition at line 83 of file sparse_shell_matrix.h.

83  :
84  ShellMatrix<T>(new_m.comm()),
85  _m(new_m)
86 {}
const SparseMatrix< T > & _m
The sparse matrix.

◆ ~SparseShellMatrix()

template<typename T >
libMesh::SparseShellMatrix< T >::~SparseShellMatrix ( )
virtual

Destructor.

Definition at line 92 of file sparse_shell_matrix.h.

93 {}

Member Function Documentation

◆ comm()

const Parallel::Communicator& libMesh::ParallelObject::comm ( ) const
inherited

◆ 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()

◆ get_diagonal()

template<typename T >
void libMesh::SparseShellMatrix< T >::get_diagonal ( NumericVector< T > &  dest) const
overridevirtual

Copies the diagonal part of the matrix into dest.

Implements libMesh::ShellMatrix< T >.

Definition at line 117 of file sparse_shell_matrix.h.

118 {
119  _m.get_diagonal(dest);
120 }
const SparseMatrix< T > & _m
The sparse matrix.

◆ 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.

◆ m()

template<typename T >
numeric_index_type libMesh::SparseShellMatrix< T >::m ( ) const
overridevirtual
Returns
m, the row-dimension of the matrix where the matrix is $ M \times N $.

Implements libMesh::ShellMatrix< T >.

Definition at line 99 of file sparse_shell_matrix.h.

100 {
101  return _m.m();
102 }
const SparseMatrix< T > & _m
The sparse matrix.

◆ n()

template<typename T >
numeric_index_type libMesh::SparseShellMatrix< T >::n ( ) const
overridevirtual
Returns
n, the column-dimension of the matrix where the matrix is $ M \times N $.

Implements libMesh::ShellMatrix< T >.

Definition at line 108 of file sparse_shell_matrix.h.

109 {
110  return _m.n();
111 }
const SparseMatrix< T > & _m
The sparse matrix.

◆ 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.

◆ n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const
inherited
Returns
The number of processors in the group.

Definition at line 93 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::size().

Referenced by libMesh::MeshBase::partition().

94  { return cast_int<processor_id_type>(_communicator.size()); }
processor_id_type size() const
Definition: communicator.h:175
const Parallel::Communicator & _communicator

◆ print_info()

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

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

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const
inherited

◆ vector_mult()

template<typename T >
virtual void libMesh::SparseShellMatrix< T >::vector_mult ( NumericVector< T > &  dest,
const NumericVector< T > &  arg 
) const
overridevirtual

Multiplies the matrix with arg and stores the result in dest.

Implements libMesh::ShellMatrix< T >.

◆ vector_mult_add()

template<typename T >
virtual void libMesh::SparseShellMatrix< T >::vector_mult_add ( NumericVector< T > &  dest,
const NumericVector< T > &  arg 
) const
overridevirtual

Multiplies the matrix with arg and adds the result to dest.

Implements libMesh::ShellMatrix< T >.

Member Data Documentation

◆ _communicator

const Parallel::Communicator& libMesh::ParallelObject::_communicator
protectedinherited

◆ _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.

◆ _m

template<typename T >
const SparseMatrix<T>& libMesh::SparseShellMatrix< T >::_m
protected

The sparse matrix.

Definition at line 74 of file sparse_shell_matrix.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().


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