Tpetra_Operator.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_OPERATOR_HPP
00030 #define TPETRA_OPERATOR_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 
00041 
00050   template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
00051   class Operator : virtual public Teuchos::Describable {
00052   public:
00053 
00056 
00058     virtual const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > & getDomainMap() const = 0;
00059 
00061     virtual const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > & getRangeMap() const = 0;
00062 
00064 
00069     virtual void apply(const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X, 
00070                MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y, 
00071                Teuchos::ETransp mode = Teuchos::NO_TRANS, 
00072                Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
00073                Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const = 0;
00074 
00076     virtual bool hasTransposeApply() const;
00077 
00079 
00080   };
00081 
00082   template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00083   bool Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node>::hasTransposeApply() const {
00084     return false;
00085   }
00086 
00087 } // Tpetra namespace
00088 
00089 #endif // TPETRA_OPERATOR_HPP

Generated on Tue Jul 13 09:39:07 2010 for Tpetra Matrix/Vector Services by  doxygen 1.4.7