Amesos2_TpetraMultiVecAdapter_decl.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//           Amesos2: Templated Direct Sparse Solver Package
//                  Copyright 2011 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//
// @HEADER

#ifndef AMESOS2_TPETRA_MULTIVEC_ADAPTER_DECL_HPP
#define AMESOS2_TPETRA_MULTIVEC_ADAPTER_DECL_HPP

#include <Teuchos_RCP.hpp>
#include <Teuchos_Array.hpp>
#include <Teuchos_as.hpp>
#include <Tpetra_MultiVector.hpp>

#include "Amesos2_MultiVecAdapter_decl.hpp"

namespace Amesos2 {

  template< typename Scalar,
      typename LocalOrdinal,
      typename GlobalOrdinal,
      class    Node >
  class MultiVecAdapter<Tpetra::MultiVector<Scalar,
              LocalOrdinal,
              GlobalOrdinal,
              Node> >
  {
  public:

    // public type definitions
    typedef Tpetra::MultiVector<Scalar,
        LocalOrdinal,
        GlobalOrdinal,
        Node>       multivec_t;
    typedef Scalar                          scalar_t;
    typedef LocalOrdinal                    local_ordinal_t;
    typedef GlobalOrdinal                   global_ordinal_t;
    typedef Node                            node_t;
    typedef Tpetra::global_size_t           global_size_t;

    friend Teuchos::RCP<MultiVecAdapter<multivec_t> > createMultiVecAdapter<>(Teuchos::RCP<multivec_t>);
    friend Teuchos::RCP<const MultiVecAdapter<multivec_t> > createConstMultiVecAdapter<>(Teuchos::RCP<const multivec_t>);

    static const char* name;


  protected:
    // Do not allow direct construction of MultiVecAdapter's.  Only
    // allow construction throw the non-member friend functions.
    
    MultiVecAdapter( const MultiVecAdapter<multivec_t>& adapter );

    MultiVecAdapter( const Teuchos::RCP<multivec_t>& m );


  public:
    
    ~MultiVecAdapter()
    { }


    bool isLocallyIndexed() const
    {
      if(getComm()->getSize() == 1){
  return true;
      } // There may be other conditions to check
    }

    // TODO
    bool isGloballyIndexed() const;


    const Teuchos::RCP<const Tpetra::Map<
       local_ordinal_t,
       global_ordinal_t,
       node_t > >&
    getMap() const
    {
      return mv_->getMap();
    }

    const Teuchos::RCP<const Teuchos::Comm<int> >& getComm() const
    {
      return getMap()->getComm();
    }

    size_t getLocalLength() const
    {
      return Teuchos::as<size_t>(mv_->getLocalLength());
    }


    size_t getLocalNumVectors() const
    {
      return mv_->getNumVectors();
    }


    global_size_t getGlobalLength() const
    {
      // return mv_->getGlobalLength();
      return getMap()->getMaxAllGlobalIndex() + 1;
    }


    global_size_t getGlobalNumVectors() const
    {
      return Teuchos::as<global_size_t>(mv_->getNumVectors());
    }


    size_t getStride() const
    {
      return mv_->getStride();
    }


    bool isConstantStride() const
    {
      return mv_->isConstantStride();
    }


    Teuchos::RCP<const Tpetra::Vector<scalar_t,local_ordinal_t,global_ordinal_t,node_t> >
    getVector( size_t j ) const
    {
      return mv_->getVector(j);
    }


    Teuchos::RCP<Tpetra::Vector<scalar_t,local_ordinal_t,global_ordinal_t,node_t> >
    getVectorNonConst( size_t j )
    {
      return mv_->getVectorNonConst(j);
    }


    void get1dCopy( const Teuchos::ArrayView<scalar_t>& A,
        size_t lda,
        Teuchos::Ptr<
          const Tpetra::Map<local_ordinal_t,
                            global_ordinal_t,
                            node_t> > distribution_map ) const;

    Teuchos::ArrayRCP<scalar_t> get1dViewNonConst( bool local = false );

    void put1dData( const Teuchos::ArrayView<const scalar_t>& new_data,
        size_t lda,
        Teuchos::Ptr<
          const Tpetra::Map<local_ordinal_t,
                            global_ordinal_t,
                            node_t> > source_map );


    std::string description() const;


    void describe( Teuchos::FancyOStream& os,
       const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default ) const;


  private:

    Teuchos::RCP<multivec_t> mv_;


    mutable Teuchos::RCP<Tpetra::Import<local_ordinal_t,
          global_ordinal_t,
          node_t> > importer_;
    mutable Teuchos::RCP<Tpetra::Export<local_ordinal_t,
          global_ordinal_t,
          node_t> > exporter_;

    mutable Teuchos::RCP<const Tpetra::Map<local_ordinal_t,
             global_ordinal_t,
             node_t> > mv_map_;

  };                              // end class MultiVecAdapter<Tpetra::MultiVector>

} // end namespace Amesos2


#endif // AMESOS2_TPETRA_MULTIVEC_ADAPTER_DECL_HPP