Amesos2 - Direct Sparse Solver Interfaces Version of the Day
Amesos2_TpetraRowMatrix_AbstractMatrixAdapter_decl.hpp
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 
00045 #ifndef AMESOS2_TPETRAROWMATRIX_MATRIXADAPTER_DECL_HPP
00046 #define AMESOS2_TPETRAROWMATRIX_MATRIXADAPTER_DECL_HPP
00047 
00048 #include "Amesos2_config.h"
00049 
00050 #include <Teuchos_ArrayView.hpp>
00051 #include <Tpetra_CrsMatrix.hpp>
00052 
00053 #include "Amesos2_AbstractConcreteMatrixAdapter.hpp"
00054 #include "Amesos2_Util.hpp"
00055 
00056 namespace Amesos2 {
00057 
00058   template <class Matrix> class MatrixAdapter;
00059 
00060   using Teuchos::RCP;
00061 
00076   template <typename Scalar,
00077       typename LocalOrdinal,
00078       typename GlobalOrdinal,
00079       typename Node,
00080       class DerivedMat >
00081   class AbstractConcreteMatrixAdapter< Tpetra::RowMatrix<Scalar,
00082                LocalOrdinal,
00083                GlobalOrdinal,
00084                Node >,
00085                DerivedMat >
00086     : public MatrixAdapter< DerivedMat > {
00087   public:
00088     // Give our base class access to our private implementation functions
00089     friend class MatrixAdapter< DerivedMat >;
00090 
00091     typedef Tpetra::RowMatrix<Scalar,
00092             LocalOrdinal,
00093             GlobalOrdinal,
00094             Node >              matrix_t;
00095              
00096     typedef Scalar                                scalar_t;
00097     typedef LocalOrdinal                   local_ordinal_t;
00098     typedef GlobalOrdinal                 global_ordinal_t;
00099     typedef Node                                    node_t;
00100 
00101   private:
00102     typedef MatrixAdapter< DerivedMat >            super_t;
00103     
00104   public:
00105     typedef typename super_t::global_size_t  global_size_t;
00106 
00107     typedef AbstractConcreteMatrixAdapter<matrix_t,
00108             DerivedMat> type;
00109 
00110     typedef no_special_impl                   get_crs_spec;
00111     typedef no_special_impl                   get_ccs_spec;
00112     typedef row_access                        major_access;
00113 
00114     AbstractConcreteMatrixAdapter(RCP<matrix_t> m);
00115 
00116   public:     // these functions should technically be private
00117 
00118     // implementation functions
00119     void getGlobalRowCopy_impl(global_ordinal_t row,
00120              const Teuchos::ArrayView<global_ordinal_t>& indices,
00121              const Teuchos::ArrayView<scalar_t>& vals,
00122              size_t& nnz) const;
00123     
00124     void getGlobalColCopy_impl(global_ordinal_t col,
00125              const Teuchos::ArrayView<global_ordinal_t>& indices,
00126              const Teuchos::ArrayView<scalar_t>& vals,
00127              size_t& nnz) const;
00128 
00129     global_size_t getGlobalNNZ_impl() const;
00130 
00131     size_t getLocalNNZ_impl() const;
00132 
00133     size_t getMaxRowNNZ_impl() const;
00134 
00135     size_t getMaxColNNZ_impl() const;
00136 
00137     size_t getGlobalRowNNZ_impl(global_ordinal_t row) const;
00138 
00139     size_t getLocalRowNNZ_impl(local_ordinal_t row) const;
00140     
00141     size_t getGlobalColNNZ_impl(global_ordinal_t col) const;
00142 
00143     size_t getLocalColNNZ_impl(local_ordinal_t col) const;
00144 
00145     global_size_t getGlobalNumRows_impl() const;
00146 
00147     global_size_t getGlobalNumCols_impl() const;
00148 
00149     // Brunt of the work is put on the implementation for converting
00150     // their maps to a Tpetra::Map
00151     const RCP<const Tpetra::Map<local_ordinal_t,
00152                                          global_ordinal_t,
00153                                          node_t> >
00154     getRowMap_impl() const;
00155 
00156     const RCP<const Tpetra::Map<local_ordinal_t,
00157                           global_ordinal_t,
00158         node_t> >
00159     getColMap_impl() const;
00160 
00161     const RCP<const Teuchos::Comm<int> > getComm_impl() const;
00162 
00163     bool isLocallyIndexed_impl() const;
00164 
00165     bool isGloballyIndexed_impl() const;
00166 
00167     // Because instantiation of the subclasses could be wildly
00168     // different (cf subclasses of Tpetra::CrsMatrix), this method
00169     // hands off implementation to the adapter for the subclass
00170     RCP<const super_t> get_impl(const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > map) const;
00171 
00172   };
00173 
00174 } // end namespace Amesos2
00175 
00176 #endif  // AMESOS2_TPETRAROWMATRIX_MATRIXADAPTER_DECL_HPP