Class FACPreconditionerStrategy provides an interface for specifying the problem-specific operations needed to implement a specific FAC preconditioner. More...

#include <ibtk/FACPreconditionerStrategy.h>

Inheritance diagram for IBTK::FACPreconditionerStrategy:

[legend]

Public Member Functions
	FACPreconditionerStrategy (std::string object_name)
	Constructor. More...

virtual	~FACPreconditionerStrategy ()=default
	Empty virtual desctructor. More...

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

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

virtual void	setFACPreconditioner (SAMRAI::tbox::ConstPointer< FACPreconditioner > preconditioner)
	Method to allow the FACPreconditioner object to register itself with the concrete FACPreconditionerStrategy. More...

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

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

virtual void	setTimeInterval (double current_time, double new_time)
	Set the current time interval. 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 void	setToZero (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &error, int level_num)=0
	Zero-out the provided vector on the specified level of the patch hierarchy. More...

virtual void	restrictResidual (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &source, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &dest, int dest_level_num)=0
	Restrict the residual from the source vector to the destination vector on the specified level of the patch hierarchy. More...

virtual void	prolongError (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &source, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &dest, int dest_level_num)=0
	Prolong the error from the source vector to the destination vector on the specified level of the patch hierarchy. More...

virtual void	prolongErrorAndCorrect (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &source, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &dest, int dest_level_num)=0
	Prolong the error from the source vector to the destination vector on the specified level of the patch hierarchy and correct the fine-grid error. More...

virtual void	smoothError (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &error, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &residual, int level_num, int num_sweeps, bool performing_pre_sweeps, bool performing_post_sweeps)=0
	Smooth the error by the specified number of sweeps on the specified level of the patch hierarchy. More...

virtual bool	solveCoarsestLevel (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &error, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &residual, int coarsest_level_num)=0
	Solve the system of equations on the coarsest level of the patch hierarchy. More...

virtual void	computeResidual (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &residual, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &solution, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &rhs, int coarsest_level_num, int finest_level_num)=0
	Compute the composite-grid residual on the specified range of levels of the patch hierarchy. More...

virtual void	initializeOperatorState (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &solution, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &rhs)
	Initialize any hierarchy-dependent data. More...

virtual void	deallocateOperatorState ()
	Deallocate any hierarchy-dependent data initialized by initializeOperatorState(). More...

virtual void	allocateScratchData ()
	Allocate scratch data. More...

virtual void	deallocateScratchData ()
	Deallocate scratch data. More...

Static Public Attributes
static constexpr bool	ALWAYS_HOMOGENEOUS_BC = true
	Every concrete FACPreconditionerStrategy implements the FAC correction scheme: it solves the error equation \( A e = r \) for a Krylov (or standalone FACPreconditioner) linear preconditioner application, and the boundary conditions satisfied by an error/ correction are always the homogeneous form of the original problem's boundary conditions. This is a mathematical consequence of what a correction equation is, not a configurable option, so unlike SAMRAI::solv::RobinBcCoefStrategy-facing classes elsewhere in IBTK, FACPreconditionerStrategy does not expose a settable homogeneous-BC toggle; see FACPreconditioner::setHomogeneousBc(), which enforces this invariant on the one place a caller can attempt to configure it. More...

Logging functions.
SAMRAI::tbox::ConstPointer< IBTK::FACPreconditioner >	d_preconditioner

const std::string	d_object_name

bool	d_is_initialized = 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()

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

virtual SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double > >	getLevelSAMRAIVectorReal (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &vec, int level_num) const
	Return a SAMRAIVectorReal object that corresponds to the given object but restricted to a single level of the patch hierarchy. More...

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

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

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

Detailed Description

This class is similar to the SAMRAI class SAMRAI::solv::FACOperatorStrategy, except that certain methods required by the SAMRAI::solv::FACOperatorStrategy interface have been modified (specifically, smoothError()) or removed (specifically, restrictSolution() and postprocessOneCycle()). This interface also requires the implementation of a method, prolongError(), that is optimized for the case in which the FAC preconditioner algorithm is configured not to use pre-smoothing sweeps.

See also: FACPreconditioner

Constructor & Destructor Documentation

◆ FACPreconditionerStrategy() [1/3]

IBTK::FACPreconditionerStrategy::FACPreconditionerStrategy ( std::string object_name )

◆ ~FACPreconditionerStrategy()

virtual IBTK::FACPreconditionerStrategy::~FACPreconditionerStrategy ( )

virtualdefault

◆ FACPreconditionerStrategy() [2/3]

IBTK::FACPreconditionerStrategy::FACPreconditionerStrategy ( )

privatedelete

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

◆ FACPreconditionerStrategy() [3/3]

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

◆ getName()

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

◆ getIsInitialized()

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

virtual

◆ setFACPreconditioner()

virtual void IBTK::FACPreconditionerStrategy::setFACPreconditioner ( SAMRAI::tbox::ConstPointer< FACPreconditioner > preconditioner )

virtual

◆ setSolutionTime()

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

virtual

◆ getSolutionTime()

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

virtual

◆ setTimeInterval()

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

virtual

◆ getTimeInterval()

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

virtual

◆ getDt()

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

virtual

◆ setToZero()

virtual void IBTK::FACPreconditionerStrategy::setToZero	(	SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	error,
		int	level_num
	)

pure virtual

Implemented in IBAMR::StaggeredStokesFACPreconditionerStrategy, and IBTK::PoissonFACPreconditionerStrategy.

◆ restrictResidual()

virtual void IBTK::FACPreconditionerStrategy::restrictResidual	(	const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	source,
		SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	dest,
		int	dest_level_num
	)

pure virtual

Note: Implementations must support the case in which source and dest are the same vector.

Implemented in IBAMR::StaggeredStokesFACPreconditionerStrategy, IBTK::VCSCViscousOpPointRelaxationFACOperator, and IBTK::PoissonFACPreconditionerStrategy.

◆ prolongError()

virtual void IBTK::FACPreconditionerStrategy::prolongError	(	const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	source,
		SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	dest,
		int	dest_level_num
	)

pure virtual

Note: Implementations must support the case in which source and dest are the same vector.

Implemented in IBAMR::StaggeredStokesFACPreconditionerStrategy, and IBTK::PoissonFACPreconditionerStrategy.

◆ prolongErrorAndCorrect()

virtual void IBTK::FACPreconditionerStrategy::prolongErrorAndCorrect	(	const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	source,
		SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	dest,
		int	dest_level_num
	)

pure virtual

Note: Implementations must support the case in which source and dest are the same vector.

Implemented in IBAMR::StaggeredStokesFACPreconditionerStrategy, and IBTK::PoissonFACPreconditionerStrategy.

◆ smoothError()

virtual void IBTK::FACPreconditionerStrategy::smoothError	(	SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	error,
		const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	residual,
		int	level_num,
		int	num_sweeps,
		bool	performing_pre_sweeps,
		bool	performing_post_sweeps
	)

pure virtual

Implemented in IBAMR::StaggeredStokesLevelRelaxationFACOperator, IBAMR::StaggeredStokesIBLevelRelaxationFACOperator, IBAMR::StaggeredStokesBoxRelaxationFACOperator, IBTK::VCSCViscousOpPointRelaxationFACOperator, IBTK::SCPoissonPointRelaxationFACOperator, IBTK::CCPoissonPointRelaxationFACOperator, IBTK::CCPoissonLevelRelaxationFACOperator, and IBTK::CCPoissonBoxRelaxationFACOperator.

◆ solveCoarsestLevel()

virtual bool IBTK::FACPreconditionerStrategy::solveCoarsestLevel	(	SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	error,
		const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	residual,
		int	coarsest_level_num
	)

pure virtual

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

Implemented in IBAMR::StaggeredStokesFACPreconditionerStrategy, IBTK::SCPoissonPointRelaxationFACOperator, IBTK::CCPoissonPointRelaxationFACOperator, IBTK::CCPoissonLevelRelaxationFACOperator, and IBTK::CCPoissonBoxRelaxationFACOperator.

◆ computeResidual()

virtual void IBTK::FACPreconditionerStrategy::computeResidual	(	SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	residual,
		const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	solution,
		const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	rhs,
		int	coarsest_level_num,
		int	finest_level_num
	)

pure virtual

Implemented in IBAMR::StaggeredStokesIBLevelRelaxationFACOperator, IBAMR::StaggeredStokesFACPreconditionerStrategy, IBTK::VCSCViscousOpPointRelaxationFACOperator, IBTK::SCPoissonPointRelaxationFACOperator, IBTK::CCPoissonPointRelaxationFACOperator, IBTK::CCPoissonLevelRelaxationFACOperator, and IBTK::CCPoissonBoxRelaxationFACOperator.

◆ initializeOperatorState()

virtual void IBTK::FACPreconditionerStrategy::initializeOperatorState	(	const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	solution,
		const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	rhs
	)

virtual

Reimplemented in IBAMR::StaggeredStokesFACPreconditionerStrategy, and IBTK::PoissonFACPreconditionerStrategy.

◆ deallocateOperatorState()

virtual void IBTK::FACPreconditionerStrategy::deallocateOperatorState ( )

virtual

Reimplemented in IBAMR::StaggeredStokesFACPreconditionerStrategy, and IBTK::PoissonFACPreconditionerStrategy.

◆ allocateScratchData()

virtual void IBTK::FACPreconditionerStrategy::allocateScratchData ( )

virtual

◆ deallocateScratchData()

virtual void IBTK::FACPreconditionerStrategy::deallocateScratchData ( )

virtual

◆ printClassData()

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

virtual

◆ getLevelSAMRAIVectorReal()

virtual SAMRAI::tbox::Pointer<SAMRAI::solv::SAMRAIVectorReal<NDIM, double> > IBTK::FACPreconditionerStrategy::getLevelSAMRAIVectorReal	(	const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &	vec,
		int	level_num
	)		const

protectedvirtual

◆ operator=()

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

Member Data Documentation

◆ ALWAYS_HOMOGENEOUS_BC

constexpr bool IBTK::FACPreconditionerStrategy::ALWAYS_HOMOGENEOUS_BC = true

staticconstexpr

This constant is named, rather than left as a bare true at each of the many call sites in concrete implementations that configure a ghost-cell-filling or level-solver object's own homogeneous-BC setting, so that a future extension supporting a standalone (as opposed to preconditioner-only) FAC or FAS solver – which would need real, inhomogeneous boundary conditions – has exactly one symbol to find and repurpose.

◆ d_preconditioner

SAMRAI::tbox::ConstPointer<IBTK::FACPreconditioner> IBTK::FACPreconditionerStrategy::d_preconditioner

protected

◆ d_object_name

const std::string IBTK::FACPreconditionerStrategy::d_object_name

protected

◆ d_is_initialized

bool IBTK::FACPreconditionerStrategy::d_is_initialized = false

protected

◆ d_solution_time

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

protected

◆ d_current_time

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

protected

◆ d_new_time

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

protected

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

ibtk/include/ibtk/FACPreconditionerStrategy.h

Public Member Functions

Static Public Attributes

Logging functions.

Detailed Description

Constructor & Destructor Documentation

◆ FACPreconditionerStrategy() [1/3]

◆ ~FACPreconditionerStrategy()

◆ FACPreconditionerStrategy() [2/3]

◆ FACPreconditionerStrategy() [3/3]

Member Function Documentation

◆ getName()

◆ getIsInitialized()

◆ setFACPreconditioner()

◆ setSolutionTime()

◆ getSolutionTime()

◆ setTimeInterval()

◆ getTimeInterval()

◆ getDt()

◆ setToZero()

◆ restrictResidual()

◆ prolongError()

◆ prolongErrorAndCorrect()

◆ smoothError()

◆ solveCoarsestLevel()

◆ computeResidual()

◆ initializeOperatorState()

◆ deallocateOperatorState()

◆ allocateScratchData()

◆ deallocateScratchData()

◆ printClassData()

◆ getLevelSAMRAIVectorReal()

◆ operator=()

Member Data Documentation

◆ ALWAYS_HOMOGENEOUS_BC

◆ d_preconditioner

◆ d_object_name

◆ d_is_initialized

◆ d_solution_time

◆ d_current_time

◆ d_new_time