trilinos_preconditioner.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2014 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_TRILINOS_PRECONDITIONER_H
#define LIBMESH_TRILINOS_PRECONDITIONER_H

#include "libmesh/libmesh_config.h"

#ifdef LIBMESH_HAVE_TRILINOS

// Local includes
#include "libmesh/preconditioner.h"
#include "libmesh/libmesh_common.h"
#include "libmesh/enum_solver_package.h"
#include "libmesh/enum_preconditioner_type.h"
#include "libmesh/reference_counted_object.h"
#include "libmesh/libmesh.h"
#include "libmesh/auto_ptr.h"

// Trilinos includes
#include "Epetra_Operator.h"
#include "Epetra_FECrsMatrix.h"
#include "Teuchos_ParameterList.hpp"

// C++ includes
#include <cstddef>

namespace libMesh
{

// forward declarations
template <typename T> class SparseMatrix;
template <typename T> class NumericVector;
template <typename T> class ShellMatrix;

template <typename T>
class TrilinosPreconditioner :
    public Preconditioner<T>,
    public Epetra_Operator
{
public:

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

  void set_preconditioner_type (const PreconditionerType & preconditioner_type);

  void compute();

protected:

  Epetra_Operator * _prec;

  Epetra_FECrsMatrix * _mat;

  Teuchos::ParameterList _param_list;

  // Epetra_Operator interface
  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;
};




/*----------------------- inline functions ----------------------------------*/
template <typename T>
inline
TrilinosPreconditioner<T>::TrilinosPreconditioner (const libMesh::Parallel::Communicator &comm) :
  Preconditioner<T>(comm),
  _prec(NULL),
  _mat(NULL)
{
}



template <typename T>
inline
TrilinosPreconditioner<T>::~TrilinosPreconditioner ()
{
  this->clear ();
}

} // namespace libMesh

#endif // #ifdef LIBMESH_HAVE_TRILINOS
#endif // LIBMESH_TRILINOS_PRECONDITIONER_H