Class PETScKrylovPoissonSolver is an extension of class PETScKrylovLinearSolver that provides an implementation of the PoissonSolver interface. More...

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

Inheritance diagram for IBTK::PETScKrylovPoissonSolver:

[legend]

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

	~PETScKrylovPoissonSolver ()=default
	Destructor.

Public Member Functions inherited from IBTK::PETScKrylovLinearSolver
	PETScKrylovLinearSolver (std::string object_name, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db, std::string default_options_prefix, MPI_Comm petsc_comm=PETSC_COMM_WORLD)
	Constructor for a concrete KrylovLinearSolver that employs the PETSc KSP solver framework.

	PETScKrylovLinearSolver (std::string object_name, const KSP &petsc_ksp)
	Constructor for a concrete KrylovLinearSolver that acts as a "wrapper" for a supplied PETSc KSP object. More...

	~PETScKrylovLinearSolver ()
	Destructor.

void	setKSPType (const std::string &ksp_type)
	Set the KSP type.

void	setOptionsPrefix (const std::string &options_prefix)
	Set the options prefix used by this PETSc solver object.

const KSP &	getPETScKSP () const
	Get the PETSc KSP object.

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

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

void	setNullspace (bool 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 > > >()) override
	Set the nullspace of the linear system. More...

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

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

Public Member Functions inherited from IBTK::KrylovLinearSolver
	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.

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.

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

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

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

virtual	~LinearSolver ()
	Empty virtual destructor.

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

Public Member Functions inherited from IBTK::KrylovLinearSolverPoissonSolverInterface
	KrylovLinearSolverPoissonSolverInterface ()=default

	~KrylovLinearSolverPoissonSolverInterface ()=default

void	setPoissonSpecifications (const SAMRAI::solv::PoissonSpecifications &poisson_spec) override
	Set the SAMRAI::solv::PoissonSpecifications object used to specify the coefficients for the scalar-valued or vector-valued Laplace operator.

void	setPhysicalBcCoef (SAMRAI::solv::RobinBcCoefStrategy< NDIM > *bc_coef) override
	Set the SAMRAI::solv::RobinBcCoefStrategy object used to specify physical boundary conditions. More...

void	setPhysicalBcCoefs (const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &bc_coefs) override
	Set the SAMRAI::solv::RobinBcCoefStrategy objects used to specify physical boundary conditions. More...

Public Member Functions inherited from IBTK::PoissonSolver
	PoissonSolver ()=default
	Default constructor.

	~PoissonSolver ()=default
	Default destructor.

Additional Inherited Members
Static Public Member Functions inherited from IBTK::PETScKrylovLinearSolver
static SAMRAI::tbox::Pointer< KrylovLinearSolver >	allocate_solver (const std::string &object_name, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db, const std::string &default_options_prefix)
	Static function to construct a PETScKrylovLinearSolver.

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

Protected Member Functions inherited from IBTK::PoissonSolver
void	initSpecialized (const std::string &object_name, bool homogeneous_bc) override

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

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

Protected Attributes inherited from IBTK::PoissonSolver
SAMRAI::solv::PoissonSpecifications	d_poisson_spec = SAMRAI::solv::PoissonSpecifications("")

std::unique_ptr< SAMRAI::solv::RobinBcCoefStrategy< NDIM > >	d_default_bc_coef

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

Detailed Description

Class PETScKrylovPoissonSolver is an extension of class PETScKrylovLinearSolver that provides an implementation of the PoissonSolver interface.

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

/home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/PETScKrylovPoissonSolver.h
/home/runner/work/IBAMR/IBAMR/ibtk/src/solvers/impls/PETScKrylovPoissonSolver.cpp

Public Member Functions

Additional Inherited Members

Detailed Description