Tpetra Matrix/Vector Services Version of the Day
TpetraExt_MatrixMatrix_decl.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_MATRIXMATRIX_DECL_HPP
00043 #define TPETRA_MATRIXMATRIX_DECL_HPP
00044 
00045 #include <Teuchos_RCP.hpp>
00046 #include <Teuchos_Array.hpp>
00047 #include "Tpetra_ConfigDefs.hpp"
00048 #include "Tpetra_CrsMatrix.hpp"
00049 #include "TpetraExt_MMHelpers.hpp"
00050 
00056 namespace Tpetra {
00057 
00058 namespace MatrixMatrix {
00059 
00084 template <class Scalar, 
00085            class LocalOrdinal,
00086            class GlobalOrdinal,
00087            class Node,
00088            class SpMatOps >
00089 void Multiply(
00090   const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps>& A,
00091   bool transposeA,
00092   const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps>& B,
00093   bool transposeB,
00094   CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps>& C,
00095   bool call_FillComplete_on_result=true);
00096 
00110 template <class Scalar, 
00111           class LocalOrdinal,
00112           class GlobalOrdinal,
00113           class Node,
00114           class SpMatOps >
00115 void Add(
00116   const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps>& A,
00117   bool transposeA,
00118   Scalar scalarA,
00119   CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps>& B,
00120   Scalar scalarB );
00121 
00137 template <class Scalar, 
00138           class LocalOrdinal,
00139           class GlobalOrdinal,
00140           class Node,
00141           class SpMatOps>
00142 void Add(
00143   const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps>& A,
00144   bool transposeA,
00145   Scalar scalarA,
00146   const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps>& B,
00147   bool transposeB,
00148   Scalar scalarB,
00149   RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps> > C);
00150 } //End Namespace MatrixMatrxix
00151 
00152 namespace MMdetails{
00153 
00154 template<class Scalar, 
00155          class LocalOrdinal, 
00156          class GlobalOrdinal, 
00157          class Node, 
00158          class SpMatOps>
00159 void mult_A_B(
00160   CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps>& Aview, 
00161   CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps>& Bview, 
00162   CrsWrapper<Scalar, LocalOrdinal, GlobalOrdinal, Node>& C,
00163   bool onlyCalculateStructure=false);
00164 
00165 template<class Scalar,
00166          class LocalOrdinal, 
00167          class GlobalOrdinal, 
00168          class Node,
00169          class SpMatOps>
00170 void import_and_extract_views(
00171   const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps>& M,
00172   RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > targetMap,
00173   CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps>& Mview);
00174 
00175 template<class Scalar,
00176          class LocalOrdinal, 
00177          class GlobalOrdinal, 
00178          class Node,
00179          class SpMatOps>
00180 void setMaxNumEntriesPerRow(
00181   CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps>& Mview);
00182   
00183 }//end namespace MMdetails
00184 
00185 } // end of Tpetra namespace
00186 
00187 #endif // TPETRA_MATRIXMATRIX_DECL_HPP
00188 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines