Tpetra parallel linear algebra Version of the Day
Loading...
Searching...
No Matches
Tpetra_ApplyOp.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Tpetra: Templated Linear Algebra Services Package
5// Copyright (2008) Sandia Corporation
6//
7// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8// the U.S. Government retains certain rights in this software.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// ************************************************************************
38// @HEADER
39
40#ifndef TPETRA_APPLYOP_HPP
41#define TPETRA_APPLYOP_HPP
42
43#include "Tpetra_ConfigDefs.hpp"
44#include "Tpetra_Operator.hpp"
45#include "Tpetra_MultiVector.hpp"
46
49
50namespace Tpetra {
51 namespace details {
52
75 template <class Scalar, class OperatorType>
76 class ApplyOp :
77 public Tpetra::Operator<Scalar,
78 typename OperatorType::local_ordinal_type,
79 typename OperatorType::global_ordinal_type,
80 typename OperatorType::node_type> {
81 public:
82 // \name Typedefs
84
86 typedef typename OperatorType::scalar_type scalar_type;
87
89 typedef typename OperatorType::local_ordinal_type local_ordinal_type;
90
92 typedef typename OperatorType::global_ordinal_type global_ordinal_type;
93
95 typedef typename OperatorType::node_type node_type;
96
98
100
104 ApplyOp (const Teuchos::RCP<const OperatorType> &op) : operator_(op)
105 {}
106
108 virtual ~ApplyOp () {}
109
111
113
119 void
122 Teuchos::ETransp mode = Teuchos::NO_TRANS,
123 Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
124 Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const
125 {
127 }
128
129
135 bool hasTransposeApply() const {
136 return operator_->hasTransposeApply ();
137 }
138
140 Teuchos::RCP<const Tpetra::Map<local_ordinal_type,global_ordinal_type,node_type> >
141 getDomainMap () const {
142 return operator_->getDomainMap ();
143 }
144
146 Teuchos::RCP<const Tpetra::Map<local_ordinal_type,global_ordinal_type,node_type> >
147 getRangeMap () const {
148 return operator_->getRangeMap ();
149 }
151
152 protected:
154 Teuchos::RCP<const OperatorType> operator_;
155 };
156
157 } // end of namespace details
158} // end of namespace Tpetra
159
160#endif // TPETRA_APPLYOP_HPP
Struct that holds views of the contents of a CrsMatrix.
Abstract interface for operators (e.g., matrices and preconditioners).
A class for wrapping an Operator apply in a Operator.
virtual ~ApplyOp()
Destructor.
ApplyOp(const Teuchos::RCP< const OperatorType > &op)
Constructor.
OperatorType::global_ordinal_type global_ordinal_type
The type of global indices in the input OperatorType.
Teuchos::RCP< const OperatorType > operator_
The underlying Operator object.
OperatorType::scalar_type scalar_type
The type of the entries of the input OperatorType.
OperatorType::local_ordinal_type local_ordinal_type
The type of local indices in the input OperatorType.
void apply(const Tpetra::MultiVector< Scalar, local_ordinal_type, global_ordinal_type, node_type > &X, Tpetra::MultiVector< Scalar, local_ordinal_type, global_ordinal_type, node_type > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const
Compute Y = beta*Y + alpha*Op(A)*X, where Op(A) is either A, , or .
Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > > getDomainMap() const
The domain Map of this Operator.
Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > > getRangeMap() const
The range Map of this Operator.
bool hasTransposeApply() const
Whether this Operator's apply() method can apply the transpose or conjugate transpose.
OperatorType::node_type node_type
The type of the Kokkos Node used by the input OperatorType.
Namespace Tpetra contains the class and methods constituting the Tpetra library.