// @HEADER // ***************************************************************************** // Stokhos Package // // Copyright 2009 NTESS and the Stokhos contributors. // SPDX-License-Identifier: BSD-3-Clause // ***************************************************************************** // @HEADER #ifndef STOKHOS_MP_BLOCK_DIAGONAL_PRECONDITIONER_HPP #define STOKHOS_MP_BLOCK_DIAGONAL_PRECONDITIONER_HPP #include "Teuchos_RCP.hpp" #include "Stokhos_MPPreconditioner.hpp" #include "EpetraExt_MultiComm.h" #include "Epetra_Map.h" #include "Stokhos_AbstractPreconditionerFactory.hpp" #include "Teuchos_ParameterList.hpp" #include "Teuchos_Array.hpp" namespace Stokhos { /*! * \brief A multi-point preconditioner based on applying the inverse of the * diagonal. */ class MPBlockDiagonalPreconditioner : public Stokhos::MPPreconditioner { public: //! Constructor MPBlockDiagonalPreconditioner( const Teuchos::RCP& mp_comm, int num_mp_blocks, const Teuchos::RCP& base_map, const Teuchos::RCP& mp_map, const Teuchos::RCP& prec_factory, const Teuchos::RCP& params); //! Destructor virtual ~MPBlockDiagonalPreconditioner(); /** \name Stokhos::MPPreconditioner methods */ //@{ //! Setup preconditioner virtual void setupPreconditioner( const Teuchos::RCP& mp_op, const Epetra_Vector& x); //@} /** \name Epetra_Operator methods */ //@{ //! Set to true if the transpose of the operator is requested virtual int SetUseTranspose(bool UseTranspose); /*! * \brief Returns the result of a Epetra_Operator applied to a * Epetra_MultiVector Input in Result as described above. */ virtual int Apply(const Epetra_MultiVector& Input, Epetra_MultiVector& Result) const; /*! * \brief Returns the result of the inverse of the operator applied to a * Epetra_MultiVector Input in Result as described above. */ virtual int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const; //! Returns an approximate infinity norm of the operator matrix. virtual double NormInf() const; //! Returns a character string describing the operator virtual const char* Label () const; //! Returns the current UseTranspose setting. virtual bool UseTranspose() const; /*! * \brief Returns true if the \e this object can provide an * approximate Inf-norm, false otherwise. */ virtual bool HasNormInf() const; /*! * \brief Returns a reference to the Epetra_Comm communicator * associated with this operator. */ virtual const Epetra_Comm & Comm() const; /*! * \brief Returns the Epetra_Map object associated with the * domain of this matrix operator. */ virtual const Epetra_Map& OperatorDomainMap () const; /*! * \brief Returns the Epetra_Map object associated with the * range of this matrix operator. */ virtual const Epetra_Map& OperatorRangeMap () const; //@} private: //! Private to prohibit copying MPBlockDiagonalPreconditioner(const MPBlockDiagonalPreconditioner&); //! Private to prohibit copying MPBlockDiagonalPreconditioner& operator=(const MPBlockDiagonalPreconditioner&); protected: //! Label for operator std::string label; //! Stores MP parallel communicator Teuchos::RCP mp_comm; //! Number of mp blocks int num_mp_blocks; //! Stores base map Teuchos::RCP base_map; //! Stores MP map Teuchos::RCP mp_map; //! Stores factory for building mean preconditioner Teuchos::RCP prec_factory; //! Stores preconditioner for each block Teuchos::Array< Teuchos::RCP > block_precs; //! Flag indicating whether transpose was selected bool useTranspose; }; // class MPBlockDiagonalPreconditioner } // namespace Stokhos #endif // STOKHOS_MP_BLOCK_DIAGONAL_PRECONDITIONER_HPP