Tpetra Matrix/Vector Services Version of the Day
Tpetra_ApplyOp.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_APPLYOP_HPP
00043 #define TPETRA_APPLYOP_HPP
00044 
00045 #include "Tpetra_ConfigDefs.hpp"
00046 #include "Tpetra_Operator.hpp"
00047 #include "Tpetra_MultiVector.hpp"
00048 
00051 
00052 namespace Tpetra {
00053   namespace details {
00054 
00077     template <class Scalar, class OperatorType>
00078     class ApplyOp :
00079       public Tpetra::Operator<Scalar,
00080             typename OperatorType::local_ordinal_type,
00081             typename OperatorType::global_ordinal_type,
00082             typename OperatorType::node_type> {
00083     public:
00084       // \name Typedefs
00086 
00088       typedef typename OperatorType::scalar_type scalar_type;
00089 
00091       typedef typename OperatorType::local_ordinal_type local_ordinal_type;
00092 
00094       typedef typename OperatorType::global_ordinal_type global_ordinal_type;
00095 
00097       typedef typename OperatorType::node_type node_type;
00098 
00100       typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType magnitude_type;
00101 
00103 
00104 
00105 
00109       ApplyOp (const Teuchos::RCP<const OperatorType> &op) : operator_(op) 
00110       {}
00111 
00113       virtual ~ApplyOp () {}
00114 
00116 
00117 
00118 
00124       void
00125       apply (const Tpetra::MultiVector<Scalar,local_ordinal_type,global_ordinal_type,node_type>& X,
00126        Tpetra::MultiVector<Scalar,local_ordinal_type,global_ordinal_type,node_type>& Y,
00127        Teuchos::ETransp mode = Teuchos::NO_TRANS,
00128        Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
00129        Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const
00130       {
00131   operator_->template applyTempl<Scalar,Scalar> (X, Y, mode, alpha, beta);
00132       }
00133 
00134 
00140       bool hasTransposeApply() const {
00141   return operator_->hasTransposeApply ();
00142       }
00143 
00145       Teuchos::RCP<const Tpetra::Map<local_ordinal_type,global_ordinal_type,node_type> > 
00146       getDomainMap () const {
00147   return operator_->getDomainMap ();
00148       }
00149 
00151       Teuchos::RCP<const Tpetra::Map<local_ordinal_type,global_ordinal_type,node_type> > 
00152       getRangeMap () const {
00153   return operator_->getRangeMap ();
00154       }
00156 
00157     protected:
00159       Teuchos::RCP<const OperatorType> operator_;
00160     };
00161 
00162   } // end of namespace details
00163 } // end of namespace Tpetra
00164 
00165 #endif // TPETRA_APPLYOP_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines