libMesh::ShellMatrix< T > Class Template Reference

#include <shell_matrix.h>

Inheritance diagram for libMesh::ShellMatrix< T >:

[legend]

List of all members.

Public Member Functions
	ShellMatrix ()
virtual	~ShellMatrix ()
virtual numeric_index_type	m () const =0
virtual numeric_index_type	n () const =0
virtual void	vector_mult (NumericVector< T > &dest, const NumericVector< T > &arg) const =0
virtual void	vector_mult_add (NumericVector< T > &dest, const NumericVector< T > &arg) const =0
virtual void	get_diagonal (NumericVector< T > &dest) const =0
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)
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

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

Generic shell matrix, i.e. a matrix that does not define anything but its action on a vector. This class contains pure virtual members that must be overloaded in derived classes.

Author:

Tim Kroeger, 2008

Definition at line 46 of file shell_matrix.h.

---

Member Typedef Documentation

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

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

Definition at line 113 of file reference_counter.h.

---

Constructor & Destructor Documentation

template<typename T >

libMesh::ShellMatrix< T >::ShellMatrix

(

)

[inline]

Constructor; does nothing.

Definition at line 97 of file shell_matrix.h.

{}

template<typename T >

libMesh::ShellMatrix< T >::~ShellMatrix

(

)

[inline, virtual]

Destructor.

Definition at line 104 of file shell_matrix.h.

{}

---

Member Function Documentation

void libMesh::ReferenceCounter::disable_print_counter_info

(

)

[static, inherited]

Definition at line 106 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

{
  _enable_print_counter = false;
  return;
}

void libMesh::ReferenceCounter::enable_print_counter_info

(

)

[static, inherited]

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

Definition at line 100 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

{
  _enable_print_counter = true;
  return;
}

template<typename T>

virtual void libMesh::ShellMatrix< T >::get_diagonal

(

NumericVector< T > &

dest

)

const [pure virtual]

Copies the diagonal part of the matrix into dest.

Implemented in libMesh::SparseShellMatrix< T >, libMesh::SumShellMatrix< T >, and libMesh::TensorShellMatrix< T >.

Referenced by libMesh::SlepcEigenSolver< T >::_petsc_shell_matrix_get_diagonal(), and libMesh::PetscLinearSolver< T >::_petsc_shell_matrix_get_diagonal().

std::string libMesh::ReferenceCounter::get_info

(

)

[static, inherited]

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

{
#if defined(LIBMESH_ENABLE_REFERENCE_COUNTING) && defined(DEBUG)

  std::ostringstream oss;

  oss << '\n'
      << " ---------------------------------------------------------------------------- \n"
      << "| Reference count information                                                |\n"
      << " ---------------------------------------------------------------------------- \n";

  for (Counts::iterator it = _counts.begin();
       it != _counts.end(); ++it)
    {
      const std::string name(it->first);
      const unsigned int creations    = it->second.first;
      const unsigned int destructions = it->second.second;

      oss << "| " << name << " reference count information:\n"
          << "|  Creations:    " << creations    << '\n'
          << "|  Destructions: " << destructions << '\n';
    }

  oss << " ---------------------------------------------------------------------------- \n";

  return oss.str();

#else

  return "";

#endif
}

void libMesh::ReferenceCounter::increment_constructor_count

(

const std::string &

name

)

[inline, protected, inherited]

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

Definition at line 163 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, and libMesh::Threads::spin_mtx.

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

{
  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
  std::pair<unsigned int, unsigned int>& p = _counts[name];

  p.first++;
}

void libMesh::ReferenceCounter::increment_destructor_count

(

const std::string &

name

)

[inline, protected, inherited]

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

Definition at line 176 of file reference_counter.h.

References libMesh::ReferenceCounter::_counts, and libMesh::Threads::spin_mtx.

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

{
  Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
  std::pair<unsigned int, unsigned int>& p = _counts[name];

  p.second++;
}

template<typename T>

virtual numeric_index_type libMesh::ShellMatrix< T >::m

(

)

const [pure virtual]

Returns:

m, the row-dimension of the matrix where the marix is .

Implemented in libMesh::SparseShellMatrix< T >, libMesh::SumShellMatrix< T >, and libMesh::TensorShellMatrix< T >.

Referenced by libMesh::SlepcEigenSolver< T >::solve_generalized(), and libMesh::SlepcEigenSolver< T >::solve_standard().

template<typename T>

virtual numeric_index_type libMesh::ShellMatrix< T >::n

(

)

const [pure virtual]

Returns:

n, the column-dimension of the matrix where the marix is .

Implemented in libMesh::SparseShellMatrix< T >, libMesh::SumShellMatrix< T >, and libMesh::TensorShellMatrix< T >.

Referenced by libMesh::SlepcEigenSolver< T >::solve_generalized(), and libMesh::SlepcEigenSolver< T >::solve_standard().

static unsigned int libMesh::ReferenceCounter::n_objects

(

)

[inline, static, inherited]

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

Definition at line 79 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

  { return _n_objects; }

void libMesh::ReferenceCounter::print_info

(

std::ostream &

out = libMesh::out

)

[static, inherited]

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

{
  if( _enable_print_counter ) out_stream << ReferenceCounter::get_info();
}

template<typename T>

virtual void libMesh::ShellMatrix< T >::vector_mult	(	NumericVector< T > &	dest,
		const NumericVector< T > &	arg
	)			const [pure virtual]

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

Implemented in libMesh::SparseShellMatrix< T >, libMesh::SumShellMatrix< T >, and libMesh::TensorShellMatrix< T >.

Referenced by libMesh::SlepcEigenSolver< T >::_petsc_shell_matrix_mult(), and libMesh::PetscLinearSolver< T >::_petsc_shell_matrix_mult().

template<typename T>

virtual void libMesh::ShellMatrix< T >::vector_mult_add	(	NumericVector< T > &	dest,
		const NumericVector< T > &	arg
	)			const [pure virtual]

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

Implemented in libMesh::SparseShellMatrix< T >, libMesh::SumShellMatrix< T >, and libMesh::TensorShellMatrix< T >.

Referenced by libMesh::PetscLinearSolver< T >::_petsc_shell_matrix_mult_add(), and libMesh::NumericVector< T >::add_vector().

---

Member Data Documentation

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts [static, protected, inherited]

Actually holds the data.

Definition at line 118 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::get_info(), libMesh::ReferenceCounter::increment_constructor_count(), and libMesh::ReferenceCounter::increment_destructor_count().

bool libMesh::ReferenceCounter::_enable_print_counter = true [static, protected, inherited]

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

Definition at line 137 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 [static, protected, inherited]

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 131 of file reference_counter.h.

Threads::atomic< unsigned int > libMesh::ReferenceCounter::_n_objects [static, protected, inherited]

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

Definition at line 126 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:

• shell_matrix.h