Class StaggeredStokesLevelRelaxationFACOperator is a concrete StaggeredStokesFACPreconditionerStrategy implementing a level relaxation smoother for use as a multigrid preconditioner.
#include <ibamr/StaggeredStokesLevelRelaxationFACOperator.h>
Inheritance diagram for IBAMR::StaggeredStokesLevelRelaxationFACOperator:
Public Member Functions | |
| StaggeredStokesLevelRelaxationFACOperator (const std::string &object_name, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db, const std::string &default_options_prefix) | |
| Constructor. More... | |
| ~StaggeredStokesLevelRelaxationFACOperator () | |
| Destructor. More... | |
| virtual 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... | |
| virtual void | setComponentsHaveNullSpace (const bool has_velocity_nullspace, const bool has_pressure_nullspace) |
| Set if velocity and pressure have nullspace. More... | |
| virtual 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... | |
| 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... | |
| const std::string & | getName () const |
| Return the object name. More... | |
| virtual bool | getIsInitialized () const |
| Return whether the operator is initialized. More... | |
| virtual void | setFACPreconditioner (SAMRAI::tbox::ConstPointer< FACPreconditioner > preconditioner) |
| Method to allow the FACPreconditioner object to register itself with the concrete FACPreconditionerStrategy. 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 | allocateScratchData () |
| Allocate scratch data. More... | |
| virtual void | deallocateScratchData () |
| Deallocate scratch data. More... | |
Partial implementation of FACPreconditionerStrategy interface. | |
| void | setToZero (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &vec, int level_num) override |
| Zero the supplied vector. More... | |
| void | restrictResidual (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &src, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &dst, int dst_ln) override |
| Restrict the residual quantity to the specified level from the next finer level. More... | |
| void | prolongError (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &src, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &dst, int dst_ln) override |
| Prolong the error quantity to the specified level from the next coarser level. More... | |
| void | prolongErrorAndCorrect (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &src, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &dst, int dst_ln) override |
| Prolong the error quantity to the specified level from the next coarser level and apply the correction to the fine-level error. More... | |
| bool | solveCoarsestLevel (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &error, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &residual, int coarsest_ln) override |
| Solve the residual equation Ae=r on the coarsest level of the patch hierarchy. More... | |
| void | computeResidual (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &residual, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &solution, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &rhs, int coarsest_level_num, int finest_level_num) override |
| Compute the composite-grid residual on the specified range of levels of the patch hierarchy. More... | |
| void | initializeOperatorState (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &solution, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &rhs) override |
| Compute hierarchy-dependent data. More... | |
| void | deallocateOperatorState () override |
| Remove all hierarchy-dependent data. More... | |
Partial implementation of FACPreconditionerStrategy interface. | |
| void | setToZero (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &vec, int level_num) override |
| Zero the supplied vector. More... | |
| void | restrictResidual (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &src, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &dst, int dst_ln) override |
| Restrict the residual quantity to the specified level from the next finer level. More... | |
| void | prolongError (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &src, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &dst, int dst_ln) override |
| Prolong the error quantity to the specified level from the next coarser level. More... | |
| void | prolongErrorAndCorrect (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &src, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &dst, int dst_ln) override |
| Prolong the error quantity to the specified level from the next coarser level and apply the correction to the fine-level error. More... | |
| bool | solveCoarsestLevel (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &error, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &residual, int coarsest_ln) override |
| Solve the residual equation Ae=r on the coarsest level of the patch hierarchy. More... | |
| void | initializeOperatorState (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &solution, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &rhs) override |
| Compute hierarchy-dependent data. More... | |
| void | deallocateOperatorState () override |
| Remove all hierarchy-dependent data. More... | |
Functions for configuring the solver. | |
| void | setResetLevels (int coarsest_ln, int finest_ln) |
| Specify the levels that need to be reset the next time the operator is re-initialized. More... | |
| void | setCoarseSolverType (const std::string &coarse_solver_type) |
| Specify the coarse level solver. More... | |
| void | setCoarseSolverMaxIterations (int coarse_solver_max_iterations) |
| Set the maximum number of iterations for the coarse level solve. More... | |
| void | setCoarseSolverAbsoluteTolerance (double coarse_solver_abs_residual_tol) |
| Set the absolute residual tolerance for convergence for coarse level solve. More... | |
| void | setCoarseSolverRelativeTolerance (double coarse_solver_rel_residual_tol) |
| Set the relative residual tolerance for convergence for coarse level solve. More... | |
| void | setProlongationMethods (const std::string &U_prolongation_method, const std::string &P_prolongation_method) |
| Set the prolongation methods. More... | |
| void | setRestrictionMethods (const std::string &U_restriction_method, const std::string &P_restriction_method) |
| Set the restriction methods. More... | |
Partial implementation of FACPreconditionerStrategy interface. | |
| void | setToZero (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &vec, int level_num) override |
| Zero the supplied vector. More... | |
| void | restrictResidual (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &src, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &dst, int dst_ln) override |
| Restrict the residual quantity to the specified level from the next finer level. More... | |
| void | prolongError (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &src, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &dst, int dst_ln) override |
| Prolong the error quantity to the specified level from the next coarser level. More... | |
| void | prolongErrorAndCorrect (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &src, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &dst, int dst_ln) override |
| Prolong the error quantity to the specified level from the next coarser level and apply the correction to the fine-level error. More... | |
| bool | solveCoarsestLevel (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &error, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &residual, int coarsest_ln) override |
| Solve the residual equation Ae=r on the coarsest level of the patch hierarchy. More... | |
| void | computeResidual (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &residual, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &solution, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &rhs, int coarsest_level_num, int finest_level_num) override |
| Compute the composite-grid residual on the specified range of levels of the patch hierarchy. More... | |
| void | initializeOperatorState (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &solution, const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &rhs) override |
| Compute hierarchy-dependent data. More... | |
| void | deallocateOperatorState () override |
| Remove all hierarchy-dependent data. More... | |
Static Public Member Functions | |
| static SAMRAI::tbox::Pointer< StaggeredStokesSolver > | 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 StaggeredStokesFACPreconditioner with a StaggeredStokesLevelRelaxationFACOperator FAC strategy. More... | |
Methods for executing, caching, and resetting communication | |
| void | xeqScheduleProlongation (const std::pair< int, int > &dst_idxs, const std::pair< int, int > &src_idxs, int dst_ln) |
| Execute a refinement schedule for prolonging data. More... | |
| void | xeqScheduleRestriction (const std::pair< int, int > &dst_idxs, const std::pair< int, int > &src_idxs, int dst_ln) |
| Execute schedule for restricting solution or residual to the specified level. More... | |
| void | xeqScheduleGhostFillNoCoarse (const std::pair< int, int > &dst_idxs, int dst_ln) |
| Execute schedule for filling ghosts on the specified level. More... | |
| void | xeqScheduleDataSynch (int dst_idx, int dst_ln) |
| Execute schedule for synchronizing data on the specified level. More... | |
| SAMRAI::solv::PoissonSpecifications | d_U_problem_coefs |
| SAMRAI::solv::RobinBcCoefStrategy< NDIM > * | d_default_U_bc_coef |
| std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > | d_U_bc_coefs |
| SAMRAI::solv::RobinBcCoefStrategy< NDIM > * | d_default_P_bc_coef |
| SAMRAI::solv::RobinBcCoefStrategy< NDIM > * | d_P_bc_coef |
| SAMRAI::tbox::Pointer< StaggeredStokesPhysicalBoundaryHelper > | d_bc_helper |
| const int | d_gcw |
Logging functions. | |
| virtual void | printClassData (std::ostream &stream) |
| Print class data to stream. More... | |
| virtual SAMRAI::tbox::Pointer< SAMRAI::solv::SAMRAIVectorReal< NDIM, double > > | getLevelSAMRAIVectorReal (const SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &vec, int level_num) const |
| Return a SAMRAIVectorReal object that corresponds to the given object but restricted to a single level of the patch hierarchy. More... | |
| SAMRAI::tbox::ConstPointer< IBTK::FACPreconditioner > | d_preconditioner |
| const std::string | d_object_name |
| bool | d_is_initialized = false |
| bool | d_homogeneous_bc |
| 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() |
Constructor & Destructor Documentation
◆ StaggeredStokesLevelRelaxationFACOperator() [1/3]
| IBAMR::StaggeredStokesLevelRelaxationFACOperator::StaggeredStokesLevelRelaxationFACOperator | ( | const std::string & | object_name, |
| SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > | input_db, | ||
| const std::string & | default_options_prefix | ||
| ) |
◆ ~StaggeredStokesLevelRelaxationFACOperator()
| IBAMR::StaggeredStokesLevelRelaxationFACOperator::~StaggeredStokesLevelRelaxationFACOperator | ( | ) |
◆ StaggeredStokesLevelRelaxationFACOperator() [2/3]
|
privatedelete |
- Note
- This constructor is not implemented and should not be used.
◆ StaggeredStokesLevelRelaxationFACOperator() [3/3]
|
privatedelete |
- Note
- This constructor is not implemented and should not be used.
- Parameters
-
from The value to copy to this object.
Member Function Documentation
◆ allocate_solver()
|
inlinestatic |
◆ setSmootherType()
| void IBAMR::StaggeredStokesLevelRelaxationFACOperator::setSmootherType | ( | const std::string & | level_solver_type | ) |
◆ smoothError()
|
overridevirtual |
- Parameters
-
error error vector residual residual vector level_num level number num_sweeps number of sweeps to perform performing_pre_sweeps boolean value that is true when pre-smoothing sweeps are being performed performing_post_sweeps boolean value that is true when post-smoothing sweeps are being performed
Implements IBTK::FACPreconditionerStrategy.
◆ initializeOperatorStateSpecialized()
|
overrideprotectedvirtual |
Implements IBAMR::StaggeredStokesFACPreconditionerStrategy.
◆ deallocateOperatorStateSpecialized()
|
overrideprotectedvirtual |
Implements IBAMR::StaggeredStokesFACPreconditionerStrategy.
◆ 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.
◆ setVelocityPoissonSpecifications()
|
virtualinherited |
◆ setComponentsHaveNullSpace()
|
virtualinherited |
◆ setPhysicalBcCoefs()
|
virtualinherited |
- 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()
|
virtualinherited |
◆ setResetLevels()
|
inherited |
When the operator is initialized, then only the specified range of levels are reset in the operator state the next time that the operator is initialized. If the operator is not initialized, this method has no effect.
To ensure the range of levels that is reset includes all levels in the patch hierarchy, use coarsest_ln = finest_ln = -1.
- Note
- This function is used to save some unnecessary computations when the hierarchy is regridded. The range of levels specified must include all levels which need to be reset by SAMRAI::mesh::StandardTagAndInitStrategy::resetHierarchyConfiguration(). Any data residing outside of this range of levels will not be reset. This is not what you want to have happen if, for instance, the Poisson specifications changes.
◆ setCoarseSolverType()
|
inherited |
◆ setCoarseSolverMaxIterations()
|
inherited |
If the coarse level solver uses a maximum number of iterations parameter, the specified value is used. If the coarse level solver does not use such a stopping parameter, implementations are free to ignore this value.
◆ setCoarseSolverAbsoluteTolerance()
|
inherited |
If the coarse level solver uses a absolute convergence tolerance parameter, the specified value is used. If the coarse level solver does not use such a stopping parameter, implementations are free to ignore this value.
◆ setCoarseSolverRelativeTolerance()
|
inherited |
If the coarse level solver uses a relative convergence tolerance parameter, the specified value is used. If the coarse level solver does not use such a stopping parameter, implementations are free to ignore this value.
◆ setProlongationMethods()
|
inherited |
◆ setRestrictionMethods()
|
inherited |
◆ setToZero()
|
overridevirtualinherited |
Implements IBTK::FACPreconditionerStrategy.
◆ restrictResidual()
|
overridevirtualinherited |
- Parameters
-
src source residual dst destination residual dst_ln destination level number
Implements IBTK::FACPreconditionerStrategy.
◆ prolongError()
|
overridevirtualinherited |
- Parameters
-
src source error vector dst destination error vector dst_ln destination level number of data transfer
Implements IBTK::FACPreconditionerStrategy.
◆ prolongErrorAndCorrect()
|
overridevirtualinherited |
- Parameters
-
src source error vector dst destination error vector dst_ln destination level number of data transfer
Implements IBTK::FACPreconditionerStrategy.
◆ solveCoarsestLevel()
|
overridevirtualinherited |
- Parameters
-
error error vector residual residual vector coarsest_ln coarsest level number
Implements IBTK::FACPreconditionerStrategy.
◆ computeResidual()
|
overridevirtualinherited |
Implements IBTK::FACPreconditionerStrategy.
Reimplemented in IBAMR::StaggeredStokesIBLevelRelaxationFACOperator.
◆ initializeOperatorState()
|
overridevirtualinherited |
Note that although the vector arguments given to other methods in this class may not necessarily be the same as those given to this method, there will be similarities, including:
- hierarchy configuration (hierarchy pointer and level range)
- number, type and alignment of vector component data
- ghost cell width of data in the solution (or solution-like) vector
- Parameters
-
solution solution vector u rhs right hand side vector f
Reimplemented from IBTK::FACPreconditionerStrategy.
◆ deallocateOperatorState()
|
overridevirtualinherited |
Remove all hierarchy-dependent data set by initializeOperatorState().
- See also
- initializeOperatorState
Reimplemented from IBTK::FACPreconditionerStrategy.
◆ xeqScheduleProlongation()
|
protectedinherited |
◆ xeqScheduleRestriction()
|
protectedinherited |
◆ xeqScheduleGhostFillNoCoarse()
|
protectedinherited |
◆ xeqScheduleDataSynch()
|
protectedinherited |
◆ getName()
|
inherited |
◆ getIsInitialized()
|
virtualinherited |
◆ setFACPreconditioner()
|
virtualinherited |
◆ setHomogeneousBc()
|
virtualinherited |
◆ getHomogeneousBc()
|
virtualinherited |
◆ setSolutionTime()
|
virtualinherited |
◆ getSolutionTime()
|
virtualinherited |
◆ setTimeInterval()
|
virtualinherited |
◆ getTimeInterval()
|
virtualinherited |
◆ getDt()
|
virtualinherited |
◆ allocateScratchData()
|
virtualinherited |
◆ deallocateScratchData()
|
virtualinherited |
◆ printClassData()
|
virtualinherited |
◆ getLevelSAMRAIVectorReal()
|
protectedvirtualinherited |
Member Data Documentation
◆ d_level_solver_type
|
private |
◆ d_level_solver_default_options_prefix
|
private |
◆ d_level_solver_abs_residual_tol
|
private |
◆ d_level_solver_rel_residual_tol
|
private |
◆ d_level_solver_max_iterations
|
private |
◆ d_level_solvers
|
private |
◆ d_level_solver_db
|
private |
◆ d_patch_side_bc_box_overlap
|
private |
◆ d_patch_cell_bc_box_overlap
|
private |
◆ d_U_problem_coefs
|
protectedinherited |
◆ d_default_U_bc_coef
|
protectedinherited |
◆ d_U_bc_coefs
|
protectedinherited |
◆ d_default_P_bc_coef
|
protectedinherited |
◆ d_P_bc_coef
|
protectedinherited |
◆ d_bc_helper
|
protectedinherited |
◆ d_gcw
|
protectedinherited |
◆ d_solution
|
protectedinherited |
◆ d_rhs
|
protectedinherited |
◆ d_hierarchy
|
protectedinherited |
◆ d_coarsest_ln
|
protectedinherited |
◆ d_finest_ln
|
protectedinherited |
◆ d_level_bdry_fill_ops
|
protectedinherited |
◆ d_level_math_ops
|
protectedinherited |
◆ d_in_initialize_operator_state
|
protectedinherited |
◆ d_coarsest_reset_ln
|
protectedinherited |
◆ d_finest_reset_ln
|
protectedinherited |
◆ d_smoother_type
|
protectedinherited |
◆ d_U_prolongation_method
|
protectedinherited |
◆ d_P_prolongation_method
|
protectedinherited |
◆ d_U_restriction_method
|
protectedinherited |
◆ d_P_restriction_method
|
protectedinherited |
◆ d_coarse_solver_init_subclass
|
protectedinherited |
◆ d_coarse_solver_type
|
protectedinherited |
◆ d_coarse_solver_default_options_prefix
|
protectedinherited |
◆ d_coarse_solver_rel_residual_tol
|
protectedinherited |
◆ d_coarse_solver_abs_residual_tol
|
protectedinherited |
◆ d_coarse_solver_max_iterations
|
protectedinherited |
◆ d_coarse_solver
|
protectedinherited |
◆ d_coarse_solver_db
|
protectedinherited |
◆ d_has_velocity_nullspace
|
protectedinherited |
◆ d_has_pressure_nullspace
|
protectedinherited |
◆ d_context
|
protectedinherited |
◆ d_side_scratch_idx
|
protectedinherited |
◆ d_cell_scratch_idx
|
protectedinherited |
◆ d_U_bc_op
|
protectedinherited |
◆ d_P_bc_op
|
protectedinherited |
◆ d_U_cf_bdry_op
|
protectedinherited |
◆ d_P_cf_bdry_op
|
protectedinherited |
◆ d_U_op_stencil_fill_pattern
|
protectedinherited |
◆ d_P_op_stencil_fill_pattern
|
protectedinherited |
◆ d_U_synch_fill_pattern
|
protectedinherited |
◆ d_U_P_bc_op
|
privateinherited |
◆ d_U_prolongation_refine_operator
|
privateinherited |
◆ d_P_prolongation_refine_operator
|
privateinherited |
◆ d_prolongation_refine_patch_strategy
|
privateinherited |
◆ d_prolongation_refine_algorithm
|
privateinherited |
◆ d_prolongation_refine_schedules
|
privateinherited |
◆ d_U_restriction_coarsen_operator
|
privateinherited |
◆ d_P_restriction_coarsen_operator
|
privateinherited |
◆ d_restriction_coarsen_algorithm
|
privateinherited |
◆ d_restriction_coarsen_schedules
|
privateinherited |
◆ d_ghostfill_nocoarse_refine_algorithm
|
privateinherited |
◆ d_ghostfill_nocoarse_refine_schedules
|
privateinherited |
◆ d_synch_refine_algorithm
|
privateinherited |
◆ d_synch_refine_schedules
|
privateinherited |
◆ d_preconditioner
|
protectedinherited |
◆ d_object_name
|
protectedinherited |
◆ d_is_initialized
|
protectedinherited |
◆ d_homogeneous_bc
|
protectedinherited |
◆ d_solution_time
|
protectedinherited |
◆ d_current_time
|
protectedinherited |
◆ d_new_time
|
protectedinherited |
The documentation for this class was generated from the following file:
- include/ibamr/StaggeredStokesLevelRelaxationFACOperator.h
