Class FACPreconditioner is a concrete LinearSolver for implementing FAC (multilevel multigrid) preconditioners. More...

#include <ibtk/FACPreconditioner.h>

Inheritance diagram for IBTK::FACPreconditioner:

[legend]

Public Member Functions
	FACPreconditioner (std::string object_name, SAMRAI::tbox::Pointer< FACPreconditionerStrategy > fac_strategy, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db, const std::string &default_options_prefix)

	~FACPreconditioner ()

Functions to access solver parameters.
SAMRAI::tbox::Pointer< FACPreconditionerStrategy >	d_fac_strategy

SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >	d_hierarchy

int	d_coarsest_ln = 0

int	d_finest_ln = 0

MGCycleType	d_cycle_type = V_CYCLE

int	d_num_pre_sweeps = 0

int	d_num_post_sweeps = 2

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

void	setMGCycleType (MGCycleType cycle_type)
	Set the multigrid algorithm cycle type. More...

MGCycleType	getMGCycleType () const
	Get the multigrid algorithm cycle type. More...

void	setNumPreSmoothingSweeps (int num_pre_sweeps)
	Set the number of pre-smoothing sweeps to employ. More...

int	getNumPreSmoothingSweeps () const
	Get the number of pre-smoothing sweeps employed by the preconditioner. More...

void	setNumPostSmoothingSweeps (int num_post_sweeps)
	Set the number of post-smoothing sweeps to employ. More...

int	getNumPostSmoothingSweeps () const
	Get the number of post-smoothing sweeps employed by the preconditioner. More...

SAMRAI::tbox::Pointer< FACPreconditionerStrategy >	getFACPreconditionerStrategy () const
	Get the FAC preconditioner strategy objects employed by the preconditioner. More...

void	FACVCycleNoPreSmoothing (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &u, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &f, int level_num)

void	muCycle (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &u, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &f, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &r, int level_num, int mu)

void	FCycle (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &u, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &f, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &r, int level_num)

void	FMGCycle (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &u, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &f, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &r, int level_num, int mu)

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

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

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

void	getFromInput (SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > db)

Logging functions.
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

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

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

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

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

Logging functions.
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

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

Detailed Description

This class is similar to the SAMRAI class SAMRAI::solv::FACPreconditioner, except that this class has been optimized for the case in which the solver is to be used as a single-pass preconditioner, especially for the case in which pre-smoothing sweeps are not needed. This class is not suitable for use as a stand-alone solver; rather, it is intended to be used in conjunction with an iterative Krylov method.

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

cycle_type = "V_CYCLE"  // see setMGCycleType()
num_pre_sweeps = 0      // see setNumPreSmoothingSweeps()
num_post_sweeps = 2     // see setNumPostSmoothingSweeps()
enable_logging = FALSE  // see setLoggingEnabled()

Constructor & Destructor Documentation

◆ FACPreconditioner() [1/3]

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

Constructor.

◆ ~FACPreconditioner()

IBTK::FACPreconditioner::~FACPreconditioner ( )

Destructor.

◆ FACPreconditioner() [2/3]

IBTK::FACPreconditioner::FACPreconditioner ( )

privatedelete

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

◆ FACPreconditioner() [3/3]

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

◆ setHomogeneousBc()

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

overridevirtual

Reimplemented from IBTK::GeneralSolver.

◆ setSolutionTime()

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

overridevirtual

Reimplemented from IBTK::GeneralSolver.

◆ setTimeInterval()

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

overridevirtual

Reimplemented from IBTK::GeneralSolver.

◆ solveSystem()

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

◆ setInitialGuessNonzero()

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

overridevirtual

Reimplemented from IBTK::LinearSolver.

◆ setMaxIterations()

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

overridevirtual

Reimplemented from IBTK::GeneralSolver.

◆ setMGCycleType()

void IBTK::FACPreconditioner::setMGCycleType ( MGCycleType cycle_type )

◆ getMGCycleType()

MGCycleType IBTK::FACPreconditioner::getMGCycleType ( ) const

◆ setNumPreSmoothingSweeps()

void IBTK::FACPreconditioner::setNumPreSmoothingSweeps ( int num_pre_sweeps )

◆ getNumPreSmoothingSweeps()

int IBTK::FACPreconditioner::getNumPreSmoothingSweeps ( ) const

◆ setNumPostSmoothingSweeps()

void IBTK::FACPreconditioner::setNumPostSmoothingSweeps ( int num_post_sweeps )

◆ getNumPostSmoothingSweeps()

int IBTK::FACPreconditioner::getNumPostSmoothingSweeps ( ) const

◆ getFACPreconditionerStrategy()

SAMRAI::tbox::Pointer<FACPreconditionerStrategy> IBTK::FACPreconditioner::getFACPreconditionerStrategy ( ) const

◆ FACVCycleNoPreSmoothing()

void IBTK::FACPreconditioner::FACVCycleNoPreSmoothing	(	SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	u,
		SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	f,
		int	level_num
	)

protected

◆ muCycle()

void IBTK::FACPreconditioner::muCycle	(	SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	u,
		SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	f,
		SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	r,
		int	level_num,
		int	mu
	)

protected

◆ FCycle()

void IBTK::FACPreconditioner::FCycle	(	SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	u,
		SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	f,
		SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	r,
		int	level_num
	)

protected

◆ FMGCycle()

void IBTK::FACPreconditioner::FMGCycle	(	SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	u,
		SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	f,
		SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	r,
		int	level_num,
		int	mu
	)

protected

◆ operator=()

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

◆ getFromInput()

void IBTK::FACPreconditioner::getFromInput ( SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > db )

private

◆ 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

◆ 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

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

◆ getNumIterations()

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

virtualinherited

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

◆ getResidualNorm()

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

virtualinherited

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

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

SAMRAI::tbox::Pointer<FACPreconditionerStrategy> IBTK::FACPreconditioner::d_fac_strategy

protected

◆ d_hierarchy

SAMRAI::tbox::Pointer<SAMRAI::hier::PatchHierarchy<NDIM> > IBTK::FACPreconditioner::d_hierarchy

protected

◆ d_coarsest_ln

int IBTK::FACPreconditioner::d_coarsest_ln = 0

protected

◆ d_finest_ln

int IBTK::FACPreconditioner::d_finest_ln = 0

protected

◆ d_cycle_type

MGCycleType IBTK::FACPreconditioner::d_cycle_type = V_CYCLE

protected

◆ d_num_pre_sweeps

int IBTK::FACPreconditioner::d_num_pre_sweeps = 0

protected

◆ d_num_post_sweeps

int IBTK::FACPreconditioner::d_num_post_sweeps = 2

protected

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

Public Member Functions

Functions to access solver parameters.

Logging functions.

Logging functions.

Detailed Description

Constructor & Destructor Documentation

◆ FACPreconditioner() [1/3]

◆ ~FACPreconditioner()

◆ FACPreconditioner() [2/3]

◆ FACPreconditioner() [3/3]

Member Function Documentation

◆ setHomogeneousBc()

◆ setSolutionTime()

◆ setTimeInterval()

◆ solveSystem()

◆ initializeSolverState()

◆ deallocateSolverState()

◆ setInitialGuessNonzero()

◆ setMaxIterations()

◆ setMGCycleType()

◆ getMGCycleType()

◆ setNumPreSmoothingSweeps()

◆ getNumPreSmoothingSweeps()

◆ setNumPostSmoothingSweeps()

◆ getNumPostSmoothingSweeps()

◆ getFACPreconditionerStrategy()

◆ FACVCycleNoPreSmoothing()

◆ muCycle()

◆ FCycle()

◆ FMGCycle()

◆ operator=()

◆ getFromInput()

◆ setNullSpace()

◆ getNullSpaceContainsConstantVector()

◆ getNullSpaceBasisVectors()

◆ getInitialGuessNonzero()

◆ printClassData()

◆ getName()

◆ getIsInitialized()

◆ getHomogeneousBc()

◆ getSolutionTime()

◆ getTimeInterval()

◆ getDt()

◆ setHierarchyMathOps()

◆ getHierarchyMathOps()

◆ getMaxIterations()

◆ setAbsoluteTolerance()

◆ getAbsoluteTolerance()

◆ setRelativeTolerance()

◆ getRelativeTolerance()

◆ getNumIterations()

◆ getResidualNorm()

◆ setLoggingEnabled()

◆ getLoggingEnabled()

◆ init()

◆ initSpecialized()

Member Data Documentation

◆ d_fac_strategy

◆ d_hierarchy

◆ d_coarsest_ln

◆ d_finest_ln

◆ d_cycle_type

◆ d_num_pre_sweeps

◆ d_num_post_sweeps

◆ 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