Class PoissonFACPreconditioner is a FACPreconditioner that has been specialized for Poisson problems.
#include <ibtk/PoissonFACPreconditioner.h>
|
| void | setInitialGuessNonzero (bool initial_guess_nonzero=true) override |
| | Set whether the initial guess is non-zero. More...
|
| |
| void | setMaxIterations (int max_iterations) override |
| | Set the maximum number of iterations to use per solve. More...
|
| |
| void | setMGCycleType (MGCycleType cycle_type) |
| | Set the multigrid algorithm cycle type. More...
|
| |
| MGCycleType | getMGCycleType () const |
| | Get the multigrid algorithm cycle type. More...
|
| |
| void | setNumPreSmoothingSweeps (int num_pre_sweeps) |
| | Set the number of pre-smoothing sweeps to employ. More...
|
| |
| int | getNumPreSmoothingSweeps () const |
| | Get the number of pre-smoothing sweeps employed by the preconditioner. More...
|
| |
| void | setNumPostSmoothingSweeps (int num_post_sweeps) |
| | Set the number of post-smoothing sweeps to employ. More...
|
| |
| int | getNumPostSmoothingSweeps () const |
| | Get the number of post-smoothing sweeps employed by the preconditioner. More...
|
| |
| SAMRAI::tbox::Pointer< FACPreconditionerStrategy > | getFACPreconditionerStrategy () const |
| | Get the FAC preconditioner strategy objects employed by the preconditioner. More...
|
| |
| void | getFromInput (SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > db) |
| |
| SAMRAI::tbox::Pointer< FACPreconditionerStrategy > | d_fac_strategy |
| |
| SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > | d_hierarchy |
| |
| int | d_coarsest_ln = 0 |
| |
| int | d_finest_ln = 0 |
| |
| MGCycleType | d_cycle_type = V_CYCLE |
| |
| int | d_num_pre_sweeps = 0 |
| |
| int | d_num_post_sweeps = 2 |
| |
| void | FACVCycleNoPreSmoothing (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &u, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &f, int level_num) |
| |
| void | muCycle (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &u, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &f, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &r, int level_num, int mu) |
| |
| void | FCycle (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &u, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &f, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &r, int level_num) |
| |
| void | FMGCycle (SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &u, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &f, SAMRAI::solv::SAMRAIVectorReal< NDIM, double > &r, int level_num, int mu) |
| |
◆ PoissonFACPreconditioner() [1/3]
◆ ~PoissonFACPreconditioner()
| IBTK::PoissonFACPreconditioner::~PoissonFACPreconditioner |
( |
| ) |
|
|
default |
◆ PoissonFACPreconditioner() [2/3]
| IBTK::PoissonFACPreconditioner::PoissonFACPreconditioner |
( |
| ) |
|
|
privatedelete |
- Note
- This constructor is not implemented and should not be used.
◆ PoissonFACPreconditioner() [3/3]
- Note
- This constructor is not implemented and should not be used.
- Parameters
-
| from | The value to copy to this object. |
◆ setPoissonSpecifications()
◆ setPhysicalBcCoef()
- Note
- bc_coef may be nullptr. In this case, default boundary conditions (as supplied to the class constructor) are employed.
- Parameters
-
| bc_coef | Pointer to an object that can set the Robin boundary condition coefficients |
Reimplemented from IBTK::PoissonSolver.
◆ setPhysicalBcCoefs()
- Note
- Any of the elements of bc_coefs may be nullptr. In this case, default boundary conditions (as supplied to the class constructor) are employed for that data depth.
- Parameters
-
| bc_coefs | Vector of pointers to objects that can set the Robin boundary condition coefficients |
Reimplemented from IBTK::PoissonSolver.
◆ operator=()
- 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.
◆ setHomogeneousBc()
| void IBTK::FACPreconditioner::setHomogeneousBc |
( |
bool |
homogeneous_bc | ) |
|
|
overridevirtualinherited |
◆ setSolutionTime()
| void IBTK::FACPreconditioner::setSolutionTime |
( |
double |
solution_time | ) |
|
|
overridevirtualinherited |
◆ setTimeInterval()
| void IBTK::FACPreconditioner::setTimeInterval |
( |
double |
current_time, |
|
|
double |
new_time |
|
) |
| |
|
overridevirtualinherited |
◆ solveSystem()
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
- The vector arguments for solveSystem() need not match those for initializeSolverState(). However, there must be 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
- The solver need not 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
Implements IBTK::GeneralSolver.
◆ initializeSolverState()
By default, the solveSystem() method computes some required hierarchy dependent data before solving and removes 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.
When linear operator or preconditioner objects have been registered with this class via setOperator() and setPreconditioner(), they are also initialized by this member function.
- 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
- The vector arguments for solveSystem() need not match those for initializeSolverState(). However, there must be 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
- It is safe to call initializeSolverState() when the state is already initialized. In this case, the solver state is first deallocated and then reinitialized.
- See also
- deallocateSolverState
Reimplemented from IBTK::GeneralSolver.
◆ deallocateSolverState()
| void IBTK::FACPreconditioner::deallocateSolverState |
( |
| ) |
|
|
overridevirtualinherited |
When linear operator or preconditioner objects have been registered with this class via setOperator() and setPreconditioner(), they are also deallocated by this member function.
- Note
- It is safe to call deallocateSolverState() when the solver state is already deallocated.
- See also
- initializeSolverState
Reimplemented from IBTK::GeneralSolver.
◆ setInitialGuessNonzero()
| void IBTK::FACPreconditioner::setInitialGuessNonzero |
( |
bool |
initial_guess_nonzero = true | ) |
|
|
overridevirtualinherited |
◆ setMaxIterations()
| void IBTK::FACPreconditioner::setMaxIterations |
( |
int |
max_iterations | ) |
|
|
overridevirtualinherited |
◆ setMGCycleType()
| void IBTK::FACPreconditioner::setMGCycleType |
( |
MGCycleType |
cycle_type | ) |
|
|
inherited |
◆ getMGCycleType()
| MGCycleType IBTK::FACPreconditioner::getMGCycleType |
( |
| ) |
const |
|
inherited |
◆ setNumPreSmoothingSweeps()
| void IBTK::FACPreconditioner::setNumPreSmoothingSweeps |
( |
int |
num_pre_sweeps | ) |
|
|
inherited |
◆ getNumPreSmoothingSweeps()
| int IBTK::FACPreconditioner::getNumPreSmoothingSweeps |
( |
| ) |
const |
|
inherited |
◆ setNumPostSmoothingSweeps()
| void IBTK::FACPreconditioner::setNumPostSmoothingSweeps |
( |
int |
num_post_sweeps | ) |
|
|
inherited |
◆ getNumPostSmoothingSweeps()
| int IBTK::FACPreconditioner::getNumPostSmoothingSweeps |
( |
| ) |
const |
|
inherited |
◆ getFACPreconditionerStrategy()
◆ FACVCycleNoPreSmoothing()
◆ muCycle()
◆ FCycle()
◆ FMGCycle()
◆ getFromInput()
◆ setNullSpace()
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::PETScKrylovLinearSolver, and IBTK::PETScLevelSolver.
◆ getNullSpaceContainsConstantVector()
| virtual bool IBTK::LinearSolver::getNullSpaceContainsConstantVector |
( |
| ) |
const |
|
virtualinherited |
◆ getNullSpaceBasisVectors()
◆ getInitialGuessNonzero()
| virtual bool IBTK::LinearSolver::getInitialGuessNonzero |
( |
| ) |
const |
|
virtualinherited |
◆ printClassData()
| virtual void IBTK::LinearSolver::printClassData |
( |
std::ostream & |
stream | ) |
|
|
overridevirtualinherited |
◆ getName()
| const std::string& IBTK::GeneralSolver::getName |
( |
| ) |
const |
|
inherited |
◆ getIsInitialized()
| virtual bool IBTK::GeneralSolver::getIsInitialized |
( |
| ) |
const |
|
virtualinherited |
◆ getHomogeneousBc()
| virtual bool IBTK::GeneralSolver::getHomogeneousBc |
( |
| ) |
const |
|
virtualinherited |
◆ getSolutionTime()
| virtual double IBTK::GeneralSolver::getSolutionTime |
( |
| ) |
const |
|
virtualinherited |
◆ getTimeInterval()
| virtual std::pair<double, double> IBTK::GeneralSolver::getTimeInterval |
( |
| ) |
const |
|
virtualinherited |
◆ getDt()
| virtual double IBTK::GeneralSolver::getDt |
( |
| ) |
const |
|
virtualinherited |
◆ setHierarchyMathOps()
◆ getHierarchyMathOps()
◆ getMaxIterations()
| virtual int IBTK::GeneralSolver::getMaxIterations |
( |
| ) |
const |
|
virtualinherited |
◆ setAbsoluteTolerance()
| virtual void IBTK::GeneralSolver::setAbsoluteTolerance |
( |
double |
abs_residual_tol | ) |
|
|
virtualinherited |
◆ getAbsoluteTolerance()
| virtual double IBTK::GeneralSolver::getAbsoluteTolerance |
( |
| ) |
const |
|
virtualinherited |
◆ setRelativeTolerance()
| virtual void IBTK::GeneralSolver::setRelativeTolerance |
( |
double |
rel_residual_tol | ) |
|
|
virtualinherited |
◆ getRelativeTolerance()
| virtual double IBTK::GeneralSolver::getRelativeTolerance |
( |
| ) |
const |
|
virtualinherited |
◆ getNumIterations()
| virtual int IBTK::GeneralSolver::getNumIterations |
( |
| ) |
const |
|
virtualinherited |
◆ getResidualNorm()
| virtual double IBTK::GeneralSolver::getResidualNorm |
( |
| ) |
const |
|
virtualinherited |
◆ setLoggingEnabled()
| virtual void IBTK::GeneralSolver::setLoggingEnabled |
( |
bool |
enable_logging = true | ) |
|
|
virtualinherited |
◆ getLoggingEnabled()
| virtual bool IBTK::GeneralSolver::getLoggingEnabled |
( |
| ) |
const |
|
virtualinherited |
◆ init()
| void IBTK::GeneralSolver::init |
( |
const std::string & |
object_name, |
|
|
bool |
homogeneous_bc |
|
) |
| |
|
protectedinherited |
◆ initSpecialized() [1/2]
| virtual void IBTK::GeneralSolver::initSpecialized |
( |
const std::string & |
object_name, |
|
|
bool |
homogeneous_bc |
|
) |
| |
|
protectedvirtualinherited |
◆ initSpecialized() [2/2]
| void IBTK::PoissonSolver::initSpecialized |
( |
const std::string & |
object_name, |
|
|
bool |
homogeneous_bc |
|
) |
| |
|
overrideprotectedvirtualinherited |
◆ d_fac_strategy
◆ d_hierarchy
◆ d_coarsest_ln
| int IBTK::FACPreconditioner::d_coarsest_ln = 0 |
|
protectedinherited |
◆ d_finest_ln
| int IBTK::FACPreconditioner::d_finest_ln = 0 |
|
protectedinherited |
◆ d_cycle_type
◆ d_num_pre_sweeps
| int IBTK::FACPreconditioner::d_num_pre_sweeps = 0 |
|
protectedinherited |
◆ d_num_post_sweeps
| int IBTK::FACPreconditioner::d_num_post_sweeps = 2 |
|
protectedinherited |
◆ d_initial_guess_nonzero
| bool IBTK::LinearSolver::d_initial_guess_nonzero = true |
|
protectedinherited |
◆ d_nullspace_contains_constant_vec
| bool IBTK::LinearSolver::d_nullspace_contains_constant_vec = false |
|
protectedinherited |
◆ d_nullspace_basis_vecs
◆ d_object_name
| std::string IBTK::GeneralSolver::d_object_name = "unitialized" |
|
protectedinherited |
◆ d_is_initialized
| bool IBTK::GeneralSolver::d_is_initialized = false |
|
protectedinherited |
◆ d_homogeneous_bc
| bool IBTK::GeneralSolver::d_homogeneous_bc = false |
|
protectedinherited |
◆ d_solution_time
| double IBTK::GeneralSolver::d_solution_time = std::numeric_limits<double>::quiet_NaN() |
|
protectedinherited |
◆ d_current_time
| double IBTK::GeneralSolver::d_current_time = std::numeric_limits<double>::quiet_NaN() |
|
protectedinherited |
◆ d_new_time
| double IBTK::GeneralSolver::d_new_time = std::numeric_limits<double>::quiet_NaN() |
|
protectedinherited |
◆ d_rel_residual_tol
| double IBTK::GeneralSolver::d_rel_residual_tol = 0.0 |
|
protectedinherited |
◆ d_abs_residual_tol
| double IBTK::GeneralSolver::d_abs_residual_tol = 0.0 |
|
protectedinherited |
◆ d_max_iterations
| int IBTK::GeneralSolver::d_max_iterations = 100 |
|
protectedinherited |
◆ d_current_iterations
| int IBTK::GeneralSolver::d_current_iterations = 0 |
|
protectedinherited |
◆ d_current_residual_norm
| double IBTK::GeneralSolver::d_current_residual_norm = std::numeric_limits<double>::quiet_NaN() |
|
protectedinherited |
◆ d_hier_math_ops
◆ d_hier_math_ops_external
| bool IBTK::GeneralSolver::d_hier_math_ops_external = false |
|
protectedinherited |
◆ d_enable_logging
| bool IBTK::GeneralSolver::d_enable_logging = false |
|
protectedinherited |
◆ d_poisson_spec
◆ d_default_bc_coef
◆ d_bc_coefs
The documentation for this class was generated from the following file: