Class PETScKrylovLinearSolver provides a KrylovLinearSolver interface for a PETSc Krylov subspace iterative linear solver (KSP). More...

#include <ibtk/PETScKrylovLinearSolver.h>

Inheritance diagram for IBTK::PETScKrylovLinearSolver:

[legend]

Public Member Functions
	PETScKrylovLinearSolver (std::string object_name, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db, std::string default_options_prefix, MPI_Comm petsc_comm=PETSC_COMM_WORLD)
	Constructor for a concrete KrylovLinearSolver that employs the PETSc KSP solver framework. More...

	PETScKrylovLinearSolver (std::string object_name, const KSP &petsc_ksp)
	Constructor for a concrete KrylovLinearSolver that acts as a "wrapper" for a supplied PETSc KSP object. More...

	~PETScKrylovLinearSolver ()
	Destructor. More...

void	setKSPType (const std::string &ksp_type)
	Set the KSP type. More...

void	setOptionsPrefix (const std::string &options_prefix)
	Set the options prefix used by this PETSc solver object. More...

void	setHierarchyMathOps (SAMRAI::tbox::Pointer< HierarchyMathOps > hier_math_ops) override
	Set the HierarchyMathOps object used by the solver. More...

Functions to access the underlying PETSc objects.
const KSP &	getPETScKSP () const
	Get the PETSc KSP object. More...

General-purpose solver functionality.
void	setHomogeneousBc (bool homogeneous_bc) override
	Set whether the solver should use homogeneous boundary conditions. More...

void	setSolutionTime (double solution_time) override
	Set the time at which the solution is to be evaluated. More...

void	setTimeInterval (double current_time, double new_time) override
	Set the current time interval. More...

Linear solver functionality.
virtual bool	getNullSpaceContainsConstantVector () const
	Get whether the nullspace of the linear system contains th constant vector. More...

virtual const std::vector< SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double > > > &	getNullSpaceBasisVectors () const
	Get the basis vectors for the nullspace of the linear system. More...

Functions to access solver parameters.
virtual void	setInitialGuessNonzero (bool initial_guess_nonzero=true)
	Set whether the initial guess is non-zero. More...

virtual bool	getInitialGuessNonzero () const
	Get whether the initial guess is non-zero. More...

General-purpose solver functionality.
const std::string &	getName () const
	Return the object name. More...

virtual bool	getIsInitialized () const
	Return whether the operator is initialized. More...

virtual bool	getHomogeneousBc () const
	Return whether the solver is using homogeneous boundary conditions. More...

virtual double	getSolutionTime () const
	Get the time at which the solution is being evaluated. More...

virtual std::pair< double, double >	getTimeInterval () const
	Get the current time interval. More...

virtual double	getDt () const
	Get the current time step size. More...

virtual SAMRAI::tbox::Pointer< HierarchyMathOps >	getHierarchyMathOps () const
	Get the HierarchyMathOps object used by the solver. More...

Functions to access solver parameters.
virtual void	setMaxIterations (int max_iterations)
	Set the maximum number of nonlinear iterations to use per solve. More...

virtual int	getMaxIterations () const
	Get the maximum number of nonlinear iterations to use per solve. More...

virtual void	setAbsoluteTolerance (double abs_residual_tol)
	Set the absolute residual tolerance for convergence. More...

virtual double	getAbsoluteTolerance () const
	Get the absolute residual tolerance for convergence. More...

virtual void	setRelativeTolerance (double rel_residual_tol)
	Set the relative residual tolerance for convergence. More...

virtual double	getRelativeTolerance () const
	Get the relative residual tolerance for convergence. More...

Functions to access data on the most recent solve.
virtual int	getNumIterations () const
	Return the iteration count from the most recent solve. More...

virtual double	getResidualNorm () const
	Return the residual norm from the most recent iteration. More...

Static Public Member Functions
static SAMRAI::tbox::Pointer< KrylovLinearSolver >	allocate_solver (const std::string &object_name, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db, const std::string &default_options_prefix)
	Static function to construct a PETScKrylovLinearSolver. More...

Friends
class	PETScNewtonKrylovSolver

Static functions for use by PETSc KSP and MatShell objects.
std::string	d_ksp_type

bool	d_reinitializing_solver = false

Vec	d_petsc_x = nullptr

Vec	d_petsc_b = nullptr

std::string	d_options_prefix

MPI_Comm	d_petsc_comm

KSP	d_petsc_ksp = nullptr

Mat	d_petsc_mat = nullptr

MatNullSpace	d_petsc_nullsp = nullptr

bool	d_managing_petsc_ksp = true

bool	d_user_provided_mat = false

bool	d_user_provided_pc = false

SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double > >	d_nullspace_constant_vec

Vec	d_petsc_nullspace_constant_vec = nullptr

std::vector< Vec >	d_petsc_nullspace_basis_vecs

bool	d_solver_has_attached_nullspace = false

static PetscErrorCode	MatVecMult_SAMRAI (Mat A, Vec x, Vec y)
	Compute the matrix vector product \(y=Ax\). More...

static PetscErrorCode	PCApply_SAMRAI (PC pc, Vec x, Vec y)
	Apply the preconditioner to x and store the result in y. More...

Krylov solver functionality.
void	setOperator (SAMRAI::tbox::Pointer< LinearOperator > A) override
	Set the linear operator used when solving \(Ax=b\). More...

void	setPreconditioner (SAMRAI::tbox::Pointer< LinearSolver > pc_solver=nullptr) override
	Set the preconditioner used by the Krylov subspace method when solving \(Ax=b\). More...

void	setNullSpace (bool contains_constant_vec, const std::vector< SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double >>> &nullspace_basis_vecs=std::vector< SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double >>>()) override
	Set the nullspace of the linear system. More...

bool	solveSystem (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &x, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &b) override
	Solve the linear system of equations \(Ax=b\) for \(x\). More...

void	initializeSolverState (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &x, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &b) override
	Compute hierarchy dependent data required for solving \(Ax=b\). More...

void	deallocateSolverState () override
	Remove all hierarchy dependent data allocated by initializeSolverState(). More...

	PETScKrylovLinearSolver ()=delete
	Default constructor. More...

	PETScKrylovLinearSolver (const PETScKrylovLinearSolver &from)=delete
	Copy constructor. More...

PETScKrylovLinearSolver &	operator= (const PETScKrylovLinearSolver &that)=delete
	Assignment operator. More...

void	common_ctor ()
	Common routine used by all class constructors. More...

void	resetWrappedKSP (KSP &petsc_ksp)
	Reset the KSP wrapped by this solver class. More...

void	resetKSPOptions ()
	Reset the values of the convergence tolerances for the PETSc KSP object. More...

void	resetKSPOperators ()
	Reset the KSP operators to correspond to the supplied LinearOperator. More...

void	resetKSPPC ()
	Reset the KSP PC to correspond to the supplied preconditioner. More...

void	resetMatNullSpace ()
	Reset the Mat nullspace object to correspond to the supplied nullspace basis vectors. More...

void	deallocateNullSpaceData ()
	Destroy data allocated to describe nullspace. More...

Krylov solver functionality.
virtual SAMRAI::tbox::Pointer< LinearOperator >	getOperator () const
	Retrieve the linear operator used when solving \(Ax=b\). More...

virtual SAMRAI::tbox::Pointer< LinearSolver >	getPreconditioner () const
	Retrieve the preconditioner used by the Krylov subspace method when solving \(Ax=b\). More...

SAMRAI::tbox::Pointer< LinearOperator >	d_A

SAMRAI::tbox::Pointer< LinearSolver >	d_pc_solver

SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double > >	d_x

SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double > >	d_b

Logging functions.
virtual void	printClassData (std::ostream &stream) override
	Print class data to stream. More...

bool	d_initial_guess_nonzero = true

bool	d_nullspace_contains_constant_vec = false

std::vector< SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double > > >	d_nullspace_basis_vecs

Logging functions.
virtual void	setLoggingEnabled (bool enable_logging=true)
	Enable or disable logging. More...

virtual bool	getLoggingEnabled () const
	Determine whether logging is enabled or disabled. More...

std::string	d_object_name = "unitialized"

bool	d_is_initialized = false

bool	d_homogeneous_bc = false

double	d_solution_time = std::numeric_limits<double>::quiet_NaN()

double	d_current_time = std::numeric_limits<double>::quiet_NaN()

double	d_new_time = std::numeric_limits<double>::quiet_NaN()

double	d_rel_residual_tol = 0.0

double	d_abs_residual_tol = 0.0

int	d_max_iterations = 100

int	d_current_iterations = 0

double	d_current_residual_norm = std::numeric_limits<double>::quiet_NaN()

SAMRAI::tbox::Pointer< HierarchyMathOps >	d_hier_math_ops

bool	d_hier_math_ops_external = false

bool	d_enable_logging = false

void	init (const std::string &object_name, bool homogeneous_bc)

virtual void	initSpecialized (const std::string &object_name, bool homogeneous_bc)

Detailed Description

This solver class provides access to a large number of Krylov subspace solvers for linear problems of the form \(Ax=b\) using the PETSc KSP linear solver interface. See http://www.mcs.anl.gov/petsc/documentation/linearsolvertable.html for a complete list of the Krylov solvers provided by this class. Note that solver configuration is typically done at runtime via command line options.

Note

Preconditioners and direct solvers provided by PETSc cannot be used within the present IBTK solver framework. However, this does not mean that preconditioners cannot be used with the PETScKrylovLinearSolver class; see, for instance, classes FACPreconditioner and CCPoissonPointRelaxationFACOperator.

Users have the option of supplying the PETScKrylovLinearSolver class constructor with a KSP object. It is important to emphasize that doing so is optional. When a KSP object is provided to the class constructor, the PETScKrylovLinearSolver class acts as a wrapper for the supplied KSP object.

The functionality of the PETScKrylovLinearSolver class is essentially identical regardless as to whether a PETSc KSP object is provided to the class constructor. The main exception is that when an external KSP object is provided to the class constructor, memory management of that object is NOT handled by the PETScKrylovLinearSolver. In particular, it is the caller's responsibility to ensure that the supplied KSP object is properly destroyed via KSPDestroy().

Sample parameters for initialization from database (and their default values):

options_prefix = ""           // see setOptionsPrefix()
ksp_type = "gmres"            // see setKSPType()
initial_guess_nonzero = TRUE  // see setInitialGuessNonzero()
rel_residual_tol = 1.0e-5     // see setRelativeTolerance()
abs_residual_tol = 1.0e-50    // see setAbsoluteTolerance()
max_iterations = 10000        // see setMaxIterations()
enable_logging = FALSE        // see setLoggingEnabled()

PETSc is developed in the Mathematics and Computer Science (MCS) Division at Argonne National Laboratory (ANL). For more information about PETSc, see http://www.mcs.anl.gov/petsc.

Constructor & Destructor Documentation

◆ PETScKrylovLinearSolver() [1/4]

IBTK::PETScKrylovLinearSolver::PETScKrylovLinearSolver	(	std::string	object_name,
		SAMRAI::tbox::Pointer< SAMRAI::tbox::Database >	input_db,
		std::string	default_options_prefix,
		MPI_Comm	petsc_comm = `PETSC_COMM_WORLD`
	)

◆ PETScKrylovLinearSolver() [2/4]

IBTK::PETScKrylovLinearSolver::PETScKrylovLinearSolver	(	std::string	object_name,
		const KSP &	petsc_ksp
	)

Parameters

object_name	Name of the solver
petsc_ksp	PETSc KSP object

Note: This constructor initializes a PETScKrylovLinearSolver object that acts as a "wrapper" for the provided KSP object. Note that memory management of the provided KSP object is NOT handled by this class.

◆ ~PETScKrylovLinearSolver()

IBTK::PETScKrylovLinearSolver::~PETScKrylovLinearSolver ( )

◆ PETScKrylovLinearSolver() [3/4]

IBTK::PETScKrylovLinearSolver::PETScKrylovLinearSolver ( )

privatedelete

Note: This constructor is not implemented and should not be used.

◆ PETScKrylovLinearSolver() [4/4]

IBTK::PETScKrylovLinearSolver::PETScKrylovLinearSolver ( const PETScKrylovLinearSolver & from )

privatedelete

Note: This constructor is not implemented and should not be used.

Parameters

from	The value to copy to this object.

Member Function Documentation

◆ allocate_solver()

static SAMRAI::tbox::Pointer<KrylovLinearSolver> IBTK::PETScKrylovLinearSolver::allocate_solver	(	const std::string &	object_name,
		SAMRAI::tbox::Pointer< SAMRAI::tbox::Database >	input_db,
		const std::string &	default_options_prefix
	)

inlinestatic

◆ setKSPType()

void IBTK::PETScKrylovLinearSolver::setKSPType ( const std::string & ksp_type )

◆ setOptionsPrefix()

void IBTK::PETScKrylovLinearSolver::setOptionsPrefix ( const std::string & options_prefix )

◆ getPETScKSP()

const KSP& IBTK::PETScKrylovLinearSolver::getPETScKSP ( ) const

◆ setOperator()

void IBTK::PETScKrylovLinearSolver::setOperator ( SAMRAI::tbox::Pointer< LinearOperator > A )

overridevirtual

Reimplemented from IBTK::KrylovLinearSolver.

◆ setPreconditioner()

void IBTK::PETScKrylovLinearSolver::setPreconditioner ( SAMRAI::tbox::Pointer< LinearSolver > pc_solver = nullptr )

overridevirtual

Note: If the preconditioner is nullptr, no preconditioning is performed.

Reimplemented from IBTK::KrylovLinearSolver.

◆ setNullSpace()

void IBTK::PETScKrylovLinearSolver::setNullSpace	(	bool	contains_constant_vec,
		const std::vector< SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double >>> &	nullspace_basis_vecs = `std::vector< SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double >>>()`
	)

overridevirtual

Basis vectors must be orthogonal but are not required to be orthonormal. Basis vectors will be normalized automatically.

Reimplemented from IBTK::LinearSolver.

◆ solveSystem()

bool IBTK::PETScKrylovLinearSolver::solveSystem	(	SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	x,
		SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	b
	)

overridevirtual

Before calling solveSystem(), the form of the solution x and right-hand-side b vectors must be set properly by the user on all patch interiors on the specified range of levels in the patch hierarchy. The user is responsible for all data management for the quantities associated with the solution and right-hand-side vectors. In particular, patch data in these vectors must be allocated prior to calling this method.

Parameters

x	solution vector
b	right-hand-side vector

Conditions on Parameters:

vectors x and b must have same patch hierarchy
vectors x and b must have same structure, depth, etc.

Note: The vector arguments for solveSystem() need not match those for initializeSolverState(). However, there must be a certain degree of similarity, including:

hierarchy configuration (hierarchy pointer and range of levels)
number, type and alignment of vector component data
ghost cell widths of data in the solution x and right-hand-side b vectors

Note: The solver need not be initialized prior to calling solveSystem(); however, see initializeSolverState() and deallocateSolverState() for opportunities to save overhead when performing multiple consecutive solves.

See also: initializeSolverState; deallocateSolverState

Returns: true if the solver converged to the specified tolerances, false otherwise

Implements IBTK::GeneralSolver.

◆ initializeSolverState()

void IBTK::PETScKrylovLinearSolver::initializeSolverState	(	const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	x,
		const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	b
	)

overridevirtual

By default, the solveSystem() method computes some required hierarchy dependent data before solving and removes that data after the solve. For multiple solves that use the same hierarchy configuration, it is more efficient to:

initialize the hierarchy-dependent data required by the solver via initializeSolverState(),
solve the system one or more times via solveSystem(), and
remove the hierarchy-dependent data via deallocateSolverState().

Note that it is generally necessary to reinitialize the solver state when the hierarchy configuration changes.

When linear operator or preconditioner objects have been registered with this class via setOperator() and setPreconditioner(), they are also initialized by this member function.

Parameters

x	solution vector
b	right-hand-side vector

Conditions on Parameters:

vectors x and b must have same patch hierarchy
vectors x and b must have same structure, depth, etc.

Note: The vector arguments for solveSystem() need not match those for initializeSolverState(). However, there must be a certain degree of similarity, including:

hierarchy configuration (hierarchy pointer and range of levels)
number, type and alignment of vector component data
ghost cell widths of data in the solution x and right-hand-side b vectors

Note: It is safe to call initializeSolverState() when the state is already initialized. In this case, the solver state is first deallocated and then reinitialized.

See also: deallocateSolverState

Reimplemented from IBTK::GeneralSolver.

◆ deallocateSolverState()

void IBTK::PETScKrylovLinearSolver::deallocateSolverState ( )

overridevirtual

When linear operator or preconditioner objects have been registered with this class via setOperator() and setPreconditioner(), they are also deallocated by this member function.

Note: It is safe to call deallocateSolverState() when the solver state is already deallocated.

See also: initializeSolverState

Reimplemented from IBTK::GeneralSolver.

◆ operator=()

PETScKrylovLinearSolver& IBTK::PETScKrylovLinearSolver::operator= ( const PETScKrylovLinearSolver & that )

privatedelete

Note: This operator is not implemented and should not be used.

Parameters

that	The value to assign to this object.

Returns: A reference to this object.

◆ common_ctor()

void IBTK::PETScKrylovLinearSolver::common_ctor ( )

private

◆ resetWrappedKSP()

void IBTK::PETScKrylovLinearSolver::resetWrappedKSP ( KSP & petsc_ksp )

private

◆ resetKSPOptions()

void IBTK::PETScKrylovLinearSolver::resetKSPOptions ( )

private

◆ resetKSPOperators()

void IBTK::PETScKrylovLinearSolver::resetKSPOperators ( )

private

◆ resetKSPPC()

void IBTK::PETScKrylovLinearSolver::resetKSPPC ( )

private

◆ resetMatNullSpace()

void IBTK::PETScKrylovLinearSolver::resetMatNullSpace ( )

private

◆ deallocateNullSpaceData()

void IBTK::PETScKrylovLinearSolver::deallocateNullSpaceData ( )

private

◆ MatVecMult_SAMRAI()

static PetscErrorCode IBTK::PETScKrylovLinearSolver::MatVecMult_SAMRAI	(	Mat	A,
		Vec	x,
		Vec	y
	)

staticprivate

◆ PCApply_SAMRAI()

static PetscErrorCode IBTK::PETScKrylovLinearSolver::PCApply_SAMRAI	(	PC	pc,
		Vec	x,
		Vec	y
	)

staticprivate

◆ setHierarchyMathOps()

void IBTK::KrylovLinearSolver::setHierarchyMathOps ( SAMRAI::tbox::Pointer< HierarchyMathOps > hier_math_ops )

overridevirtualinherited

Reimplemented from IBTK::GeneralSolver.

◆ setHomogeneousBc()

void IBTK::KrylovLinearSolver::setHomogeneousBc ( bool homogeneous_bc )

overridevirtualinherited

Reimplemented from IBTK::GeneralSolver.

◆ setSolutionTime()

void IBTK::KrylovLinearSolver::setSolutionTime ( double solution_time )

overridevirtualinherited

Reimplemented from IBTK::GeneralSolver.

◆ setTimeInterval()

void IBTK::KrylovLinearSolver::setTimeInterval	(	double	current_time,
		double	new_time
	)

overridevirtualinherited

Reimplemented from IBTK::GeneralSolver.

◆ getOperator()

virtual SAMRAI::tbox::Pointer<LinearOperator> IBTK::KrylovLinearSolver::getOperator ( ) const

virtualinherited

◆ getPreconditioner()

virtual SAMRAI::tbox::Pointer<LinearSolver> IBTK::KrylovLinearSolver::getPreconditioner ( ) const

virtualinherited

◆ getNullSpaceContainsConstantVector()

virtual bool IBTK::LinearSolver::getNullSpaceContainsConstantVector ( ) const

virtualinherited

◆ getNullSpaceBasisVectors()

virtual const std::vector<SAMRAI::tbox::Pointer<SAMRAI::solv::SAMRAIVectorReal<NDIM, double> > >& IBTK::LinearSolver::getNullSpaceBasisVectors ( ) const

virtualinherited

◆ setInitialGuessNonzero()

virtual void IBTK::LinearSolver::setInitialGuessNonzero ( bool initial_guess_nonzero = true )

virtualinherited

Reimplemented in IBAMR::VCStaggeredStokesProjectionPreconditioner, IBAMR::StaggeredStokesProjectionPreconditioner, IBAMR::StaggeredStokesBlockFactorizationPreconditioner, IBTK::PETScPCLSWrapper, IBTK::FACPreconditioner, IBTK::BJacobiPreconditioner, and IBTK::BGaussSeidelPreconditioner.

◆ getInitialGuessNonzero()

virtual bool IBTK::LinearSolver::getInitialGuessNonzero ( ) const

virtualinherited

Reimplemented in IBTK::PETScPCLSWrapper.

◆ printClassData()

virtual void IBTK::LinearSolver::printClassData ( std::ostream & stream )

overridevirtualinherited

Reimplemented from IBTK::GeneralSolver.

◆ getName()

const std::string& IBTK::GeneralSolver::getName ( ) const

inherited

◆ getIsInitialized()

virtual bool IBTK::GeneralSolver::getIsInitialized ( ) const

virtualinherited

◆ getHomogeneousBc()

virtual bool IBTK::GeneralSolver::getHomogeneousBc ( ) const

virtualinherited

◆ getSolutionTime()

virtual double IBTK::GeneralSolver::getSolutionTime ( ) const

virtualinherited

◆ getTimeInterval()

virtual std::pair<double, double> IBTK::GeneralSolver::getTimeInterval ( ) const

virtualinherited

◆ getDt()

virtual double IBTK::GeneralSolver::getDt ( ) const

virtualinherited

◆ getHierarchyMathOps()

virtual SAMRAI::tbox::Pointer<HierarchyMathOps> IBTK::GeneralSolver::getHierarchyMathOps ( ) const

virtualinherited

◆ setMaxIterations()

virtual void IBTK::GeneralSolver::setMaxIterations ( int max_iterations )

virtualinherited

Reimplemented in IBAMR::VCStaggeredStokesProjectionPreconditioner, IBAMR::StaggeredStokesProjectionPreconditioner, IBAMR::StaggeredStokesBlockFactorizationPreconditioner, IBTK::PETScPCLSWrapper, IBTK::FACPreconditioner, IBTK::BJacobiPreconditioner, and IBTK::BGaussSeidelPreconditioner.

◆ getMaxIterations()

virtual int IBTK::GeneralSolver::getMaxIterations ( ) const

virtualinherited

Reimplemented in IBTK::PETScPCLSWrapper.

◆ setAbsoluteTolerance()

virtual void IBTK::GeneralSolver::setAbsoluteTolerance ( double abs_residual_tol )

virtualinherited

Reimplemented in IBTK::PETScPCLSWrapper.

◆ getAbsoluteTolerance()

virtual double IBTK::GeneralSolver::getAbsoluteTolerance ( ) const

virtualinherited

Reimplemented in IBTK::PETScPCLSWrapper.

◆ setRelativeTolerance()

virtual void IBTK::GeneralSolver::setRelativeTolerance ( double rel_residual_tol )

virtualinherited

Reimplemented in IBTK::PETScPCLSWrapper.

◆ getRelativeTolerance()

virtual double IBTK::GeneralSolver::getRelativeTolerance ( ) const

virtualinherited

Reimplemented in IBTK::PETScPCLSWrapper.

◆ getNumIterations()

virtual int IBTK::GeneralSolver::getNumIterations ( ) const

virtualinherited

Reimplemented in IBTK::PETScPCLSWrapper, IBTK::BJacobiPreconditioner, and IBTK::BGaussSeidelPreconditioner.

◆ getResidualNorm()

virtual double IBTK::GeneralSolver::getResidualNorm ( ) const

virtualinherited

Reimplemented in IBTK::PETScPCLSWrapper, IBTK::BJacobiPreconditioner, and IBTK::BGaussSeidelPreconditioner.

◆ setLoggingEnabled()

virtual void IBTK::GeneralSolver::setLoggingEnabled ( bool enable_logging = true )

virtualinherited

◆ getLoggingEnabled()

virtual bool IBTK::GeneralSolver::getLoggingEnabled ( ) const

virtualinherited

◆ init()

void IBTK::GeneralSolver::init	(	const std::string &	object_name,
		bool	homogeneous_bc
	)

protectedinherited

◆ initSpecialized()

virtual void IBTK::GeneralSolver::initSpecialized	(	const std::string &	object_name,
		bool	homogeneous_bc
	)

protectedvirtualinherited

Reimplemented in IBTK::PoissonSolver.

Friends And Related Function Documentation

◆ PETScNewtonKrylovSolver

friend class PETScNewtonKrylovSolver

friend

Member Data Documentation

◆ d_ksp_type

std::string IBTK::PETScKrylovLinearSolver::d_ksp_type

private

◆ d_reinitializing_solver

bool IBTK::PETScKrylovLinearSolver::d_reinitializing_solver = false

private

◆ d_petsc_x

Vec IBTK::PETScKrylovLinearSolver::d_petsc_x = nullptr

private

◆ d_petsc_b

Vec IBTK::PETScKrylovLinearSolver::d_petsc_b = nullptr

private

◆ d_options_prefix

std::string IBTK::PETScKrylovLinearSolver::d_options_prefix

private

◆ d_petsc_comm

MPI_Comm IBTK::PETScKrylovLinearSolver::d_petsc_comm

private

◆ d_petsc_ksp

KSP IBTK::PETScKrylovLinearSolver::d_petsc_ksp = nullptr

private

◆ d_petsc_mat

Mat IBTK::PETScKrylovLinearSolver::d_petsc_mat = nullptr

private

◆ d_petsc_nullsp

MatNullSpace IBTK::PETScKrylovLinearSolver::d_petsc_nullsp = nullptr

private

◆ d_managing_petsc_ksp

bool IBTK::PETScKrylovLinearSolver::d_managing_petsc_ksp = true

private

◆ d_user_provided_mat

bool IBTK::PETScKrylovLinearSolver::d_user_provided_mat = false

private

◆ d_user_provided_pc

bool IBTK::PETScKrylovLinearSolver::d_user_provided_pc = false

private

◆ d_nullspace_constant_vec

SAMRAI::tbox::Pointer<SAMRAI::solv::SAMRAIVectorReal<NDIM, double> > IBTK::PETScKrylovLinearSolver::d_nullspace_constant_vec

private

◆ d_petsc_nullspace_constant_vec

Vec IBTK::PETScKrylovLinearSolver::d_petsc_nullspace_constant_vec = nullptr

private

◆ d_petsc_nullspace_basis_vecs

std::vector<Vec> IBTK::PETScKrylovLinearSolver::d_petsc_nullspace_basis_vecs

private

◆ d_solver_has_attached_nullspace

bool IBTK::PETScKrylovLinearSolver::d_solver_has_attached_nullspace = false

private

◆ d_A

SAMRAI::tbox::Pointer<LinearOperator> IBTK::KrylovLinearSolver::d_A

protectedinherited

◆ d_pc_solver

SAMRAI::tbox::Pointer<LinearSolver> IBTK::KrylovLinearSolver::d_pc_solver

protectedinherited

◆ d_x

SAMRAI::tbox::Pointer<SAMRAI::solv::SAMRAIVectorReal<NDIM, double> > IBTK::KrylovLinearSolver::d_x

protectedinherited

◆ d_b

SAMRAI::tbox::Pointer<SAMRAI::solv::SAMRAIVectorReal<NDIM, double> > IBTK::KrylovLinearSolver::d_b

protectedinherited

◆ d_initial_guess_nonzero

bool IBTK::LinearSolver::d_initial_guess_nonzero = true

protectedinherited

◆ d_nullspace_contains_constant_vec

bool IBTK::LinearSolver::d_nullspace_contains_constant_vec = false

protectedinherited

◆ d_nullspace_basis_vecs

std::vector<SAMRAI::tbox::Pointer<SAMRAI::solv::SAMRAIVectorReal<NDIM, double> > > IBTK::LinearSolver::d_nullspace_basis_vecs

protectedinherited

◆ d_object_name

std::string IBTK::GeneralSolver::d_object_name = "unitialized"

protectedinherited

◆ d_is_initialized

bool IBTK::GeneralSolver::d_is_initialized = false

protectedinherited

◆ d_homogeneous_bc

bool IBTK::GeneralSolver::d_homogeneous_bc = false

protectedinherited

◆ d_solution_time

double IBTK::GeneralSolver::d_solution_time = std::numeric_limits<double>::quiet_NaN()

protectedinherited

◆ d_current_time

double IBTK::GeneralSolver::d_current_time = std::numeric_limits<double>::quiet_NaN()

protectedinherited

◆ d_new_time

double IBTK::GeneralSolver::d_new_time = std::numeric_limits<double>::quiet_NaN()

protectedinherited

◆ d_rel_residual_tol

double IBTK::GeneralSolver::d_rel_residual_tol = 0.0

protectedinherited

◆ d_abs_residual_tol

double IBTK::GeneralSolver::d_abs_residual_tol = 0.0

protectedinherited

◆ d_max_iterations

int IBTK::GeneralSolver::d_max_iterations = 100

protectedinherited

◆ d_current_iterations

int IBTK::GeneralSolver::d_current_iterations = 0

protectedinherited

◆ d_current_residual_norm

double IBTK::GeneralSolver::d_current_residual_norm = std::numeric_limits<double>::quiet_NaN()

protectedinherited

◆ d_hier_math_ops

SAMRAI::tbox::Pointer<HierarchyMathOps> IBTK::GeneralSolver::d_hier_math_ops

protectedinherited

◆ d_hier_math_ops_external

bool IBTK::GeneralSolver::d_hier_math_ops_external = false

protectedinherited

◆ d_enable_logging

bool IBTK::GeneralSolver::d_enable_logging = false

protectedinherited

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

ibtk/include/ibtk/PETScKrylovLinearSolver.h

Public Member Functions

Static Public Member Functions

Friends

Static functions for use by PETSc KSP and MatShell objects.

Krylov solver functionality.

Krylov solver functionality.

Logging functions.

Logging functions.

Detailed Description

Constructor & Destructor Documentation

◆ PETScKrylovLinearSolver() [1/4]

◆ PETScKrylovLinearSolver() [2/4]

◆ ~PETScKrylovLinearSolver()

◆ PETScKrylovLinearSolver() [3/4]

◆ PETScKrylovLinearSolver() [4/4]

Member Function Documentation

◆ allocate_solver()

◆ setKSPType()

◆ setOptionsPrefix()

◆ getPETScKSP()

◆ setOperator()

◆ setPreconditioner()

◆ setNullSpace()

◆ solveSystem()

◆ initializeSolverState()

◆ deallocateSolverState()

◆ operator=()

◆ common_ctor()

◆ resetWrappedKSP()

◆ resetKSPOptions()

◆ resetKSPOperators()

◆ resetKSPPC()

◆ resetMatNullSpace()

◆ deallocateNullSpaceData()

◆ MatVecMult_SAMRAI()

◆ PCApply_SAMRAI()

◆ setHierarchyMathOps()

◆ setHomogeneousBc()

◆ setSolutionTime()

◆ setTimeInterval()

◆ getOperator()

◆ getPreconditioner()

◆ getNullSpaceContainsConstantVector()

◆ getNullSpaceBasisVectors()

◆ setInitialGuessNonzero()

◆ getInitialGuessNonzero()

◆ printClassData()

◆ getName()

◆ getIsInitialized()

◆ getHomogeneousBc()

◆ getSolutionTime()

◆ getTimeInterval()

◆ getDt()

◆ getHierarchyMathOps()

◆ setMaxIterations()

◆ getMaxIterations()

◆ setAbsoluteTolerance()

◆ getAbsoluteTolerance()

◆ setRelativeTolerance()

◆ getRelativeTolerance()

◆ getNumIterations()

◆ getResidualNorm()

◆ setLoggingEnabled()

◆ getLoggingEnabled()

◆ init()

◆ initSpecialized()

Friends And Related Function Documentation

◆ PETScNewtonKrylovSolver

Member Data Documentation

◆ d_ksp_type

◆ d_reinitializing_solver

◆ d_petsc_x

◆ d_petsc_b

◆ d_options_prefix

◆ d_petsc_comm

◆ d_petsc_ksp

◆ d_petsc_mat

◆ d_petsc_nullsp

◆ d_managing_petsc_ksp

◆ d_user_provided_mat