#include <sum_shell_matrix.h>

Inheritance diagram for libMesh::SumShellMatrix< T >:

Public Member Functions
	SumShellMatrix (const Parallel::Communicator &comm_in LIBMESH_CAN_DEFAULT_TO_COMMWORLD)
	SumShellMatrix (const std::vector< ShellMatrix< T > * > &mat, const Parallel::Communicator &comm_in LIBMESH_CAN_DEFAULT_TO_COMMWORLD)
virtual	~SumShellMatrix ()
virtual numeric_index_type	m () const
virtual numeric_index_type	n () const
virtual void	vector_mult (NumericVector< T > &dest, const NumericVector< T > &arg) const
virtual void	vector_mult_add (NumericVector< T > &dest, const NumericVector< T > &arg) const
virtual void	get_diagonal (NumericVector< T > &dest) const
const Parallel::Communicator &	comm () const
processor_id_type	n_processors () const
processor_id_type	processor_id () 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 ()
Public Attributes
std::vector< ShellMatrix< T > * >	matrices
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 Parallel::Communicator &	_communicator
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::SumShellMatrix< T >

This class combines any number of shell matrices to a single shell matrix, acting as the sum of the matrices.

Author:: Tim Kroeger, 2008

Definition at line 45 of file sum_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::SumShellMatrix< T >::SumShellMatrix ( const Parallel::Communicator &comm_in LIBMESH_CAN_DEFAULT_TO_COMMWORLD )

Constructor; initializes an empty sum. Note that an empty sum is not a valid object in that a call to m() or n() will result in an error. However, an empty sum is allowed to be multiplied with a vector and will give the expected result.

template<typename T >

libMesh::SumShellMatrix< T >::SumShellMatrix	(	const std::vector< ShellMatrix< T > * > &	mat,
		const Parallel::Communicator &comm_in	LIBMESH_CAN_DEFAULT_TO_COMMWORLD
	)		`[explicit]`

Constructor that passes a vector of shell matrices.

template<typename T >

libMesh::SumShellMatrix< T >::~SumShellMatrix ( ) [inline, virtual]

Destructor.

Definition at line 132 of file sum_shell_matrix.h.

{}

Member Function Documentation

const Parallel::Communicator& libMesh::ParallelObject::comm ( ) const [inline, inherited]

Returns:: a reference to the Parallel::Communicator object used by this mesh.

Definition at line 86 of file parallel_object.h.

References libMesh::ParallelObject::_communicator.

  { return _communicator; }

void libMesh::ReferenceCounter::disable_print_counter_info ( ) [static, inherited]

Definition at line 106 of file reference_counter.C.

References libMesh::ReferenceCounter::_enable_print_counter.

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

{
  _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 >

void libMesh::SumShellMatrix< T >::get_diagonal ( NumericVector< T > & dest ) const [virtual]

Copies the diagonal part of the matrix into dest.

Implements libMesh::ShellMatrix< T >.

Definition at line 82 of file sum_shell_matrix.C.

References libMesh::NumericVector< T >::clone(), and libMesh::NumericVector< T >::zero().

{
  UniquePtr<NumericVector<T> > a = dest.clone();
  dest.zero();
  for(std::size_t i=matrices.size(); i-->0; )
    {
      matrices[i]->get_diagonal(*a);
      dest += *a;
    }
}

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, libMesh::Quality::name(), 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, libMesh::Quality::name(), 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 >

numeric_index_type libMesh::SumShellMatrix< T >::m ( ) const [virtual]

Returns:: m, the row-dimension of the matrix where the marix is $M \times N$ .

Implements libMesh::ShellMatrix< T >.

Definition at line 28 of file sum_shell_matrix.C.

References libMesh::libmesh_assert().

{
  libmesh_assert(!matrices.empty());
  const numeric_index_type result = matrices[0]->m();
#ifndef NDEBUG
  for(std::size_t i=matrices.size(); i-->1; )
    {
      libmesh_assert_equal_to (matrices[i]->m(), result);
    }
#endif
  return result;
}

template<typename T >

numeric_index_type libMesh::SumShellMatrix< T >::n ( ) const [virtual]

Returns:: n, the column-dimension of the matrix where the marix is $M \times N$ .

Implements libMesh::ShellMatrix< T >.

Definition at line 44 of file sum_shell_matrix.C.

References libMesh::libmesh_assert().

{
  libmesh_assert(!matrices.empty());
  const numeric_index_type result = matrices[0]->n();
#ifndef NDEBUG
  for(std::size_t i=matrices.size(); i-->1; )
    {
      libmesh_assert_equal_to (matrices[i]->n(), result);
    }
#endif
  return result;
}

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.

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

  { return _n_objects; }

processor_id_type libMesh::ParallelObject::n_processors ( ) const [inline, inherited]

Returns:: the number of processors in the group.

Definition at line 92 of file parallel_object.h.

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

  { return cast_int<processor_id_type>(_communicator.size()); }

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

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

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

processor_id_type libMesh::ParallelObject::processor_id ( ) const [inline, inherited]

Returns:: the rank of this processor in the group.

Definition at line 98 of file parallel_object.h.

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

  { return cast_int<processor_id_type>(_communicator.rank()); }

template<typename T >

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

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

Implements libMesh::ShellMatrix< T >.

Definition at line 60 of file sum_shell_matrix.C.

References libMesh::NumericVector< T >::zero().

{
  dest.zero();
  this->vector_mult_add(dest,arg);
}

template<typename T >

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

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

Implements libMesh::ShellMatrix< T >.

Definition at line 70 of file sum_shell_matrix.C.

{
  for(std::size_t i=matrices.size(); i-->0; )
    {
      matrices[i]->vector_mult_add(dest,arg);
    }
}

Member Data Documentation

const Parallel::Communicator& libMesh::ParallelObject::_communicator [protected, inherited]

Definition at line 104 of file parallel_object.h.

Referenced by libMesh::EquationSystems::build_solution_vector(), libMesh::ParallelObject::comm(), libMesh::EquationSystems::get_solution(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), and libMesh::ParallelObject::processor_id().

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

template<typename T >

std::vector<ShellMatrix<T>*> libMesh::SumShellMatrix< T >::matrices

A vector of the summands.

Definition at line 103 of file sum_shell_matrix.h.

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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