Tpetra Matrix/Vector Services Version of the Day
Tpetra_BlockMultiVector_decl.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //          Tpetra: Templated Linear Algebra Services Package
00005 //                 Copyright (2008) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef TPETRA_BLOCKMULTIVECTOR_DECL_HPP
00030 #define TPETRA_BLOCKMULTIVECTOR_DECL_HPP
00031 
00032 #include "Tpetra_BlockMap.hpp"
00033 #include "Tpetra_MultiVector.hpp"
00034 
00039 namespace Tpetra {
00040 
00046 template <class Scalar, class LocalOrdinal=int, class GlobalOrdinal=LocalOrdinal, class Node=Kokkos::DefaultNode::DefaultNodeType>
00047 class BlockMultiVector : public MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
00048  public:
00049   typedef Scalar        scalar_type;
00050   typedef LocalOrdinal  local_ordinal_type;
00051   typedef GlobalOrdinal global_ordinal_type;
00052   typedef Node          node_type;
00053 
00055 
00056 
00057   BlockMultiVector(const Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> >& blockMap, size_t NumVectors, bool zeroOut=true);
00058 
00060   ~BlockMultiVector(){}
00061 
00063 
00065 
00066 
00067   const Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> >& getBlockMap() const
00068   { return blockMap_; }
00069 
00071 
00073 
00074 
00075   //using-declaration avoids warnings about hiding inherited methods:
00076   using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::replaceGlobalValue;
00077 
00079   void replaceGlobalValue(GlobalOrdinal globalBlockRow, LocalOrdinal blockOffset, size_t vectorIndex, const Scalar &value);
00080 
00081   //using-declaration avoids warnings about hiding inherited methods:
00082   using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::replaceLocalValue;
00083 
00085   void replaceLocalValue(LocalOrdinal localBlockRow, LocalOrdinal blockOffset, size_t vectorIndex, const Scalar &value);
00086 
00087   //using-declaration avoids warnings about hiding inherited methods:
00088   using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::sumIntoGlobalValue;
00089 
00091   void sumIntoGlobalValue(GlobalOrdinal globalBlockRow, LocalOrdinal blockOffset, size_t vectorIndex, const Scalar &value);
00092 
00093   //using-declaration avoids warnings about hiding inherited methods:
00094   using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::sumIntoLocalValue;
00095 
00097   void sumIntoLocalValue(LocalOrdinal localBlockRow, LocalOrdinal blockOffset, size_t vectorIndex, const Scalar &value);
00098 
00100 
00101  private:
00102   LocalOrdinal getLocalPointIndex(GlobalOrdinal globalBlockRow, LocalOrdinal blockOffset) const;
00103   Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> > blockMap_;
00104 };//class BlockMultiVector
00105 }//namespace Tpetra
00106 
00107 #endif
00108 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines