Ifpack2 Templated Preconditioning Package Version 1.0
Ifpack2_BorderedOperator_decl.hpp
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 //-----------------------------------------------------
00044 // Ifpack2::BorderedOperator is a translation of the
00045 // LOCA_BorderedSolver_EpetraHouseholder
00046 // implementation written by Eric Phipps.
00047 // DMD.
00048 //------------------------------------------------------
00049 
00050 
00051 #ifndef IFPACK2_BORDEREDOPERATOR_DECL_HPP
00052 #define IFPACK2_BORDEREDOPERATOR_DECL_HPP
00053 
00054 #include "Ifpack2_ConfigDefs.hpp"
00055 #include "Kokkos_DefaultNode.hpp"
00056 
00057 #include "Tpetra_Operator.hpp"
00058 #include "Teuchos_ParameterList.hpp"
00059 #include "Teuchos_ScalarTraits.hpp"
00060 #include <iostream>
00061 
00062 namespace Ifpack2 {
00064 
00086 template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType >
00087 class BorderedOperator : 
00088     virtual public Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node > {
00089 public:
00091   BorderedOperator (const Teuchos::RCP<const Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node> >& A);
00092 
00094   virtual ~BorderedOperator() {}
00095 
00097 
00098 
00100   virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > getDomainMap() const;
00101 
00103   virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > getRangeMap() const;
00104 
00106   bool hasTransposeApply() const;
00107 
00109   void
00110   apply (const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X, 
00111    Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y, 
00112    Teuchos::ETransp mode = Teuchos::NO_TRANS,
00113    Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
00114    Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const;
00116 
00117 private:
00119   Teuchos::RCP<const Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> > A_;
00120 };
00121 
00122 }//namespace Ifpack2
00123 
00124 #endif // IFPACK2_BORDEREDOPERATOR_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends