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

//////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////// More...

#include <mumps_solver.h>

+ Inheritance diagram for oomph::NewMumpsPreconditioner:

Public Member Functions

 NewMumpsPreconditioner ()
 Constructor. More...
 
 ~NewMumpsPreconditioner ()
 Destructor. More...
 
 NewMumpsPreconditioner (const NewMumpsPreconditioner &)=delete
 Broken copy constructor. More...
 
void operator= (const NewMumpsPreconditioner &)=delete
 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 Mumps to vector r for (exact) preconditioning, this requires a call to setup(...) first. More...
 
void clean_up_memory ()
 Clean up memory – forward the call to the version in Mumps in its LinearSolver incarnation. More...
 
void enable_doc_time ()
 Enable documentation of timings. More...
 
void disable_doc_time ()
 Disable the documentation of timings. 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 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

MumpsSolver Solver
 the Mumps 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...
 
- 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

//////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////

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

Definition at line 337 of file mumps_solver.h.

Constructor & Destructor Documentation

◆ NewMumpsPreconditioner() [1/2]

oomph::NewMumpsPreconditioner::NewMumpsPreconditioner ( )
inline

Constructor.

Definition at line 341 of file mumps_solver.h.

◆ ~NewMumpsPreconditioner()

oomph::NewMumpsPreconditioner::~NewMumpsPreconditioner ( )
inline

Destructor.

Definition at line 344 of file mumps_solver.h.

◆ NewMumpsPreconditioner() [2/2]

oomph::NewMumpsPreconditioner::NewMumpsPreconditioner ( const NewMumpsPreconditioner )
delete

Broken copy constructor.

Member Function Documentation

◆ clean_up_memory()

void oomph::NewMumpsPreconditioner::clean_up_memory ( )
inlinevirtual

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

Reimplemented from oomph::Preconditioner.

Definition at line 391 of file mumps_solver.h.

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

◆ disable_doc_time()

void oomph::NewMumpsPreconditioner::disable_doc_time ( )
inline

Disable the documentation of timings.

Definition at line 404 of file mumps_solver.h.

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

◆ enable_doc_time()

void oomph::NewMumpsPreconditioner::enable_doc_time ( )
inline

Enable documentation of timings.

Definition at line 398 of file mumps_solver.h.

References oomph::LinearSolver::enable_doc_time(), and Solver.

◆ operator=()

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

Broken assignment operator.

◆ preconditioner_solve()

void oomph::NewMumpsPreconditioner::preconditioner_solve ( const DoubleVector r,
DoubleVector z 
)
inlinevirtual

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

Implements oomph::Preconditioner.

Definition at line 383 of file mumps_solver.h.

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

◆ setup()

void oomph::NewMumpsPreconditioner::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 357 of file mumps_solver.h.

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

Member Data Documentation

◆ Solver

MumpsSolver oomph::NewMumpsPreconditioner::Solver
private

the Mumps solver emplyed by this preconditioner

Definition at line 411 of file mumps_solver.h.

Referenced by clean_up_memory(), disable_doc_time(), enable_doc_time(), preconditioner_solve(), and setup().


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