action functions
|
Please note that the library has not been "officially" released. While we continue to work on the documentation, these web pages are likely to contain broken links and documents in draft form. Please send an email to if you wish to be informed of the library's "official" release. |
#include <general_purpose_preconditioners.h>
Inheritance diagram for oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >:

Definition at line 392 of file general_purpose_preconditioners.h.
Public Member Functions | |
| InnerIterationPreconditioner () | |
| Constructor. | |
| ~InnerIterationPreconditioner () | |
| void | clean_up_memory () |
| Clean up memory (empty). Generic interface to allows data associated with a preconditioner to be deleted. | |
| void | setup (Problem *problem_pt, DoubleMatrixBase *matrix_pt) |
| Preconditioner setup method. Setup the preconditioner for the inner iteration solver. | |
| void | preconditioner_solve (const DoubleVector &r, DoubleVector &z) |
| Preconditioner solve method. Performs the specified number of Krylov iterations preconditioned with the specified preconditioner. | |
| double & | tolerance () |
| Access to convergence tolerance of the inner iteration solver. | |
| unsigned & | max_iter () |
| Access to max. number of iterations of the inner iteration solver. | |
| SOLVER * | solver_pt () |
| PRECONDITIONER * | preconditioner_pt () |
Private Attributes | |
| SOLVER * | Solver_pt |
| pointer to the underlying solver | |
| PRECONDITIONER * | Preconditioner_pt |
| pointer to the underlying preconditioner | |
| oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::InnerIterationPreconditioner | ( | ) | [inline] |
Constructor.
Definition at line 397 of file general_purpose_preconditioners.h.
References OOMPH_EXCEPTION_LOCATION, oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Preconditioner_pt, and oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.
| oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::~InnerIterationPreconditioner | ( | ) | [inline] |
Definition at line 432 of file general_purpose_preconditioners.h.
References oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Preconditioner_pt, and oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.
| void oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::clean_up_memory | ( | ) | [inline, virtual] |
Clean up memory (empty). Generic interface to allows data associated with a preconditioner to be deleted.
Reimplemented from oomph::Preconditioner.
Definition at line 439 of file general_purpose_preconditioners.h.
References oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Preconditioner_pt, and oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.
| unsigned& oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::max_iter | ( | ) | [inline] |
Access to max. number of iterations of the inner iteration solver.
Definition at line 488 of file general_purpose_preconditioners.h.
References oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.
Referenced by oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::setup().
| PRECONDITIONER* oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::preconditioner_pt | ( | ) | [inline] |
Definition at line 494 of file general_purpose_preconditioners.h.
References oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Preconditioner_pt.
| void oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::preconditioner_solve | ( | const DoubleVector & | r, | |
| DoubleVector & | z | |||
| ) | [inline, virtual] |
Preconditioner solve method. Performs the specified number of Krylov iterations preconditioned with the specified preconditioner.
Reimplemented from oomph::Preconditioner.
Definition at line 479 of file general_purpose_preconditioners.h.
References oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.
| void oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::setup | ( | Problem * | problem_pt, | |
| DoubleMatrixBase * | matrix_pt | |||
| ) | [inline, virtual] |
Preconditioner setup method. Setup the preconditioner for the inner iteration solver.
Reimplemented from oomph::Preconditioner.
Definition at line 447 of file general_purpose_preconditioners.h.
References oomph::Problem::communicator_pt(), oomph::DistributableLinearAlgebraObject::distribution_pt(), oomph::DistributableLinearAlgebraObject::Distribution_pt, oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::max_iter(), oomph::DoubleMatrixBase::nrow(), oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Preconditioner_pt, oomph::LinearAlgebraDistribution::rebuild(), and oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.
| SOLVER* oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::solver_pt | ( | ) | [inline] |
Definition at line 491 of file general_purpose_preconditioners.h.
References oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.
| double& oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::tolerance | ( | ) | [inline] |
Access to convergence tolerance of the inner iteration solver.
Definition at line 485 of file general_purpose_preconditioners.h.
References oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.
PRECONDITIONER* oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Preconditioner_pt [private] |
pointer to the underlying preconditioner
Definition at line 502 of file general_purpose_preconditioners.h.
Referenced by oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::clean_up_memory(), oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::InnerIterationPreconditioner(), oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::preconditioner_pt(), oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::setup(), and oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::~InnerIterationPreconditioner().
SOLVER* oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt [private] |
pointer to the underlying solver
Definition at line 499 of file general_purpose_preconditioners.h.
Referenced by oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::clean_up_memory(), oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::InnerIterationPreconditioner(), oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::max_iter(), oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::preconditioner_solve(), oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::setup(), oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::solver_pt(), oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::tolerance(), and oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::~InnerIterationPreconditioner().
1.4.7