libtrilinos-nox-dev 12.10.1-3 / usr / include / trilinos / Anasazi_LOCA_MultiVecTraits.H

// $Id$
// $Source$

//@HEADER
// ************************************************************************
//
//            LOCA: Library of Continuation Algorithms Package
//                 Copyright (2005) 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.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roger Pawlowski (rppawlo@sandia.gov) or
// Eric Phipps (etphipp@sandia.gov), Sandia National Laboratories.
// ************************************************************************
//  CVS Information
//  $Source$
//  $Author$
//  $Date$
//  $Revision$
// ************************************************************************
//@HEADER

#ifndef ANASAZI_LOCA_MULTIVECTRAITS_H
#define ANASAZI_LOCA_MULTIVECTRAITS_H

// Anasazi includes
#include "AnasaziMultiVecTraits.hpp"

// NOX/LOCA includes
#include "NOX_Abstract_MultiVector.H"

namespace Anasazi {

  /*!
   * \brief Implementation of the Anasazi::MultiVecTraits for
   * NOX::Abstract::MultiVectors.
   */
  /*!
   * This class provides an implementation of the Anasazi::MultiVecTraits class
   * for NOX::Abstract::MultiVector's, to be used in conjunction with the
   * Anasazi::LOCA::Matrix class.
   */
  template <>
  class MultiVecTraits<double,NOX::Abstract::MultiVector> {
  public:

    //! Synony for double
    typedef double ScalarType;

    //! Synonym for NOX::Abstract::MultiVector
    typedef NOX::Abstract::MultiVector MV;

    //@{ \name Creation methods

    /*!
     * \brief Creates a new empty \c MV containing \c numvecs columns.
     *
     * \return Reference-counted pointer to the new multivector of type \c MV.
     */
    static Teuchos::RCP<MV> Clone( const MV& mv, const int numvecs )
    {
      return mv.clone(numvecs);
    }

    /*!
     * \brief Creates a new \c MV and copies contents of \c mv into the new
     * vector (deep copy).
     *
     * \return Reference-counted pointer to the new multivector of type \c MV.
     */
    static Teuchos::RCP<MV> CloneCopy( const MV& mv )
    {
      return mv.clone(NOX::DeepCopy);
    }

    /*!
     * \brief Creates a new \c MV and copies the selected contents of \c mv
     * into the new vector (deep copy).
     *
     * The copied vectors from \c mv are indicated by the \c index.size()
     * indices in \c index.
     * \return Reference-counted pointer to the new multivector of type \c MV.
     */
    static Teuchos::RCP<MV> CloneCopy( const MV& mv,
                           const std::vector<int>& index )
    {
      return mv.subCopy(index);
    }

    /*!
     * \brief Creates a new \c MV that shares the selected contents of
     * \c mv (shallow copy).
     *
     * The index of the \c numvecs vectors shallow copied from \c mv are
     * indicated by the indices given in \c index.
     * \return Reference-counted pointer to the new multivector of type \c MV.
     */
    static Teuchos::RCP<MV> CloneViewNonConst( MV& mv,
                           const std::vector<int>& index )
    {
      return mv.subView(index);
    }

    /*!
     * \brief Creates a new const \c MV that shares the selected contents of
     * \c mv (shallow copy).
     *
     * The index of the \c numvecs vectors shallow copied from \c mv are
     * indicated by the indices given in \c index.
     * \return Reference-counted pointer to the new const multivector of
     * type \c MV.
     */
    static Teuchos::RCP<const MV> CloneView( const MV& mv,
                             const std::vector<int>& index )
    {
      return mv.subView(index).getConst();
    }

    //@}

    //@{ \name Attribute methods

    //! Obtain the vector length of \c mv.
    static ptrdiff_t GetGlobalLength( const MV& mv )
    {
      return mv.length();
    }

    //! Obtain the number of vectors in \c mv
    static int GetNumberVecs( const MV& mv )
    {
      return mv.numVectors();
    }

    //@}

    //@{ \name Update methods

    /*!
     * \brief Update \c mv with \f$ \alpha AB + \beta mv \f$.
     */
    static void MvTimesMatAddMv( const ScalarType alpha, const MV& A,
                 const Teuchos::SerialDenseMatrix<int,ScalarType>& B,
                 const ScalarType beta, MV& mv )
    {
      mv.update(Teuchos::NO_TRANS, alpha, A, B, beta);
    }

    /*!
     * \brief Replace \c mv with \f$\alpha A + \beta B\f$.
     */
    static void MvAddMv( const ScalarType alpha, const MV& A,
             const ScalarType beta, const MV& B, MV& mv )
    {
      mv.update(alpha, A, beta, B);
    }

    /*!
     * \brief Compute a dense matrix \c B through the matrix-matrix multiply
     * \f$ \alpha A^Hmv \f$.
     */
    static void MvTransMv( const ScalarType alpha, const MV& A, const MV& mv,
               Teuchos::SerialDenseMatrix<int,ScalarType>& B)
    {
      mv.multiply(alpha, A, B);
    }

    /*!
     * \brief Compute a vector \c b where the components are the individual
     * dot-products of the \c i-th columns of \c A and \c mv, i.e.
     * \f$b[i] = A[i]^Hmv[i]\f$.
     */
    static void MvDot ( const MV& mv, const MV& A,
            std::vector<ScalarType> &b)
    {
      for (unsigned int i=0; i<b.size(); i++)
        b[i] = A[i].innerProduct(mv[i]);
    }

    /*!
     * \brief Scale each element of the vectors in \c *this with \c alpha.
     */
    static void MvScale ( MV& mv, const ScalarType alpha )
    {
      mv.scale(alpha);
    }

    /*!
     * \brief Scale each element of the \c i-th vector in \c *this with
     * \c alpha[i].
     */
    static void MvScale ( MV& mv, const std::vector<ScalarType>& alpha )
    {
      for (unsigned int i=0; i<alpha.size(); i++)
    mv[i].scale(alpha[i]);
    }

    //@}
    //@{ \name Norm method

    /*!
     * \brief Compute the 2-norm of each individual vector of \c mv.
     * Upon return, \c normvec[i] holds the value of \f$||mv_i||_2\f$,
     * the \c i-th column of \c mv.
     */
    static void MvNorm( const MV& mv,
            std::vector<double> &normvec )
    {
      mv.norm(normvec);
    }

    //@}

    //@{ \name Initialization methods

    /*!
     * \brief Copy the vectors in \c A to a set of vectors in \c mv indicated
     * by the indices given in \c index.
     *
     * The \c numvecs vectors in \c A are copied to a subset of vectors in
     * \c mv indicated by the indices given in \c index,
     * i.e.<tt> mv[index[i]] = A[i]</tt>.
     */
    static void SetBlock( const MV& A, const std::vector<int>& index, MV& mv )
    {
      mv.setBlock(A, index);
    }

    /*!
     * \brief Replace the vectors in \c mv with random vectors.
     */
    static void MvRandom( MV& mv )
    {
      mv.random();
    }

    /*!
     * \brief Replace each element of the vectors in \c mv with \c alpha.
     */
    static void MvInit( MV& mv,
            const ScalarType alpha = 0.0 )
    {
      mv.init(alpha);
    }

    //@}

    //@{ \name Print method

    /*!
     * \brief Print the \c mv multi-vector to the \c os output stream.
     */
    static void MvPrint( const MV& mv, std::ostream& os )
    {
      mv.print(os);
    }

    //@}
  }; // class MultiVecTraits
} // namespace Anasazi

#endif