|
| | KrylovLinearSolverStaggeredStokesSolverInterface ()=default |
| |
| | ~KrylovLinearSolverStaggeredStokesSolverInterface ()=default |
| |
| 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...
|
| |
| void | setComponentsHaveNullSpace (const bool has_velocity_nullspace, const bool has_pressure_nullspace) override |
| | Set if velocity and pressure have nullspace. More...
|
| |
| 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 | setPhysicalBoundaryHelper (SAMRAI::tbox::Pointer< StaggeredStokesPhysicalBoundaryHelper > bc_helper) override |
| | Set the StokesSpecifications object and timestep size used to specify the coefficients for the time-dependent incompressible Stokes operator. More...
|
| |
|
| 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...
|
| |
| 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\). 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. 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...
|
| |
|
| 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...
|
| |
This class is intented to be used to create a (trivial) subclass of an existing implementation of KrylovLinearSolver that also supports the StaggeredStokesSolver interface.
- See also
- PETScKrylovStaggeredStokesSolver
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.
In a typical implementation, the solveSystem() method will compute some required hierarchy dependent data before the solve, and then remove 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.
- 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 it is safe to call initializeSolverState() when the solver state is already initialized. In this case, the solver state should be first deallocated and then reinitialized.
-
Subclasses are required to be implemented so that when any operator objects have been registered with the solver via setOperator() or setJacobian(), they are also initialized by initializeSolverState().
- See also
- deallocateSolverState
Reimplemented in IBAMR::VCStaggeredStokesProjectionPreconditioner, IBAMR::StaggeredStokesProjectionPreconditioner, IBAMR::StaggeredStokesBlockPreconditioner, IBAMR::StaggeredStokesBlockFactorizationPreconditioner, IBAMR::CIBStaggeredStokesSolver, IBTK::SCPoissonHypreLevelSolver, IBTK::PETScPCLSWrapper, IBTK::PETScNewtonKrylovSolver, IBTK::PETScLevelSolver, IBTK::PETScKrylovLinearSolver, IBTK::FACPreconditioner, IBTK::CCPoissonHypreLevelSolver, IBTK::BJacobiPreconditioner, and IBTK::BGaussSeidelPreconditioner.