#include <general_purpose_preconditioners.h>

Inheritance diagram for oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >:

Public Member Functions
	InnerIterationPreconditioner ()
	Constructor. More...

	~InnerIterationPreconditioner ()

void	clean_up_memory ()
	Clean up memory (empty). Generic interface function. More...

void	setup ()

void	preconditioner_solve (const DoubleVector &r, DoubleVector &z)

double &	tolerance ()
	Access to convergence tolerance of the inner iteration solver. More...

unsigned &	max_iter ()
	Access to max. number of iterations of the inner iteration solver. More...

SOLVER *	solver_pt ()

PRECONDITIONER *	preconditioner_pt ()

Public Member Functions inherited from oomph::Preconditioner
	Preconditioner ()
	Constructor. More...

	Preconditioner (const Preconditioner &)=delete
	Broken copy constructor. More...

void	operator= (const Preconditioner &)=delete
	Broken assignment operator. More...

virtual	~Preconditioner ()
	Destructor (empty) More...

virtual void	preconditioner_solve_transpose (const DoubleVector &r, DoubleVector &z)

void	setup (DoubleMatrixBase *matrix_pt)

void	setup (const Problem problem_pt, DoubleMatrixBase matrix_pt)

void	enable_silent_preconditioner_setup ()
	Set up the block preconditioner quietly! More...

void	disable_silent_preconditioner_setup ()
	Be verbose in the block preconditioner setup. More...

virtual DoubleMatrixBase *	matrix_pt () const
	Get function for matrix pointer. More...

virtual void	set_matrix_pt (DoubleMatrixBase *matrix_pt)
	Set the matrix pointer. More...

virtual const OomphCommunicator *	comm_pt () const
	Get function for comm pointer. More...

virtual void	set_comm_pt (const OomphCommunicator *const comm_pt)
	Set the communicator pointer. More...

double	setup_time () const
	Returns the time to setup the preconditioner. More...

virtual void	turn_into_subsidiary_block_preconditioner (BlockPreconditioner< CRDoubleMatrix > *master_block_prec_pt, const Vector< unsigned > &doftype_in_master_preconditioner_coarse)

virtual void	turn_into_subsidiary_block_preconditioner (BlockPreconditioner< CRDoubleMatrix > *master_block_prec_pt, const Vector< unsigned > &doftype_in_master_preconditioner_coarse, const Vector< Vector< unsigned >> &doftype_coarsen_map_coarse)

Public Member Functions inherited from oomph::DistributableLinearAlgebraObject
	DistributableLinearAlgebraObject ()
	Default constructor - create a distribution. More...

	DistributableLinearAlgebraObject (const DistributableLinearAlgebraObject &matrix)=delete
	Broken copy constructor. More...

void	operator= (const DistributableLinearAlgebraObject &)=delete
	Broken assignment operator. More...

virtual	~DistributableLinearAlgebraObject ()
	Destructor. More...

LinearAlgebraDistribution *	distribution_pt () const
	access to the LinearAlgebraDistribution More...

unsigned	nrow () const
	access function to the number of global rows. More...

unsigned	nrow_local () const
	access function for the num of local rows on this processor. More...

unsigned	nrow_local (const unsigned &p) const
	access function for the num of local rows on this processor. More...

unsigned	first_row () const
	access function for the first row on this processor More...

unsigned	first_row (const unsigned &p) const
	access function for the first row on this processor More...

bool	distributed () const
	distribution is serial or distributed More...

bool	distribution_built () const

void	build_distribution (const LinearAlgebraDistribution *const dist_pt)

void	build_distribution (const LinearAlgebraDistribution &dist)

Private Attributes
SOLVER *	Solver_pt
	pointer to the underlying solver More...

PRECONDITIONER *	Preconditioner_pt
	pointer to the underlying preconditioner More...

Additional Inherited Members
Protected Member Functions inherited from oomph::DistributableLinearAlgebraObject
void	clear_distribution ()

Protected Attributes inherited from oomph::Preconditioner
bool	Silent_preconditioner_setup
	Boolean to indicate whether or not the build should be done silently. More...

std::ostream *	Stream_pt
	Pointer to the output stream – defaults to std::cout. More...

Detailed Description

template<class SOLVER, class PRECONDITIONER>
class oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >

A preconditioner for performing inner iteration preconditioner solves. The template argument SOLVER specifies the inner iteration solver (which must be derived from IterativeLinearSolver) and the template argument PRECONDITIONER specifies the preconditioner for the inner iteration iterative solver. Note: For no preconditioning use the IdentityPreconditioner.

Constructor & Destructor Documentation

◆ InnerIterationPreconditioner()

template<class SOLVER , class PRECONDITIONER >

oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::InnerIterationPreconditioner ( )

inline

Constructor.

     {
       // create the solver
       Solver_pt = new SOLVER;
  
       // create the preconditioner
       Preconditioner_pt = new PRECONDITIONER;
  
 #ifdef PARANOID
       // paranoid check that the solver is an iterative solver and
       // the preconditioner is a preconditioner
       if (dynamic_cast<IterativeLinearSolver*>(Solver_pt) == 0)
       {
         throw OomphLibError(
           "The template argument SOLVER must be of type IterativeLinearSolver",
           OOMPH_CURRENT_FUNCTION,
           OOMPH_EXCEPTION_LOCATION);
       }
       if (dynamic_cast<Preconditioner*>(Preconditioner_pt) == 0)
       {
         throw OomphLibError(
           "The template argument PRECONDITIONER must be of type Preconditioner",
           OOMPH_CURRENT_FUNCTION,
           OOMPH_EXCEPTION_LOCATION);
       }
 #endif
  
       // ensure the solver does not re-setup the preconditioner
       Solver_pt->disable_setup_preconditioner_before_solve();
  
       // pass the preconditioner to the solver
       Solver_pt->preconditioner_pt() = Preconditioner_pt;
     }

References OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Preconditioner_pt, and oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.

◆ ~InnerIterationPreconditioner()

template<class SOLVER , class PRECONDITIONER >

oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::~InnerIterationPreconditioner ( )

inline

     {
       delete Solver_pt;
       delete Preconditioner_pt;
     }

References oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Preconditioner_pt, and oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.

Member Function Documentation

◆ clean_up_memory()

template<class SOLVER , class PRECONDITIONER >

void oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::clean_up_memory ( )

inlinevirtual

Clean up memory (empty). Generic interface function.

Reimplemented from oomph::Preconditioner.

     {
       Preconditioner_pt->clean_up_memory();
       Solver_pt->clean_up_memory();
     }

References oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Preconditioner_pt, and oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.

◆ max_iter()

template<class SOLVER , class PRECONDITIONER >

unsigned& oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::max_iter ( )

inline

Access to max. number of iterations of the inner iteration solver.

     {
       return Solver_pt->max_iter();
     }

References oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.

Referenced by oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::setup().

◆ preconditioner_pt()

template<class SOLVER , class PRECONDITIONER >

PRECONDITIONER* oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::preconditioner_pt ( )

inline

     {
       return Preconditioner_pt;
     }

References oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Preconditioner_pt.

◆ preconditioner_solve()

template<class SOLVER , class PRECONDITIONER >

void oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::preconditioner_solve	(	const DoubleVector &	r,
		DoubleVector &	z
	)

inlinevirtual

Preconditioner solve method. Performs the specified number of Krylov iterations preconditioned with the specified preconditioner

Implements oomph::Preconditioner.

     {
       Solver_pt->resolve(r, z);
     }

References UniformPSDSelfTest::r, and oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.

◆ setup()

template<class SOLVER , class PRECONDITIONER >

void oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::setup ( )

inlinevirtual

Preconditioner setup method. Setup the preconditioner for the inner iteration solver.

Implements oomph::Preconditioner.

     {
       // set the distribution
       DistributableLinearAlgebraObject* dist_pt =
         dynamic_cast<DistributableLinearAlgebraObject*>(matrix_pt());
       if (dist_pt != 0)
       {
         this->build_distribution(dist_pt->distribution_pt());
       }
       else
       {
         LinearAlgebraDistribution dist(comm_pt(), matrix_pt()->nrow(), false);
         this->build_distribution(dist);
       }
  
       // Setup the inner iteration preconditioner (For some reason we need to
       // remind the compiler that there is also a function named setup in the
       // base class.)
       Preconditioner_pt->Preconditioner::setup(matrix_pt());
  
       // setup the solverready for resolve
       unsigned max_iter = Solver_pt->max_iter();
       Solver_pt->max_iter() = 1;
       DoubleVector x(this->distribution_pt(), 0.0);
       DoubleVector y(x);
       Solver_pt->enable_resolve();
       Solver_pt->solve(matrix_pt(), x, y);
       Solver_pt->max_iter() = max_iter;
     }

References oomph::DistributableLinearAlgebraObject::build_distribution(), oomph::Preconditioner::comm_pt(), oomph::DistributableLinearAlgebraObject::distribution_pt(), oomph::Preconditioner::matrix_pt(), oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::max_iter(), oomph::DistributableLinearAlgebraObject::nrow(), oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Preconditioner_pt, oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt, plotDoE::x, and y.

◆ solver_pt()

template<class SOLVER , class PRECONDITIONER >

SOLVER* oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::solver_pt ( )

inline

     {
       return Solver_pt;
     }

References oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.

◆ tolerance()

template<class SOLVER , class PRECONDITIONER >

double& oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::tolerance ( )

inline

Access to convergence tolerance of the inner iteration solver.

     {
       return Solver_pt->tolerance();
     }

References oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt.

Member Data Documentation

◆ Preconditioner_pt

template<class SOLVER , class PRECONDITIONER >

PRECONDITIONER* oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Preconditioner_pt

private

pointer to the underlying preconditioner

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_pt

template<class SOLVER , class PRECONDITIONER >

SOLVER* oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >::Solver_pt

private

pointer to the underlying solver

The documentation for this class was generated from the following file:

general_purpose_preconditioners.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class SOLVER, class PRECONDITIONER> class oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >

Constructor & Destructor Documentation

◆ InnerIterationPreconditioner()

◆ ~InnerIterationPreconditioner()

Member Function Documentation

◆ clean_up_memory()

◆ max_iter()

◆ preconditioner_pt()

◆ preconditioner_solve()

◆ setup()

◆ solver_pt()

◆ tolerance()

Member Data Documentation

◆ Preconditioner_pt

◆ Solver_pt

template<class SOLVER, class PRECONDITIONER>
class oomph::InnerIterationPreconditioner< SOLVER, PRECONDITIONER >