GEOS
Classes | Public Types | Public Member Functions | List of all members
geos::MultiscalePreconditioner< LAI > Class Template Reference

Multiscale preconditioner for near-elliptic and coupled problems. More...

#include <MultiscalePreconditioner.hpp>

Inheritance diagram for geos::MultiscalePreconditioner< LAI >:
Inheritance graph
[legend]

Public Types

using Base = PreconditionerBase< LAI >
 Alias for base type.
 
using Vector = typename Base::Vector
 Alias for vector type.
 
using Matrix = typename Base::Matrix
 Alias for matrix type.
 
using Operator = LinearOperator< Vector >
 Alias for operator type.
 
- Public Types inherited from geos::PreconditionerBase< LAI >
using Base = LinearOperator< typename LAI::ParallelVector >
 Alias for base type.
 
using Vector = typename Base::Vector
 Alias for vector type.
 
using Matrix = typename LAI::ParallelMatrix
 Alias for matrix type.
 
- Public Types inherited from geos::LinearOperator< LAI::ParallelVector >
using Vector = LAI::ParallelVector
 Alias for template parameter.
 

Public Member Functions

 MultiscalePreconditioner (LinearSolverParameters params, DomainPartition &domain)
 Constructor. More...
 
virtual void setup (Matrix const &mat) override
 Compute the preconditioner from a matrix. More...
 
virtual void apply (Vector const &src, Vector &dst) const override
 Apply operator to a vector, dst = this(src). More...
 
virtual void clear () override
 Clean up the preconditioner setup. More...
 
- Public Member Functions inherited from geos::PreconditionerBase< LAI >
virtual globalIndex numGlobalRows () const override
 Get the number of global rows. More...
 
virtual globalIndex numGlobalCols () const override
 Get the number of global columns. More...
 
virtual localIndex numLocalRows () const override
 Get the number of local rows. More...
 
virtual localIndex numLocalCols () const override
 Get the number of local columns. More...
 
virtual MPI_Comm comm () const override
 Get the MPI communicator the matrix was created with. More...
 
bool ready () const
 Chech if preconditioner is ready to use. More...
 
Matrix const & matrix () const
 Access the matrix the preconditioner was computed from. More...
 
virtual bool hasPreconditionerMatrix () const
 Check whether the preconditioner is available in matrix (explicit) form. More...
 
virtual Matrix const & preconditionerMatrix () const
 Access the preconditioner in matrix form (whenever available). It must be overridden by the specific preconditioner. More...
 
- Public Member Functions inherited from geos::LinearOperator< LAI::ParallelVector >
 LinearOperator ()=default
 Constructor.
 
virtual ~LinearOperator ()=default
 Destructor.
 
virtual void apply (Vector const &src, Vector &dst) const=0
 Apply operator to a vector, dst = this(src). More...
 
virtual void residual (Vector const &x, Vector const &b, Vector &r) const
 Compute residual r = b - this(x). More...
 
virtual globalIndex numGlobalNonzeros () const
 
virtual localIndex numLocalNonzeros () const
 

Detailed Description

template<typename LAI>
class geos::MultiscalePreconditioner< LAI >

Multiscale preconditioner for near-elliptic and coupled problems.

Template Parameters
LAIlinear algebra interface type

Definition at line 42 of file MultiscalePreconditioner.hpp.

Constructor & Destructor Documentation

◆ MultiscalePreconditioner()

template<typename LAI >
geos::MultiscalePreconditioner< LAI >::MultiscalePreconditioner ( LinearSolverParameters  params,
DomainPartition domain 
)

Constructor.

Parameters
paramslinear solver parameters
domainphysical domain

Member Function Documentation

◆ apply()

template<typename LAI >
virtual void geos::MultiscalePreconditioner< LAI >::apply ( Vector const &  src,
Vector dst 
) const
overridevirtual

Apply operator to a vector, dst = this(src).

Parameters
srcinput vector
dstoutput vector
Warning
src and dst cannot alias the same vector (some implementations may allow this).

◆ clear()

template<typename LAI >
virtual void geos::MultiscalePreconditioner< LAI >::clear ( )
overridevirtual

Clean up the preconditioner setup.

Releases memory used and allows the matrix to be deleted cleanly. This method should be called before the matrix used to compute the preconditioner goes out of scope or is re-created. Some implementations require the matrix to outlive the preconditioner (for example, Trilinos/ML may crash the program if deleted after the matrix).

Note
Should be properly overridden in derived classes, which may call this method.

Reimplemented from geos::PreconditionerBase< LAI >.

◆ setup()

template<typename LAI >
virtual void geos::MultiscalePreconditioner< LAI >::setup ( Matrix const &  mat)
overridevirtual

Compute the preconditioner from a matrix.

Parameters
matthe matrix to precondition.

Reimplemented from geos::PreconditionerBase< LAI >.


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