Tpetra_InverseOperator.hpp

00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //          Tpetra: Templated Linear Algebra Services Package
00005 //                 Copyright (2008) 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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef TPETRA_INVERSEOPERATOR_HPP
00030 #define TPETRA_INVERSEOPERATOR_HPP
00031 
00032 #include <Kokkos_DefaultNode.hpp>
00033 #include <Teuchos_Describable.hpp>
00034 #include <Teuchos_RCP.hpp>
00035 #include "Tpetra_Map.hpp"
00036 #include "Tpetra_MultiVector.hpp"
00037 
00038 namespace Tpetra {
00039 
00040   // forward declaration
00041   template <class S, class LO, class GO, class N>
00042   class Operator;
00043 
00045 
00057   template <class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
00058   class InverseOperator : virtual public Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
00059   public:
00060 
00063 
00065     virtual void applyInverse(const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X, 
00066                MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y, 
00067                Teuchos::ETransp mode = Teuchos::NO_TRANS) const = 0;
00068 
00070     virtual bool hasTransposeApplyInverse() const;
00071 
00073 
00074   };
00075 
00076   template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00077   bool InverseOperator<Scalar,LocalOrdinal,GlobalOrdinal,Node>::hasTransposeApplyInverse() const {
00078     return false;
00079   }
00080 
00081 } // Tpetra namespace
00082 
00083 #endif // TPETRA_INVERSEOPERATOR_HPP

Generated on Wed May 12 21:40:14 2010 for Tpetra Matrix/Vector Services by  doxygen 1.4.7