Tpetra parallel linear algebra  Version of the Day
Tpetra_Operator.hpp
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 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ************************************************************************
40 // @HEADER
41 
42 #ifndef TPETRA_OPERATOR_HPP
43 #define TPETRA_OPERATOR_HPP
44 
46 #include <Teuchos_Describable.hpp>
47 #include <Teuchos_BLAS_types.hpp>
48 #include <Teuchos_ScalarTraits.hpp>
49 
50 namespace Tpetra {
79  template <class Scalar = Details::DefaultTypes::scalar_type,
80  class LocalOrdinal = Details::DefaultTypes::local_ordinal_type,
81  class GlobalOrdinal = Details::DefaultTypes::global_ordinal_type,
83  class Operator : virtual public Teuchos::Describable {
84  public:
87 
89  typedef Scalar scalar_type;
90 
92  typedef LocalOrdinal local_ordinal_type;
93 
95  typedef GlobalOrdinal global_ordinal_type;
96 
98  typedef Node node_type;
99 
101 
103 
105  virtual Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > getDomainMap() const = 0;
106 
108  virtual Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > getRangeMap() const = 0;
109 
111 
116  virtual void
119  Teuchos::ETransp mode = Teuchos::NO_TRANS,
120  Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
121  Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const = 0;
122 
129  virtual bool hasTransposeApply() const;
130 
132  };
133 
134  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
136  return false;
137  }
138 
139 } // Tpetra namespace
140 
141 #endif // TPETRA_OPERATOR_HPP
Namespace Tpetra contains the class and methods constituting the Tpetra library.
Scalar scalar_type
The type of the entries of the input and output multivectors.
Node node_type
The Kokkos Node type.
KokkosClassic::DefaultNode::DefaultNodeType node_type
Default value of Node template parameter.
virtual bool hasTransposeApply() const
Whether this operator supports applying the transpose or conjugate transpose.
One or more distributed dense vectors.
virtual void apply(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const =0
Computes the operator-multivector application.
virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const =0
The Map associated with the range of this operator, which must be compatible with Y...
int local_ordinal_type
Default value of LocalOrdinal template parameter.
Declaration of the Tpetra::MultiVector class.
Abstract interface for operators (e.g., matrices and preconditioners).
virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const =0
The Map associated with the domain of this operator, which must be compatible with X...
GlobalOrdinal global_ordinal_type
The global index type.
double scalar_type
Default value of Scalar template parameter.
LocalOrdinal local_ordinal_type
The local index type.