Class KrylovLinearSolver provides an abstract interface for the implementation of Krylov subspace solvers for linear problems of the form $Ax=b$ . More...

#include </home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/KrylovLinearSolver.h>

Inheritance diagram for IBTK::KrylovLinearSolver:

[legend]

Public Member Functions
	KrylovLinearSolver ()=default
	Default constructor.

	~KrylovLinearSolver ()=default
	Empty destructor.

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

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

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

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

Public Member Functions inherited from IBTK::LinearSolver
	LinearSolver ()
	Constructor.

virtual	~LinearSolver ()
	Empty virtual destructor.

virtual void	setNullSpace (bool nullspace_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 > > >())
	Set the nullspace of the linear system.

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

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.

virtual void	setInitialGuessNonzero (bool initial_guess_nonzero=true)
	Set whether the initial guess is non-zero.

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

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

Public Member Functions inherited from IBTK::GeneralSolver
	GeneralSolver ()=default
	Constructor.

virtual	~GeneralSolver ()=default
	Empty virtual destructor.

const std::string &	getName () const
	Return the object name.

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

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

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

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

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

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

virtual bool	solveSystem (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &x, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &b)=0
	Solve the system of equations.

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

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

virtual void	setMaxIterations (int max_iterations)
	Set the maximum number of nonlinear iterations to use per solve.

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

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

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

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

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

virtual int	getNumIterations () const
	Return the iteration count from the most recent solve.

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

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

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

Krylov solver functionality.
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

virtual void	setOperator (SAMRAI::tbox::Pointer< LinearOperator > A)
	Set the linear operator used when solving .

virtual SAMRAI::tbox::Pointer< LinearOperator >	getOperator () const
	Retrieve the linear operator used when solving .

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

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

Additional Inherited Members
Protected Member Functions inherited from IBTK::GeneralSolver
void	init (const std::string &object_name, bool homogeneous_bc)

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

Protected Attributes inherited from IBTK::LinearSolver
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

Protected Attributes inherited from IBTK::GeneralSolver
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

Detailed Description

Class KrylovLinearSolver provides an abstract interface for the implementation of Krylov subspace solvers for linear problems of the form $Ax=b$ .

Member Function Documentation

◆ setHierarchyMathOps()

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

overridevirtual

Set the HierarchyMathOps object used by the solver.

Reimplemented from IBTK::GeneralSolver.

◆ setHomogeneousBc()

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

overridevirtual

Set whether the solver should use homogeneous boundary conditions.

Reimplemented from IBTK::GeneralSolver.

◆ setOperator()

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

virtual

Set the linear operator used when solving $Ax=b$ .

Reimplemented in IBTK::PETScKrylovLinearSolver.

◆ setPreconditioner()

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

virtual

Set the preconditioner used by the Krylov subspace method when solving $Ax=b$ .

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

Reimplemented in IBTK::PETScKrylovLinearSolver.

◆ setSolutionTime()

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

overridevirtual

Set the time at which the solution is to be evaluated.

Reimplemented from IBTK::GeneralSolver.

◆ setTimeInterval()

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

overridevirtual

Set the current time interval.

Reimplemented from IBTK::GeneralSolver.

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

/home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/KrylovLinearSolver.h
/home/runner/work/IBAMR/IBAMR/ibtk/src/solvers/interfaces/KrylovLinearSolver.cpp

Public Member Functions

Krylov solver functionality.

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ setHierarchyMathOps()

◆ setHomogeneousBc()

◆ setOperator()

◆ setPreconditioner()

◆ setSolutionTime()

◆ setTimeInterval()