Tpetra Matrix/Vector Services Version of the Day
Tpetra_CrsMatrixSolveOp_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_CRSMATRIXSOLVEOP_HPP
00043 #define TPETRA_CRSMATRIXSOLVEOP_HPP
00044 
00045 #include <Kokkos_DefaultNode.hpp>
00046 #include <Kokkos_DefaultKernels.hpp>
00047 #include "Tpetra_ConfigDefs.hpp"
00048 #include "Tpetra_Operator.hpp"
00049 #include "Tpetra_CrsMatrix.hpp"
00050 
00056 namespace Tpetra {
00057 
00094   template <class Scalar, 
00095       class MatScalar = Scalar, 
00096       class LocalOrdinal = int, 
00097       class GlobalOrdinal = LocalOrdinal, 
00098       class Node = KokkosClassic::DefaultNode::DefaultNodeType, 
00099       class LocalMatOps = typename KokkosClassic::DefaultKernels<MatScalar,LocalOrdinal,Node>::SparseOps>
00100   class CrsMatrixSolveOp : public Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
00101   public:
00103 
00104 
00106     CrsMatrixSolveOp (const Teuchos::RCP<const CrsMatrix<MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> > &A);
00107 
00109     virtual ~CrsMatrixSolveOp();
00110 
00112 
00113 
00114 
00117     void
00118     apply (const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> & X, 
00119      MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y, 
00120      Teuchos::ETransp mode = Teuchos::NO_TRANS, 
00121      Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(), 
00122      Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const;
00123 
00125     bool hasTransposeApply() const;
00126 
00129     Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > getDomainMap() const;
00130 
00133     Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > getRangeMap() const;
00134 
00136   protected:
00137     typedef MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> MV;
00138 
00140     const Teuchos::RCP<const CrsMatrix<MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> > matrix_;
00141 
00143     mutable Teuchos::RCP<MV> importMV_;
00145     mutable Teuchos::RCP<MV> exportMV_;
00146 
00148     void 
00149     applyNonTranspose (const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> & X, 
00150            MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y) const;
00152     void 
00153     applyTranspose (const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> & X, 
00154         MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y) const;
00155   };
00156 
00161   template <class Scalar, class MatScalar, class LocalOrdinal, class GlobalOrdinal, class Node, class LocalMatOps>
00162   Teuchos::RCP< CrsMatrixSolveOp<Scalar,MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> >
00163   createCrsMatrixSolveOp(const Teuchos::RCP<const CrsMatrix<MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> > &A);
00164 
00165 } // end of namespace Tpetra
00166 
00167 #endif // TPETRA_CRSMATRIXSOLVEOP_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines