An interface to allow SuperLU to be used as an (exact) Preconditioner. More...

#include <SuperLU_preconditioner.h>

Inheritance diagram for oomph::SuperLUPreconditioner:

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

	~SuperLUPreconditioner ()
	Destructor. More...

	SuperLUPreconditioner (const SuperLUPreconditioner &)
	Broken copy constructor. More...

void	operator= (const SuperLUPreconditioner &)
	Broken assignment operator. More...

void	setup ()
	Function to set up a preconditioner for the linear system defined by matrix_pt. This function must be called before using preconditioner_solve. Note: matrix_pt must point to an object of class CRDoubleMatrix or CCDoubleMatrix. More...

void	preconditioner_solve (const DoubleVector &r, DoubleVector &z)
	Function applies SuperLU to vector r for (exact) preconditioning, this requires a call to setup(...) first. More...

virtual void	clean_up_memory ()
	Clean up memory – forward the call to the version in SuperLU in its LinearSolver incarnation. More...

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

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

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

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

void	setup (DoubleMatrixBase *matrix_pt)
	Setup the preconditioner: store the matrix pointer and the communicator pointer then call preconditioner specific setup() function. More...

void	setup (const Problem problem_pt, DoubleMatrixBase matrix_pt)
	Compatability layer for old preconditioners where problem pointers were needed. The problem pointer is only used to get a communicator pointer. 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)
	Broken copy constructor. More...

void	operator= (const DistributableLinearAlgebraObject &)
	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)
	setup the distribution of this distributable linear algebra object More...

void	build_distribution (const LinearAlgebraDistribution &dist)
	setup the distribution of this distributable linear algebra object More...

Private Attributes
SuperLUSolver	Solver
	the SuperLU solver emplyed by this preconditioner More...

Additional Inherited Members
Protected Member Functions inherited from oomph::DistributableLinearAlgebraObject
void	clear_distribution ()
	clear the distribution of this distributable linear algebra object More...

Detailed Description

An interface to allow SuperLU to be used as an (exact) Preconditioner.

Definition at line 44 of file SuperLU_preconditioner.h.

Constructor & Destructor Documentation

◆ SuperLUPreconditioner() [1/2]

oomph::SuperLUPreconditioner::SuperLUPreconditioner ( )

inline

Constructor.

Definition at line 49 of file SuperLU_preconditioner.h.

References oomph::SuperLUSolver::disable_doc_stats(), oomph::LinearSolver::disable_doc_time(), and Solver.

◆ ~SuperLUPreconditioner()

oomph::SuperLUPreconditioner::~SuperLUPreconditioner ( )

inline

Destructor.

Definition at line 56 of file SuperLU_preconditioner.h.

◆ SuperLUPreconditioner() [2/2]

oomph::SuperLUPreconditioner::SuperLUPreconditioner ( const SuperLUPreconditioner & )

inline

Broken copy constructor.

Definition at line 60 of file SuperLU_preconditioner.h.

References oomph::BrokenCopy::broken_copy().

Member Function Documentation

◆ clean_up_memory()

virtual void oomph::SuperLUPreconditioner::clean_up_memory ( )

inlinevirtual

Clean up memory – forward the call to the version in SuperLU in its LinearSolver incarnation.

Reimplemented from oomph::Preconditioner.

Definition at line 114 of file SuperLU_preconditioner.h.

References oomph::SuperLUSolver::clean_up_memory(), and Solver.

◆ operator=()

void oomph::SuperLUPreconditioner::operator= ( const SuperLUPreconditioner & )

inline

Broken assignment operator.

Definition at line 67 of file SuperLU_preconditioner.h.

References oomph::BrokenCopy::broken_assign().

◆ preconditioner_solve()

void oomph::SuperLUPreconditioner::preconditioner_solve	(	const DoubleVector &	r,
		DoubleVector &	z
	)

inlinevirtual

Function applies SuperLU to vector r for (exact) preconditioning, this requires a call to setup(...) first.

Implements oomph::Preconditioner.

Definition at line 105 of file SuperLU_preconditioner.h.

References oomph::SuperLUSolver::resolve(), and Solver.

◆ setup()

void oomph::SuperLUPreconditioner::setup ( )

inlinevirtual

Function to set up a preconditioner for the linear system defined by matrix_pt. This function must be called before using preconditioner_solve. Note: matrix_pt must point to an object of class CRDoubleMatrix or CCDoubleMatrix.

Implements oomph::Preconditioner.

Definition at line 77 of file SuperLU_preconditioner.h.

References oomph::DistributableLinearAlgebraObject::build_distribution(), oomph::DistributableLinearAlgebraObject::distribution_pt(), oomph::SuperLUSolver::factorise(), oomph::Preconditioner::matrix_pt(), oomph::oomph_info, and Solver.

Referenced by oomph::PseudoElasticPreconditioner::setup(), oomph::ExactSubBiharmonicPreconditioner::setup(), oomph::InexactSubBiharmonicPreconditioner::setup(), oomph::PseudoElasticPreconditionerOld::setup(), oomph::PseudoElasticPreconditionerSubsidiaryPreconditionerOld::setup(), and oomph::SimpleFSIPreconditioner< MATRIX >::setup().