laspack_linear_solver.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2026 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_LASPACK_LINEAR_SOLVER_H
#define LIBMESH_LASPACK_LINEAR_SOLVER_H
 
#include "libmesh/libmesh_common.h"
 
#if defined(LIBMESH_HAVE_LASPACK)
//#if defined(LIBMESH_HAVE_LASPACK) && !defined(LIBMESH_USE_COMPLEX_NUMBERS)
 
// Laspack includes
#include <itersolv.h>
#include <rtc.h>
#include <errhandl.h>
 
// Local includes
#include "libmesh/linear_solver.h"
#include "libmesh/laspack_vector.h"
#include "libmesh/laspack_matrix.h"
 
namespace libMesh
{
 
template <typename T>
class LaspackLinearSolver : public LinearSolver<T>
{
public:
  LaspackLinearSolver (const libMesh::Parallel::Communicator & comm);
 
  ~LaspackLinearSolver ();
 
  virtual void clear () override;
 
  virtual void init (const char * name = nullptr) override;
 
  virtual std::pair<unsigned int, Real>
  solve (SparseMatrix<T> & matrix,
         NumericVector<T> & solution,
         NumericVector<T> & rhs,
         const std::optional<double> tol = std::nullopt,
         const std::optional<unsigned int> m_its = std::nullopt) override;
 
  virtual std::pair<unsigned int, Real>
  adjoint_solve (SparseMatrix<T> & matrix,
                 NumericVector<T> & solution,
                 NumericVector<T> & rhs,
                 const std::optional<double> tol = std::nullopt,
                 const std::optional<unsigned int> m_its = std::nullopt) override;
 
  virtual std::pair<unsigned int, Real>
  solve (SparseMatrix<T> & matrix,
         SparseMatrix<T> & pc,
         NumericVector<T> & solution,
         NumericVector<T> & rhs,
         const std::optional<double> tol = std::nullopt,
         const std::optional<unsigned int> m_its = std::nullopt) override;
 
  virtual std::pair<unsigned int, Real>
  solve (const ShellMatrix<T> & shell_matrix,
         NumericVector<T> & solution_in,
         NumericVector<T> & rhs_in,
         const std::optional<double> tol = std::nullopt,
         const std::optional<unsigned int> m_its = std::nullopt) override;
 
  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 std::optional<double> tol = std::nullopt,
         const std::optional<unsigned int> m_its = std::nullopt) override;
 
  virtual void print_converged_reason() const override;
 
  virtual LinearConvergenceReason get_converged_reason() const override;
 
private:
 
  void set_laspack_preconditioner_type ();
 
  PrecondProcType _precond_type;
};
 
 
/*----------------------- functions ----------------------------------*/
template <typename T>
inline
LaspackLinearSolver<T>::LaspackLinearSolver (const libMesh::Parallel::Communicator & comm) :
  LinearSolver<T>(comm),
  _precond_type (ILUPrecond)
{
}
 
 
 
template <typename T>
inline
LaspackLinearSolver<T>::~LaspackLinearSolver ()
{
  this->clear ();
}
 
 
 
template <typename T>
inline
std::pair<unsigned int, Real>
LaspackLinearSolver<T>::solve (SparseMatrix<T> &,
                               SparseMatrix<T> &,
                               NumericVector<T> &,
                               NumericVector<T> &,
                               const std::optional<double>,
                               const std::optional<unsigned int>)
{
  libmesh_error_msg("ERROR: LASPACK does not support a user-supplied preconditioner!");
 
  std::pair<unsigned int, Real> p;
  return p;
}
 
} // namespace libMesh
 
#endif // #ifdef LIBMESH_HAVE_LASPACK
#endif // LIBMESH_LASPACK_LINEAR_SOLVER_H