Tpetra Matrix/Vector Services Version of the Day
Tpetra_BlockMultiVector_def.hpp
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_DEF_HPP
00043 #define TPETRA_BLOCKMULTIVECTOR_DEF_HPP
00044 
00045 #include "Tpetra_ConfigDefs.hpp"
00046 
00047 namespace Tpetra {
00048 
00049 template<class Scalar,class LocalOrdinal,class GlobalOrdinal,class Node>
00050 BlockMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::BlockMultiVector(const Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> >& blockMap, size_t NumVectors, bool zeroOut)
00051  : MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>(blockMap->getPointMap(), NumVectors, zeroOut),
00052    blockMap_(blockMap)
00053 {
00054 }
00055 
00056 template<class Scalar,class LocalOrdinal,class GlobalOrdinal,class Node>
00057 LocalOrdinal BlockMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::getLocalPointIndex(GlobalOrdinal globalBlockRow, LocalOrdinal blockOffset) const
00058 {
00059   LocalOrdinal LBID = blockMap_->getLocalBlockID(globalBlockRow);
00060 
00061   TEUCHOS_TEST_FOR_EXCEPTION( LBID == Teuchos::OrdinalTraits<LocalOrdinal>::invalid(), std::runtime_error, "Tpetra::BlockMultiVector::getLocalPointIndex ERROR: specified globalBlockRow not found in local block-map.");
00062 
00063   LocalOrdinal blkSize = blockMap_->getLocalBlockSize(LBID);
00064 
00065   TEUCHOS_TEST_FOR_EXCEPTION( blockOffset >= blkSize, std::runtime_error,
00066      "Tpetra::BlockMultiVector::getLocalPointIndex ERROR: specified blockOffset >= blockSize.");
00067 
00068   LocalOrdinal pointIndex = blockMap_->getFirstLocalPointInLocalBlock(LBID);
00069 
00070   return pointIndex + blockOffset;
00071 }
00072 
00073 template<class Scalar,class LocalOrdinal,class GlobalOrdinal,class Node>
00074 void
00075 BlockMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::replaceGlobalValue(GlobalOrdinal globalBlockRow, LocalOrdinal blockOffset, size_t vectorIndex, const Scalar &value)
00076 {
00077   LocalOrdinal pointIndex = getLocalPointIndex(globalBlockRow, blockOffset);
00078 
00079   replaceLocalValue(pointIndex, vectorIndex, value);
00080 }
00081 
00082 template<class Scalar,class LocalOrdinal,class GlobalOrdinal,class Node>
00083 void
00084 BlockMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::replaceLocalValue(LocalOrdinal localBlockRow, LocalOrdinal blockOffset, size_t vectorIndex, const Scalar &value)
00085 {
00086   LocalOrdinal pointIndex = blockMap_->getFirstLocalPointInLocalBlock(localBlockRow);
00087 
00088   replaceLocalValue(pointIndex+blockOffset, vectorIndex, value);
00089 }
00090 
00091 template<class Scalar,class LocalOrdinal,class GlobalOrdinal,class Node>
00092 void
00093 BlockMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::sumIntoGlobalValue(GlobalOrdinal globalBlockRow, LocalOrdinal blockOffset, size_t vectorIndex, const Scalar &value)
00094 {
00095   LocalOrdinal pointIndex = getLocalPointIndex(globalBlockRow, blockOffset);
00096 
00097   sumIntoLocalValue(pointIndex, vectorIndex, value);
00098 }
00099 
00100 template<class Scalar,class LocalOrdinal,class GlobalOrdinal,class Node>
00101 void
00102 BlockMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>::sumIntoLocalValue(LocalOrdinal localBlockRow, LocalOrdinal blockOffset, size_t vectorIndex, const Scalar &value)
00103 {
00104   LocalOrdinal pointIndex = blockMap_->getFirstLocalPointInLocalBlock(localBlockRow);
00105 
00106   sumIntoLocalValue(pointIndex+blockOffset, vectorIndex, value);
00107 }
00108 
00109 //
00110 // Explicit instantiation macro
00111 //
00112 // Must be expanded from within the Tpetra namespace!
00113 //
00114 
00115 #define TPETRA_BLOCKMULTIVECTOR_INSTANT(SCALAR,LO,GO,NODE) \
00116   \
00117   template class BlockMultiVector< SCALAR , LO , GO , NODE >;
00118 
00119 }//namespace Tpetra
00120 
00121 #endif
00122 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines