Class LinearSolver provides an abstract interface for the implementation of solvers for linear problems of the form 
.
More...
#include </home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/LinearSolver.h>
Inheritance diagram for IBTK::LinearSolver:
Public Member Functions | |
| LinearSolver () | |
| Constructor. | |
| virtual | ~LinearSolver () |
| Empty virtual destructor. | |
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. | |
| 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. | |
Functions to access solver parameters. | |
| 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. | |
 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 void | setHomogeneousBc (bool homogeneous_bc) |
| Set whether the solver should use homogeneous boundary conditions. | |
| virtual bool | getHomogeneousBc () const |
| Return whether the solver is using homogeneous boundary conditions. | |
| virtual void | setSolutionTime (double solution_time) |
| Set the time at which the solution is to be evaluated. | |
| virtual double | getSolutionTime () const |
| Get the time at which the solution is being evaluated. | |
| virtual void | setTimeInterval (double current_time, double new_time) |
| Set the current time interval. | |
| virtual std::pair< double, double > | getTimeInterval () const |
| Get the current time interval. | |
| virtual double | getDt () const |
| Get the current time step size. | |
| virtual void | setHierarchyMathOps (SAMRAI::tbox::Pointer< HierarchyMathOps > hier_math_ops) |
| Set the HierarchyMathOps object used by the solver. | |
| virtual SAMRAI::tbox::Pointer< HierarchyMathOps > | getHierarchyMathOps () const |
| Get the HierarchyMathOps object used by the solver. | |
| virtual bool | solveSystem (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &x, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &b)=0 |
| Solve the system of equations. More... | |
| virtual void | initializeSolverState (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &x, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &b) |
Compute hierarchy dependent data required for solving ![$F[x]=b$](form_202.png) . More... | |
| virtual void | deallocateSolverState () |
| Remove all hierarchy dependent data allocated by initializeSolverState(). More... | |
| 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. | |
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. | |
Additional Inherited Members | |
| Protected Member Functions inherited from IBTK::GeneralSolver | |
| void | init (const std::string &object_name, bool homogeneous_bc) |
| virtual void | initSpecialized (const std::string &object_name, bool homogeneous_bc) |
| 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 |
Detailed Description
Class LinearSolver provides an abstract interface for the implementation of solvers for linear problems of the form .
Member Function Documentation
◆ setNullspace()
|
virtual |
Set the nullspace of the linear system.
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.
The documentation for this class was generated from the following files:
- /home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/LinearSolver.h
- /home/runner/work/IBAMR/IBAMR/ibtk/src/solvers/interfaces/LinearSolver.cpp
