Public Member Functions | Private Attributes | List of all members
oomph::MatrixBasedDiagPreconditioner Class Reference

Matrix-based diagonal preconditioner. More...

#include <general_purpose_preconditioners.h>

+ Inheritance diagram for oomph::MatrixBasedDiagPreconditioner:

Public Member Functions

 MatrixBasedDiagPreconditioner ()
 Constructor (empty) More...
 
 ~MatrixBasedDiagPreconditioner ()
 Destructor (empty) More...
 
 MatrixBasedDiagPreconditioner (const MatrixBasedDiagPreconditioner &)=delete
 Broken copy constructor. More...
 
void operator= (const MatrixBasedDiagPreconditioner &)=delete
 Broken assignment operator. More...
 
void preconditioner_solve (const DoubleVector &r, DoubleVector &z)
 Apply preconditioner to z, i.e. z=D^-1. More...
 
void setup ()
 Setup the preconditioner (store diagonal) from the fully assembled matrix. More...
 
- 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)
 Apply the preconditioner. Pure virtual generic interface function. This method should apply the preconditioner operator to the vector r and return the vector z. (broken virtual) 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...
 
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 void clean_up_memory ()
 Clean up memory (empty). Generic interface function. More...
 
virtual DoubleMatrixBasematrix_pt () const
 Get function for matrix pointer. More...
 
virtual void set_matrix_pt (DoubleMatrixBase *matrix_pt)
 Set the matrix pointer. More...
 
virtual const OomphCommunicatorcomm_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 interface function for making a preconditioner a subsidiary of a block preconditioner. By default nothing is needed, but if this preconditioner is also a block preconditioner then things need to happen. There's an assumption here that the block preconditioner will be in CR form but since that assumption is hard coded all over BlockPreconditioner we're safe. More...
 
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)
 Virtual interface function for making a preconditioner a subsidiary of a block preconditioner. By default nothing is needed, but if this preconditioner is also a block preconditioner then things need to happen. Version for coarsening dof-types. More...
 
- 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...
 
LinearAlgebraDistributiondistribution_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
 if the communicator_pt is null then the distribution is not setup then false is returned, otherwise return true More...
 
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

Vector< double > Inv_diag
 Vector of inverse diagonal entries. More...
 

Additional Inherited Members

- Protected Member Functions inherited from oomph::DistributableLinearAlgebraObject
void clear_distribution ()
 clear the distribution of this distributable linear algebra object More...
 
- 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

Matrix-based diagonal preconditioner.

Definition at line 48 of file general_purpose_preconditioners.h.

Constructor & Destructor Documentation

◆ MatrixBasedDiagPreconditioner() [1/2]

oomph::MatrixBasedDiagPreconditioner::MatrixBasedDiagPreconditioner ( )
inline

Constructor (empty)

Definition at line 52 of file general_purpose_preconditioners.h.

◆ ~MatrixBasedDiagPreconditioner()

oomph::MatrixBasedDiagPreconditioner::~MatrixBasedDiagPreconditioner ( )
inline

Destructor (empty)

Definition at line 55 of file general_purpose_preconditioners.h.

◆ MatrixBasedDiagPreconditioner() [2/2]

oomph::MatrixBasedDiagPreconditioner::MatrixBasedDiagPreconditioner ( const MatrixBasedDiagPreconditioner )
delete

Broken copy constructor.

Member Function Documentation

◆ operator=()

void oomph::MatrixBasedDiagPreconditioner::operator= ( const MatrixBasedDiagPreconditioner )
delete

Broken assignment operator.

◆ preconditioner_solve()

void oomph::MatrixBasedDiagPreconditioner::preconditioner_solve ( const DoubleVector r,
DoubleVector z 
)
virtual

Apply preconditioner to z, i.e. z=D^-1.

Apply preconditioner: Multiply r by the inverse of the diagonal.

Implements oomph::Preconditioner.

Definition at line 117 of file general_purpose_preconditioners.cc.

References oomph::DoubleVector::build(), oomph::DoubleVector::built(), oomph::DistributableLinearAlgebraObject::distribution_pt(), i, Inv_diag, oomph::DistributableLinearAlgebraObject::nrow_local(), and oomph::DoubleVector::values_pt().

◆ setup()

void oomph::MatrixBasedDiagPreconditioner::setup ( )
virtual

Setup the preconditioner (store diagonal) from the fully assembled matrix.

Setup diagonal preconditioner: Store the inverse of the diagonal entries from the fully assembled matrix.

Implements oomph::Preconditioner.

Definition at line 43 of file general_purpose_preconditioners.cc.

References oomph::DistributableLinearAlgebraObject::build_distribution(), oomph::Preconditioner::comm_pt(), oomph::DistributableLinearAlgebraObject::distribution_pt(), oomph::DistributableLinearAlgebraObject::first_row(), i, Inv_diag, oomph::Preconditioner::matrix_pt(), oomph::DoubleMatrixBase::nrow(), and oomph::DistributableLinearAlgebraObject::nrow_local().

Member Data Documentation

◆ Inv_diag

Vector<double> oomph::MatrixBasedDiagPreconditioner::Inv_diag
private

Vector of inverse diagonal entries.

Definition at line 73 of file general_purpose_preconditioners.h.

Referenced by preconditioner_solve(), and setup().


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