Amesos2 - Direct Sparse Solver Interfaces Version of the Day
Amesos2_TpetraCrsMatrix_MatrixAdapter_decl.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 //
00003 // ***********************************************************************
00004 //
00005 //           Amesos2: Templated Direct Sparse Solver Package 
00006 //                  Copyright 2011 Sandia Corporation
00007 //
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00039 //
00040 // ***********************************************************************
00041 //
00042 // @HEADER
00043 
00044 
00055 #ifndef AMESOS2_TPETRACRSMATRIX_MATRIXADAPTER_DECL_HPP
00056 #define AMESOS2_TPETRACRSMATRIX_MATRIXADAPTER_DECL_HPP
00057 
00058 #include "Amesos2_config.h"
00059 
00060 #include "Amesos2_TpetraRowMatrix_AbstractMatrixAdapter_decl.hpp"
00061 #include "Amesos2_MatrixAdapter_decl.hpp"
00062 
00063 namespace Amesos2 {
00064 
00077   template <typename Scalar,
00078             typename LocalOrdinal,
00079             typename GlobalOrdinal,
00080             typename Node,
00081             typename LocalMatOps >
00082   class ConcreteMatrixAdapter<Tpetra::CrsMatrix<Scalar,
00083                                                 LocalOrdinal,
00084                                                 GlobalOrdinal,
00085                                                 Node,
00086                                                 LocalMatOps> >
00087     : public AbstractConcreteMatrixAdapter<Tpetra::RowMatrix<Scalar,
00088                                                              LocalOrdinal,
00089                                                              GlobalOrdinal,
00090                                                              Node>,
00091                                            Tpetra::CrsMatrix<Scalar,
00092                                                              LocalOrdinal,
00093                                                              GlobalOrdinal,
00094                                                              Node,
00095                                                              LocalMatOps> >
00096   {
00097     // Give our matrix adapter class access to our private
00098     // implementation functions
00099     friend class MatrixAdapter<Tpetra::RowMatrix<Scalar,        
00100                                                  LocalOrdinal,
00101                                                  GlobalOrdinal,
00102                                                  Node> >;
00103   public:
00104     typedef Tpetra::CrsMatrix<Scalar,
00105                               LocalOrdinal,
00106                               GlobalOrdinal,
00107                               Node,
00108                               LocalMatOps>             matrix_t;
00109   private:
00110     typedef AbstractConcreteMatrixAdapter<
00111       Tpetra::RowMatrix<Scalar,
00112                         LocalOrdinal,
00113                         GlobalOrdinal,
00114                         Node>, matrix_t>                super_t;
00115   public:
00116     // 'import' superclass types
00117     typedef typename super_t::scalar_t                 scalar_t;
00118     typedef typename super_t::local_ordinal_t   local_ordinal_t;
00119     typedef typename super_t::global_ordinal_t global_ordinal_t;
00120     typedef typename super_t::node_t                     node_t;
00121     typedef typename super_t::global_size_t       global_size_t;
00122     
00123     typedef LocalMatOps                         local_mat_ops_t;
00124     
00125     typedef ConcreteMatrixAdapter<matrix_t>                type;
00126     
00127     ConcreteMatrixAdapter(RCP<matrix_t> m);
00128     
00129     RCP<const MatrixAdapter<matrix_t> > get_impl(const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > map) const;
00130     
00131   };
00132 
00133 } // end namespace Amesos2
00134 
00135 #endif  // AMESOS2_TPETRACRSMATRIX_MATRIXADAPTER_DECL_HPP