Class BGaussSeidelPreconditioner is a block Gauss-Seidel preconditioner which implements the abstract LinearSolver interface. More...

#include <ibtk/BGaussSeidelPreconditioner.h>

Inheritance diagram for IBTK::BGaussSeidelPreconditioner:

[legend]

Public Member Functions
	BGaussSeidelPreconditioner (std::string object_name, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db, const std::string &default_options_prefix)
	Constructor. More...

	~BGaussSeidelPreconditioner ()
	Destructor. More...

void	setComponentPreconditioner (SAMRAI::tbox::Pointer< LinearSolver > preconditioner, unsigned int component)
	Set the preconditioner to be employed on the specified vector component. More...

void	setComponentOperators (const std::vector< SAMRAI::tbox::Pointer< LinearOperator > > &linear_ops, unsigned int component)
	Set the linear operators to be employed on the specified vector component. More...

void	setSymmetricPreconditioner (bool symmetric_preconditioner)
	Indicate whether to apply the component preconditioners symmetrically. More...

void	setReversedOrder (bool reverse_order)
	Indicate whether to apply the component preconditioners in reversed order (i.e., starting with the last component and ending with the first component). More...

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

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

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

Functions to access data on the most recent solve.
std::map< unsigned int, SAMRAI::tbox::Pointer< LinearSolver > >	d_pc_map

std::map< unsigned int, std::vector< SAMRAI::tbox::Pointer< LinearOperator > > >	d_linear_ops_map

bool	d_symmetric_preconditioner = false

bool	d_reverse_order = false

int	getNumIterations () const override
	Return the iteration count from the most recent linear solve. More...

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

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

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

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

static std::vector< SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double > > >	getComponentVectors (SAMRAI::tbox::ConstPointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double > > x)
	Extract the individual components of a SAMRAI::solv::SAMRAIVectorReal object, and create individual SAMRAI::solv::SAMRAIVectorReal objects to correspond to each of the components. More...

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)

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

Detailed Description

This solver class performs a single block Gauss-Seidel sweep, applying specified component LinearSolver and LinearOperator objects to the components of a supplied SAMRAI::solv::SAMRAIVectorReal vector, and doing so in a multiplicative fashion. Note that the block Gauss-Seidel algorithm is not generally convergent, but can be used as a preconditioner for a KrylovLinearSolver.

Note that the default block Gauss-Seidel algorithm is not a symmetric linear operator, even if the individual component linear operators and solvers are symmetric. Instead, the algorithm applies the component preconditioners to the vector components starting with the first vector component and ending with the last vector component. The algorithm can be symmetrized via the setSymmetricPreconditioner() member function, and the order in which vector components are visited can be reversed via the setReversedOrder() member function.

Note: Class BJacobiPreconditioner implements the additive (i.e., block Jacobi) version of this algorithm.

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

symmetric_preconditioner = FALSE   // see setSymmetricPreconditioner()
reverse_order = FALSE              // see setReversedOrder()
initial_guess_nonzero = FALSE      // see setInitialGuessNonzero()
rel_residual_tol = 1.0e-6          // see setRelativeTolerance()
abs_residual_tol = 1.0e-30         // see setAbsoluteTolerance()
max_iterations = 1                 // see setMaxIterations()

Constructor & Destructor Documentation

◆ BGaussSeidelPreconditioner() [1/3]

IBTK::BGaussSeidelPreconditioner::BGaussSeidelPreconditioner	(	std::string	object_name,
		SAMRAI::tbox::Pointer< SAMRAI::tbox::Database >	input_db,
		const std::string &	default_options_prefix
	)

◆ ~BGaussSeidelPreconditioner()

IBTK::BGaussSeidelPreconditioner::~BGaussSeidelPreconditioner ( )

◆ BGaussSeidelPreconditioner() [2/3]

IBTK::BGaussSeidelPreconditioner::BGaussSeidelPreconditioner ( )

privatedelete

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

◆ BGaussSeidelPreconditioner() [3/3]

IBTK::BGaussSeidelPreconditioner::BGaussSeidelPreconditioner ( const BGaussSeidelPreconditioner & 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

◆ setComponentPreconditioner()

void IBTK::BGaussSeidelPreconditioner::setComponentPreconditioner	(	SAMRAI::tbox::Pointer< LinearSolver >	preconditioner,
		unsigned int	component
	)

◆ setComponentOperators()

void IBTK::BGaussSeidelPreconditioner::setComponentOperators	(	const std::vector< SAMRAI::tbox::Pointer< LinearOperator > > &	linear_ops,
		unsigned int	component
	)

◆ setSymmetricPreconditioner()

void IBTK::BGaussSeidelPreconditioner::setSymmetricPreconditioner ( bool symmetric_preconditioner )

◆ setReversedOrder()

void IBTK::BGaussSeidelPreconditioner::setReversedOrder ( bool reverse_order )

◆ solveSystem()

bool IBTK::BGaussSeidelPreconditioner::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::BGaussSeidelPreconditioner::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.

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::BGaussSeidelPreconditioner::deallocateSolverState ( )

overridevirtual

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

See also: initializeSolverState

Reimplemented from IBTK::GeneralSolver.

◆ setInitialGuessNonzero()

void IBTK::BGaussSeidelPreconditioner::setInitialGuessNonzero ( bool initial_guess_nonzero = true )

overridevirtual

Reimplemented from IBTK::LinearSolver.

◆ setMaxIterations()

void IBTK::BGaussSeidelPreconditioner::setMaxIterations ( int max_iterations )

overridevirtual

Reimplemented from IBTK::GeneralSolver.

◆ getNumIterations()

int IBTK::BGaussSeidelPreconditioner::getNumIterations ( ) const

overridevirtual

Reimplemented from IBTK::GeneralSolver.

◆ getResidualNorm()

double IBTK::BGaussSeidelPreconditioner::getResidualNorm ( ) const

overridevirtual

Reimplemented from IBTK::GeneralSolver.

◆ operator=()

BGaussSeidelPreconditioner& IBTK::BGaussSeidelPreconditioner::operator= ( const BGaussSeidelPreconditioner & 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.

◆ getComponentVectors()

static std::vector<SAMRAI::tbox::Pointer<SAMRAI::solv::SAMRAIVectorReal<NDIM, double> > > IBTK::BGaussSeidelPreconditioner::getComponentVectors ( SAMRAI::tbox::ConstPointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double > > x )

staticprivate

◆ setNullSpace()

virtual void IBTK::LinearSolver::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 > > >()`
	)

virtualinherited

Implementations can require the nullspace basis vectors to be orthogonal but should not assume the basis vectors to be orthonormal. If the basis vectors are not orthonormal, the solver may normalize them in place.

Reimplemented in IBTK::PETScKrylovLinearSolver, and IBTK::PETScLevelSolver.

◆ 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

◆ 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

◆ setHomogeneousBc()

virtual void IBTK::GeneralSolver::setHomogeneousBc ( bool homogeneous_bc )

virtualinherited

Reimplemented in IBTK::FACPreconditioner, IBTK::NewtonKrylovSolver, and IBTK::KrylovLinearSolver.

◆ getHomogeneousBc()

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

virtualinherited

◆ setSolutionTime()

virtual void IBTK::GeneralSolver::setSolutionTime ( double solution_time )

virtualinherited

Reimplemented in IBAMR::CIBStaggeredStokesSolver, IBTK::FACPreconditioner, IBTK::NewtonKrylovSolver, and IBTK::KrylovLinearSolver.

◆ getSolutionTime()

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

virtualinherited

◆ setTimeInterval()

virtual void IBTK::GeneralSolver::setTimeInterval	(	double	current_time,
		double	new_time
	)

virtualinherited

Reimplemented in IBAMR::CIBStaggeredStokesSolver, IBTK::FACPreconditioner, IBTK::NewtonKrylovSolver, and IBTK::KrylovLinearSolver.

◆ getTimeInterval()

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

virtualinherited

◆ getDt()

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

virtualinherited

◆ setHierarchyMathOps()

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

virtualinherited

Reimplemented in IBTK::NewtonKrylovSolver, and IBTK::KrylovLinearSolver.

◆ getHierarchyMathOps()

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

virtualinherited

◆ 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.

◆ 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.

Member Data Documentation

◆ d_pc_map

std::map<unsigned int, SAMRAI::tbox::Pointer<LinearSolver> > IBTK::BGaussSeidelPreconditioner::d_pc_map

private

The component preconditioners.

◆ d_linear_ops_map

std::map<unsigned int, std::vector<SAMRAI::tbox::Pointer<LinearOperator> > > IBTK::BGaussSeidelPreconditioner::d_linear_ops_map

private

The component operators.

◆ d_symmetric_preconditioner

bool IBTK::BGaussSeidelPreconditioner::d_symmetric_preconditioner = false

private

Parameters to specify the ordering of the application of the component preconditioners.

◆ d_reverse_order

bool IBTK::BGaussSeidelPreconditioner::d_reverse_order = false

private

◆ 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/BGaussSeidelPreconditioner.h

Public Member Functions

Functions to access data on the most recent solve.

Logging functions.

Logging functions.

Detailed Description

Constructor & Destructor Documentation

◆ BGaussSeidelPreconditioner() [1/3]

◆ ~BGaussSeidelPreconditioner()

◆ BGaussSeidelPreconditioner() [2/3]

◆ BGaussSeidelPreconditioner() [3/3]

Member Function Documentation

◆ setComponentPreconditioner()

◆ setComponentOperators()

◆ setSymmetricPreconditioner()

◆ setReversedOrder()

◆ solveSystem()

◆ initializeSolverState()

◆ deallocateSolverState()

◆ setInitialGuessNonzero()

◆ setMaxIterations()

◆ getNumIterations()

◆ getResidualNorm()

◆ operator=()

◆ getComponentVectors()

◆ setNullSpace()

◆ getNullSpaceContainsConstantVector()

◆ getNullSpaceBasisVectors()

◆ getInitialGuessNonzero()

◆ printClassData()

◆ getName()

◆ getIsInitialized()

◆ setHomogeneousBc()

◆ getHomogeneousBc()

◆ setSolutionTime()

◆ getSolutionTime()

◆ setTimeInterval()

◆ getTimeInterval()

◆ getDt()

◆ setHierarchyMathOps()

◆ getHierarchyMathOps()

◆ getMaxIterations()

◆ setAbsoluteTolerance()

◆ getAbsoluteTolerance()

◆ setRelativeTolerance()

◆ getRelativeTolerance()

◆ setLoggingEnabled()

◆ getLoggingEnabled()

◆ init()

◆ initSpecialized()

Member Data Documentation

◆ d_pc_map

◆ d_linear_ops_map

◆ d_symmetric_preconditioner

◆ d_reverse_order

◆ d_initial_guess_nonzero

◆ d_nullspace_contains_constant_vec

◆ d_nullspace_basis_vecs

◆ d_object_name

◆ d_is_initialized

◆ d_homogeneous_bc

◆ d_solution_time

◆ d_current_time

◆ d_new_time

◆ d_rel_residual_tol

◆ d_abs_residual_tol

◆ d_max_iterations

◆ d_current_iterations

◆ d_current_residual_norm

◆ d_hier_math_ops

◆ d_hier_math_ops_external

◆ d_enable_logging