Class CIBSaddlePointSolver solves for the fluid velocity \( \vec{v} \), fluid pressure \( p \), and the Lagrange multiplier \( \vec{\lambda} \) maintaining the rigidity constraint. More...
#include <ibamr/CIBSaddlePointSolver.h>
Inheritance diagram for IBAMR::CIBSaddlePointSolver:
Public Member Functions | |
| CIBSaddlePointSolver (std::string object_name, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db, SAMRAI::tbox::Pointer< IBAMR::INSStaggeredHierarchyIntegrator > navier_stokes_integrator, SAMRAI::tbox::Pointer< IBAMR::CIBStrategy > cib_strategy, std::string default_options_prefix, MPI_Comm petsc_comm=PETSC_COMM_WORLD) | |
| Constructor for a saddle-point solver that employs the PETSc KSP solver framework. More... | |
| virtual | ~CIBSaddlePointSolver () |
| Destructor. More... | |
| void | setKSPType (const std::string &ksp_type) |
| Set the KSP type. More... | |
| void | setOptionsPrefix (const std::string &options_prefix) |
| Set the options prefix used by this PETSc solver object. More... | |
| void | setVelocityPoissonSpecifications (const SAMRAI::solv::PoissonSpecifications &u_problem_coefs) |
| Set the PoissonSpecifications object used to specify the coefficients for the momentum equation in the incompressible Stokes operator. More... | |
| void | setPhysicalBcCoefs (const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &u_bc_coefs, SAMRAI::solv::RobinBcCoefStrategy< NDIM > *p_bc_coef) |
| Set the SAMRAI::solv::RobinBcCoefStrategy objects used to specify physical boundary conditions. More... | |
| void | setPhysicalBoundaryHelper (SAMRAI::tbox::Pointer< IBAMR::StaggeredStokesPhysicalBoundaryHelper > bc_helper) |
| Set the StokesSpecifications object and timestep size used to specify the coefficients for the time-dependent incompressible Stokes operator. More... | |
| SAMRAI::tbox::Pointer< IBTK::LinearOperator > | getA () const |
| Return the linear operator for the saddle-point solver. More... | |
| SAMRAI::tbox::Pointer< IBAMR::StaggeredStokesSolver > | getStokesSolver () const |
| Return the Stokes solver used in the preconditioner of the solver. More... | |
| double | getInterpScale () const |
| Return the interpolation scale factor. More... | |
| double | getSpreadScale () const |
| Return the spreading scale factor. More... | |
| double | getRegularizationWeight () const |
| Return the regularization scale factor. More... | |
| bool | getNormalizeSpreadForce () const |
| Return if the spread force is to be normalized. More... | |
| bool | solveSystem (Vec x, Vec b) |
| Solve the linear system of equations \(Ax=b\) for \(x\). More... | |
| void | initializeSolverState (Vec x, Vec b) |
| Compute hierarchy dependent data required for solving \(Ax=b\). More... | |
| void | deallocateSolverState () |
| Remove all hierarchy dependent data allocated by initializeSolverState(). More... | |
| void | setSolutionTime (double solution_time) |
| Set the time at which the solution is to be evaluated. More... | |
| void | setTimeInterval (double current_time, double new_time) |
| Set the current time interval. More... | |
| SAMRAI::tbox::Pointer< IBAMR::CIBMobilitySolver > | getCIBMobilitySolver () const |
| Get the mobility solver. More... | |
Private Member Functions | |
| CIBSaddlePointSolver (const CIBSaddlePointSolver &from)=delete | |
| Copy constructor. More... | |
| CIBSaddlePointSolver & | operator= (const CIBSaddlePointSolver &that)=delete |
| Assignment operator. More... | |
| void | getFromInput (SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > db) |
| Get options from input file. More... | |
| void | destroyKSP () |
| Routine to destroy KSP object. More... | |
| void | initializeStokesSolver (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &sol_vec, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &rhs_vec) |
| Initialize the Stokes solver needed in the preconditioning step. More... | |
| void | initializeKSP () |
| Routine to setup KSP object. More... | |
| void | resetKSPOptions () |
| Reset the values of the convergence tolerances for the PETSc KSP object. More... | |
| void | resetKSPOperators () |
| Reset the KSP operators to correspond to the supplied LinearOperator. More... | |
| void | resetKSPPC () |
| Reset the KSP PC to correspond to the supplied preconditioner. More... | |
Detailed Description
For free-moving (self-moving bodies) it also solves for the rigid body translational and rotational velocities \( \vec{U} \).
- For free-moving case, the class solves a saddle-point problem of the type:
\begin{eqnarray*} A \vec{v} + \nabla p - \gamma S \vec{\lambda} &=& \vec{g} \\ -\nabla \cdot \vec{v} &=& (h = 0) \\ -\beta J \vec{v} + \beta T^{*} \vec{U} -\beta \delta \vec{\lambda} &=& (\vec{w} = -\beta \vec{U}_{\mbox{\scriptsize def}}) \\ T \vec{\lambda} &=& \vec{F} \end{eqnarray*}
- For imposed kinematics case, the class solves:
\begin{eqnarray*} A \vec{v} + \nabla p - \gamma S \vec{\lambda} &=& \vec{g} \\ -\nabla \cdot \vec{v} &=& (h = 0) \\ -\beta J \vec{v} - \beta \delta \vec{\lambda} &=& (w = -\beta (T^{*}\vec{U}+ \vec{U}_{\mbox{\scriptsize def}}) = -\beta \vec{U}_{\mbox{\scriptsize imposed}}) \end{eqnarray*}
Here, \( A \) is the Helmholtz operator, \( S \) is the spreading operator, \( G \) is the gradient operator, \( J \) is the interpolation operator, and \( T \) is the rigid body operator (with \( T^{*} \) denoting its adjoint), \( \vec{F} \) is the net external force/torque on the body (excluding the hydrodynamic force/torque), \( \vec{U}_{\mbox{\scriptsize def}} \) is the deformational velocity of the body, and \( \vec{U}_{\mbox{\scriptsize imposed}} \) is the velocity imposed on the body. \( \gamma \) and \( \beta \) are two scaling parameters to make the system well-scaled. \( \delta \) is the regularization parameter that regularizes the problem in presence of many IB/control points in a grid cell.
Here, we employ the Krylov solver to solve the above saddle-point problem. We use Schur complement preconditioner to precondition the iterative solver.
Constructor & Destructor Documentation
◆ CIBSaddlePointSolver() [1/2]
| IBAMR::CIBSaddlePointSolver::CIBSaddlePointSolver | ( | std::string | object_name, |
| SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > | input_db, | ||
| SAMRAI::tbox::Pointer< IBAMR::INSStaggeredHierarchyIntegrator > | navier_stokes_integrator, | ||
| SAMRAI::tbox::Pointer< IBAMR::CIBStrategy > | cib_strategy, | ||
| std::string | default_options_prefix, | ||
| MPI_Comm | petsc_comm = PETSC_COMM_WORLD |
||
| ) |
◆ ~CIBSaddlePointSolver()
|
virtual |
◆ CIBSaddlePointSolver() [2/2]
|
privatedelete |
- Note
- This constructor is not implemented and should not be used.
- Parameters
-
from The value to copy to this object.
Member Function Documentation
◆ setKSPType()
| void IBAMR::CIBSaddlePointSolver::setKSPType | ( | const std::string & | ksp_type | ) |
◆ setOptionsPrefix()
| void IBAMR::CIBSaddlePointSolver::setOptionsPrefix | ( | const std::string & | options_prefix | ) |
◆ setVelocityPoissonSpecifications()
| void IBAMR::CIBSaddlePointSolver::setVelocityPoissonSpecifications | ( | const SAMRAI::solv::PoissonSpecifications & | u_problem_coefs | ) |
◆ setPhysicalBcCoefs()
| void IBAMR::CIBSaddlePointSolver::setPhysicalBcCoefs | ( | const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > & | u_bc_coefs, |
| SAMRAI::solv::RobinBcCoefStrategy< NDIM > * | p_bc_coef | ||
| ) |
- 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 IBTK::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.
◆ setPhysicalBoundaryHelper()
| void IBAMR::CIBSaddlePointSolver::setPhysicalBoundaryHelper | ( | SAMRAI::tbox::Pointer< IBAMR::StaggeredStokesPhysicalBoundaryHelper > | bc_helper | ) |
◆ getA()
| SAMRAI::tbox::Pointer<IBTK::LinearOperator> IBAMR::CIBSaddlePointSolver::getA | ( | ) | const |
◆ getStokesSolver()
| SAMRAI::tbox::Pointer<IBAMR::StaggeredStokesSolver> IBAMR::CIBSaddlePointSolver::getStokesSolver | ( | ) | const |
◆ getInterpScale()
|
inline |
◆ getSpreadScale()
|
inline |
◆ getRegularizationWeight()
|
inline |
◆ getNormalizeSpreadForce()
|
inline |
◆ solveSystem()
| bool IBAMR::CIBSaddlePointSolver::solveSystem | ( | Vec | x, |
| Vec | b | ||
| ) |
- Returns
trueif the solver converged to the specified tolerances,falseotherwise
◆ initializeSolverState()
| void IBAMR::CIBSaddlePointSolver::initializeSolverState | ( | Vec | x, |
| Vec | b | ||
| ) |
◆ deallocateSolverState()
| void IBAMR::CIBSaddlePointSolver::deallocateSolverState | ( | ) |
- Note
- It is safe to call deallocateSolverState() when the solver state is already deallocated.
- See also
- initializeSolverState
◆ setSolutionTime()
| void IBAMR::CIBSaddlePointSolver::setSolutionTime | ( | double | solution_time | ) |
◆ setTimeInterval()
◆ getCIBMobilitySolver()
| SAMRAI::tbox::Pointer<IBAMR::CIBMobilitySolver> IBAMR::CIBSaddlePointSolver::getCIBMobilitySolver | ( | ) | const |
◆ operator=()
|
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.
◆ getFromInput()
|
private |
◆ destroyKSP()
|
private |
◆ initializeStokesSolver()
|
private |
◆ initializeKSP()
|
private |
◆ resetKSPOptions()
|
private |
◆ resetKSPOperators()
|
private |
◆ resetKSPPC()
|
private |
◆ MatVecMult_SaddlePoint()
|
staticprivate |
◆ PCApply_SaddlePoint()
|
staticprivate |
◆ monitorKSP()
|
staticprivate |
Member Data Documentation
◆ d_object_name
|
private |
◆ d_ksp_type
|
private |
◆ d_pc_type
|
private |
◆ d_is_initialized
|
private |
◆ d_reinitializing_solver
|
private |
◆ d_petsc_x
|
private |
◆ d_petsc_b
|
private |
◆ d_options_prefix
|
private |
◆ d_petsc_comm
|
private |
◆ d_petsc_ksp
|
private |
◆ d_petsc_mat
|
private |
◆ d_A
|
private |
◆ d_max_iterations
|
private |
◆ d_current_iterations
|
private |
◆ d_abs_residual_tol
|
private |
◆ d_rel_residual_tol
|
private |
◆ d_current_residual_norm
|
private |
◆ d_initial_guess_nonzero
|
private |
◆ d_enable_logging
|
private |
◆ d_ins_integrator
|
private |
◆ d_LInv
|
private |
◆ d_velocity_solver
|
private |
◆ d_pressure_solver
|
private |
◆ d_cib_strategy
|
private |
◆ d_mob_solver
|
private |
◆ d_num_rigid_parts
|
private |
◆ d_scale_interp
|
private |
◆ d_scale_spread
|
private |
◆ d_reg_mob_factor
|
private |
◆ d_normalize_spread_force
|
private |
◆ d_hierarchy
|
private |
◆ d_u_bc_coefs
|
private |
◆ d_fill_pattern
|
private |
◆ d_transaction_comps
|
private |
◆ d_hier_bdry_fill
|
private |
◆ d_nul_vecs
|
private |
◆ d_U_nul_vecs
|
private |
◆ d_normalize_pressure
|
private |
This boolean value determines whether the pressure is normalized to have zero mean (i.e., discrete integral) at the end of each timestep.
◆ d_normalize_velocity
|
private |
This boolean value determines whether the velocity is normalized to have zero mean (i.e., discrete integral) at the end of each timestep.
This parameter only affects the case in which rho=0 (i.e. the steady Stokes equations).
◆ d_current_time
|
private |
◆ d_new_time
|
private |
The documentation for this class was generated from the following file:
- include/ibamr/CIBSaddlePointSolver.h
