Stokhos_KroneckerProductPreconditioner.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                           Stokhos Package
//
// Copyright 2009 NTESS and the Stokhos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef STOKHOS_KRONECKER_PRODUCT_PRECONDITIONER_HPP
#define STOKHOS_KRONECKER_PRODUCT_PRECONDITIONER_HPP

#include "Teuchos_RCP.hpp"

#include "Stokhos_SGPreconditioner.hpp"
#include "EpetraExt_MultiComm.h"
#include "Stokhos_OrthogPolyBasis.hpp"
#include "Stokhos_EpetraSparse3Tensor.hpp"
#include "Epetra_Map.h"
#include "Stokhos_AbstractPreconditionerFactory.hpp"
#include "Teuchos_ParameterList.hpp"

namespace Stokhos {
    
  class KroneckerProductPreconditioner : public Stokhos::SGPreconditioner {
      
  public:

    KroneckerProductPreconditioner(
      const Teuchos::RCP<const EpetraExt::MultiComm>& sg_comm,
      const Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> >& sg_basis,
      const Teuchos::RCP<const Stokhos::EpetraSparse3Tensor>& epetraCijk,
      const Teuchos::RCP<const Epetra_Map>& base_map,
      const Teuchos::RCP<const Epetra_Map>& sg_map,
      const Teuchos::RCP<Stokhos::AbstractPreconditionerFactory>& mean_prec_factory,
      const Teuchos::RCP<Stokhos::AbstractPreconditionerFactory>& G_prec_factory,
      const Teuchos::RCP<Teuchos::ParameterList>& params);
    
    virtual ~KroneckerProductPreconditioner();


    virtual void 
    setupPreconditioner(const Teuchos::RCP<Stokhos::SGOperator>& sg_op, 
      const Epetra_Vector& x);


    
    virtual int SetUseTranspose(bool UseTranspose);
    
    virtual int Apply(const Epetra_MultiVector& Input, 
                      Epetra_MultiVector& Result) const;

    virtual int ApplyInverse(const Epetra_MultiVector& X, 
                             Epetra_MultiVector& Y) const;
    
    virtual double NormInf() const;
    
    virtual const char* Label () const;
  
    virtual bool UseTranspose() const;
    
    virtual bool HasNormInf() const;

    virtual const Epetra_Comm & Comm() const;

    virtual const Epetra_Map& OperatorDomainMap () const;

    virtual const Epetra_Map& OperatorRangeMap () const;


  protected:

    double MatrixTrace(const Epetra_CrsMatrix& A,
           const Epetra_CrsMatrix& B) const;

  private:
    
    KroneckerProductPreconditioner(const KroneckerProductPreconditioner&);
    
    KroneckerProductPreconditioner& operator=(const KroneckerProductPreconditioner&);
    
  protected:
    
    std::string label;

    Teuchos::RCP<const EpetraExt::MultiComm> sg_comm;

    Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> > sg_basis;

    Teuchos::RCP<const Stokhos::EpetraSparse3Tensor> epetraCijk;
    
    Teuchos::RCP<const Epetra_Map> base_map;

    Teuchos::RCP<const Epetra_Map> sg_map;

    Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> mean_prec_factory;

    Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> G_prec_factory;

    Teuchos::RCP<Teuchos::ParameterList> params;

    Teuchos::RCP<Epetra_Operator> mean_prec;

    Teuchos::RCP<Epetra_Operator> G_prec;

    bool useTranspose;

    Teuchos::RCP<Stokhos::SGOperator> sg_op;

    Teuchos::RCP<Stokhos::EpetraOperatorOrthogPoly > sg_poly;

    typedef Stokhos::Sparse3Tensor<int,double> Cijk_type;

    Teuchos::RCP<const Cijk_type> Cijk;
 
    Teuchos::RCP<Epetra_CrsMatrix> G;

    bool scale_op;

    bool only_use_linear;

    mutable Teuchos::RCP<Epetra_MultiVector> result_MVT;

  }; // class KroneckerProductPreconditioner
  
} // namespace Stokhos

#endif // STOKHOS_KRONECKER_PRODUCT_PRECONDITIONER_HPP