Tpetra Matrix/Vector Services Version of the Day
Tpetra_Operator.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //          Tpetra: Templated Linear Algebra Services Package
00005 //                 Copyright (2008) Sandia Corporation
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
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 #ifndef TPETRA_OPERATOR_HPP
00043 #define TPETRA_OPERATOR_HPP
00044 
00045 #include <Kokkos_DefaultNode.hpp>
00046 #include <Teuchos_Describable.hpp>
00047 #include <Teuchos_BLAS_types.hpp>
00048 #include <Teuchos_ScalarTraits.hpp>
00049 
00050 namespace Tpetra {
00051   //
00052   // Forward declarations.  The "doxygen" bit simply tells Doxygen
00053   // (our automatic documentation generation system) to skip forward
00054   // declarations.
00055   //
00056 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00057   template<class LocalOrdinal, class GlobalOrdinal, class Node>
00058   class Map;
00059 
00060   template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00061   class MultiVector;
00062 #endif // DOXYGEN_SHOULD_SKIP_THIS
00063 
00065 
00074   template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
00075   class Operator : virtual public Teuchos::Describable {
00076   public:
00079 
00081     typedef Scalar scalar_type;
00082 
00084     typedef LocalOrdinal local_ordinal_type;
00085 
00087     typedef GlobalOrdinal global_ordinal_type;
00088 
00090     typedef Node node_type;
00091 
00093 
00095 
00097     virtual Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > getDomainMap() const = 0;
00098 
00100     virtual Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > getRangeMap() const = 0;
00101 
00103 
00108     virtual void
00109     apply (const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X,
00110      MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
00111      Teuchos::ETransp mode = Teuchos::NO_TRANS,
00112      Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
00113      Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const = 0;
00114 
00121     virtual bool hasTransposeApply() const;
00122 
00124   };
00125 
00126   template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00127   bool Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node>::hasTransposeApply() const {
00128     return false;
00129   }
00130 
00131 } // Tpetra namespace
00132 
00133 #endif // TPETRA_OPERATOR_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines