Ifpack2 Templated Preconditioning Package Version 1.0
Ifpack2_Container.hpp
Go to the documentation of this file.
00001 /*@HEADER
00002 // ***********************************************************************
00003 //
00004 //       Ifpack2: Tempated Object-Oriented Algebraic Preconditioner Package
00005 //                 Copyright (2009) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
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 
00043 #ifndef IFPACK2_CONTAINER_HPP
00044 #define IFPACK2_CONTAINER_HPP
00045 
00048 
00049 #include <Ifpack2_ConfigDefs.hpp>
00050 #include <Tpetra_RowMatrix.hpp>
00051 #include <Teuchos_ParameterList.hpp>
00052 #include <Teuchos_Describable.hpp>
00053 #include <iostream>
00054 
00055 namespace Ifpack2 {
00056 
00100 template<class MatrixType>
00101 class Container : public Teuchos::Describable {
00102 public:
00103   typedef typename MatrixType::scalar_type          scalar_type;
00104   typedef typename MatrixType::local_ordinal_type   local_ordinal_type;
00105   typedef typename MatrixType::global_ordinal_type  global_ordinal_type;
00106   typedef typename MatrixType::node_type            node_type;
00107 
00108   typedef Tpetra::RowMatrix<scalar_type, local_ordinal_type, global_ordinal_type, node_type> row_matrix_type;
00109 
00121   Container (const Teuchos::RCP<const row_matrix_type>& matrix,
00122              const Teuchos::ArrayView<const local_ordinal_type>& localRows) :
00123     inputMatrix_ (matrix),
00124     localRows_ (localRows.begin (), localRows.end ())
00125   {
00126     TEUCHOS_TEST_FOR_EXCEPTION(
00127       matrix.is_null (), std::invalid_argument, "Ifpack2::Container: "
00128       "The constructor's input matrix must be non-null.");
00129   }
00130 
00132   virtual ~Container() {};
00133 
00142   Teuchos::RCP<const row_matrix_type> getMatrix() const {
00143     return inputMatrix_;
00144   }
00145 
00147   virtual size_t getNumRows() const = 0;
00148 
00164   Teuchos::ArrayView<const local_ordinal_type> getLocalRows () const {
00165     return localRows_ ();
00166   }
00167 
00176   virtual void initialize () = 0;
00177 
00183   virtual void compute () = 0;
00184 
00186   virtual void setParameters (const Teuchos::ParameterList& List) = 0;
00187 
00189   virtual bool isInitialized () const = 0;
00190 
00192   virtual bool isComputed () const = 0;
00193 
00206   virtual void
00207   apply (const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
00208          Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
00209          Teuchos::ETransp mode = Teuchos::NO_TRANS,
00210          scalar_type alpha = Teuchos::ScalarTraits<scalar_type>::one (),
00211          scalar_type beta = Teuchos::ScalarTraits<scalar_type>::zero ()) const = 0;
00212 
00233   virtual void
00234   weightedApply (const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
00235                  Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
00236                  const Tpetra::Vector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& D,
00237                  Teuchos::ETransp mode = Teuchos::NO_TRANS,
00238                  scalar_type alpha = Teuchos::ScalarTraits<scalar_type>::one (),
00239                  scalar_type beta = Teuchos::ScalarTraits<scalar_type>::zero ()) const = 0;
00240 
00242   virtual std::ostream& print (std::ostream& os) const = 0;
00243 
00244 private:
00246   Teuchos::RCP<const row_matrix_type> inputMatrix_;
00247 
00249   Teuchos::Array<local_ordinal_type> localRows_;
00250 };
00251 
00253 template <class MatrixType>
00254 inline std::ostream&
00255 operator<< (std::ostream& os, const Ifpack2::Container<MatrixType>& obj)
00256 {
00257   return obj.print (os);
00258 }
00259 
00260 }
00261 
00262 #endif // IFPACK2_CONTAINER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends