#include <petsc_linear_solver.h>

Inheritance diagram for libMesh::PetscLinearSolver< T >:

[legend]

Public Member Functions
	PetscLinearSolver (const libMesh::Parallel::Communicator &comm_in)

	~PetscLinearSolver ()

virtual void	clear () override

virtual void	init (const char *name=nullptr) override

void	init (PetscMatrix< T > matrix, const char name=nullptr)

virtual void	init_names (const System &) override

virtual void	restrict_solve_to (const std::vector< unsigned int > *const dofs, const SubsetSolveMode subset_solve_mode=SUBSET_ZERO) override

virtual 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) override

virtual std::pair< unsigned int, Real >	adjoint_solve (SparseMatrix< T > &matrix_in, NumericVector< T > &solution_in, NumericVector< T > &rhs_in, const double tol, const unsigned int m_its) override

virtual 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) override

virtual 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) 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 double tol, const unsigned int m_its) override

PC	pc ()

KSP	ksp ()

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

Real	get_initial_residual ()

virtual LinearConvergenceReason	get_converged_reason () const override

bool	initialized () const

SolverType	solver_type () const

void	set_solver_type (const SolverType st)

PreconditionerType	preconditioner_type () const

void	set_preconditioner_type (const PreconditionerType pct)

void	attach_preconditioner (Preconditioner< T > *preconditioner)

virtual void	reuse_preconditioner (bool)

bool	get_same_preconditioner ()

std::pair< unsigned int, Real >	solve (SparseMatrix< T > &matrix, SparseMatrix< T > *precond_matrix, NumericVector< T > &, NumericVector< T > &, const double, const unsigned int)

std::pair< unsigned int, Real >	solve (const ShellMatrix< T > &matrix, const SparseMatrix< T > *precond_matrix, NumericVector< T > &, NumericVector< T > &, const double, const unsigned int)

virtual void	print_converged_reason () const

void	set_solver_configuration (SolverConfiguration &solver_configuration)

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static std::unique_ptr< LinearSolver< T > >	build (const libMesh::Parallel::Communicator &comm_in, 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
SolverType	_solver_type

PreconditionerType	_preconditioner_type

bool	_is_initialized

Preconditioner< T > *	_preconditioner

bool	same_preconditioner

SolverConfiguration *	_solver_configuration

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

Private Member Functions
void	set_petsc_solver_type ()

PetscInt	_restrict_solve_to_is_local_size () const

void	_create_complement_is (const NumericVector< T > &vec_in)

Static Private Member Functions
static PetscErrorCode	_petsc_shell_matrix_mult (Mat mat, Vec arg, Vec dest)

static PetscErrorCode	_petsc_shell_matrix_mult_add (Mat mat, Vec arg, Vec add, Vec dest)

static PetscErrorCode	_petsc_shell_matrix_get_diagonal (Mat mat, Vec dest)

Private Attributes
PC	_pc

KSP	_ksp

IS	_restrict_solve_to_is

IS	_restrict_solve_to_is_complement

SubsetSolveMode	_subset_solve_mode

Detailed Description

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

This class provides an interface to PETSc iterative solvers that is compatible with the libMesh LinearSolver<>

Author: Benjamin Kirk

Date: 2002-2007

Definition at line 101 of file petsc_linear_solver.h.

Member Typedef Documentation

◆ Counts

typedef std::map<std::string, std::pair<unsigned int, unsigned int> > libMesh::ReferenceCounter::Counts

protectedinherited

Data structure to log the information. The log is identified by the class name.

Definition at line 117 of file reference_counter.h.

Constructor & Destructor Documentation

◆ PetscLinearSolver()

template<typename T >

libMesh::PetscLinearSolver< T >::PetscLinearSolver ( const libMesh::Parallel::Communicator & comm_in )

Constructor. Initializes Petsc data structures

Definition at line 134 of file petsc_linear_solver.C.

References libMesh::LinearSolver< T >::_preconditioner_type, libMesh::BLOCK_JACOBI_PRECOND, libMesh::ILU_PRECOND, and libMesh::ParallelObject::n_processors().

                                                                                    :
   LinearSolver<T>(comm_in),
   _restrict_solve_to_is(nullptr),
   _restrict_solve_to_is_complement(nullptr),
   _subset_solve_mode(SUBSET_ZERO)
 {
   if (this->n_processors() == 1)
     this->_preconditioner_type = ILU_PRECOND;
   else
     this->_preconditioner_type = BLOCK_JACOBI_PRECOND;
 }

◆ ~PetscLinearSolver()

template<typename T >

libMesh::PetscLinearSolver< T >::~PetscLinearSolver ( )

inline

Destructor.

Definition at line 331 of file petsc_linear_solver.h.

 {
   this->clear ();
 }

Member Function Documentation

◆ _create_complement_is()

template<typename T >

void libMesh::PetscLinearSolver< T >::_create_complement_is ( const NumericVector< T > & vec_in )

private

Creates _restrict_solve_to_is_complement to contain all indices that are local in vec_in, except those that are contained in _restrict_solve_to_is.

Definition at line 355 of file petsc_linear_solver.h.

References ierr.

 {
   libmesh_assert(_restrict_solve_to_is);
 #if PETSC_VERSION_LESS_THAN(3,0,0)
   // No ISComplement in PETSc 2.3.3
   libmesh_not_implemented();
 #else
   if (_restrict_solve_to_is_complement==nullptr)
     {
       int ierr = ISComplement(_restrict_solve_to_is,
                               vec_in.first_local_index(),
                               vec_in.last_local_index(),
                               &_restrict_solve_to_is_complement);
       LIBMESH_CHKERR(ierr);
     }
 #endif
 }

◆ _petsc_shell_matrix_get_diagonal()

template<typename T >

PetscErrorCode libMesh::PetscLinearSolver< T >::_petsc_shell_matrix_get_diagonal	(	Mat	mat,
		Vec	dest
	)

staticprivate

Internal function if shell matrix mode is used.

Definition at line 1781 of file petsc_linear_solver.C.

References libMesh::ParallelObject::comm(), libMesh::Parallel::Communicator::get(), libMesh::ShellMatrix< T >::get_diagonal(), and ierr.

 {
   /* Get the matrix context.  */
   PetscErrorCode ierr=0;
   void * ctx;
   ierr = MatShellGetContext(mat,&ctx);
 
   /* Get user shell matrix object.  */
   const ShellMatrix<T> & shell_matrix = *static_cast<const ShellMatrix<T> *>(ctx);
   CHKERRABORT(shell_matrix.comm().get(), ierr);
 
   /* Make \p NumericVector instances around the vector.  */
   PetscVector<T> dest_global(dest, shell_matrix.comm());
 
   /* Call the user function.  */
   shell_matrix.get_diagonal(dest_global);
 
   return ierr;
 }

◆ _petsc_shell_matrix_mult()

template<typename T >

PetscErrorCode libMesh::PetscLinearSolver< T >::_petsc_shell_matrix_mult	(	Mat	mat,
		Vec	arg,
		Vec	dest
	)

staticprivate

Internal function if shell matrix mode is used.

Definition at line 1727 of file petsc_linear_solver.C.

References libMesh::ParallelObject::comm(), libMesh::Parallel::Communicator::get(), ierr, and libMesh::ShellMatrix< T >::vector_mult().

 {
   /* Get the matrix context.  */
   PetscErrorCode ierr=0;
   void * ctx;
   ierr = MatShellGetContext(mat,&ctx);
 
   /* Get user shell matrix object.  */
   const ShellMatrix<T> & shell_matrix = *static_cast<const ShellMatrix<T> *>(ctx);
   CHKERRABORT(shell_matrix.comm().get(), ierr);
 
   /* Make \p NumericVector instances around the vectors.  */
   PetscVector<T> arg_global(arg, shell_matrix.comm());
   PetscVector<T> dest_global(dest, shell_matrix.comm());
 
   /* Call the user function.  */
   shell_matrix.vector_mult(dest_global,arg_global);
 
   return ierr;
 }

◆ _petsc_shell_matrix_mult_add()

template<typename T >

PetscErrorCode libMesh::PetscLinearSolver< T >::_petsc_shell_matrix_mult_add	(	Mat	mat,
		Vec	arg,
		Vec	add,
		Vec	dest
	)

staticprivate

Internal function if shell matrix mode is used.

Definition at line 1751 of file petsc_linear_solver.C.

References libMesh::ParallelObject::comm(), libMesh::Parallel::Communicator::get(), ierr, and libMesh::ShellMatrix< T >::vector_mult_add().

 {
   /* Get the matrix context.  */
   PetscErrorCode ierr=0;
   void * ctx;
   ierr = MatShellGetContext(mat,&ctx);
 
   /* Get user shell matrix object.  */
   const ShellMatrix<T> & shell_matrix = *static_cast<const ShellMatrix<T> *>(ctx);
   CHKERRABORT(shell_matrix.comm().get(), ierr);
 
   /* Make \p NumericVector instances around the vectors.  */
   PetscVector<T> arg_global(arg, shell_matrix.comm());
   PetscVector<T> dest_global(dest, shell_matrix.comm());
   PetscVector<T> add_global(add, shell_matrix.comm());
 
   if (add!=arg)
     {
       arg_global = add_global;
     }
 
   /* Call the user function.  */
   shell_matrix.vector_mult_add(dest_global,arg_global);
 
   return ierr;
 }

◆ _restrict_solve_to_is_local_size()

template<typename T >

PetscInt libMesh::PetscLinearSolver< T >::_restrict_solve_to_is_local_size ( ) const

inlineprivate

Returns: The local size of _restrict_solve_to_is.

Definition at line 340 of file petsc_linear_solver.h.

References ierr.

 {
   libmesh_assert(_restrict_solve_to_is);
 
   PetscInt s;
   int ierr = ISGetLocalSize(_restrict_solve_to_is, &s);
   LIBMESH_CHKERR(ierr);
 
   return s;
 }

◆ adjoint_solve()

template<typename T >

std::pair< unsigned int, Real > libMesh::PetscLinearSolver< T >::adjoint_solve	(	SparseMatrix< T > &	matrix_in,
		NumericVector< T > &	solution_in,
		NumericVector< T > &	rhs_in,
		const double	tol,
		const unsigned int	m_its
	)

overridevirtual

Call the Petsc solver. It calls the method below, using the same matrix for the system and preconditioner matrices.

Reimplemented from libMesh::LinearSolver< T >.

Definition at line 708 of file petsc_linear_solver.C.

References libMesh::PetscMatrix< T >::close(), ierr, libMesh::TriangleWrapper::init(), libMesh::NumericVector< T >::local_size(), libMesh::PetscMatrix< T >::mat(), libMesh::SUBSET_COPY_RHS, libMesh::SUBSET_DONT_TOUCH, and libMesh::SUBSET_ZERO.

 {
   LOG_SCOPE("solve()", "PetscLinearSolver");
 
   // Make sure the data passed in are really of Petsc types
   PetscMatrix<T> * matrix   = cast_ptr<PetscMatrix<T> *>(&matrix_in);
   // Note that the matrix and precond matrix are the same
   PetscMatrix<T> * precond  = cast_ptr<PetscMatrix<T> *>(&matrix_in);
   PetscVector<T> * solution = cast_ptr<PetscVector<T> *>(&solution_in);
   PetscVector<T> * rhs      = cast_ptr<PetscVector<T> *>(&rhs_in);
 
   this->init (matrix);
 
   PetscErrorCode ierr=0;
   PetscInt its=0, max_its = static_cast<PetscInt>(m_its);
   PetscReal final_resid=0.;
 
   // Close the matrices and vectors in case this wasn't already done.
   matrix->close ();
   precond->close ();
   solution->close ();
   rhs->close ();
 
   Mat submat = nullptr;
   Mat subprecond = nullptr;
   Vec subrhs = nullptr;
   Vec subsolution = nullptr;
   VecScatter scatter = nullptr;
   std::unique_ptr<PetscMatrix<Number>> subprecond_matrix;
 
   // Set operators.  Also restrict rhs and solution vector to
   // subdomain if necessary.
   if (_restrict_solve_to_is != nullptr)
     {
       PetscInt is_local_size = this->_restrict_solve_to_is_local_size();
 
       ierr = VecCreate(this->comm().get(),&subrhs);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetSizes(subrhs,is_local_size,PETSC_DECIDE);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetFromOptions(subrhs);
       LIBMESH_CHKERR(ierr);
 
       ierr = VecCreate(this->comm().get(),&subsolution);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetSizes(subsolution,is_local_size,PETSC_DECIDE);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetFromOptions(subsolution);
       LIBMESH_CHKERR(ierr);
 
       ierr = LibMeshVecScatterCreate(rhs->vec(),_restrict_solve_to_is, subrhs, nullptr, &scatter);
       LIBMESH_CHKERR(ierr);
 
       ierr = VecScatterBegin(scatter,rhs->vec(),subrhs,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
       ierr = VecScatterEnd(scatter,rhs->vec(),subrhs,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
 
       ierr = VecScatterBegin(scatter,solution->vec(),subsolution,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
       ierr = VecScatterEnd(scatter,solution->vec(),subsolution,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
 
       ierr = LibMeshCreateSubMatrix(matrix->mat(),
                                     _restrict_solve_to_is,
                                     _restrict_solve_to_is,
 #if PETSC_VERSION_LESS_THAN(3,1,0)
                                     PETSC_DECIDE,
 #endif
                                     MAT_INITIAL_MATRIX,
                                     &submat);
       LIBMESH_CHKERR(ierr);
 
       ierr = LibMeshCreateSubMatrix(precond->mat(),
                                     _restrict_solve_to_is,
                                     _restrict_solve_to_is,
 #if PETSC_VERSION_LESS_THAN(3,1,0)
                                     PETSC_DECIDE,
 #endif
                                     MAT_INITIAL_MATRIX,
                                     &subprecond);
       LIBMESH_CHKERR(ierr);
 
       /* Since removing columns of the matrix changes the equation
          system, we will now change the right hand side to compensate
          for this.  Note that this is not necessary if \p SUBSET_ZERO
          has been selected.  */
       if (_subset_solve_mode!=SUBSET_ZERO)
         {
           _create_complement_is(rhs_in);
           PetscInt is_complement_local_size =
             cast_int<PetscInt>(rhs_in.local_size()-is_local_size);
 
           Vec subvec1 = nullptr;
           Mat submat1 = nullptr;
           VecScatter scatter1 = nullptr;
 
           ierr = VecCreate(this->comm().get(),&subvec1);
           LIBMESH_CHKERR(ierr);
           ierr = VecSetSizes(subvec1,is_complement_local_size,PETSC_DECIDE);
           LIBMESH_CHKERR(ierr);
           ierr = VecSetFromOptions(subvec1);
           LIBMESH_CHKERR(ierr);
 
           ierr = LibMeshVecScatterCreate(rhs->vec(),_restrict_solve_to_is_complement, subvec1, nullptr, &scatter1);
           LIBMESH_CHKERR(ierr);
 
           ierr = VecScatterBegin(scatter1,_subset_solve_mode==SUBSET_COPY_RHS ? rhs->vec() : solution->vec(),subvec1,INSERT_VALUES,SCATTER_FORWARD);
           LIBMESH_CHKERR(ierr);
           ierr = VecScatterEnd(scatter1,_subset_solve_mode==SUBSET_COPY_RHS ? rhs->vec() : solution->vec(),subvec1,INSERT_VALUES,SCATTER_FORWARD);
           LIBMESH_CHKERR(ierr);
 
           ierr = VecScale(subvec1,-1.0);
           LIBMESH_CHKERR(ierr);
 
           ierr = LibMeshCreateSubMatrix(matrix->mat(),
                                         _restrict_solve_to_is,
                                         _restrict_solve_to_is_complement,
 #if PETSC_VERSION_LESS_THAN(3,1,0)
                                         PETSC_DECIDE,
 #endif
                                         MAT_INITIAL_MATRIX,
                                         &submat1);
           LIBMESH_CHKERR(ierr);
 
           ierr = MatMultAdd(submat1,subvec1,subrhs,subrhs);
           LIBMESH_CHKERR(ierr);
 
           ierr = LibMeshVecScatterDestroy(&scatter1);
           LIBMESH_CHKERR(ierr);
           ierr = LibMeshVecDestroy(&subvec1);
           LIBMESH_CHKERR(ierr);
           ierr = LibMeshMatDestroy(&submat1);
           LIBMESH_CHKERR(ierr);
         }
 #if PETSC_RELEASE_LESS_THAN(3,5,0)
       ierr = KSPSetOperators(_ksp, submat, subprecond,
                              this->same_preconditioner ? SAME_PRECONDITIONER : DIFFERENT_NONZERO_PATTERN);
 #else
       ierr = KSPSetOperators(_ksp, submat, subprecond);
 
       PetscBool ksp_reuse_preconditioner = this->same_preconditioner ? PETSC_TRUE : PETSC_FALSE;
       ierr = KSPSetReusePreconditioner(_ksp, ksp_reuse_preconditioner);
 #endif
       LIBMESH_CHKERR(ierr);
 
       if (this->_preconditioner)
         {
           subprecond_matrix.reset(new PetscMatrix<Number>(subprecond, this->comm()));
           this->_preconditioner->set_matrix(*subprecond_matrix);
           this->_preconditioner->init();
         }
     }
   else
     {
 #if PETSC_RELEASE_LESS_THAN(3,5,0)
       ierr = KSPSetOperators(_ksp, matrix->mat(), precond->mat(),
                              this->same_preconditioner ? SAME_PRECONDITIONER : DIFFERENT_NONZERO_PATTERN);
 #else
       ierr = KSPSetOperators(_ksp, matrix->mat(), precond->mat());
 
       PetscBool ksp_reuse_preconditioner = this->same_preconditioner ? PETSC_TRUE : PETSC_FALSE;
       ierr = KSPSetReusePreconditioner(_ksp, ksp_reuse_preconditioner);
 #endif
       LIBMESH_CHKERR(ierr);
 
       if (this->_preconditioner)
         {
           this->_preconditioner->set_matrix(matrix_in);
           this->_preconditioner->init();
         }
     }
 
   // Set the tolerances for the iterative solver.  Use the user-supplied
   // tolerance for the relative residual & leave the others at default values.
   ierr = KSPSetTolerances (_ksp, tol, PETSC_DEFAULT,
                            PETSC_DEFAULT, max_its);
   LIBMESH_CHKERR(ierr);
 
   // Allow command line options to override anything set programmatically.
   ierr = KSPSetFromOptions(_ksp);
   LIBMESH_CHKERR(ierr);
 
   // Solve the linear system
   if (_restrict_solve_to_is != nullptr)
     {
       ierr = KSPSolveTranspose (_ksp, subrhs, subsolution);
       LIBMESH_CHKERR(ierr);
     }
   else
     {
       ierr = KSPSolveTranspose (_ksp, rhs->vec(), solution->vec());
       LIBMESH_CHKERR(ierr);
     }
 
   // Get the number of iterations required for convergence
   ierr = KSPGetIterationNumber (_ksp, &its);
   LIBMESH_CHKERR(ierr);
 
   // Get the norm of the final residual to return to the user.
   ierr = KSPGetResidualNorm (_ksp, &final_resid);
   LIBMESH_CHKERR(ierr);
 
   if (_restrict_solve_to_is != nullptr)
     {
       switch(_subset_solve_mode)
         {
         case SUBSET_ZERO:
           ierr = VecZeroEntries(solution->vec());
           LIBMESH_CHKERR(ierr);
           break;
 
         case SUBSET_COPY_RHS:
           ierr = VecCopy(rhs->vec(),solution->vec());
           LIBMESH_CHKERR(ierr);
           break;
 
         case SUBSET_DONT_TOUCH:
           /* Nothing to do here.  */
           break;
 
         default:
           libmesh_error_msg("Invalid subset solve mode = " << _subset_solve_mode);
         }
       ierr = VecScatterBegin(scatter,subsolution,solution->vec(),INSERT_VALUES,SCATTER_REVERSE);
       LIBMESH_CHKERR(ierr);
       ierr = VecScatterEnd(scatter,subsolution,solution->vec(),INSERT_VALUES,SCATTER_REVERSE);
       LIBMESH_CHKERR(ierr);
 
       ierr = LibMeshVecScatterDestroy(&scatter);
       LIBMESH_CHKERR(ierr);
 
       if (this->_preconditioner)
         {
           // Before subprecond_matrix gets cleaned up, we should give
           // the _preconditioner a different matrix.
           this->_preconditioner->set_matrix(matrix_in);
           this->_preconditioner->init();
         }
 
       ierr = LibMeshVecDestroy(&subsolution);
       LIBMESH_CHKERR(ierr);
       ierr = LibMeshVecDestroy(&subrhs);
       LIBMESH_CHKERR(ierr);
       ierr = LibMeshMatDestroy(&submat);
       LIBMESH_CHKERR(ierr);
       ierr = LibMeshMatDestroy(&subprecond);
       LIBMESH_CHKERR(ierr);
     }
 
   // return the # of its. and the final residual norm.
   return std::make_pair(its, final_resid);
 }

◆ attach_preconditioner()

template<typename T>

void libMesh::LinearSolver< T >::attach_preconditioner ( Preconditioner< T > * preconditioner )

inherited

Attaches a Preconditioner object to be used

Definition at line 118 of file linear_solver.C.

 {
   if (this->_is_initialized)
     libmesh_error_msg("Preconditioner must be attached before the solver is initialized!");
 
   _preconditioner_type = SHELL_PRECOND;
   _preconditioner = preconditioner;
 }

◆ build()

template<typename T >

std::unique_ptr< LinearSolver< T > > libMesh::LinearSolver< T >::build	(	const libMesh::Parallel::Communicator &	comm_in,
		const SolverPackage	solver_package = `libMesh::default_solver_package()`
	)

staticinherited

Builds a LinearSolver using the linear solver package specified by solver_package

Definition at line 57 of file linear_solver.C.

Referenced by libMesh::ImplicitSystem::get_linear_solver(), and libMesh::TimeSolver::init().

 {
   // Avoid unused parameter warnings when no solver packages are enabled.
   libmesh_ignore(comm);
 
   // Build the appropriate solver
   switch (solver_package)
     {
 #ifdef LIBMESH_HAVE_LASPACK
     case LASPACK_SOLVERS:
       return libmesh_make_unique<LaspackLinearSolver<T>>(comm);
 #endif
 
 
 #ifdef LIBMESH_HAVE_PETSC
     case PETSC_SOLVERS:
       return libmesh_make_unique<PetscLinearSolver<T>>(comm);
 #endif
 
 
 #ifdef LIBMESH_TRILINOS_HAVE_AZTECOO
     case TRILINOS_SOLVERS:
       return libmesh_make_unique<AztecLinearSolver<T>>(comm);
 #endif
 
 
 #ifdef LIBMESH_HAVE_EIGEN
     case EIGEN_SOLVERS:
       return libmesh_make_unique<EigenSparseLinearSolver<T>>(comm);
 #endif
 
     default:
       libmesh_error_msg("ERROR:  Unrecognized solver package: " << solver_package);
     }
 
   return std::unique_ptr<LinearSolver<T>>();
 }

◆ clear()

template<typename T >

void libMesh::PetscLinearSolver< T >::clear ( )

overridevirtual

Release all memory and clear data structures.

Reimplemented from libMesh::LinearSolver< T >.

Definition at line 149 of file petsc_linear_solver.C.

References libMesh::libMeshPrivateData::_is_initialized, libMesh::BLOCK_JACOBI_PRECOND, libMesh::GMRES, ierr, libMesh::ILU_PRECOND, and libMesh::initialized().

 {
   if (this->initialized())
     {
       /* If we were restricted to some subset, this restriction must
          be removed and the subset index set destroyed.  */
       if (_restrict_solve_to_is != nullptr)
         {
           PetscErrorCode ierr = LibMeshISDestroy(&_restrict_solve_to_is);
           LIBMESH_CHKERR(ierr);
           _restrict_solve_to_is = nullptr;
         }
 
       if (_restrict_solve_to_is_complement != nullptr)
         {
           PetscErrorCode ierr = LibMeshISDestroy(&_restrict_solve_to_is_complement);
           LIBMESH_CHKERR(ierr);
           _restrict_solve_to_is_complement = nullptr;
         }
 
       this->_is_initialized = false;
 
       PetscErrorCode ierr=0;
 
       ierr = LibMeshKSPDestroy(&_ksp);
       LIBMESH_CHKERR(ierr);
 
       // Mimic PETSc default solver and preconditioner
       this->_solver_type           = GMRES;
 
       if (!this->_preconditioner)
         {
           if (this->n_processors() == 1)
             this->_preconditioner_type = ILU_PRECOND;
           else
             this->_preconditioner_type = BLOCK_JACOBI_PRECOND;
         }
     }
 }

◆ comm()

const Parallel::Communicator& libMesh::ParallelObject::comm ( ) const

inlineinherited

Returns: A reference to the Parallel::Communicator object used by this mesh.

Definition at line 89 of file parallel_object.h.

References libMesh::ParallelObject::_communicator.

90 { return _communicator; }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

◆ disable_print_counter_info()

void libMesh::ReferenceCounter::disable_print_counter_info ( )

staticinherited

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

◆ enable_print_counter_info()

void libMesh::ReferenceCounter::enable_print_counter_info ( )

staticinherited

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

◆ get_converged_reason()

template<typename T >

LinearConvergenceReason libMesh::PetscLinearSolver< T >::get_converged_reason ( ) const

overridevirtual

Returns: The solver's convergence flag

Implements libMesh::LinearSolver< T >.

Definition at line 1684 of file petsc_linear_solver.C.

 {
   KSPConvergedReason reason;
   KSPGetConvergedReason(_ksp, &reason);
 
   switch(reason)
     {
 #if !PETSC_VERSION_LESS_THAN(3,2,0)
     case KSP_CONVERGED_RTOL_NORMAL     : return CONVERGED_RTOL_NORMAL;
     case KSP_CONVERGED_ATOL_NORMAL     : return CONVERGED_ATOL_NORMAL;
 #endif
     case KSP_CONVERGED_RTOL            : return CONVERGED_RTOL;
     case KSP_CONVERGED_ATOL            : return CONVERGED_ATOL;
     case KSP_CONVERGED_ITS             : return CONVERGED_ITS;
     case KSP_CONVERGED_CG_NEG_CURVE    : return CONVERGED_CG_NEG_CURVE;
     case KSP_CONVERGED_CG_CONSTRAINED  : return CONVERGED_CG_CONSTRAINED;
     case KSP_CONVERGED_STEP_LENGTH     : return CONVERGED_STEP_LENGTH;
     case KSP_CONVERGED_HAPPY_BREAKDOWN : return CONVERGED_HAPPY_BREAKDOWN;
     case KSP_DIVERGED_NULL             : return DIVERGED_NULL;
     case KSP_DIVERGED_ITS              : return DIVERGED_ITS;
     case KSP_DIVERGED_DTOL             : return DIVERGED_DTOL;
     case KSP_DIVERGED_BREAKDOWN        : return DIVERGED_BREAKDOWN;
     case KSP_DIVERGED_BREAKDOWN_BICG   : return DIVERGED_BREAKDOWN_BICG;
     case KSP_DIVERGED_NONSYMMETRIC     : return DIVERGED_NONSYMMETRIC;
     case KSP_DIVERGED_INDEFINITE_PC    : return DIVERGED_INDEFINITE_PC;
 #if PETSC_VERSION_LESS_THAN(3,4,0)
     case KSP_DIVERGED_NAN              : return DIVERGED_NAN;
 #else
     case KSP_DIVERGED_NANORINF         : return DIVERGED_NAN;
 #endif
     case KSP_DIVERGED_INDEFINITE_MAT   : return DIVERGED_INDEFINITE_MAT;
     case KSP_CONVERGED_ITERATING       : return CONVERGED_ITERATING;
 #if !PETSC_VERSION_LESS_THAN(3,7,0)
     case KSP_DIVERGED_PCSETUP_FAILED   : return DIVERGED_PCSETUP_FAILED;
 #endif
     default :
       libMesh::err << "Unknown convergence flag!" << std::endl;
       return UNKNOWN_FLAG;
     }
 }

◆ get_info()

std::string libMesh::ReferenceCounter::get_info ( )

staticinherited

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 (const auto & pr : _counts)
     {
       const std::string name(pr.first);
       const unsigned int creations    = pr.second.first;
       const unsigned int destructions = pr.second.second;
 
       oss << "| " << name << " reference count information:\n"
           << "|  Creations:    " << creations    << '\n'
           << "|  Destructions: " << destructions << '\n';
     }
 
   oss << " ---------------------------------------------------------------------------- \n";
 
   return oss.str();
 
 #else
 
   return "";
 
 #endif
 }

◆ get_initial_residual()

template<typename T >

Real libMesh::PetscLinearSolver< T >::get_initial_residual ( )

Returns: Just the initial residual for the solve just completed with this interface.

Use this method instead of the one above if you just want the starting residual and not the entire history.

Definition at line 1570 of file petsc_linear_solver.C.

References libMesh::err, and ierr.

 {
   PetscErrorCode ierr = 0;
   PetscInt its  = 0;
 
   // Fill the residual history vector with the residual norms
   // Note that GetResidualHistory() does not copy any values, it
   // simply sets the pointer p.  Note that for some Krylov subspace
   // methods, the number of residuals returned in the history
   // vector may be different from what you are expecting.  For
   // example, TFQMR returns two residual values per iteration step.
   PetscReal * p;
   ierr = KSPGetResidualHistory(_ksp, &p, &its);
   LIBMESH_CHKERR(ierr);
 
   // Check no residual history
   if (its == 0)
     {
       libMesh::err << "No iterations have been performed, returning 0." << std::endl;
       return 0.;
     }
 
   // Otherwise, return the value pointed to by p.
   return *p;
 }

◆ get_residual_history()

template<typename T >

void libMesh::PetscLinearSolver< T >::get_residual_history ( std::vector< double > & hist )

Fills the input vector with the sequence of residual norms from the latest iterative solve.

Definition at line 1537 of file petsc_linear_solver.C.

References ierr.

 {
   PetscErrorCode ierr = 0;
   PetscInt its  = 0;
 
   // Fill the residual history vector with the residual norms
   // Note that GetResidualHistory() does not copy any values, it
   // simply sets the pointer p.  Note that for some Krylov subspace
   // methods, the number of residuals returned in the history
   // vector may be different from what you are expecting.  For
   // example, TFQMR returns two residual values per iteration step.
   PetscReal * p;
   ierr = KSPGetResidualHistory(_ksp, &p, &its);
   LIBMESH_CHKERR(ierr);
 
   // Check for early return
   if (its == 0) return;
 
   // Create space to store the result
   hist.resize(its);
 
   // Copy history into the vector provided by the user.
   for (PetscInt i=0; i<its; ++i)
     {
       hist[i] = *p;
       p++;
     }
 }

◆ get_same_preconditioner()

template<typename T >

bool libMesh::LinearSolver< T >::get_same_preconditioner ( )

inlineinherited

Returns: same_preconditioner, which indicates if we reuse the same preconditioner for subsequent solves.

Definition at line 322 of file linear_solver.h.

 {
   return same_preconditioner;
 }

◆ increment_constructor_count()

void libMesh::ReferenceCounter::increment_constructor_count ( const std::string & name )

inlineprotectedinherited

Increments the construction counter. Should be called in the constructor of any derived class that will be reference counted.

Definition at line 181 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++;
 }

◆ increment_destructor_count()

void libMesh::ReferenceCounter::increment_destructor_count ( const std::string & name )

inlineprotectedinherited

Increments the destruction counter. Should be called in the destructor of any derived class that will be reference counted.

Definition at line 194 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++;
 }

◆ init() [1/2]

template<typename T >

void libMesh::PetscLinearSolver< T >::init ( const char * name = nullptr )

overridevirtual

Initialize data structures if not done so already. Assigns a name, which is turned into an underscore-separated prefix for the underlying KSP object.

Implements libMesh::LinearSolver< T >.

Definition at line 192 of file petsc_linear_solver.C.

References libMesh::libMeshPrivateData::_is_initialized, ierr, libMesh::initialized(), libMesh::libmesh_petsc_preconditioner_apply(), libMesh::libmesh_petsc_preconditioner_setup(), libMesh::Quality::name(), and libMesh::PetscPreconditioner< T >::set_petsc_preconditioner_type().

Referenced by libMesh::PetscLinearSolver< T >::ksp(), and libMesh::PetscLinearSolver< T >::pc().

 {
   // Initialize the data structures if not done so already.
   if (!this->initialized())
     {
       this->_is_initialized = true;
 
       PetscErrorCode ierr=0;
 
       // Create the linear solver context
       ierr = KSPCreate (this->comm().get(), &_ksp);
       LIBMESH_CHKERR(ierr);
 
       if (name)
         {
           ierr = KSPSetOptionsPrefix(_ksp, name);
           LIBMESH_CHKERR(ierr);
         }
 
       // Create the preconditioner context
       ierr = KSPGetPC        (_ksp, &_pc);
       LIBMESH_CHKERR(ierr);
 
       // Set user-specified  solver and preconditioner types
       this->set_petsc_solver_type();
 
       // If the SolverConfiguration object is provided, use it to set
       // options during solver initialization.
       if (this->_solver_configuration)
         {
           this->_solver_configuration->set_options_during_init();
         }
 
       // Set the options from user-input
       // Set runtime options, e.g.,
       //      -ksp_type <type> -pc_type <type> -ksp_monitor -ksp_rtol <rtol>
       //  These options will override those specified above as long as
       //  KSPSetFromOptions() is called _after_ any other customization
       //  routines.
 
       ierr = KSPSetFromOptions (_ksp);
       LIBMESH_CHKERR(ierr);
 
       // Not sure if this is necessary, or if it is already handled by KSPSetFromOptions?
       // NOT NECESSARY!!!!
       //ierr = PCSetFromOptions (_pc);
       //LIBMESH_CHKERR(ierr);
 
       // Have the Krylov subspace method use our good initial guess
       // rather than 0, unless the user requested a KSPType of
       // preonly, which complains if asked to use initial guesses.
 #if PETSC_VERSION_LESS_THAN(3,0,0) || !PETSC_RELEASE_LESS_THAN(3,4,0)
       // Pre-3.0 and petsc-dev (as of October 2012) use non-const versions
       KSPType ksp_type;
 #else
       const KSPType ksp_type;
 #endif
 
       ierr = KSPGetType (_ksp, &ksp_type);
       LIBMESH_CHKERR(ierr);
 
       if (strcmp(ksp_type, "preonly"))
         {
           ierr = KSPSetInitialGuessNonzero (_ksp, PETSC_TRUE);
           LIBMESH_CHKERR(ierr);
         }
 
       // Notify PETSc of location to store residual history.
       // This needs to be called before any solves, since
       // it sets the residual history length to zero.  The default
       // behavior is for PETSc to allocate (internally) an array
       // of size 1000 to hold the residual norm history.
       ierr = KSPSetResidualHistory(_ksp,
                                    PETSC_NULL,   // pointer to the array which holds the history
                                    PETSC_DECIDE, // size of the array holding the history
                                    PETSC_TRUE);  // Whether or not to reset the history for each solve.
       LIBMESH_CHKERR(ierr);
 
       PetscPreconditioner<T>::set_petsc_preconditioner_type(this->_preconditioner_type,_pc);
 
       //If there is a preconditioner object we need to set the internal setup and apply routines
       if (this->_preconditioner)
         {
           this->_preconditioner->init();
           PCShellSetContext(_pc,(void *)this->_preconditioner);
           PCShellSetSetUp(_pc,libmesh_petsc_preconditioner_setup);
           PCShellSetApply(_pc,libmesh_petsc_preconditioner_apply);
         }
     }
 }

◆ init() [2/2]

template<typename T >

void libMesh::PetscLinearSolver< T >::init	(	PetscMatrix< T > *	matrix,
		const char *	name = `nullptr`
	)

Initialize data structures if not done so already plus much more

Definition at line 285 of file petsc_linear_solver.C.

References libMesh::libMeshPrivateData::_is_initialized, ierr, libMesh::initialized(), libMesh::libmesh_petsc_preconditioner_apply(), libMesh::libmesh_petsc_preconditioner_setup(), libMesh::PetscMatrix< T >::mat(), libMesh::Quality::name(), and libMesh::PetscPreconditioner< T >::set_petsc_preconditioner_type().

 {
   // Initialize the data structures if not done so already.
   if (!this->initialized())
     {
       this->_is_initialized = true;
 
       PetscErrorCode ierr=0;
 
       // Create the linear solver context
       ierr = KSPCreate (this->comm().get(), &_ksp);
       LIBMESH_CHKERR(ierr);
 
       if (name)
         {
           ierr = KSPSetOptionsPrefix(_ksp, name);
           LIBMESH_CHKERR(ierr);
         }
 
       //ierr = PCCreate (this->comm().get(), &_pc);
       //     LIBMESH_CHKERR(ierr);
 
       // Create the preconditioner context
       ierr = KSPGetPC        (_ksp, &_pc);
       LIBMESH_CHKERR(ierr);
 
       // Set operators. The input matrix works as the preconditioning matrix
 #if PETSC_RELEASE_LESS_THAN(3,5,0)
       ierr = KSPSetOperators(_ksp, matrix->mat(), matrix->mat(),DIFFERENT_NONZERO_PATTERN);
 #else
       ierr = KSPSetOperators(_ksp, matrix->mat(), matrix->mat());
 #endif
       LIBMESH_CHKERR(ierr);
 
       // Set user-specified  solver and preconditioner types
       this->set_petsc_solver_type();
 
       // If the SolverConfiguration object is provided, use it to set
       // options during solver initialization.
       if (this->_solver_configuration)
         {
           this->_solver_configuration->set_options_during_init();
         }
 
       // Set the options from user-input
       // Set runtime options, e.g.,
       //      -ksp_type <type> -pc_type <type> -ksp_monitor -ksp_rtol <rtol>
       //  These options will override those specified above as long as
       //  KSPSetFromOptions() is called _after_ any other customization
       //  routines.
 
       ierr = KSPSetFromOptions (_ksp);
       LIBMESH_CHKERR(ierr);
 
       // Not sure if this is necessary, or if it is already handled by KSPSetFromOptions?
       // NOT NECESSARY!!!!
       //ierr = PCSetFromOptions (_pc);
       //LIBMESH_CHKERR(ierr);
 
       // Have the Krylov subspace method use our good initial guess
       // rather than 0, unless the user requested a KSPType of
       // preonly, which complains if asked to use initial guesses.
 #if PETSC_VERSION_LESS_THAN(3,0,0) || !PETSC_RELEASE_LESS_THAN(3,4,0)
       KSPType ksp_type;
 #else
       const KSPType ksp_type;
 #endif
 
       ierr = KSPGetType (_ksp, &ksp_type);
       LIBMESH_CHKERR(ierr);
 
       if (strcmp(ksp_type, "preonly"))
         {
           ierr = KSPSetInitialGuessNonzero (_ksp, PETSC_TRUE);
           LIBMESH_CHKERR(ierr);
         }
 
       // Notify PETSc of location to store residual history.
       // This needs to be called before any solves, since
       // it sets the residual history length to zero.  The default
       // behavior is for PETSc to allocate (internally) an array
       // of size 1000 to hold the residual norm history.
       ierr = KSPSetResidualHistory(_ksp,
                                    PETSC_NULL,   // pointer to the array which holds the history
                                    PETSC_DECIDE, // size of the array holding the history
                                    PETSC_TRUE);  // Whether or not to reset the history for each solve.
       LIBMESH_CHKERR(ierr);
 
       PetscPreconditioner<T>::set_petsc_preconditioner_type(this->_preconditioner_type,_pc);
       if (this->_preconditioner)
         {
           this->_preconditioner->set_matrix(*matrix);
           this->_preconditioner->init();
           PCShellSetContext(_pc,(void *)this->_preconditioner);
           PCShellSetSetUp(_pc,libmesh_petsc_preconditioner_setup);
           PCShellSetApply(_pc,libmesh_petsc_preconditioner_apply);
         }
     }
 }

◆ init_names()

template<typename T >

void libMesh::PetscLinearSolver< T >::init_names ( const System & sys )

overridevirtual

Apply names to the system to be solved. This sets an option prefix from the system name and sets field names from the system's variable names.

Since field names are applied to DoF numberings, this method must be called again after any System reinit.

Reimplemented from libMesh::LinearSolver< T >.

Definition at line 390 of file petsc_linear_solver.C.

References libMesh::petsc_auto_fieldsplit().

 {
   petsc_auto_fieldsplit(this->pc(), sys);
 }

◆ initialized()

template<typename T>

bool libMesh::LinearSolver< T >::initialized ( ) const

inlineinherited

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

Definition at line 96 of file linear_solver.h.

96 { return _is_initialized; }

libMesh::LinearSolver::_is_initialized

bool _is_initialized

Definition: linear_solver.h:287

◆ ksp()

template<typename T >

KSP libMesh::PetscLinearSolver< T >::ksp ( )

inline

Returns: The raw PETSc ksp context pointer.

This is useful if you are for example setting a custom convergence test with KSPSetConvergenceTest().

Definition at line 240 of file petsc_linear_solver.h.

References libMesh::PetscLinearSolver< T >::_ksp, and libMesh::PetscLinearSolver< T >::init().

240 { this->init(); return _ksp; }

libMesh::PetscLinearSolver::init

virtual void init(const char *name=nullptr) override

Definition: petsc_linear_solver.C:192

libMesh::PetscLinearSolver::_ksp

KSP _ksp

Definition: petsc_linear_solver.h:293

◆ n_objects()

static unsigned int libMesh::ReferenceCounter::n_objects ( )

inlinestaticinherited

Prints the number of outstanding (created, but not yet destroyed) objects.

Definition at line 83 of file reference_counter.h.

References libMesh::ReferenceCounter::_n_objects.

84 { return _n_objects; }

libMesh::ReferenceCounter::_n_objects

static Threads::atomic< unsigned int > _n_objects

Definition: reference_counter.h:130

◆ n_processors()

processor_id_type libMesh::ParallelObject::n_processors ( ) const

inlineinherited

Returns: The number of processors in the group.

Definition at line 95 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::size().

96 { return cast_int<processor_id_type>(_communicator.size()); }

libMesh::Parallel::Communicator::size

processor_id_type size() const

Definition: communicator.h:175

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

◆ pc()

template<typename T >

PC libMesh::PetscLinearSolver< T >::pc ( )

inline

Returns: The raw PETSc preconditioner context pointer.

This allows you to specify the PCShellSetApply() and PCShellSetSetUp() functions if you desire. Just don't do anything crazy like calling libMeshPCDestroy() on the pointer!

Definition at line 232 of file petsc_linear_solver.h.

References libMesh::PetscLinearSolver< T >::_pc, and libMesh::PetscLinearSolver< T >::init().

232 { this->init(); return _pc; }

libMesh::PetscLinearSolver::init

virtual void init(const char *name=nullptr) override

Definition: petsc_linear_solver.C:192

libMesh::PetscLinearSolver::_pc

PC _pc

Definition: petsc_linear_solver.h:288

◆ preconditioner_type()

template<typename T >

PreconditionerType libMesh::LinearSolver< T >::preconditioner_type ( ) const

inherited

Returns: The type of preconditioner to use.

Definition at line 98 of file linear_solver.C.

 {
   if (_preconditioner)
     return _preconditioner->type();
 
   return _preconditioner_type;
 }

◆ print_converged_reason()

template<typename T >

void libMesh::LinearSolver< T >::print_converged_reason ( ) const

virtualinherited

Prints a useful message about why the latest linear solve con(di)verged.

Reimplemented in libMesh::AztecLinearSolver< T >, and libMesh::LaspackLinearSolver< T >.

Definition at line 170 of file linear_solver.C.

 {
   LinearConvergenceReason reason = this->get_converged_reason();
   libMesh::out << "Linear solver convergence/divergence reason: " << Utility::enum_to_string(reason) << std::endl;
 }

◆ print_info()

void libMesh::ReferenceCounter::print_info ( std::ostream & out = libMesh::out )

staticinherited

Prints the reference information, by default to libMesh::out.

Definition at line 87 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();
 }

◆ processor_id()

processor_id_type libMesh::ParallelObject::processor_id ( ) const

inlineinherited

Returns: The rank of this processor in the group.

Definition at line 101 of file parallel_object.h.

References libMesh::ParallelObject::_communicator, and libMesh::Parallel::Communicator::rank().

102 { return cast_int<processor_id_type>(_communicator.rank()); }

libMesh::ParallelObject::_communicator

const Parallel::Communicator & _communicator

Definition: parallel_object.h:107

libMesh::Parallel::Communicator::rank

processor_id_type rank() const

Definition: communicator.h:173

◆ restrict_solve_to()

template<typename T >

void libMesh::PetscLinearSolver< T >::restrict_solve_to	(	const std::vector< unsigned int > *const	dofs,
		const SubsetSolveMode	subset_solve_mode = `SUBSET_ZERO`
	)

overridevirtual

After calling this method, all successive solves will be restricted to the given set of dofs, which must contain local dofs on each processor only and not contain any duplicates. This mode can be disabled by calling this method with dofs being a nullptr.

Reimplemented from libMesh::LinearSolver< T >.

Definition at line 399 of file petsc_linear_solver.C.

References ierr, and PETSC_OWN_POINTER.

 {
   PetscErrorCode ierr=0;
 
   /* The preconditioner (in particular if a default preconditioner)
      will have to be reset.  We call this->clear() to do that.  This
      call will also remove and free any previous subset that may have
      been set before.  */
   this->clear();
 
   _subset_solve_mode = subset_solve_mode;
 
   if (dofs != nullptr)
     {
       PetscInt * petsc_dofs = nullptr;
       ierr = PetscMalloc(dofs->size()*sizeof(PetscInt), &petsc_dofs);
       LIBMESH_CHKERR(ierr);
 
       for (std::size_t i=0; i<dofs->size(); i++)
         petsc_dofs[i] = (*dofs)[i];
 
       ierr = ISCreateLibMesh(this->comm().get(),
                              cast_int<PetscInt>(dofs->size()),
                              petsc_dofs, PETSC_OWN_POINTER,
                              &_restrict_solve_to_is);
       LIBMESH_CHKERR(ierr);
     }
 }

◆ reuse_preconditioner()

template<typename T >

void libMesh::LinearSolver< T >::reuse_preconditioner ( bool reuse_flag )

virtualinherited

Set the same_preconditioner flag, which indicates if we reuse the same preconditioner for subsequent solves.

Definition at line 129 of file linear_solver.C.

Referenced by libMesh::ImplicitSystem::disable_cache().

 {
   same_preconditioner = reuse_flag;
 }

◆ set_petsc_solver_type()

template<typename T >

void libMesh::PetscLinearSolver< T >::set_petsc_solver_type ( )

private

Tells PETSC to use the user-specified solver stored in _solver_type

Definition at line 1600 of file petsc_linear_solver.C.

References libMesh::BICG, libMesh::BICGSTAB, libMesh::CG, libMesh::CGS, libMesh::CHEBYSHEV, libMesh::CR, libMesh::Utility::enum_to_string(), libMesh::err, libMesh::GMRES, ierr, libMesh::LSQR, libMesh::MINRES, libMesh::RICHARDSON, libMesh::TCQMR, and libMesh::TFQMR.

 {
   PetscErrorCode ierr = 0;
 
   switch (this->_solver_type)
     {
 
     case CG:
       ierr = KSPSetType (_ksp, const_cast<KSPType>(KSPCG));
       LIBMESH_CHKERR(ierr);
       return;
 
     case CR:
       ierr = KSPSetType (_ksp, const_cast<KSPType>(KSPCR));
       LIBMESH_CHKERR(ierr);
       return;
 
     case CGS:
       ierr = KSPSetType (_ksp, const_cast<KSPType>(KSPCGS));
       LIBMESH_CHKERR(ierr);
       return;
 
     case BICG:
       ierr = KSPSetType (_ksp, const_cast<KSPType>(KSPBICG));
       LIBMESH_CHKERR(ierr);
       return;
 
     case TCQMR:
       ierr = KSPSetType (_ksp, const_cast<KSPType>(KSPTCQMR));
       LIBMESH_CHKERR(ierr);
       return;
 
     case TFQMR:
       ierr = KSPSetType (_ksp, const_cast<KSPType>(KSPTFQMR));
       LIBMESH_CHKERR(ierr);
       return;
 
     case LSQR:
       ierr = KSPSetType (_ksp, const_cast<KSPType>(KSPLSQR));
       LIBMESH_CHKERR(ierr);
       return;
 
     case BICGSTAB:
       ierr = KSPSetType (_ksp, const_cast<KSPType>(KSPBCGS));
       LIBMESH_CHKERR(ierr);
       return;
 
     case MINRES:
       ierr = KSPSetType (_ksp, const_cast<KSPType>(KSPMINRES));
       LIBMESH_CHKERR(ierr);
       return;
 
     case GMRES:
       ierr = KSPSetType (_ksp, const_cast<KSPType>(KSPGMRES));
       LIBMESH_CHKERR(ierr);
       return;
 
     case RICHARDSON:
       ierr = KSPSetType (_ksp, const_cast<KSPType>(KSPRICHARDSON));
       LIBMESH_CHKERR(ierr);
       return;
 
     case CHEBYSHEV:
 #if defined(LIBMESH_HAVE_PETSC) && PETSC_VERSION_LESS_THAN(3,3,0)
       ierr = KSPSetType (_ksp, const_cast<KSPType>(KSPCHEBYCHEV));
       LIBMESH_CHKERR(ierr);
       return;
 #else
       ierr = KSPSetType (_ksp, const_cast<KSPType>(KSPCHEBYSHEV));
       LIBMESH_CHKERR(ierr);
       return;
 #endif
 
 
     default:
       libMesh::err << "ERROR:  Unsupported PETSC Solver: "
                    << Utility::enum_to_string(this->_solver_type) << std::endl
                    << "Continuing with PETSC defaults" << std::endl;
     }
 }

◆ set_preconditioner_type()

template<typename T >

void libMesh::LinearSolver< T >::set_preconditioner_type ( const PreconditionerType pct )

inherited

Sets the type of preconditioner to use.

Definition at line 108 of file linear_solver.C.

 {
   if (_preconditioner)
     _preconditioner->set_type(pct);
   else
     _preconditioner_type = pct;
 }

◆ set_solver_configuration()

template<typename T >

void libMesh::LinearSolver< T >::set_solver_configuration ( SolverConfiguration & solver_configuration )

inherited

Set the solver configuration object.

Definition at line 177 of file linear_solver.C.

 {
   _solver_configuration = &solver_configuration;
 }

◆ set_solver_type()

template<typename T>

void libMesh::LinearSolver< T >::set_solver_type ( const SolverType st )

inlineinherited

Sets the type of solver to use.

Definition at line 127 of file linear_solver.h.

128 { _solver_type = st; }

libMesh::LinearSolver::_solver_type

SolverType _solver_type

Definition: linear_solver.h:277

◆ solve() [1/6]

template<typename T >

virtual std::pair<unsigned int, Real> libMesh::PetscLinearSolver< T >::solve	(	SparseMatrix< T > &	matrix_in,
		NumericVector< T > &	solution_in,
		NumericVector< T > &	rhs_in,
		const double	tol,
		const unsigned int	m_its
	)

inlineoverridevirtual

Call the Petsc solver. It calls the method below, using the same matrix for the system and preconditioner matrices.

Implements libMesh::LinearSolver< T >.

Definition at line 157 of file petsc_linear_solver.h.

   {
     return this->solve(matrix_in, matrix_in, solution_in, rhs_in, tol, m_its);
   }

◆ solve() [2/6]

template<typename T >

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

overridevirtual

This method allows you to call a linear solver while specifying the matrix to use as the (left) preconditioning matrix.

Note: The linear solver will not compute a preconditioner in this case, and will instead premultiply by the matrix you provide. In PETSc, this is accomplished by calling
PCSetType(_pc, PCMAT);
before invoking KSPSolve().; This functionality is not implemented in the LinearSolver class since there is not a built-in analog to this method for LASPACK. You could probably implement it by hand if you wanted.

Implements libMesh::LinearSolver< T >.

Definition at line 433 of file petsc_linear_solver.C.

References libMesh::PetscMatrix< T >::close(), ierr, libMesh::TriangleWrapper::init(), libMesh::NumericVector< T >::local_size(), libMesh::PetscMatrix< T >::mat(), libMesh::SUBSET_COPY_RHS, libMesh::SUBSET_DONT_TOUCH, and libMesh::SUBSET_ZERO.

 {
   LOG_SCOPE("solve()", "PetscLinearSolver");
 
   // Make sure the data passed in are really of Petsc types
   PetscMatrix<T> * matrix   = cast_ptr<PetscMatrix<T> *>(&matrix_in);
   PetscMatrix<T> * precond  = cast_ptr<PetscMatrix<T> *>(&precond_in);
   PetscVector<T> * solution = cast_ptr<PetscVector<T> *>(&solution_in);
   PetscVector<T> * rhs      = cast_ptr<PetscVector<T> *>(&rhs_in);
 
   this->init (matrix);
 
   PetscErrorCode ierr=0;
   PetscInt its=0, max_its = static_cast<PetscInt>(m_its);
   PetscReal final_resid=0.;
 
   // Close the matrices and vectors in case this wasn't already done.
   matrix->close ();
   precond->close ();
   solution->close ();
   rhs->close ();
 
   //   // If matrix != precond, then this means we have specified a
   //   // special preconditioner, so reset preconditioner type to PCMAT.
   //   if (matrix != precond)
   //     {
   //       this->_preconditioner_type = USER_PRECOND;
   //       this->set_petsc_preconditioner_type ();
   //     }
 
   Mat submat = nullptr;
   Mat subprecond = nullptr;
   Vec subrhs = nullptr;
   Vec subsolution = nullptr;
   VecScatter scatter = nullptr;
   std::unique_ptr<PetscMatrix<Number>> subprecond_matrix;
 
   // Set operators.  Also restrict rhs and solution vector to
   // subdomain if necessary.
   if (_restrict_solve_to_is != nullptr)
     {
       PetscInt is_local_size = this->_restrict_solve_to_is_local_size();
 
       ierr = VecCreate(this->comm().get(),&subrhs);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetSizes(subrhs,is_local_size,PETSC_DECIDE);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetFromOptions(subrhs);
       LIBMESH_CHKERR(ierr);
 
       ierr = VecCreate(this->comm().get(),&subsolution);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetSizes(subsolution,is_local_size,PETSC_DECIDE);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetFromOptions(subsolution);
       LIBMESH_CHKERR(ierr);
 
       ierr = LibMeshVecScatterCreate(rhs->vec(), _restrict_solve_to_is, subrhs, nullptr, &scatter);
       LIBMESH_CHKERR(ierr);
 
       ierr = VecScatterBegin(scatter,rhs->vec(),subrhs,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
       ierr = VecScatterEnd(scatter,rhs->vec(),subrhs,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
 
       ierr = VecScatterBegin(scatter,solution->vec(),subsolution,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
       ierr = VecScatterEnd(scatter,solution->vec(),subsolution,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
 
       ierr = LibMeshCreateSubMatrix(matrix->mat(),
                                     _restrict_solve_to_is,
                                     _restrict_solve_to_is,
 #if PETSC_VERSION_LESS_THAN(3,1,0)
                                     PETSC_DECIDE,
 #endif
                                     MAT_INITIAL_MATRIX,
                                     &submat);
       LIBMESH_CHKERR(ierr);
 
       ierr = LibMeshCreateSubMatrix(precond->mat(),
                                     _restrict_solve_to_is,
                                     _restrict_solve_to_is,
 #if PETSC_VERSION_LESS_THAN(3,1,0)
                                     PETSC_DECIDE,
 #endif
                                     MAT_INITIAL_MATRIX,
                                     &subprecond);
       LIBMESH_CHKERR(ierr);
 
       /* Since removing columns of the matrix changes the equation
          system, we will now change the right hand side to compensate
          for this.  Note that this is not necessary if \p SUBSET_ZERO
          has been selected.  */
       if (_subset_solve_mode!=SUBSET_ZERO)
         {
           _create_complement_is(rhs_in);
           PetscInt is_complement_local_size =
             cast_int<PetscInt>(rhs_in.local_size()-is_local_size);
 
           Vec subvec1 = nullptr;
           Mat submat1 = nullptr;
           VecScatter scatter1 = nullptr;
 
           ierr = VecCreate(this->comm().get(),&subvec1);
           LIBMESH_CHKERR(ierr);
           ierr = VecSetSizes(subvec1,is_complement_local_size,PETSC_DECIDE);
           LIBMESH_CHKERR(ierr);
           ierr = VecSetFromOptions(subvec1);
           LIBMESH_CHKERR(ierr);
 
           ierr = LibMeshVecScatterCreate(rhs->vec(),_restrict_solve_to_is_complement, subvec1, nullptr, &scatter1);
           LIBMESH_CHKERR(ierr);
 
           ierr = VecScatterBegin(scatter1,_subset_solve_mode==SUBSET_COPY_RHS ? rhs->vec() : solution->vec(),subvec1,INSERT_VALUES,SCATTER_FORWARD);
           LIBMESH_CHKERR(ierr);
           ierr = VecScatterEnd(scatter1,_subset_solve_mode==SUBSET_COPY_RHS ? rhs->vec() : solution->vec(),subvec1,INSERT_VALUES,SCATTER_FORWARD);
           LIBMESH_CHKERR(ierr);
 
           ierr = VecScale(subvec1,-1.0);
           LIBMESH_CHKERR(ierr);
 
           ierr = LibMeshCreateSubMatrix(matrix->mat(),
                                         _restrict_solve_to_is,
                                         _restrict_solve_to_is_complement,
 #if PETSC_VERSION_LESS_THAN(3,1,0)
                                         PETSC_DECIDE,
 #endif
                                         MAT_INITIAL_MATRIX,
                                         &submat1);
           LIBMESH_CHKERR(ierr);
 
           ierr = MatMultAdd(submat1,subvec1,subrhs,subrhs);
           LIBMESH_CHKERR(ierr);
 
           ierr = LibMeshVecScatterDestroy(&scatter1);
           LIBMESH_CHKERR(ierr);
           ierr = LibMeshVecDestroy(&subvec1);
           LIBMESH_CHKERR(ierr);
           ierr = LibMeshMatDestroy(&submat1);
           LIBMESH_CHKERR(ierr);
         }
 #if PETSC_RELEASE_LESS_THAN(3,5,0)
       ierr = KSPSetOperators(_ksp, submat, subprecond,
                              this->same_preconditioner ? SAME_PRECONDITIONER : DIFFERENT_NONZERO_PATTERN);
 #else
       ierr = KSPSetOperators(_ksp, submat, subprecond);
 
       PetscBool ksp_reuse_preconditioner = this->same_preconditioner ? PETSC_TRUE : PETSC_FALSE;
       ierr = KSPSetReusePreconditioner(_ksp, ksp_reuse_preconditioner);
 #endif
       LIBMESH_CHKERR(ierr);
 
       if (this->_preconditioner)
         {
           subprecond_matrix.reset(new PetscMatrix<Number>(subprecond, this->comm()));
           this->_preconditioner->set_matrix(*subprecond_matrix);
           this->_preconditioner->init();
         }
     }
   else
     {
 #if PETSC_RELEASE_LESS_THAN(3,5,0)
       ierr = KSPSetOperators(_ksp, matrix->mat(), precond->mat(),
                              this->same_preconditioner ? SAME_PRECONDITIONER : DIFFERENT_NONZERO_PATTERN);
 #else
       ierr = KSPSetOperators(_ksp, matrix->mat(), precond->mat());
 
       PetscBool ksp_reuse_preconditioner = this->same_preconditioner ? PETSC_TRUE : PETSC_FALSE;
       ierr = KSPSetReusePreconditioner(_ksp, ksp_reuse_preconditioner);
 #endif
       LIBMESH_CHKERR(ierr);
 
       if (this->_preconditioner)
         {
           this->_preconditioner->set_matrix(matrix_in);
           this->_preconditioner->init();
         }
     }
 
   // Set the tolerances for the iterative solver.  Use the user-supplied
   // tolerance for the relative residual & leave the others at default values.
   ierr = KSPSetTolerances (_ksp, tol, PETSC_DEFAULT,
                            PETSC_DEFAULT, max_its);
   LIBMESH_CHKERR(ierr);
 
   // Allow command line options to override anything set programmatically.
   ierr = KSPSetFromOptions(_ksp);
   LIBMESH_CHKERR(ierr);
 
   // If the SolverConfiguration object is provided, use it to override
   // solver options.
   if (this->_solver_configuration)
     {
       this->_solver_configuration->configure_solver();
     }
 
   // Solve the linear system
   if (_restrict_solve_to_is != nullptr)
     {
       ierr = KSPSolve (_ksp, subrhs, subsolution);
       LIBMESH_CHKERR(ierr);
     }
   else
     {
       ierr = KSPSolve (_ksp, rhs->vec(), solution->vec());
       LIBMESH_CHKERR(ierr);
     }
 
   // Get the number of iterations required for convergence
   ierr = KSPGetIterationNumber (_ksp, &its);
   LIBMESH_CHKERR(ierr);
 
   // Get the norm of the final residual to return to the user.
   ierr = KSPGetResidualNorm (_ksp, &final_resid);
   LIBMESH_CHKERR(ierr);
 
   if (_restrict_solve_to_is != nullptr)
     {
       switch(_subset_solve_mode)
         {
         case SUBSET_ZERO:
           ierr = VecZeroEntries(solution->vec());
           LIBMESH_CHKERR(ierr);
           break;
 
         case SUBSET_COPY_RHS:
           ierr = VecCopy(rhs->vec(),solution->vec());
           LIBMESH_CHKERR(ierr);
           break;
 
         case SUBSET_DONT_TOUCH:
           /* Nothing to do here.  */
           break;
 
         default:
           libmesh_error_msg("Invalid subset solve mode = " << _subset_solve_mode);
         }
       ierr = VecScatterBegin(scatter,subsolution,solution->vec(),INSERT_VALUES,SCATTER_REVERSE);
       LIBMESH_CHKERR(ierr);
       ierr = VecScatterEnd(scatter,subsolution,solution->vec(),INSERT_VALUES,SCATTER_REVERSE);
       LIBMESH_CHKERR(ierr);
 
       ierr = LibMeshVecScatterDestroy(&scatter);
       LIBMESH_CHKERR(ierr);
 
       if (this->_preconditioner)
         {
           // Before subprecond_matrix gets cleaned up, we should give
           // the _preconditioner a different matrix.
           this->_preconditioner->set_matrix(matrix_in);
           this->_preconditioner->init();
         }
 
       ierr = LibMeshVecDestroy(&subsolution);
       LIBMESH_CHKERR(ierr);
       ierr = LibMeshVecDestroy(&subrhs);
       LIBMESH_CHKERR(ierr);
       ierr = LibMeshMatDestroy(&submat);
       LIBMESH_CHKERR(ierr);
       ierr = LibMeshMatDestroy(&subprecond);
       LIBMESH_CHKERR(ierr);
     }
 
   // return the # of its. and the final residual norm.
   return std::make_pair(its, final_resid);
 }

◆ solve() [3/6]

template<typename T >

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

overridevirtual

This function solves a system whose matrix is a shell matrix.

Implements libMesh::LinearSolver< T >.

Definition at line 969 of file petsc_linear_solver.C.

References libMesh::PetscVector< T >::close(), ierr, libMesh::TriangleWrapper::init(), libMesh::NumericVector< T >::local_size(), libMesh::NumericVector< T >::size(), libMesh::SUBSET_COPY_RHS, libMesh::SUBSET_DONT_TOUCH, libMesh::SUBSET_ZERO, and libMesh::PetscVector< T >::vec().

 {
 
 #if PETSC_VERSION_LESS_THAN(3,1,0)
   if (_restrict_solve_to_is != nullptr)
     libmesh_error_msg("The current implementation of subset solves with " \
                       << "shell matrices requires PETSc version 3.1 or above.  " \
                       << "Older PETSc version do not support automatic " \
                       << "submatrix generation of shell matrices.");
 #endif
 
   LOG_SCOPE("solve()", "PetscLinearSolver");
 
   // Make sure the data passed in are really of Petsc types
   PetscVector<T> * solution = cast_ptr<PetscVector<T> *>(&solution_in);
   PetscVector<T> * rhs      = cast_ptr<PetscVector<T> *>(&rhs_in);
 
   this->init ();
 
   PetscErrorCode ierr=0;
   PetscInt its=0, max_its = static_cast<PetscInt>(m_its);
   PetscReal final_resid=0.;
 
   Mat submat = nullptr;
   Vec subrhs = nullptr;
   Vec subsolution = nullptr;
   VecScatter scatter = nullptr;
 
   // Close the matrices and vectors in case this wasn't already done.
   solution->close ();
   rhs->close ();
 
   // Prepare the matrix.
   Mat mat;
   ierr = MatCreateShell(this->comm().get(),
                         rhs_in.local_size(),
                         solution_in.local_size(),
                         rhs_in.size(),
                         solution_in.size(),
                         const_cast<void *>(static_cast<const void *>(&shell_matrix)),
                         &mat);
   /* Note that the const_cast above is only necessary because PETSc
      does not accept a const void *.  Inside the member function
      _petsc_shell_matrix() below, the pointer is casted back to a
      const ShellMatrix<T> *.  */
 
   LIBMESH_CHKERR(ierr);
   ierr = MatShellSetOperation(mat,MATOP_MULT,reinterpret_cast<void(*)(void)>(_petsc_shell_matrix_mult));
   LIBMESH_CHKERR(ierr);
   ierr = MatShellSetOperation(mat,MATOP_MULT_ADD,reinterpret_cast<void(*)(void)>(_petsc_shell_matrix_mult_add));
   LIBMESH_CHKERR(ierr);
   ierr = MatShellSetOperation(mat,MATOP_GET_DIAGONAL,reinterpret_cast<void(*)(void)>(_petsc_shell_matrix_get_diagonal));
   LIBMESH_CHKERR(ierr);
 
   // Restrict rhs and solution vectors and set operators.  The input
   // matrix works as the preconditioning matrix.
   if (_restrict_solve_to_is != nullptr)
     {
       PetscInt is_local_size = this->_restrict_solve_to_is_local_size();
 
       ierr = VecCreate(this->comm().get(),&subrhs);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetSizes(subrhs,is_local_size,PETSC_DECIDE);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetFromOptions(subrhs);
       LIBMESH_CHKERR(ierr);
 
       ierr = VecCreate(this->comm().get(),&subsolution);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetSizes(subsolution,is_local_size,PETSC_DECIDE);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetFromOptions(subsolution);
       LIBMESH_CHKERR(ierr);
 
       ierr = LibMeshVecScatterCreate(rhs->vec(),_restrict_solve_to_is, subrhs, nullptr, &scatter);
       LIBMESH_CHKERR(ierr);
 
       ierr = VecScatterBegin(scatter,rhs->vec(),subrhs,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
       ierr = VecScatterEnd(scatter,rhs->vec(),subrhs,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
 
       ierr = VecScatterBegin(scatter,solution->vec(),subsolution,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
       ierr = VecScatterEnd(scatter,solution->vec(),subsolution,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
 
 #if !PETSC_VERSION_LESS_THAN(3,1,0)
       ierr = LibMeshCreateSubMatrix(mat,
                                     _restrict_solve_to_is,
                                     _restrict_solve_to_is,
                                     MAT_INITIAL_MATRIX,
                                     &submat);
       LIBMESH_CHKERR(ierr);
 #endif
 
       /* Since removing columns of the matrix changes the equation
          system, we will now change the right hand side to compensate
          for this.  Note that this is not necessary if \p SUBSET_ZERO
          has been selected.  */
       if (_subset_solve_mode!=SUBSET_ZERO)
         {
           _create_complement_is(rhs_in);
           PetscInt is_complement_local_size =
             cast_int<PetscInt>(rhs_in.local_size()-is_local_size);
 
           Vec subvec1 = nullptr;
           Mat submat1 = nullptr;
           VecScatter scatter1 = nullptr;
 
           ierr = VecCreate(this->comm().get(),&subvec1);
           LIBMESH_CHKERR(ierr);
           ierr = VecSetSizes(subvec1,is_complement_local_size,PETSC_DECIDE);
           LIBMESH_CHKERR(ierr);
           ierr = VecSetFromOptions(subvec1);
           LIBMESH_CHKERR(ierr);
 
           ierr = LibMeshVecScatterCreate(rhs->vec(),_restrict_solve_to_is_complement, subvec1, nullptr, &scatter1);
           LIBMESH_CHKERR(ierr);
 
           ierr = VecScatterBegin(scatter1,_subset_solve_mode==SUBSET_COPY_RHS ? rhs->vec() : solution->vec(),subvec1,INSERT_VALUES,SCATTER_FORWARD);
           LIBMESH_CHKERR(ierr);
           ierr = VecScatterEnd(scatter1,_subset_solve_mode==SUBSET_COPY_RHS ? rhs->vec() : solution->vec(),subvec1,INSERT_VALUES,SCATTER_FORWARD);
           LIBMESH_CHKERR(ierr);
 
           ierr = VecScale(subvec1,-1.0);
           LIBMESH_CHKERR(ierr);
 
 #if !PETSC_VERSION_LESS_THAN(3,1,0)
           ierr = LibMeshCreateSubMatrix(mat,
                                         _restrict_solve_to_is,
                                         _restrict_solve_to_is_complement,
                                         MAT_INITIAL_MATRIX,
                                         &submat1);
           LIBMESH_CHKERR(ierr);
 #endif
 
           // The following lines would be correct, but don't work
           // correctly in PETSc up to 3.1.0-p5.  See discussion in
           // petsc-users of Nov 9, 2010.
           //
           // ierr = MatMultAdd(submat1,subvec1,subrhs,subrhs);
           // LIBMESH_CHKERR(ierr);
           //
           // We workaround by using a temporary vector.  Note that the
           // fix in PETsc 3.1.0-p6 uses a temporary vector internally,
           // so this is no effective performance loss.
           Vec subvec2 = nullptr;
           ierr = VecCreate(this->comm().get(),&subvec2);
           LIBMESH_CHKERR(ierr);
           ierr = VecSetSizes(subvec2,is_local_size,PETSC_DECIDE);
           LIBMESH_CHKERR(ierr);
           ierr = VecSetFromOptions(subvec2);
           LIBMESH_CHKERR(ierr);
           ierr = MatMult(submat1,subvec1,subvec2);
           LIBMESH_CHKERR(ierr);
           ierr = VecAXPY(subrhs,1.0,subvec2);
 
           ierr = LibMeshVecScatterDestroy(&scatter1);
           LIBMESH_CHKERR(ierr);
           ierr = LibMeshVecDestroy(&subvec1);
           LIBMESH_CHKERR(ierr);
           ierr = LibMeshMatDestroy(&submat1);
           LIBMESH_CHKERR(ierr);
         }
 #if PETSC_RELEASE_LESS_THAN(3,5,0)
       ierr = KSPSetOperators(_ksp, submat, submat,
                              DIFFERENT_NONZERO_PATTERN);
 #else
       ierr = KSPSetOperators(_ksp, submat, submat);
 #endif
       LIBMESH_CHKERR(ierr);
     }
   else
     {
 #if PETSC_RELEASE_LESS_THAN(3,5,0)
       ierr = KSPSetOperators(_ksp, mat, mat,
                              DIFFERENT_NONZERO_PATTERN);
 #else
       ierr = KSPSetOperators(_ksp, mat, mat);
 #endif
       LIBMESH_CHKERR(ierr);
     }
 
   // Set the tolerances for the iterative solver.  Use the user-supplied
   // tolerance for the relative residual & leave the others at default values.
   ierr = KSPSetTolerances (_ksp, tol, PETSC_DEFAULT,
                            PETSC_DEFAULT, max_its);
   LIBMESH_CHKERR(ierr);
 
   // Allow command line options to override anything set programmatically.
   ierr = KSPSetFromOptions(_ksp);
   LIBMESH_CHKERR(ierr);
 
   // Solve the linear system
   if (_restrict_solve_to_is != nullptr)
     {
       ierr = KSPSolve (_ksp, subrhs, subsolution);
       LIBMESH_CHKERR(ierr);
     }
   else
     {
       ierr = KSPSolve (_ksp, rhs->vec(), solution->vec());
       LIBMESH_CHKERR(ierr);
     }
 
   // Get the number of iterations required for convergence
   ierr = KSPGetIterationNumber (_ksp, &its);
   LIBMESH_CHKERR(ierr);
 
   // Get the norm of the final residual to return to the user.
   ierr = KSPGetResidualNorm (_ksp, &final_resid);
   LIBMESH_CHKERR(ierr);
 
   if (_restrict_solve_to_is != nullptr)
     {
       switch(_subset_solve_mode)
         {
         case SUBSET_ZERO:
           ierr = VecZeroEntries(solution->vec());
           LIBMESH_CHKERR(ierr);
           break;
 
         case SUBSET_COPY_RHS:
           ierr = VecCopy(rhs->vec(),solution->vec());
           LIBMESH_CHKERR(ierr);
           break;
 
         case SUBSET_DONT_TOUCH:
           /* Nothing to do here.  */
           break;
 
         default:
           libmesh_error_msg("Invalid subset solve mode = " << _subset_solve_mode);
         }
       ierr = VecScatterBegin(scatter,subsolution,solution->vec(),INSERT_VALUES,SCATTER_REVERSE);
       LIBMESH_CHKERR(ierr);
       ierr = VecScatterEnd(scatter,subsolution,solution->vec(),INSERT_VALUES,SCATTER_REVERSE);
       LIBMESH_CHKERR(ierr);
 
       ierr = LibMeshVecScatterDestroy(&scatter);
       LIBMESH_CHKERR(ierr);
 
       ierr = LibMeshVecDestroy(&subsolution);
       LIBMESH_CHKERR(ierr);
       ierr = LibMeshVecDestroy(&subrhs);
       LIBMESH_CHKERR(ierr);
       ierr = LibMeshMatDestroy(&submat);
       LIBMESH_CHKERR(ierr);
     }
 
   // Destroy the matrix.
   ierr = LibMeshMatDestroy(&mat);
   LIBMESH_CHKERR(ierr);
 
   // return the # of its. and the final residual norm.
   return std::make_pair(its, final_resid);
 }

◆ solve() [4/6]

template<typename T>

std::pair< unsigned int, Real > libMesh::LinearSolver< T >::solve	(	SparseMatrix< T > &	matrix,
		SparseMatrix< T > *	precond_matrix,
		NumericVector< T > &	sol,
		NumericVector< T > &	rhs,
		const double	tol,
		const unsigned int	n_iter
	)

inlineinherited

This function calls the solver "_solver_type" preconditioned with the "_preconditioner_type" preconditioner. The preconditioning matrix is used if it is provided, or the system matrix is used if precond_matrix is null

Definition at line 330 of file linear_solver.h.

 {
   if (pc_mat)
     return this->solve(mat, *pc_mat, sol, rhs, tol, n_iter);
   else
     return this->solve(mat, sol, rhs, tol, n_iter);
 }

◆ solve() [5/6]

template<typename T >

std::pair< unsigned int, Real > libMesh::PetscLinearSolver< T >::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
	)

overridevirtual

This function solves a system whose matrix is a shell matrix, but a sparse matrix is used as preconditioning matrix, this allowing other preconditioners than JACOBI.

Implements libMesh::LinearSolver< T >.

Definition at line 1236 of file petsc_linear_solver.C.

References ierr, libMesh::TriangleWrapper::init(), libMesh::NumericVector< T >::local_size(), libMesh::NumericVector< T >::size(), libMesh::SUBSET_COPY_RHS, libMesh::SUBSET_DONT_TOUCH, and libMesh::SUBSET_ZERO.

 {
 
 #if PETSC_VERSION_LESS_THAN(3,1,0)
   if (_restrict_solve_to_is != nullptr)
     libmesh_error_msg("The current implementation of subset solves with " \
                       << "shell matrices requires PETSc version 3.1 or above.  " \
                       << "Older PETSc version do not support automatic " \
                       << "submatrix generation of shell matrices.");
 #endif
 
   LOG_SCOPE("solve()", "PetscLinearSolver");
 
   // Make sure the data passed in are really of Petsc types
   const PetscMatrix<T> * precond  = cast_ptr<const PetscMatrix<T> *>(&precond_matrix);
   PetscVector<T> * solution = cast_ptr<PetscVector<T> *>(&solution_in);
   PetscVector<T> * rhs      = cast_ptr<PetscVector<T> *>(&rhs_in);
 
   this->init ();
 
   PetscErrorCode ierr=0;
   PetscInt its=0, max_its = static_cast<PetscInt>(m_its);
   PetscReal final_resid=0.;
 
   Mat submat = nullptr;
   Mat subprecond = nullptr;
   Vec subrhs = nullptr;
   Vec subsolution = nullptr;
   VecScatter scatter = nullptr;
   std::unique_ptr<PetscMatrix<Number>> subprecond_matrix;
 
   // Close the matrices and vectors in case this wasn't already done.
   solution->close ();
   rhs->close ();
 
   // Prepare the matrix.
   Mat mat;
   ierr = MatCreateShell(this->comm().get(),
                         rhs_in.local_size(),
                         solution_in.local_size(),
                         rhs_in.size(),
                         solution_in.size(),
                         const_cast<void *>(static_cast<const void *>(&shell_matrix)),
                         &mat);
   /* Note that the const_cast above is only necessary because PETSc
      does not accept a const void *.  Inside the member function
      _petsc_shell_matrix() below, the pointer is casted back to a
      const ShellMatrix<T> *.  */
 
   LIBMESH_CHKERR(ierr);
   ierr = MatShellSetOperation(mat,MATOP_MULT,reinterpret_cast<void(*)(void)>(_petsc_shell_matrix_mult));
   LIBMESH_CHKERR(ierr);
   ierr = MatShellSetOperation(mat,MATOP_MULT_ADD,reinterpret_cast<void(*)(void)>(_petsc_shell_matrix_mult_add));
   LIBMESH_CHKERR(ierr);
   ierr = MatShellSetOperation(mat,MATOP_GET_DIAGONAL,reinterpret_cast<void(*)(void)>(_petsc_shell_matrix_get_diagonal));
   LIBMESH_CHKERR(ierr);
 
   // Restrict rhs and solution vectors and set operators.  The input
   // matrix works as the preconditioning matrix.
   if (_restrict_solve_to_is != nullptr)
     {
       PetscInt is_local_size = this->_restrict_solve_to_is_local_size();
 
       ierr = VecCreate(this->comm().get(),&subrhs);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetSizes(subrhs,is_local_size,PETSC_DECIDE);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetFromOptions(subrhs);
       LIBMESH_CHKERR(ierr);
 
       ierr = VecCreate(this->comm().get(),&subsolution);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetSizes(subsolution,is_local_size,PETSC_DECIDE);
       LIBMESH_CHKERR(ierr);
       ierr = VecSetFromOptions(subsolution);
       LIBMESH_CHKERR(ierr);
 
       ierr = LibMeshVecScatterCreate(rhs->vec(),_restrict_solve_to_is, subrhs, nullptr, &scatter);
       LIBMESH_CHKERR(ierr);
 
       ierr = VecScatterBegin(scatter,rhs->vec(),subrhs,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
       ierr = VecScatterEnd(scatter,rhs->vec(),subrhs,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
 
       ierr = VecScatterBegin(scatter,solution->vec(),subsolution,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
       ierr = VecScatterEnd(scatter,solution->vec(),subsolution,INSERT_VALUES,SCATTER_FORWARD);
       LIBMESH_CHKERR(ierr);
 
 #if !PETSC_VERSION_LESS_THAN(3,1,0)
       ierr = LibMeshCreateSubMatrix(mat,
                                     _restrict_solve_to_is,
                                     _restrict_solve_to_is,
                                     MAT_INITIAL_MATRIX,
                                     &submat);
       LIBMESH_CHKERR(ierr);
 
       ierr = LibMeshCreateSubMatrix(const_cast<PetscMatrix<T> *>(precond)->mat(),
                                     _restrict_solve_to_is,
                                     _restrict_solve_to_is,
                                     MAT_INITIAL_MATRIX,
                                     &subprecond);
       LIBMESH_CHKERR(ierr);
 #endif
 
       /* Since removing columns of the matrix changes the equation
          system, we will now change the right hand side to compensate
          for this.  Note that this is not necessary if \p SUBSET_ZERO
          has been selected.  */
       if (_subset_solve_mode!=SUBSET_ZERO)
         {
           _create_complement_is(rhs_in);
           PetscInt is_complement_local_size = rhs_in.local_size()-is_local_size;
 
           Vec subvec1 = nullptr;
           Mat submat1 = nullptr;
           VecScatter scatter1 = nullptr;
 
           ierr = VecCreate(this->comm().get(),&subvec1);
           LIBMESH_CHKERR(ierr);
           ierr = VecSetSizes(subvec1,is_complement_local_size,PETSC_DECIDE);
           LIBMESH_CHKERR(ierr);
           ierr = VecSetFromOptions(subvec1);
           LIBMESH_CHKERR(ierr);
 
           ierr = LibMeshVecScatterCreate(rhs->vec(),_restrict_solve_to_is_complement, subvec1, nullptr, &scatter1);
           LIBMESH_CHKERR(ierr);
 
           ierr = VecScatterBegin(scatter1,_subset_solve_mode==SUBSET_COPY_RHS ? rhs->vec() : solution->vec(),subvec1,INSERT_VALUES,SCATTER_FORWARD);
           LIBMESH_CHKERR(ierr);
           ierr = VecScatterEnd(scatter1,_subset_solve_mode==SUBSET_COPY_RHS ? rhs->vec() : solution->vec(),subvec1,INSERT_VALUES,SCATTER_FORWARD);
           LIBMESH_CHKERR(ierr);
 
           ierr = VecScale(subvec1,-1.0);
           LIBMESH_CHKERR(ierr);
 
 #if !PETSC_VERSION_LESS_THAN(3,1,0)
           ierr = LibMeshCreateSubMatrix(mat,
                                         _restrict_solve_to_is,
                                         _restrict_solve_to_is_complement,
                                         MAT_INITIAL_MATRIX,
                                         &submat1);
           LIBMESH_CHKERR(ierr);
 #endif
 
           // The following lines would be correct, but don't work
           // correctly in PETSc up to 3.1.0-p5.  See discussion in
           // petsc-users of Nov 9, 2010.
           //
           // ierr = MatMultAdd(submat1,subvec1,subrhs,subrhs);
           // LIBMESH_CHKERR(ierr);
           //
           // We workaround by using a temporary vector.  Note that the
           // fix in PETsc 3.1.0-p6 uses a temporary vector internally,
           // so this is no effective performance loss.
           Vec subvec2 = nullptr;
           ierr = VecCreate(this->comm().get(),&subvec2);
           LIBMESH_CHKERR(ierr);
           ierr = VecSetSizes(subvec2,is_local_size,PETSC_DECIDE);
           LIBMESH_CHKERR(ierr);
           ierr = VecSetFromOptions(subvec2);
           LIBMESH_CHKERR(ierr);
           ierr = MatMult(submat1,subvec1,subvec2);
           LIBMESH_CHKERR(ierr);
           ierr = VecAXPY(subrhs,1.0,subvec2);
           LIBMESH_CHKERR(ierr);
 
           ierr = LibMeshVecScatterDestroy(&scatter1);
           LIBMESH_CHKERR(ierr);
           ierr = LibMeshVecDestroy(&subvec1);
           LIBMESH_CHKERR(ierr);
           ierr = LibMeshMatDestroy(&submat1);
           LIBMESH_CHKERR(ierr);
         }
 
 #if PETSC_RELEASE_LESS_THAN(3,5,0)
       ierr = KSPSetOperators(_ksp, submat, subprecond,
                              DIFFERENT_NONZERO_PATTERN);
 #else
       ierr = KSPSetOperators(_ksp, submat, subprecond);
 #endif
       LIBMESH_CHKERR(ierr);
 
       if (this->_preconditioner)
         {
           subprecond_matrix.reset(new PetscMatrix<Number>(subprecond, this->comm()));
           this->_preconditioner->set_matrix(*subprecond_matrix);
           this->_preconditioner->init();
         }
     }
   else
     {
 #if PETSC_RELEASE_LESS_THAN(3,5,0)
       ierr = KSPSetOperators(_ksp, mat, const_cast<PetscMatrix<T> *>(precond)->mat(),
                              DIFFERENT_NONZERO_PATTERN);
 #else
       ierr = KSPSetOperators(_ksp, mat, const_cast<PetscMatrix<T> *>(precond)->mat());
 #endif
       LIBMESH_CHKERR(ierr);
 
       if (this->_preconditioner)
         {
           this->_preconditioner->set_matrix(const_cast<SparseMatrix<Number> &>(precond_matrix));
           this->_preconditioner->init();
         }
     }
 
   // Set the tolerances for the iterative solver.  Use the user-supplied
   // tolerance for the relative residual & leave the others at default values.
   ierr = KSPSetTolerances (_ksp, tol, PETSC_DEFAULT,
                            PETSC_DEFAULT, max_its);
   LIBMESH_CHKERR(ierr);
 
   // Allow command line options to override anything set programmatically.
   ierr = KSPSetFromOptions(_ksp);
   LIBMESH_CHKERR(ierr);
 
   // Solve the linear system
   if (_restrict_solve_to_is != nullptr)
     {
       ierr = KSPSolve (_ksp, subrhs, subsolution);
       LIBMESH_CHKERR(ierr);
     }
   else
     {
       ierr = KSPSolve (_ksp, rhs->vec(), solution->vec());
       LIBMESH_CHKERR(ierr);
     }
 
   // Get the number of iterations required for convergence
   ierr = KSPGetIterationNumber (_ksp, &its);
   LIBMESH_CHKERR(ierr);
 
   // Get the norm of the final residual to return to the user.
   ierr = KSPGetResidualNorm (_ksp, &final_resid);
   LIBMESH_CHKERR(ierr);
 
   if (_restrict_solve_to_is != nullptr)
     {
       switch(_subset_solve_mode)
         {
         case SUBSET_ZERO:
           ierr = VecZeroEntries(solution->vec());
           LIBMESH_CHKERR(ierr);
           break;
 
         case SUBSET_COPY_RHS:
           ierr = VecCopy(rhs->vec(),solution->vec());
           LIBMESH_CHKERR(ierr);
           break;
 
         case SUBSET_DONT_TOUCH:
           /* Nothing to do here.  */
           break;
 
         default:
           libmesh_error_msg("Invalid subset solve mode = " << _subset_solve_mode);
         }
       ierr = VecScatterBegin(scatter,subsolution,solution->vec(),INSERT_VALUES,SCATTER_REVERSE);
       LIBMESH_CHKERR(ierr);
       ierr = VecScatterEnd(scatter,subsolution,solution->vec(),INSERT_VALUES,SCATTER_REVERSE);
       LIBMESH_CHKERR(ierr);
 
       ierr = LibMeshVecScatterDestroy(&scatter);
       LIBMESH_CHKERR(ierr);
 
       if (this->_preconditioner)
         {
           // Before subprecond_matrix gets cleaned up, we should give
           // the _preconditioner a different matrix.
           this->_preconditioner->set_matrix(const_cast<SparseMatrix<Number> &>(precond_matrix));
           this->_preconditioner->init();
         }
 
       ierr = LibMeshVecDestroy(&subsolution);
       LIBMESH_CHKERR(ierr);
       ierr = LibMeshVecDestroy(&subrhs);
       LIBMESH_CHKERR(ierr);
       ierr = LibMeshMatDestroy(&submat);
       LIBMESH_CHKERR(ierr);
       ierr = LibMeshMatDestroy(&subprecond);
       LIBMESH_CHKERR(ierr);
     }
 
   // Destroy the matrix.
   ierr = LibMeshMatDestroy(&mat);
   LIBMESH_CHKERR(ierr);
 
   // return the # of its. and the final residual norm.
   return std::make_pair(its, final_resid);
 }

◆ solve() [6/6]

template<typename T>

std::pair< unsigned int, Real > libMesh::LinearSolver< T >::solve	(	const ShellMatrix< T > &	matrix,
		const SparseMatrix< T > *	precond_matrix,
		NumericVector< T > &	sol,
		NumericVector< T > &	rhs,
		const double	tol,
		const unsigned int	n_iter
	)

inlineinherited

This function solves a system whose matrix is a shell matrix, but an optional sparse matrix may be used as preconditioning matrix.

Definition at line 347 of file linear_solver.h.

 {
   if (pc_mat)
     return this->solve(mat, *pc_mat, sol, rhs, tol, n_iter);
   else
     return this->solve(mat, sol, rhs, tol, n_iter);
 }

◆ solver_type()

template<typename T>

SolverType libMesh::LinearSolver< T >::solver_type ( ) const

inlineinherited

Returns: The type of solver to use.

Definition at line 122 of file linear_solver.h.

122 { return _solver_type; }

libMesh::LinearSolver::_solver_type

SolverType _solver_type

Definition: linear_solver.h:277

Member Data Documentation

◆ _communicator

const Parallel::Communicator& libMesh::ParallelObject::_communicator

protectedinherited

Definition at line 107 of file parallel_object.h.

Referenced by libMesh::EquationSystems::build_parallel_elemental_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::ParallelObject::comm(), libMesh::ParallelObject::n_processors(), libMesh::ParallelObject::operator=(), and libMesh::ParallelObject::processor_id().

◆ _counts

ReferenceCounter::Counts libMesh::ReferenceCounter::_counts

staticprotectedinherited

Actually holds the data.

Definition at line 122 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::get_info(), libMesh::ReferenceCounter::increment_constructor_count(), and libMesh::ReferenceCounter::increment_destructor_count().

◆ _enable_print_counter

bool libMesh::ReferenceCounter::_enable_print_counter = true

staticprotectedinherited

Flag to control whether reference count information is printed when print_info is called.

Definition at line 141 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::disable_print_counter_info(), libMesh::ReferenceCounter::enable_print_counter_info(), and libMesh::ReferenceCounter::print_info().

◆ _is_initialized

template<typename T>

bool libMesh::LinearSolver< T >::_is_initialized

protectedinherited

Flag indicating if the data structures have been initialized.

Definition at line 287 of file linear_solver.h.

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

◆ _ksp

template<typename T >

KSP libMesh::PetscLinearSolver< T >::_ksp

private

Krylov subspace context

Definition at line 293 of file petsc_linear_solver.h.

Referenced by libMesh::PetscLinearSolver< T >::ksp().

◆ _mutex

Threads::spin_mutex libMesh::ReferenceCounter::_mutex

staticprotectedinherited

Mutual exclusion object to enable thread-safe reference counting.

Definition at line 135 of file reference_counter.h.

◆ _n_objects

Threads::atomic< unsigned int > libMesh::ReferenceCounter::_n_objects

staticprotectedinherited

The number of objects. Print the reference count information when the number returns to 0.

Definition at line 130 of file reference_counter.h.

Referenced by libMesh::ReferenceCounter::n_objects(), libMesh::ReferenceCounter::ReferenceCounter(), and libMesh::ReferenceCounter::~ReferenceCounter().

◆ _pc

template<typename T >

PC libMesh::PetscLinearSolver< T >::_pc

private

Preconditioner context

Definition at line 288 of file petsc_linear_solver.h.

Referenced by libMesh::PetscLinearSolver< T >::pc().

◆ _preconditioner

template<typename T>

Preconditioner<T>* libMesh::LinearSolver< T >::_preconditioner

protectedinherited

Holds the Preconditioner object to be used for the linear solves.

Definition at line 292 of file linear_solver.h.

◆ _preconditioner_type

template<typename T>

PreconditionerType libMesh::LinearSolver< T >::_preconditioner_type

protectedinherited

Enum stating with type of preconditioner to use.

Definition at line 282 of file linear_solver.h.

Referenced by libMesh::AztecLinearSolver< T >::AztecLinearSolver(), and libMesh::PetscLinearSolver< T >::PetscLinearSolver().

◆ _restrict_solve_to_is

template<typename T >

IS libMesh::PetscLinearSolver< T >::_restrict_solve_to_is

private

PETSc index set containing the dofs on which to solve (nullptr means solve on all dofs).

Definition at line 299 of file petsc_linear_solver.h.

◆ _restrict_solve_to_is_complement

template<typename T >

IS libMesh::PetscLinearSolver< T >::_restrict_solve_to_is_complement

private

PETSc index set, complement to _restrict_solve_to_is. This will be created on demand by the method _create_complement_is().

Definition at line 306 of file petsc_linear_solver.h.

◆ _solver_configuration

template<typename T>

SolverConfiguration* libMesh::LinearSolver< T >::_solver_configuration

protectedinherited

Optionally store a SolverOptions object that can be used to set parameters like solver type, tolerances and iteration limits.

Definition at line 306 of file linear_solver.h.

◆ _solver_type

template<typename T>

SolverType libMesh::LinearSolver< T >::_solver_type

protectedinherited

Enum stating which type of iterative solver to use.

Definition at line 277 of file linear_solver.h.

Referenced by libMesh::EigenSparseLinearSolver< T >::EigenSparseLinearSolver(), libMesh::LinearSolver< Number >::set_solver_type(), and libMesh::LinearSolver< Number >::solver_type().

◆ _subset_solve_mode

template<typename T >

SubsetSolveMode libMesh::PetscLinearSolver< T >::_subset_solve_mode

private

If restrict-solve-to-subset mode is active, this member decides what happens with the dofs outside the subset.

Definition at line 324 of file petsc_linear_solver.h.

◆ same_preconditioner

template<typename T>

bool libMesh::LinearSolver< T >::same_preconditioner

protectedinherited

Boolean flag to indicate whether we want to use an identical preconditioner to the previous solve. This can save substantial work in the cases where the system matrix is the same for successive solves.

Definition at line 300 of file linear_solver.h.

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

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ Counts

Constructor & Destructor Documentation

◆ PetscLinearSolver()

◆ ~PetscLinearSolver()

Member Function Documentation

◆ _create_complement_is()

◆ _petsc_shell_matrix_get_diagonal()

◆ _petsc_shell_matrix_mult()

◆ _petsc_shell_matrix_mult_add()

◆ _restrict_solve_to_is_local_size()

◆ adjoint_solve()

◆ attach_preconditioner()

◆ build()

◆ clear()

◆ comm()

◆ disable_print_counter_info()

◆ enable_print_counter_info()

◆ get_converged_reason()

◆ get_info()

◆ get_initial_residual()

◆ get_residual_history()

◆ get_same_preconditioner()

◆ increment_constructor_count()

◆ increment_destructor_count()

◆ init() [1/2]

◆ init() [2/2]

◆ init_names()

◆ initialized()

◆ ksp()

◆ n_objects()

◆ n_processors()

◆ pc()

◆ preconditioner_type()

◆ print_converged_reason()

◆ print_info()

◆ processor_id()

◆ restrict_solve_to()

◆ reuse_preconditioner()

◆ set_petsc_solver_type()

◆ set_preconditioner_type()

◆ set_solver_configuration()

◆ set_solver_type()

◆ solve() [1/6]

◆ solve() [2/6]

◆ solve() [3/6]

◆ solve() [4/6]

◆ solve() [5/6]

◆ solve() [6/6]

◆ solver_type()

Member Data Documentation

◆ _communicator

◆ _counts

◆ _enable_print_counter

◆ _is_initialized

◆ _ksp

◆ _mutex

◆ _n_objects

◆ _pc

◆ _preconditioner

◆ _preconditioner_type

◆ _restrict_solve_to_is

◆ _restrict_solve_to_is_complement

◆ _solver_configuration

◆ _solver_type

◆ _subset_solve_mode

◆ same_preconditioner

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