trilinos_aztec_linear_solver.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_AZTEC_LINEAR_SOLVER_H
#define LIBMESH_TRILINOS_AZTEC_LINEAR_SOLVER_H



// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/linear_solver.h"

#ifdef LIBMESH_HAVE_AZTECOO
#include <Epetra_LinearProblem.h>
#include <AztecOO.h>

// C++ includes
#include <vector>

namespace libMesh
{

template <typename T>
class AztecLinearSolver : public LinearSolver<T>
{
public:
  AztecLinearSolver (const libMesh::Parallel::Communicator &comm
                     LIBMESH_CAN_DEFAULT_TO_COMMWORLD);

  ~AztecLinearSolver ();

  void clear ();

  void init (const char *name=NULL);

  std::pair<unsigned int, Real>
  solve (SparseMatrix<T>  &matrix_in,
         NumericVector<T> &solution_in,
         NumericVector<T> &rhs_in,
         const double tol,
         const unsigned int m_its)
  {
    return this->solve(matrix_in, matrix_in, solution_in, rhs_in, tol, m_its);
  }

  std::pair<unsigned int, Real>
  solve (SparseMatrix<T>  &matrix,
         SparseMatrix<T>  &preconditioner,
         NumericVector<T> &solution,
         NumericVector<T> &rhs,
         const double tol,
         const unsigned int m_its);

  std::pair<unsigned int, Real>
  solve (const ShellMatrix<T>& shell_matrix,
         NumericVector<T>& solution_in,
         NumericVector<T>& rhs_in,
         const double tol,
         const unsigned int m_its);

  virtual std::pair<unsigned int, Real>
  solve (const ShellMatrix<T>& shell_matrix,
         const SparseMatrix<T>& precond_matrix,
         NumericVector<T>& solution_in,
         NumericVector<T>& rhs_in,
         const double tol,
         const unsigned int m_its);

  void get_residual_history(std::vector<double>& hist);

  Real get_initial_residual();

  virtual LinearConvergenceReason get_converged_reason() const;

private:

  void set_solver_type ();

  Epetra_LinearProblem * _linear_problem;

  AztecOO * _linear_solver;
};


/*----------------------- functions ----------------------------------*/
template <typename T>
inline
AztecLinearSolver<T>::AztecLinearSolver (const libMesh::Parallel::Communicator &comm) :
  LinearSolver<T>(comm)
{
  if (this->n_processors() == 1)
    this->_preconditioner_type = ILU_PRECOND;
  else
    this->_preconditioner_type = BLOCK_JACOBI_PRECOND;
}



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

} // namespace libMesh



#endif // #ifdef LIBMESH_HAVE_AZTECOO
#endif // LIBMESH_TRILINOS_AZTEC_LINEAR_SOLVER_H