#include <trilinos_preconditioner.h>

Inheritance diagram for libMesh::TrilinosPreconditioner< T >:

Public Member Functions
	TrilinosPreconditioner (const libMesh::Parallel::Communicator &comm LIBMESH_CAN_DEFAULT_TO_COMMWORLD)
virtual	~TrilinosPreconditioner ()
virtual void	apply (const NumericVector< T > &x, NumericVector< T > &y)
virtual void	clear ()
virtual void	init ()
void	set_params (Teuchos::ParameterList &list)
Epetra_FECrsMatrix *	mat ()
void	set_preconditioner_type (const PreconditionerType &preconditioner_type)
void	compute ()
bool	initialized () const
virtual void	setup ()
void	set_matrix (SparseMatrix< Number > &mat)
PreconditionerType	type () const
void	set_type (const PreconditionerType pct)
const Parallel::Communicator &	comm () const
processor_id_type	n_processors () const
processor_id_type	processor_id () const
Static Public Member Functions
static Preconditioner< T > *	build (const libMesh::Parallel::Communicator &comm LIBMESH_CAN_DEFAULT_TO_COMMWORLD, 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
virtual int	SetUseTranspose (bool UseTranspose)
virtual int	Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
virtual int	ApplyInverse (const Epetra_MultiVector &r, Epetra_MultiVector &z) const
virtual double	NormInf () const
virtual const char *	Label () const
virtual bool	UseTranspose () const
virtual bool	HasNormInf () const
virtual const Epetra_Comm &	Comm () const
virtual const Epetra_Map &	OperatorDomainMap () const
virtual const Epetra_Map &	OperatorRangeMap () const
void	increment_constructor_count (const std::string &name)
void	increment_destructor_count (const std::string &name)
Protected Attributes
Epetra_Operator *	_prec
Epetra_FECrsMatrix *	_mat
Teuchos::ParameterList	_param_list
SparseMatrix< T > *	_matrix
PreconditionerType	_preconditioner_type
bool	_is_initialized
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::TrilinosPreconditioner< T >

This class provides an interface to the suite of preconditioners available from Trilinos.

Author:: David Andrs, 2011

Definition at line 60 of file trilinos_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::TrilinosPreconditioner< T >::TrilinosPreconditioner ( const libMesh::Parallel::Communicator &comm LIBMESH_CAN_DEFAULT_TO_COMMWORLD ) [inline]

Constructor. Initializes PetscPreconditioner data structures

Definition at line 145 of file trilinos_preconditioner.h.

                                                                                          :
  Preconditioner<T>(comm),
  _prec(NULL),
  _mat(NULL)
{
}

template<typename T >

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

Destructor.

Definition at line 156 of file trilinos_preconditioner.h.

{
  this->clear ();
}

Member Function Documentation

template<typename T >

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

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

Implements libMesh::Preconditioner< T >.

Definition at line 46 of file trilinos_preconditioner.C.

{
}

template<typename T >

int libMesh::TrilinosPreconditioner< T >::Apply	(	const Epetra_MultiVector &	X,
		Epetra_MultiVector &	Y
	)		const `[protected, virtual]`

Definition at line 185 of file trilinos_preconditioner.C.

{
  return _prec->Apply(X, Y);
}

template<typename T >

int libMesh::TrilinosPreconditioner< T >::ApplyInverse	(	const Epetra_MultiVector &	r,
		Epetra_MultiVector &	z
	)		const `[protected, virtual]`

Definition at line 192 of file trilinos_preconditioner.C.

{
  return _prec->ApplyInverse(r, z);
}

template<typename T>

Preconditioner< T > * libMesh::Preconditioner< T >::build	(	const libMesh::Parallel::Communicator &comm	LIBMESH_CAN_DEFAULT_TO_COMMWORLD,
		const SolverPackage	solver_package = `libMesh::default_solver_package()`
	)		`[static, inherited]`

Builds a Preconditioner using the linear solver package specified by solver_package

Definition at line 38 of file preconditioner.C.

References libMesh::EIGEN_SOLVERS, libMesh::PETSC_SOLVERS, and libMesh::TRILINOS_SOLVERS.

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

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

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

#ifdef LIBMESH_HAVE_EIGEN
    case EIGEN_SOLVERS:
      return new EigenPreconditioner<T>(comm);
#endif

    default:
      libmesh_error_msg("ERROR:  Unrecognized solver package: " << solver_package);
    }

  return NULL;
}

template<typename T>

virtual void libMesh::TrilinosPreconditioner< T >::clear ( ) [inline, virtual]

Release all memory and clear data structures.

Reimplemented from libMesh::Preconditioner< T >.

Definition at line 86 of file trilinos_preconditioner.h.

{}

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

template<typename T >

const Epetra_Comm & libMesh::TrilinosPreconditioner< T >::Comm ( ) const [protected, virtual]

Definition at line 227 of file trilinos_preconditioner.C.

{
  return _prec->Comm();
}

template<typename T >

void libMesh::TrilinosPreconditioner< T >::compute ( )

Compute the preconditioner. In Trilinos, we need to call this explicitly.

Definition at line 83 of file trilinos_preconditioner.C.

References libMesh::AMG_PRECOND, libMesh::ILU_PRECOND, and libMesh::SOR_PRECOND.

Referenced by libMesh::Problem_Interface::computePreconditioner().

{
  Ifpack_Preconditioner * ifpack = NULL;
#ifdef LIBMESH_HAVE_ML
  ML_Epetra::MultiLevelPreconditioner * ml = NULL;
#endif

  switch (this->_preconditioner_type)
    {
      // IFPACK preconditioners
    case ILU_PRECOND:
    case SOR_PRECOND:
      ifpack = dynamic_cast<Ifpack_Preconditioner *>(_prec);
      ifpack->Compute();
      break;

#ifdef LIBMESH_HAVE_ML
      // ML preconditioners
    case AMG_PRECOND:
      ml = dynamic_cast<ML_Epetra::MultiLevelPreconditioner *>(_prec);
      ml->ComputePreconditioner();
      break;
#endif

    default:
      // no nothing here
      break;
    }
}

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

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
}

template<typename T >

bool libMesh::TrilinosPreconditioner< T >::HasNormInf ( ) const [protected, virtual]

Definition at line 220 of file trilinos_preconditioner.C.

{
  return _prec->HasNormInf();
}

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 >

void libMesh::TrilinosPreconditioner< T >::init ( ) [virtual]

Initialize data structures if not done so already.

Reimplemented from libMesh::Preconditioner< T >.

Definition at line 55 of file trilinos_preconditioner.C.

References libMesh::libMeshPrivateData::_is_initialized, and libMesh::EpetraMatrix< T >::mat().

{
  if(!this->_matrix)
    libmesh_error_msg("ERROR: No matrix set for PetscPreconditioner, but init() called");

  // Clear the preconditioner in case it has been created in the past
  if (!this->_is_initialized)
    {
      EpetraMatrix<T> * matrix = cast_ptr<EpetraMatrix<T>*, SparseMatrix<T> >(this->_matrix);
      _mat = matrix->mat();
    }

  set_preconditioner_type(this->_preconditioner_type);

  this->_is_initialized = true;
}

template<typename T>

bool libMesh::Preconditioner< T >::initialized ( ) const [inline, inherited]

Returns:: true if the data structures are initialized, false otherwise.

Definition at line 88 of file preconditioner.h.

{ return _is_initialized; }

template<typename T >

const char * libMesh::TrilinosPreconditioner< T >::Label ( ) const [protected, virtual]

Definition at line 206 of file trilinos_preconditioner.C.

{
  return _prec->Label();
}

template<typename T>

Epetra_FECrsMatrix* libMesh::TrilinosPreconditioner< T >::mat ( ) [inline]

Returns the actual Trilinos preconditioner object.

Definition at line 98 of file trilinos_preconditioner.h.

References libMesh::TrilinosPreconditioner< T >::_mat.

Referenced by libMesh::Problem_Interface::computePreconditioner().

{ return _mat; }

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

template<typename T >

double libMesh::TrilinosPreconditioner< T >::NormInf ( ) const [protected, virtual]

Definition at line 199 of file trilinos_preconditioner.C.

{
  return _prec->NormInf();
}

template<typename T >

const Epetra_Map & libMesh::TrilinosPreconditioner< T >::OperatorDomainMap ( ) const [protected, virtual]

Definition at line 234 of file trilinos_preconditioner.C.

{
  return _prec->OperatorDomainMap();
}

template<typename T >

const Epetra_Map & libMesh::TrilinosPreconditioner< T >::OperatorRangeMap ( ) const [protected, virtual]

Definition at line 241 of file trilinos_preconditioner.C.

{
  return _prec->OperatorRangeMap();
}

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::Preconditioner< T >::set_matrix ( SparseMatrix< Number > & mat ) [inherited]

Sets the matrix P to be preconditioned.

Definition at line 175 of file preconditioner.h.

References libMesh::libMeshPrivateData::_is_initialized.

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

template<typename T >

void libMesh::TrilinosPreconditioner< T >::set_params ( Teuchos::ParameterList & list )

Definition at line 75 of file trilinos_preconditioner.C.

{
  _param_list = list;
}

template<typename T >

void libMesh::TrilinosPreconditioner< T >::set_preconditioner_type ( const PreconditionerType & preconditioner_type )

Definition at line 116 of file trilinos_preconditioner.C.

References libMesh::AMG_PRECOND, libMesh::ASM_PRECOND, libMesh::BLOCK_JACOBI_PRECOND, libMesh::CHOLESKY_PRECOND, libMesh::EISENSTAT_PRECOND, libMesh::err, libMesh::ICC_PRECOND, libMesh::IDENTITY_PRECOND, libMesh::ILU_PRECOND, libMesh::JACOBI_PRECOND, libMesh::LU_PRECOND, libMesh::pc, and libMesh::SOR_PRECOND.

{
  Ifpack_Preconditioner * pc = NULL;
#ifdef LIBMESH_HAVE_ML
  ML_Epetra::MultiLevelPreconditioner * ml = NULL;
#endif

  switch (preconditioner_type)
    {
    case IDENTITY_PRECOND:
      //    pc = new Ifpack_DiagPreconditioner();
      break;

    case CHOLESKY_PRECOND:
      break;

    case ICC_PRECOND:
      break;

    case ILU_PRECOND:
      pc = new Ifpack_ILU(_mat);
      pc->SetParameters(_param_list);
      pc->Initialize();
      _prec = pc;
      break;

    case LU_PRECOND:
      break;

    case ASM_PRECOND:
      break;

    case JACOBI_PRECOND:
      break;

    case BLOCK_JACOBI_PRECOND:
      break;

    case SOR_PRECOND:
      break;

    case EISENSTAT_PRECOND:
      break;

#ifdef LIBMESH_HAVE_ML
    case AMG_PRECOND:
      ml = new ML_Epetra::MultiLevelPreconditioner(*_mat, _param_list, false);;
      _prec = ml;
      break;
#endif

    default:
      libMesh::err << "ERROR:  Unsupported Trilinos Preconditioner: "
                   << preconditioner_type       << std::endl
                   << "Continuing with Trilinos defaults" << std::endl;
    }

}

template<typename T >

void libMesh::Preconditioner< T >::set_type ( const PreconditionerType pct ) [inherited]

Sets the type of preconditioner to use.

Definition at line 184 of file preconditioner.h.

References libMesh::libMeshPrivateData::_is_initialized.

{
  //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, inherited]

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 113 of file preconditioner.h.

{}

template<typename T >

int libMesh::TrilinosPreconditioner< T >::SetUseTranspose ( bool UseTranspose ) [protected, virtual]

Definition at line 178 of file trilinos_preconditioner.C.

{
  return _prec->SetUseTranspose(UseTranspose);
}

template<typename T>

PreconditionerType libMesh::Preconditioner< T >::type ( ) const [inline, inherited]

Returns the type of preconditioner to use.

Definition at line 123 of file preconditioner.h.

  { return _preconditioner_type; }

template<typename T >

bool libMesh::TrilinosPreconditioner< T >::UseTranspose ( ) const [protected, virtual]

Definition at line 213 of file trilinos_preconditioner.C.

{
  return _prec->UseTranspose();
}

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

template<typename T>

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

Flag indicating if the data structures have been initialized.

Definition at line 147 of file preconditioner.h.

Referenced by libMesh::Preconditioner< Number >::initialized().

template<typename T>

Epetra_FECrsMatrix* libMesh::TrilinosPreconditioner< T >::_mat [protected]

Trilinos matrix that's been pulled out of the _matrix object.

Definition at line 119 of file trilinos_preconditioner.h.

Referenced by libMesh::TrilinosPreconditioner< T >::mat().

template<typename T>

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

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

Definition at line 137 of file preconditioner.h.

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>

Teuchos::ParameterList libMesh::TrilinosPreconditioner< T >::_param_list [protected]

Parameter list to be used for building the preconditioner

Definition at line 124 of file trilinos_preconditioner.h.

template<typename T>

Epetra_Operator* libMesh::TrilinosPreconditioner< T >::_prec [protected]

Trilinos preconditioner

Definition at line 114 of file trilinos_preconditioner.h.

template<typename T>

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

Enum statitng with type of preconditioner to use.

Definition at line 142 of file preconditioner.h.

Referenced by libMesh::Preconditioner< Number >::type().

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

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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