Thyra_MultiVectorStdOpsDecl.hpp

// @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_MULTI_VECTOR_STD_OPS_DECL_HPP
#define THYRA_MULTI_VECTOR_STD_OPS_DECL_HPP

#include "Thyra_OperatorVectorTypes.hpp"
#include "RTOpPack_ROpNorm1.hpp"
#include "RTOpPack_ROpNorm2.hpp"
#include "RTOpPack_ROpNormInf.hpp"

namespace Thyra {



template<class Scalar>
void norms( const MultiVectorBase<Scalar>& V, typename Teuchos::ScalarTraits<Scalar>::magnitudeType norms[] );

template<class Scalar, class NormOp>
void reductions( const MultiVectorBase<Scalar>& V, const NormOp &op, typename Teuchos::ScalarTraits<Scalar>::magnitudeType norms[] );

template<class Scalar>
void norms_1( const MultiVectorBase<Scalar>& V, typename Teuchos::ScalarTraits<Scalar>::magnitudeType norms[] );

template<class Scalar>
void norms_2( const MultiVectorBase<Scalar>& V, typename Teuchos::ScalarTraits<Scalar>::magnitudeType norms[] );

template<class Scalar>
void norms_inf( const MultiVectorBase<Scalar>& V, typename Teuchos::ScalarTraits<Scalar>::magnitudeType norms[] );

template<class Scalar>
Array<typename Teuchos::ScalarTraits<Scalar>::magnitudeType>
norms_inf( const MultiVectorBase<Scalar>& V );

template<class Scalar>
void dots( const MultiVectorBase<Scalar>& V1, const MultiVectorBase<Scalar>& V2, Scalar dots[] );

template<class Scalar>
void sums( const MultiVectorBase<Scalar>& V, Scalar sums[] );

template<class Scalar>
typename Teuchos::ScalarTraits<Scalar>::magnitudeType norm_1( const MultiVectorBase<Scalar>& V );

template<class Scalar>
void scale( Scalar alpha, MultiVectorBase<Scalar>* V );

template<class Scalar>
void scaleUpdate( const VectorBase<Scalar>& a, const MultiVectorBase<Scalar>& U, MultiVectorBase<Scalar>* V );

template<class Scalar>
void assign( MultiVectorBase<Scalar>* V, Scalar alpha );

template<class Scalar>
void assign( MultiVectorBase<Scalar>* V, const MultiVectorBase<Scalar>& U );

template<class Scalar>
void update( Scalar alpha, const MultiVectorBase<Scalar>& U, MultiVectorBase<Scalar>* V );

template<class Scalar>
void update( Scalar alpha[], Scalar beta, const MultiVectorBase<Scalar>& U, MultiVectorBase<Scalar>* V );

template<class Scalar>
void update( const MultiVectorBase<Scalar>& U, Scalar alpha[], Scalar beta, MultiVectorBase<Scalar>* V );

template<class Scalar>
void linear_combination(
  const int                         m
  ,const Scalar                     alpha[]
  ,const MultiVectorBase<Scalar>*   X[]
  ,const Scalar                     &beta
  ,MultiVectorBase<Scalar>          *Y
  );

template<class Scalar>
void randomize( Scalar l, Scalar u, MultiVectorBase<Scalar>* V );



template<class Scalar>
void Vt_S( MultiVectorBase<Scalar>* Z, const Scalar& alpha );

template<class Scalar>
void Vp_S( MultiVectorBase<Scalar>* Z, const Scalar& alpha );

template<class Scalar>
void Vp_V( MultiVectorBase<Scalar>* Z, const MultiVectorBase<Scalar>& X );

template<class Scalar>
void V_VpV( MultiVectorBase<Scalar>* Z, const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y );

template<class Scalar>
void V_VmV( MultiVectorBase<Scalar>* Z, const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y );

template<class Scalar>
void V_StVpV(
  MultiVectorBase<Scalar>* Z, const Scalar &alpha,
  const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y 
  );


} // end namespace Thyra

// /////////////////////////////////////
// Inline functions

template<class Scalar>
inline
void Thyra::norms_1( const MultiVectorBase<Scalar>& V, typename Teuchos::ScalarTraits<Scalar>::magnitudeType norms[] )
{
  reductions(V,RTOpPack::ROpNorm1<Scalar>(),norms);
}

template<class Scalar>
inline
void Thyra::norms_2( const MultiVectorBase<Scalar>& V, typename Teuchos::ScalarTraits<Scalar>::magnitudeType norms[] )
{
  reductions(V,RTOpPack::ROpNorm2<Scalar>(),norms);
}

template<class Scalar>
inline
void Thyra::norms_inf( const MultiVectorBase<Scalar>& V, typename Teuchos::ScalarTraits<Scalar>::magnitudeType norms[] )
{
  reductions(V,RTOpPack::ROpNormInf<Scalar>(),norms);
}

template<class Scalar>
Teuchos::Array<typename Teuchos::ScalarTraits<Scalar>::magnitudeType>
Thyra::norms_inf( const MultiVectorBase<Scalar>& V )
{
  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType ScalarMag;
  Array<ScalarMag> norms(V.domain()->dim());
  Thyra::norms_inf(V,&norms[0]);
  return norms;
}

#endif // THYRA_MULTI_VECTOR_STD_OPS_DECL_HPP

---