Class StaggeredStokesBlockPreconditioner is an abstract base class for Stokes solvers that are implemented using block (subdomain) solvers.

#include <ibamr/StaggeredStokesBlockPreconditioner.h>

Inheritance diagram for IBAMR::StaggeredStokesBlockPreconditioner:

[legend]

Public Member Functions
	StaggeredStokesBlockPreconditioner (bool needs_velocity_solver, bool needs_pressure_solver)
	Constructor. More...

	~StaggeredStokesBlockPreconditioner ()=default
	Destructor. More...

virtual bool	needsVelocitySubdomainSolver () const
	Indicate whether the preconditioner needs a velocity subdomain solver. More...

virtual void	setVelocitySubdomainSolver (SAMRAI::tbox::Pointer< IBTK::PoissonSolver > velocity_solver)
	Provide a velocity subdomain solver. More...

void	setVelocityPoissonSpecifications (const SAMRAI::solv::PoissonSpecifications &U_problem_coefs) override
	Set the PoissonSpecifications object used to specify the coefficients for the momentum equation in the incompressible Stokes operator. More...

virtual bool	needsPressureSubdomainSolver () const
	Indicate whether the preconditioner needs a pressure subdomain solver. More...

virtual void	setPressureSubdomainSolver (SAMRAI::tbox::Pointer< IBTK::PoissonSolver > pressure_solver)
	Provide a pressure subdomain solver. More...

virtual void	setPressurePoissonSpecifications (const SAMRAI::solv::PoissonSpecifications &P_problem_coefs)
	Set the PoissonSpecifications object used to specify the coefficients for the pressure-Poisson problem. More...

virtual void	setPhysicalBcCoefs (const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &U_bc_coefs, SAMRAI::solv::RobinBcCoefStrategy< NDIM > *P_bc_coef) override
	Set the SAMRAI::solv::RobinBcCoefStrategy objects used to specify physical boundary conditions. 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...

virtual void	setComponentsHaveNullSpace (const bool has_velocity_nullspace, const bool has_pressure_nullspace)
	Set if velocity and pressure have nullspace. More...

virtual void	setPhysicalBoundaryHelper (SAMRAI::tbox::Pointer< StaggeredStokesPhysicalBoundaryHelper > bc_helper)
	Set the StokesSpecifications object and timestep size used to specify the coefficients for the time-dependent incompressible Stokes operator. More...

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

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 void	setHomogeneousBc (bool homogeneous_bc)
	Set whether the solver should use homogeneous boundary conditions. More...

virtual bool	getHomogeneousBc () const
	Return whether the solver is using homogeneous boundary conditions. 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	setHierarchyMathOps (SAMRAI::tbox::Pointer< HierarchyMathOps > hier_math_ops)
	Set the HierarchyMathOps object used by the solver. More...

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

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

Protected Member Functions
void	correctNullSpace (SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double >> U_vec, SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double >> P_vec)
	Remove components in operator null space. More...

Protected Attributes
const bool	d_needs_velocity_solver

SAMRAI::tbox::Pointer< IBTK::PoissonSolver >	d_velocity_solver

SAMRAI::solv::PoissonSpecifications	d_P_problem_coefs

const bool	d_needs_pressure_solver

SAMRAI::tbox::Pointer< IBTK::PoissonSolver >	d_pressure_solver

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

int	d_coarsest_ln = IBTK::invalid_level_number

int	d_finest_ln = IBTK::invalid_level_number

SAMRAI::tbox::Pointer< SAMRAI::math::HierarchyDataOpsReal< NDIM, double > >	d_velocity_data_ops

SAMRAI::tbox::Pointer< SAMRAI::math::HierarchyDataOpsReal< NDIM, double > >	d_pressure_data_ops

int	d_velocity_wgt_idx = IBTK::invalid_index

int	d_pressure_wgt_idx = IBTK::invalid_index

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

SAMRAI::solv::PoissonSpecifications	d_U_problem_coefs

SAMRAI::solv::LocationIndexRobinBcCoefs< NDIM >	d_default_U_bc_coef

std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * >	d_U_bc_coefs

SAMRAI::solv::LocationIndexRobinBcCoefs< NDIM >	d_default_P_bc_coef

SAMRAI::solv::RobinBcCoefStrategy< NDIM > *	d_P_bc_coef

SAMRAI::tbox::Pointer< StaggeredStokesPhysicalBoundaryHelper >	d_bc_helper

bool	d_has_velocity_nullspace = false

bool	d_has_pressure_nullspace = false

Private Member Functions
	StaggeredStokesBlockPreconditioner ()=delete
	Default constructor. More...

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

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

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

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()

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)

Constructor & Destructor Documentation

◆ StaggeredStokesBlockPreconditioner() [1/3]

IBAMR::StaggeredStokesBlockPreconditioner::StaggeredStokesBlockPreconditioner	(	bool	needs_velocity_solver,
		bool	needs_pressure_solver
	)

◆ ~StaggeredStokesBlockPreconditioner()

IBAMR::StaggeredStokesBlockPreconditioner::~StaggeredStokesBlockPreconditioner ( )

default

◆ StaggeredStokesBlockPreconditioner() [2/3]

IBAMR::StaggeredStokesBlockPreconditioner::StaggeredStokesBlockPreconditioner ( )

privatedelete

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

◆ StaggeredStokesBlockPreconditioner() [3/3]

IBAMR::StaggeredStokesBlockPreconditioner::StaggeredStokesBlockPreconditioner ( const StaggeredStokesBlockPreconditioner & 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

◆ needsVelocitySubdomainSolver()

virtual bool IBAMR::StaggeredStokesBlockPreconditioner::needsVelocitySubdomainSolver ( ) const

virtual

◆ setVelocitySubdomainSolver()

virtual void IBAMR::StaggeredStokesBlockPreconditioner::setVelocitySubdomainSolver ( SAMRAI::tbox::Pointer< IBTK::PoissonSolver > velocity_solver )

virtual

◆ setVelocityPoissonSpecifications()

void IBAMR::StaggeredStokesBlockPreconditioner::setVelocityPoissonSpecifications ( const SAMRAI::solv::PoissonSpecifications & U_problem_coefs )

overridevirtual

Reimplemented from IBAMR::StaggeredStokesSolver.

◆ needsPressureSubdomainSolver()

virtual bool IBAMR::StaggeredStokesBlockPreconditioner::needsPressureSubdomainSolver ( ) const

virtual

◆ setPressureSubdomainSolver()

virtual void IBAMR::StaggeredStokesBlockPreconditioner::setPressureSubdomainSolver ( SAMRAI::tbox::Pointer< IBTK::PoissonSolver > pressure_solver )

virtual

◆ setPressurePoissonSpecifications()

virtual void IBAMR::StaggeredStokesBlockPreconditioner::setPressurePoissonSpecifications ( const SAMRAI::solv::PoissonSpecifications & P_problem_coefs )

virtual

◆ setPhysicalBcCoefs()

virtual void IBAMR::StaggeredStokesBlockPreconditioner::setPhysicalBcCoefs	(	const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &	U_bc_coefs,
		SAMRAI::solv::RobinBcCoefStrategy< NDIM > *	P_bc_coef
	)

overridevirtual

Note: Any of the elements of U_bc_coefs may be nullptr. In this case, homogeneous Dirichlet boundary conditions are employed for that data depth. P_bc_coef may also be nullptr; in that case, homogeneous Neumann boundary conditions are employed for the pressure.

Parameters

U_bc_coefs	vector of pointers to objects that can set the Robin boundary condition coefficients for the velocity
P_bc_coef	Pointer to object that can set the Robin boundary condition coefficients for the pressure

Reimplemented from IBAMR::StaggeredStokesSolver.

◆ initializeSolverState()

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

overridevirtual

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: It is safe to call initializeSolverState() when the solver state is already initialized.

See also: deallocateSolverState

Note: A default implementation is provided which does nothing.

Reimplemented from IBTK::GeneralSolver.

Reimplemented in IBAMR::VCStaggeredStokesProjectionPreconditioner, and IBAMR::StaggeredStokesProjectionPreconditioner.

◆ deallocateSolverState()

void IBAMR::StaggeredStokesBlockPreconditioner::deallocateSolverState ( )

overridevirtual

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

See also: initializeSolverState

Note: A default implementation is provided which does nothing.

Reimplemented from IBTK::GeneralSolver.

Reimplemented in IBAMR::VCStaggeredStokesProjectionPreconditioner, and IBAMR::StaggeredStokesProjectionPreconditioner.

◆ correctNullSpace()

void IBAMR::StaggeredStokesBlockPreconditioner::correctNullSpace	(	SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double >>	U_vec,
		SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double >>	P_vec
	)

protected

◆ operator=()

StaggeredStokesBlockPreconditioner& IBAMR::StaggeredStokesBlockPreconditioner::operator= ( const StaggeredStokesBlockPreconditioner & 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.

◆ 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::PETScLevelSolver, and IBTK::PETScKrylovLinearSolver.

◆ 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

◆ setHomogeneousBc()

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

virtualinherited

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

◆ getHomogeneousBc()

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

virtualinherited

◆ setSolutionTime()

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

virtualinherited

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

◆ 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::NewtonKrylovSolver, IBTK::KrylovLinearSolver, and IBTK::FACPreconditioner.

◆ 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

◆ solveSystem()

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

pure virtualinherited

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: Subclasses must be implemented so that the vector arguments for solveSystem() need not match those for initializeSolverState(). However, they are allowed to require 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: Subclasses are required to be implemented so that the solver does not need to 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

Implemented in IBAMR::VCStaggeredStokesProjectionPreconditioner, IBAMR::StaggeredStokesProjectionPreconditioner, IBAMR::StaggeredStokesBlockFactorizationPreconditioner, IBAMR::CIBStaggeredStokesSolver, IBTK::SCPoissonHypreLevelSolver, IBTK::PETScPCLSWrapper, IBTK::PETScNewtonKrylovSolver, IBTK::PETScLevelSolver, IBTK::PETScKrylovLinearSolver, IBTK::FACPreconditioner, IBTK::CCPoissonHypreLevelSolver, IBTK::BJacobiPreconditioner, IBTK::BGaussSeidelPreconditioner, and IBAMR::IBImplicitStaggeredHierarchyIntegrator::IBImplicitStaggeredStokesSolver.

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

◆ setComponentsHaveNullSpace()

virtual void IBAMR::StaggeredStokesSolver::setComponentsHaveNullSpace	(	const bool	has_velocity_nullspace,
		const bool	has_pressure_nullspace
	)

virtualinherited

Reimplemented in IBAMR::StaggeredStokesFACPreconditioner, IBAMR::KrylovLinearSolverStaggeredStokesSolverInterface, and IBAMR::IBImplicitStaggeredHierarchyIntegrator::IBImplicitStaggeredStokesSolver.

◆ setPhysicalBoundaryHelper()

virtual void IBAMR::StaggeredStokesSolver::setPhysicalBoundaryHelper ( SAMRAI::tbox::Pointer< StaggeredStokesPhysicalBoundaryHelper > bc_helper )

virtualinherited

Reimplemented in IBAMR::StaggeredStokesFACPreconditioner, IBAMR::KrylovLinearSolverStaggeredStokesSolverInterface, IBAMR::IBImplicitStaggeredHierarchyIntegrator::IBImplicitStaggeredStokesSolver, and IBAMR::CIBStaggeredStokesSolver.

Member Data Documentation

◆ d_needs_velocity_solver

const bool IBAMR::StaggeredStokesBlockPreconditioner::d_needs_velocity_solver

protected

◆ d_velocity_solver

SAMRAI::tbox::Pointer<IBTK::PoissonSolver> IBAMR::StaggeredStokesBlockPreconditioner::d_velocity_solver

protected

◆ d_P_problem_coefs

SAMRAI::solv::PoissonSpecifications IBAMR::StaggeredStokesBlockPreconditioner::d_P_problem_coefs

protected

◆ d_needs_pressure_solver

const bool IBAMR::StaggeredStokesBlockPreconditioner::d_needs_pressure_solver

protected

◆ d_pressure_solver

SAMRAI::tbox::Pointer<IBTK::PoissonSolver> IBAMR::StaggeredStokesBlockPreconditioner::d_pressure_solver

protected

◆ d_hierarchy

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

protected

◆ d_coarsest_ln

int IBAMR::StaggeredStokesBlockPreconditioner::d_coarsest_ln = IBTK::invalid_level_number

protected

◆ d_finest_ln

int IBAMR::StaggeredStokesBlockPreconditioner::d_finest_ln = IBTK::invalid_level_number

protected

◆ d_velocity_data_ops

SAMRAI::tbox::Pointer<SAMRAI::math::HierarchyDataOpsReal<NDIM, double> > IBAMR::StaggeredStokesBlockPreconditioner::d_velocity_data_ops

protected

◆ d_pressure_data_ops

SAMRAI::tbox::Pointer<SAMRAI::math::HierarchyDataOpsReal<NDIM, double> > IBAMR::StaggeredStokesBlockPreconditioner::d_pressure_data_ops

protected

◆ d_velocity_wgt_idx

int IBAMR::StaggeredStokesBlockPreconditioner::d_velocity_wgt_idx = IBTK::invalid_index

protected

◆ d_pressure_wgt_idx

int IBAMR::StaggeredStokesBlockPreconditioner::d_pressure_wgt_idx = IBTK::invalid_index

protected

◆ d_hier_math_ops

SAMRAI::tbox::Pointer<IBTK::HierarchyMathOps> IBAMR::StaggeredStokesBlockPreconditioner::d_hier_math_ops

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_external

bool IBTK::GeneralSolver::d_hier_math_ops_external = false

protectedinherited

◆ d_enable_logging

bool IBTK::GeneralSolver::d_enable_logging = false

protectedinherited

◆ d_U_problem_coefs

SAMRAI::solv::PoissonSpecifications IBAMR::StaggeredStokesSolver::d_U_problem_coefs

protectedinherited

◆ d_default_U_bc_coef

SAMRAI::solv::LocationIndexRobinBcCoefs<NDIM> IBAMR::StaggeredStokesSolver::d_default_U_bc_coef

protectedinherited

◆ d_U_bc_coefs

std::vector<SAMRAI::solv::RobinBcCoefStrategy<NDIM>*> IBAMR::StaggeredStokesSolver::d_U_bc_coefs

protectedinherited

◆ d_default_P_bc_coef

SAMRAI::solv::LocationIndexRobinBcCoefs<NDIM> IBAMR::StaggeredStokesSolver::d_default_P_bc_coef

protectedinherited

◆ d_P_bc_coef

SAMRAI::solv::RobinBcCoefStrategy<NDIM>* IBAMR::StaggeredStokesSolver::d_P_bc_coef

protectedinherited

◆ d_bc_helper

SAMRAI::tbox::Pointer<StaggeredStokesPhysicalBoundaryHelper> IBAMR::StaggeredStokesSolver::d_bc_helper

protectedinherited

◆ d_has_velocity_nullspace

bool IBAMR::StaggeredStokesSolver::d_has_velocity_nullspace = false

protectedinherited

◆ d_has_pressure_nullspace

bool IBAMR::StaggeredStokesSolver::d_has_pressure_nullspace = false

protectedinherited

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

include/ibamr/StaggeredStokesBlockPreconditioner.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Logging functions.

Logging functions.

Constructor & Destructor Documentation

◆ StaggeredStokesBlockPreconditioner() [1/3]

◆ ~StaggeredStokesBlockPreconditioner()

◆ StaggeredStokesBlockPreconditioner() [2/3]

◆ StaggeredStokesBlockPreconditioner() [3/3]

Member Function Documentation

◆ needsVelocitySubdomainSolver()

◆ setVelocitySubdomainSolver()

◆ setVelocityPoissonSpecifications()

◆ needsPressureSubdomainSolver()

◆ setPressureSubdomainSolver()

◆ setPressurePoissonSpecifications()

◆ setPhysicalBcCoefs()

◆ initializeSolverState()

◆ deallocateSolverState()

◆ correctNullSpace()

◆ operator=()

◆ setNullSpace()

◆ getNullSpaceContainsConstantVector()

◆ getNullSpaceBasisVectors()

◆ setInitialGuessNonzero()

◆ getInitialGuessNonzero()

◆ printClassData()

◆ getName()

◆ getIsInitialized()

◆ setHomogeneousBc()

◆ getHomogeneousBc()

◆ setSolutionTime()

◆ getSolutionTime()

◆ setTimeInterval()

◆ getTimeInterval()

◆ getDt()

◆ setHierarchyMathOps()

◆ getHierarchyMathOps()

◆ solveSystem()

◆ setMaxIterations()

◆ getMaxIterations()

◆ setAbsoluteTolerance()

◆ getAbsoluteTolerance()

◆ setRelativeTolerance()

◆ getRelativeTolerance()

◆ getNumIterations()

◆ getResidualNorm()

◆ setLoggingEnabled()

◆ getLoggingEnabled()

◆ init()

◆ initSpecialized()

◆ setComponentsHaveNullSpace()

◆ setPhysicalBoundaryHelper()

Member Data Documentation

◆ d_needs_velocity_solver

◆ d_velocity_solver

◆ d_P_problem_coefs

◆ d_needs_pressure_solver

◆ d_pressure_solver

◆ d_hierarchy

◆ d_coarsest_ln

◆ d_finest_ln

◆ d_velocity_data_ops

◆ d_pressure_data_ops

◆ d_velocity_wgt_idx

◆ d_pressure_wgt_idx

◆ d_hier_math_ops

◆ 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