Base class for Trilinos preconditioners as oomph-lib preconditioner. More...

#include <trilinos_preconditioners.h>

Inheritance diagram for oomph::TrilinosPreconditionerBase:

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

virtual	~TrilinosPreconditionerBase ()
	Destructor. More...

void	clean_up_memory ()
	deletes the preconditioner, matrices and maps More...

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

void	setup ()
	Broken assignment operator. More...

void	setup (Epetra_CrsMatrix *epetra_matrix_pt)
	Function to setup a preconditioner for the linear system defined by the oomph-lib oomph_matrix_pt and Epetra epetra_matrix_pt matrices. This method is called by Trilinos solvers. More...

void	preconditioner_solve (const DoubleVector &r, DoubleVector &z)
	applies the preconditioner More...

Epetra_Operator *&	epetra_operator_pt ()

Epetra_Operator *	epetra_operator_pt () const

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...

Static Public Attributes
static double	Cumulative_preconditioner_solve_time =0.0
	Static double that accumulates the preconditioner solve time of all instantiations of this class. Reset it manually, e.g. after every Newton solve. More...

Protected Member Functions
virtual void	setup_trilinos_preconditioner (Epetra_CrsMatrix *epetra_matrix_pt)=0
	Function to set up a specific Trilinos preconditioner. This is called by setup(...). More...

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

Protected Attributes
Epetra_Operator *	Epetra_preconditioner_pt
	The preconditioner which will be set up using function setup_trilinos_preconditioner(...) More...

Epetra_CrsMatrix *	Epetra_matrix_pt
	Pointer used to store the epetra matrix - only used when this preconditioner is setup using the oomph-lib interface. More...

Detailed Description

Base class for Trilinos preconditioners as oomph-lib preconditioner.

Definition at line 60 of file trilinos_preconditioners.h.

Constructor & Destructor Documentation

◆ TrilinosPreconditionerBase() [1/2]

oomph::TrilinosPreconditionerBase::TrilinosPreconditionerBase ( )

inline

Constructor.

Definition at line 65 of file trilinos_preconditioners.h.

References Epetra_matrix_pt, and Epetra_preconditioner_pt.

◆ ~TrilinosPreconditionerBase()

virtual oomph::TrilinosPreconditionerBase::~TrilinosPreconditionerBase ( )

inlinevirtual

Destructor.

Definition at line 73 of file trilinos_preconditioners.h.

References clean_up_memory().

◆ TrilinosPreconditionerBase() [2/2]

oomph::TrilinosPreconditionerBase::TrilinosPreconditionerBase ( const TrilinosPreconditionerBase & )

inline

Broken copy constructor.

Definition at line 96 of file trilinos_preconditioners.h.

References oomph::BrokenCopy::broken_copy(), preconditioner_solve(), and setup().

Member Function Documentation

◆ clean_up_memory()

void oomph::TrilinosPreconditionerBase::clean_up_memory ( )

inlinevirtual

deletes the preconditioner, matrices and maps

Reimplemented from oomph::Preconditioner.

Definition at line 84 of file trilinos_preconditioners.h.

References Epetra_matrix_pt, and Epetra_preconditioner_pt.

Referenced by setup(), and ~TrilinosPreconditionerBase().

◆ epetra_operator_pt() [1/2]

Epetra_Operator*& oomph::TrilinosPreconditionerBase::epetra_operator_pt ( )

inline

Access function to Epetra_preconditioner_pt. For use with TrilinosAztecOOSolver

Definition at line 131 of file trilinos_preconditioners.h.

References Epetra_preconditioner_pt.

Referenced by oomph::TrilinosAztecOOSolver::solver_setup().

◆ epetra_operator_pt() [2/2]

Epetra_Operator* oomph::TrilinosPreconditionerBase::epetra_operator_pt ( ) const

inline

Access function to Epetra_preconditioner_pt (const version) For use with TrilinosAztecOOSolver

Definition at line 138 of file trilinos_preconditioners.h.

References Epetra_preconditioner_pt, and setup_trilinos_preconditioner().

◆ preconditioner_solve()

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

virtual

applies the preconditioner

preconditioner_solve - applies the preconditioner to the vector r taking distributed oomph-lib vectors (DistributedVector<double>) as arguments.

Implements oomph::Preconditioner.

Definition at line 135 of file trilinos_preconditioners.cc.

References oomph::DoubleVector::build(), oomph::TrilinosEpetraHelpers::copy_to_oomphlib_vector(), oomph::TrilinosEpetraHelpers::create_distributed_epetra_vector(), Cumulative_preconditioner_solve_time, oomph::TrilinosMLPreconditioner::Default_n_cycles, oomph::DistributableLinearAlgebraObject::distribution_pt(), Epetra_preconditioner_pt, oomph::TrilinosMLPreconditioner::setup_trilinos_preconditioner(), and oomph::TimingHelpers::timer().

Referenced by setup(), and TrilinosPreconditionerBase().

◆ setup() [1/2]

void oomph::TrilinosPreconditionerBase::setup ( )

virtual

Broken assignment operator.

Function to set up a preconditioner for the linear system defined by matrix_pt. This function must be called before using preconditioner_solve. NOTE 1. matrix_pt must point to an object of class CRDoubleMatrix or DistributedCRDoubleMatrix This method should be called by oomph-lib solvers and preconditioners.

Function to set up a preconditioner for the linear system defined by matrix_pt. This function must be called before using preconditioner_solve. NOTE 1. matrix_pt must point to an object of class CRDoubleMatrix or DistributedCRDoubleMatrix This method should be called by oomph-lib solvers and preconditioners

Implements oomph::Preconditioner.

Definition at line 59 of file trilinos_preconditioners.cc.

References oomph::DistributableLinearAlgebraObject::build_distribution(), clean_up_memory(), oomph::TrilinosEpetraHelpers::create_distributed_epetra_matrix(), oomph::DistributableLinearAlgebraObject::distribution_pt(), Epetra_matrix_pt, oomph::Preconditioner::matrix_pt(), oomph::DoubleMatrixBase::ncol(), oomph::DoubleMatrixBase::nrow(), oomph::DistributableLinearAlgebraObject::nrow(), and setup_trilinos_preconditioner().

Referenced by oomph::TrilinosAztecOOSolver::solver_setup(), and TrilinosPreconditionerBase().

◆ setup() [2/2]

void oomph::TrilinosPreconditionerBase::setup ( Epetra_CrsMatrix * epetra_matrix_pt )

Function to setup a preconditioner for the linear system defined by the oomph-lib oomph_matrix_pt and Epetra epetra_matrix_pt matrices. This method is called by Trilinos solvers.

Definition at line 107 of file trilinos_preconditioners.cc.

References clean_up_memory(), oomph::Preconditioner::matrix_pt(), preconditioner_solve(), and setup_trilinos_preconditioner().