libMesh::Preconditioner< T > Class Template Reference

#include <preconditioner.h>

Inheritance diagram for libMesh::Preconditioner< T >:

[legend]

List of all members.

Public Member Functions
	Preconditioner ()
virtual	~Preconditioner ()
bool	initialized () const
virtual void	apply (const NumericVector< T > &x, NumericVector< T > &y)=0
virtual void	clear ()
virtual void	init ()
virtual void	setup ()
void	set_matrix (SparseMatrix< Number > &mat)
PreconditionerType	type () const
void	set_type (const PreconditionerType pct)
Static Public Member Functions
static Preconditioner< T > *	build (const SolverPackage solver_package=libMesh::default_solver_package())
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)
Protected Attributes
SparseMatrix< T > *	_matrix
PreconditionerType	_preconditioner_type
bool	_is_initialized
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::Preconditioner< T >

This class provides a uniform interface for preconditioners. This base class is overloaded to provide linear solvers from different packages like PETSC or Trilinos.

In the below comments P is the matrix to be preconditioned with Apply() performing the equivalent of the matrix vector product P^-1 x. This can also be thought of as (usually approximately) solving for Py=x.

Author:

Derek Gaston, 2009

Definition at line 61 of file preconditioner.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::Preconditioner< T >::Preconditioner

(

)

[inline]

Constructor. Initializes Preconditioner data structures

Definition at line 154 of file preconditioner.h.

                                   :
  _matrix(NULL),
  _preconditioner_type (ILU_PRECOND),
  _is_initialized      (false)
{
}

template<typename T >

libMesh::Preconditioner< T >::~Preconditioner

(

)

[inline, virtual]

Destructor.

Definition at line 165 of file preconditioner.h.

References libMesh::Preconditioner< T >::clear().

{
  this->clear ();
}

---

Member Function Documentation

template<typename T>

virtual void libMesh::Preconditioner< T >::apply	(	const NumericVector< T > &	x,
		NumericVector< T > &	y
	)			[pure virtual]

Computes the preconditioned vector "y" based on input "x". Usually by solving Py=x to get the action of P^-1 x.

Implemented in libMesh::PetscPreconditioner< T >, and libMesh::TrilinosPreconditioner< T >.

template<typename T >

Preconditioner< T > * libMesh::Preconditioner< T >::build

(

const SolverPackage

solver_package = libMesh::default_solver_package()

)

[inline, static]

Builds a Preconditioner using the linear solver package specified by solver_package

Definition at line 35 of file preconditioner.C.

References libMesh::err, libMeshEnums::PETSC_SOLVERS, and libMesh::TRILINOS_SOLVERS.

{
  // Build the appropriate solver
  switch (solver_package)
    {

/*
#ifdef LIBMESH_HAVE_LASPACK
    case LASPACK_SOLVERS:
      {
        AutoPtr<Preconditioner<T> > ap(new LaspackPreconditioner<T>);
        return ap;
      }
#endif
*/

#ifdef LIBMESH_HAVE_PETSC
    case PETSC_SOLVERS:
      {
        return new PetscPreconditioner<T>();
      }
#endif

#ifdef LIBMESH_HAVE_TRILINOS
    case TRILINOS_SOLVERS:
      return new TrilinosPreconditioner<T>();
#endif

    default:
      libMesh::err << "ERROR:  Unrecognized solver package: "
                    << solver_package
                    << std::endl;
      libmesh_error();
    }

  return NULL;
}

template<typename T>

virtual void libMesh::Preconditioner< T >::clear

(

)

[inline, virtual]

Release all memory and clear data structures.

Reimplemented in libMesh::PetscPreconditioner< T >, and libMesh::TrilinosPreconditioner< T >.

Definition at line 97 of file preconditioner.h.

Referenced by libMesh::Preconditioner< T >::~Preconditioner().

{}

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;
}

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 void libMesh::Preconditioner< T >::init

(

)

[inline, virtual]

Initialize data structures if not done so already.

This MUST be called before the preconditioning object is used.

Reimplemented in libMesh::PetscPreconditioner< T >, and libMesh::TrilinosPreconditioner< T >.

Definition at line 104 of file preconditioner.h.

{}

template<typename T>

bool libMesh::Preconditioner< T >::initialized

(

)

const [inline]

Returns:

true if the data structures are initialized, false otherwise.

Definition at line 86 of file preconditioner.h.

{ return _is_initialized; }

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 >

void libMesh::Preconditioner< T >::set_matrix

(

SparseMatrix< Number > &

mat

)

[inline]

Sets the matrix P to be preconditioned.

Definition at line 172 of file preconditioner.h.

References libMesh::Preconditioner< T >::_is_initialized, and libMesh::Preconditioner< T >::_matrix.

{
  //If the matrix is changing then we (probably) need to reinitialize.
  _is_initialized = false;
  _matrix = &mat;
}

template<typename T >

void libMesh::Preconditioner< T >::set_type

(

const PreconditionerType

pct

)

[inline]

Sets the type of preconditioner to use.

Definition at line 181 of file preconditioner.h.

References libMesh::Preconditioner< T >::_is_initialized, and libMesh::Preconditioner< T >::_preconditioner_type.

{
  //If the preconditioner type changes we (probably) need to reinitialize.
  _is_initialized = false;
  _preconditioner_type = pct;
}

template<typename T>

virtual void libMesh::Preconditioner< T >::setup

(

)

[inline, virtual]

This is called every time the "operator might have changed".

This is essentially where you need to fill in your preconditioning matrix.

Definition at line 111 of file preconditioner.h.

{}

template<typename T>

PreconditionerType libMesh::Preconditioner< T >::type

(

)

const [inline]

Returns the type of preconditioner to use.

Definition at line 121 of file preconditioner.h.

  { return _preconditioner_type; }

---

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

template<typename T>

bool libMesh::Preconditioner< T >::_is_initialized [protected]

Flag indicating if the data structures have been initialized.

Definition at line 145 of file preconditioner.h.

Referenced by libMesh::TrilinosPreconditioner< T >::init(), libMesh::PetscPreconditioner< T >::init(), libMesh::Preconditioner< Number >::initialized(), libMesh::Preconditioner< T >::set_matrix(), and libMesh::Preconditioner< T >::set_type().

template<typename T>

SparseMatrix<T>* libMesh::Preconditioner< T >::_matrix [protected]

The matrix P... ie the matrix to be preconditioned. This is often the actual system matrix of a linear sytem.

Definition at line 135 of file preconditioner.h.

Referenced by libMesh::TrilinosPreconditioner< T >::init(), libMesh::PetscPreconditioner< T >::init(), and libMesh::Preconditioner< T >::set_matrix().

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>

PreconditionerType libMesh::Preconditioner< T >::_preconditioner_type [protected]

Enum statitng with type of preconditioner to use.

Definition at line 140 of file preconditioner.h.

Referenced by libMesh::TrilinosPreconditioner< T >::compute(), libMesh::TrilinosPreconditioner< T >::init(), libMesh::PetscPreconditioner< T >::init(), libMesh::Preconditioner< T >::set_type(), and libMesh::Preconditioner< Number >::type().

---

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

• preconditioner.h
• preconditioner.C