BelosMatOrthoManager.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                 Belos: Block Linear Solvers Package
//
// Copyright 2004-2016 NTESS and the Belos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef BELOS_MATORTHOMANAGER_HPP
#define BELOS_MATORTHOMANAGER_HPP

#include "BelosConfigDefs.hpp"
#include "BelosTypes.hpp"
#include "BelosOrthoManager.hpp"
#include "BelosMultiVecTraits.hpp"
#include "BelosOperatorTraits.hpp"

namespace Belos {

  template <class ScalarType, class MV, class OP>
  class MatOrthoManager : public OrthoManager<ScalarType,MV> {
  protected:
    Teuchos::RCP<const OP> _Op;
    bool _hasOp;

  public:

    MatOrthoManager(Teuchos::RCP<const OP> Op = Teuchos::null) : _Op(Op), _hasOp(Op!=Teuchos::null) {};

    virtual ~MatOrthoManager() {};



    void setOp( Teuchos::RCP<const OP> Op ) {
      _Op = Op;
      _hasOp = (_Op != Teuchos::null);
    };

    Teuchos::RCP<const OP> getOp() const { return _Op; }





    void innerProd( const MV& X, const MV& Y,
                                  Teuchos::SerialDenseMatrix<int,ScalarType>& Z ) const {
      typedef Teuchos::ScalarTraits<ScalarType> SCT;
      typedef MultiVecTraits<ScalarType,MV>     MVT;
      typedef OperatorTraits<ScalarType,MV,OP>  OPT;

      Teuchos::RCP<const MV> P,Q;
      Teuchos::RCP<MV> R;

      if (_hasOp) {
        // attempt to minimize the amount of work in applying
        if ( MVT::GetNumberVecs(X) < MVT::GetNumberVecs(Y) ) {
          R = MVT::Clone(X,MVT::GetNumberVecs(X));
          OPT::Apply(*_Op,X,*R);
          P = R;
          Q = Teuchos::rcp( &Y, false );
        }
        else {
          P = Teuchos::rcp( &X, false );
          R = MVT::Clone(Y,MVT::GetNumberVecs(Y));
          OPT::Apply(*_Op,Y,*R);
          Q = R;
        }
      }
      else {
        P = Teuchos::rcp( &X, false );
        Q = Teuchos::rcp( &Y, false );
      }

      MVT::MvTransMv(SCT::one(),*P,*Q,Z);
    }

    void innerProd( const MV& X, const MV& Y, Teuchos::RCP<const MV> MY,
                            Teuchos::SerialDenseMatrix<int,ScalarType>& Z ) const {
      typedef Teuchos::ScalarTraits<ScalarType> SCT;
      typedef MultiVecTraits<ScalarType,MV>     MVT;

      Teuchos::RCP<MV> P,Q;

      if ( MY == Teuchos::null ) {
        innerProd(X,Y,Z);
      }
      else if ( _hasOp ) {
        // the user has done the matrix vector for us
        MVT::MvTransMv(SCT::one(),X,*MY,Z);
      }
      else {
        // there is no matrix vector
        MVT::MvTransMv(SCT::one(),X,Y,Z);
      }
    }

    void norm( const MV& X, std::vector< typename Teuchos::ScalarTraits<ScalarType>::magnitudeType >& normvec ) const {
      norm(X,Teuchos::null,normvec);
    }

    void
    norm (const MV& X,
          Teuchos::RCP<const MV> MX,
          std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType>& normvec) const
    {
      typedef Teuchos::ScalarTraits<ScalarType> SCT;
      typedef Teuchos::ScalarTraits<typename SCT::magnitudeType> MT;
      typedef MultiVecTraits<ScalarType,MV>     MVT;
      typedef OperatorTraits<ScalarType,MV,OP>  OPT;
      
      int nvecs = MVT::GetNumberVecs(X);
      
      // Make sure that normvec has enough entries to hold the norms
      // of all the columns of X.  std::vector<T>::size_type is
      // unsigned, so do the appropriate cast to avoid signed/unsigned
      // comparisons that trigger compiler warnings.
      if (normvec.size() < static_cast<size_t>(nvecs))
        normvec.resize (nvecs);
      
      if (!_hasOp) {
        // X == MX, since the operator M is the identity.
        MX = Teuchos::rcp(&X, false);
        MVT::MvNorm(X, normvec);
      }
      else {
        // The caller didn't give us a previously computed MX, so
        // apply the operator.  We assign to MX only after applying
        // the operator, so that if the application fails, MX won't be
        // modified.
        if(MX == Teuchos::null) {
          Teuchos::RCP<MV> tempVec = MVT::Clone(X,nvecs);
          OPT::Apply(*_Op,X,*tempVec);
          MX = tempVec;
        }
        else {
          // The caller gave us a previously computed MX.  Make sure
          // that it has at least as many columns as X.
          const int numColsMX = MVT::GetNumberVecs(*MX);
          TEUCHOS_TEST_FOR_EXCEPTION(numColsMX < nvecs, std::invalid_argument,
                             "MatOrthoManager::norm(X, MX, normvec): "
                             "MX has fewer columns than X: "
                             "MX has " << numColsMX << " columns, "
                             "and X has " << nvecs << " columns.");
        }
        
        std::vector<ScalarType> dotvec(nvecs);
        MVT::MvDot(X,*MX,dotvec);
        for (int i=0; i<nvecs; i++) {
          normvec[i] = MT::squareroot( SCT::magnitude(dotvec[i]) );
        }
      }
    }


    virtual void project ( MV &X, Teuchos::RCP<MV> MX,
                           Teuchos::Array<Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > > C,
                           Teuchos::ArrayView<Teuchos::RCP<const MV> > Q) const = 0;



    virtual void project ( MV &X,
                           Teuchos::Array<Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > > C,
                           Teuchos::ArrayView<Teuchos::RCP<const MV> > Q) const {
      project(X,Teuchos::null,C,Q);
    }

    virtual int normalize ( MV &X, Teuchos::RCP<MV> MX,
                            Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > B ) const = 0;


    virtual int normalize ( MV &X, Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > B ) const {
      return normalize(X,Teuchos::null,B);
    }


  protected:
    virtual int
    projectAndNormalizeWithMxImpl (MV &X,
                                   Teuchos::RCP<MV> MX,
                                   Teuchos::Array<Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > > C,
                                   Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > B,
                                   Teuchos::ArrayView<Teuchos::RCP<const MV> > Q) const = 0;

    virtual int
    projectAndNormalizeImpl (MV &X,
                             Teuchos::Array<Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > > C,
                             Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > B,
                             Teuchos::ArrayView<Teuchos::RCP<const MV> > Q) const
    {
      return this->projectAndNormalizeWithMxImpl (X, Teuchos::null, C, B, Q);
    }

  public:

    int
    projectAndNormalize (MV &X,
                         Teuchos::RCP<MV> MX,
                         Teuchos::Array<Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > > C,
                         Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > B,
                         Teuchos::ArrayView<Teuchos::RCP<const MV> > Q) const
    {
      return this->projectAndNormalizeWithMxImpl (X, MX, C, B, Q);
    }



    virtual typename Teuchos::ScalarTraits<ScalarType>::magnitudeType
    orthonormError(const MV &X) const {
      return orthonormError(X,Teuchos::null);
    }

    virtual typename Teuchos::ScalarTraits<ScalarType>::magnitudeType
    orthonormError(const MV &X, Teuchos::RCP<const MV> MX) const = 0;

    virtual typename Teuchos::ScalarTraits<ScalarType>::magnitudeType
    orthogError(const MV &X1, const MV &X2) const {
      return orthogError(X1,Teuchos::null,X2);
    }

    virtual typename Teuchos::ScalarTraits<ScalarType>::magnitudeType
    orthogError(const MV &X1, Teuchos::RCP<const MV> MX1, const MV &X2) const = 0;


  };

} // end of Belos namespace


#endif

// end of file BelosMatOrthoManager.hpp