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// Tpetra: Templated Linear Algebra Services Package
4//
5// Copyright 2008 NTESS and the Tpetra contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef TPETRA_APPLYOP_HPP
11#define TPETRA_APPLYOP_HPP
12
13#include "Tpetra_ConfigDefs.hpp"
14#include "Tpetra_Operator.hpp"
15#include "Tpetra_MultiVector.hpp"
16
19
20namespace Tpetra {
21namespace details {
22
45template <class Scalar, class OperatorType>
46class ApplyOp : public Tpetra::Operator<Scalar,
47 typename OperatorType::local_ordinal_type,
48 typename OperatorType::global_ordinal_type,
49 typename OperatorType::node_type> {
50 public:
51 // \name Typedefs
53
55 typedef typename OperatorType::scalar_type scalar_type;
56
58 typedef typename OperatorType::local_ordinal_type local_ordinal_type;
59
61 typedef typename OperatorType::global_ordinal_type global_ordinal_type;
62
64 typedef typename OperatorType::node_type node_type;
65
67
69
73 ApplyOp(const Teuchos::RCP<const OperatorType>& op)
74 : operator_(op) {}
75
77 virtual ~ApplyOp() {}
78
80
82
88 void
91 Teuchos::ETransp mode = Teuchos::NO_TRANS,
92 Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
93 Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const {
95 }
96
102 bool hasTransposeApply() const {
103 return operator_->hasTransposeApply();
104 }
105
107 Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> >
108 getDomainMap() const {
109 return operator_->getDomainMap();
110 }
111
113 Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> >
114 getRangeMap() const {
115 return operator_->getRangeMap();
116 }
118
119 protected:
121 Teuchos::RCP<const OperatorType> operator_;
122};
123
124} // end of namespace details
125} // end of namespace Tpetra
126
127#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.