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 the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00038 // 
00039 // ************************************************************************
00040 // @HEADER
00041 
00042 #ifndef TPETRA_BLOCKMULTIVECTOR_DECL_HPP
00043 #define TPETRA_BLOCKMULTIVECTOR_DECL_HPP
00044 
00045 #include "Tpetra_BlockMap.hpp"
00046 #include "Tpetra_MultiVector.hpp"
00047 
00052 namespace Tpetra {
00053 
00059 template <class Scalar, class LocalOrdinal=int, class GlobalOrdinal=LocalOrdinal, class Node=KokkosClassic::DefaultNode::DefaultNodeType>
00060 class BlockMultiVector : public MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
00061 public:
00062   typedef Scalar        scalar_type;
00063   typedef LocalOrdinal  local_ordinal_type;
00064   typedef GlobalOrdinal global_ordinal_type;
00065   typedef Node          node_type;
00066 
00068 
00069 
00070   BlockMultiVector(const Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> >& blockMap, size_t NumVectors, bool zeroOut=true);
00071 
00073   ~BlockMultiVector(){}
00074 
00076 
00078 
00079 
00080   Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> > getBlockMap() const
00081   { return blockMap_; }
00082 
00084 
00086 
00087 
00088   //using-declaration avoids warnings about hiding inherited methods:
00089   using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::replaceGlobalValue;
00090 
00092   void replaceGlobalValue(GlobalOrdinal globalBlockRow, LocalOrdinal blockOffset, size_t vectorIndex, const Scalar &value);
00093 
00094   //using-declaration avoids warnings about hiding inherited methods:
00095   using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::replaceLocalValue;
00096 
00098   void replaceLocalValue(LocalOrdinal localBlockRow, LocalOrdinal blockOffset, size_t vectorIndex, const Scalar &value);
00099 
00100   //using-declaration avoids warnings about hiding inherited methods:
00101   using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::sumIntoGlobalValue;
00102 
00104   void sumIntoGlobalValue(GlobalOrdinal globalBlockRow, LocalOrdinal blockOffset, size_t vectorIndex, const Scalar &value);
00105 
00106   //using-declaration avoids warnings about hiding inherited methods:
00107   using MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::sumIntoLocalValue;
00108 
00110   void sumIntoLocalValue(LocalOrdinal localBlockRow, LocalOrdinal blockOffset, size_t vectorIndex, const Scalar &value);
00111 
00113 
00114  private:
00115   LocalOrdinal getLocalPointIndex(GlobalOrdinal globalBlockRow, LocalOrdinal blockOffset) const;
00116   Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> > blockMap_;
00117 };//class BlockMultiVector
00118 }//namespace Tpetra
00119 
00120 #endif
00121 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines