Thyra_LinearOpBaseDecl.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_LINEAR_OP_DECL_HPP
#define THYRA_LINEAR_OP_DECL_HPP

#include "Thyra_OperatorVectorTypes.hpp"
#include "Teuchos_Describable.hpp"
#include "Teuchos_PromotionTraits.hpp"

namespace Thyra {

template<class RangeScalar, class DomainScalar>
class LinearOpBase : virtual public Teuchos::Describable {
public:


  virtual Teuchos::RefCountPtr< const VectorSpaceBase<RangeScalar> > range() const = 0;

  virtual Teuchos::RefCountPtr< const VectorSpaceBase<DomainScalar> > domain() const = 0;

  virtual void apply(
    const EConj                             conj
    ,const MultiVectorBase<DomainScalar>    &X
    ,MultiVectorBase<RangeScalar>           *Y
    ,const RangeScalar                      alpha = Teuchos::ScalarTraits<RangeScalar>::one()
    ,const RangeScalar                      beta  = Teuchos::ScalarTraits<RangeScalar>::zero()
    ) const = 0;



  virtual bool applySupports( const EConj conj ) const;

  virtual bool applyTransposeSupports( const EConj conj ) const;

  virtual void applyTranspose(
    const EConj                            conj
    ,const MultiVectorBase<RangeScalar>    &X
    ,MultiVectorBase<DomainScalar>         *Y
    ,const DomainScalar                     alpha = Teuchos::ScalarTraits<DomainScalar>::one()
    ,const DomainScalar                     beta  = Teuchos::ScalarTraits<DomainScalar>::zero()
    ) const;

  virtual Teuchos::RefCountPtr<const LinearOpBase<RangeScalar,DomainScalar> > clone() const;


};  // end class LinearOpBase


template<class Scalar>
inline bool opSupported( const LinearOpBase<Scalar> &M, ETransp M_trans )
{
  if(real_trans(M_trans)==NOTRANS)
    return M.applySupports(transToConj(M_trans));
  return M.applyTransposeSupports(transToConj(M_trans));
}

template<class RangeScalar, class DomainScalar>
inline void apply(
  const LinearOpBase<RangeScalar,DomainScalar>     &M
  ,const EConj                                     conj
  ,const MultiVectorBase<DomainScalar>             &X
  ,MultiVectorBase<RangeScalar>                    *Y
  ,const RangeScalar                               alpha
#ifndef __sun
                                                         = Teuchos::ScalarTraits<RangeScalar>::one()
#endif
  ,const RangeScalar                               beta
#ifndef __sun
                                                         = Teuchos::ScalarTraits<RangeScalar>::zero()
#endif
  )
{
  M.apply(conj,X,Y,alpha,beta);
}

#ifdef __sun

template<class RangeScalar, class DomainScalar>
inline void apply(
  const LinearOpBase<RangeScalar,DomainScalar>     &M
  ,const EConj                                     conj
  ,const MultiVectorBase<DomainScalar>             &X
  ,MultiVectorBase<RangeScalar>                    *Y
  ,const RangeScalar                               alpha
  )
{
  typedef Teuchos::ScalarTraits<RangeScalar> ST;
  apply(M,conj,X,Y,alpha,ST::zero());
}

template<class RangeScalar, class DomainScalar>
inline void apply(
  const LinearOpBase<RangeScalar,DomainScalar>     &M
  ,const EConj                                     conj
  ,const MultiVectorBase<DomainScalar>             &X
  ,MultiVectorBase<RangeScalar>                    *Y
  )
{
  typedef Teuchos::ScalarTraits<RangeScalar> ST;
  apply(M,conj,X,Y,ST::one(),ST::zero());
}

#endif // __sun

template<class RangeScalar, class DomainScalar>
inline void applyTranspose(
  const LinearOpBase<RangeScalar,DomainScalar>      &M
  ,const EConj                                      conj
  ,const MultiVectorBase<RangeScalar>               &X
  ,MultiVectorBase<DomainScalar>                    *Y
  ,const DomainScalar                               alpha
#ifndef __sun
                                                          = Teuchos::ScalarTraits<DomainScalar>::one()
#endif
  ,const DomainScalar                               beta
#ifndef __sun
                                                          = Teuchos::ScalarTraits<DomainScalar>::zero()
#endif
  )
{
  M.applyTranspose(conj,X,Y,alpha,beta);
}

#ifdef __sun

template<class RangeScalar, class DomainScalar>
inline void applyTranspose(
  const LinearOpBase<RangeScalar,DomainScalar>      &M
  ,const EConj                                      conj
  ,const MultiVectorBase<RangeScalar>               &X
  ,MultiVectorBase<DomainScalar>                    *Y
  ,const DomainScalar                               alpha
  )
{
  typedef Teuchos::ScalarTraits<DomainScalar> ST;
  applyTranspose(M,conj,X,Y,alpha,ST::zero());
}

template<class RangeScalar, class DomainScalar>
inline void applyTranspose(
  const LinearOpBase<RangeScalar,DomainScalar>      &M
  ,const EConj                                      conj
  ,const MultiVectorBase<RangeScalar>               &X
  ,MultiVectorBase<DomainScalar>                    *Y
  )
{
  typedef Teuchos::ScalarTraits<DomainScalar> ST;
  applyTranspose(M,conj,X,Y,ST::one(),ST::zero());
}

#endif

template<class Scalar>
inline void apply(
  const LinearOpBase<Scalar>        &M
  ,const ETransp                    M_trans
  ,const MultiVectorBase<Scalar>    &X
  ,MultiVectorBase<Scalar>          *Y
  ,const Scalar                     alpha
#ifndef __sun
                                          = Teuchos::ScalarTraits<Scalar>::one()
#endif
  ,const Scalar                     beta
#ifndef __sun
                                          = Teuchos::ScalarTraits<Scalar>::zero()
#endif
  )
{
  if(real_trans(M_trans)==NOTRANS) {
    M.apply(transToConj(M_trans),X,Y,alpha,beta);
  }
  else {
    M.applyTranspose(transToConj(M_trans),X,Y,alpha,beta);
  }
}

#ifdef __sun

template<class Scalar>
inline void apply(
  const LinearOpBase<Scalar>        &M
  ,const ETransp                    M_trans
  ,const MultiVectorBase<Scalar>    &X
  ,MultiVectorBase<Scalar>          *Y
  ,const Scalar                     alpha
  )
{
  apply(M,M_trans,X,Y,alpha,Teuchos::ScalarTraits<Scalar>::zero());
}

template<class Scalar>
inline void apply(
  const LinearOpBase<Scalar>        &M
  ,const ETransp                    M_trans
  ,const MultiVectorBase<Scalar>    &X
  ,MultiVectorBase<Scalar>          *Y
  )
{
  apply(M,M_trans,X,Y,Teuchos::ScalarTraits<Scalar>::one());
}

#endif


} // end namespace Thyra

#endif  // THYRA_LINEAR_OP_DECL_HPP

---