A class for wrapping an Operator of one Scalar type into an Operator of another Scalar type. More...
#include <Tpetra_MixedScalarMultiplyOp.hpp>
Public Types | |
| using | op_type = Operator< OpScalar, LocalOrdinal, GlobalOrdinal, Node > |
| The specialization of CrsMatrix which this class wraps. | |
| using | map_type = Map< LocalOrdinal, GlobalOrdinal, Node > |
| The specialization of Map which this class uses. | |
Typedefs that give access to the template parameters. | |
| typedef Scalar | scalar_type |
| The type of the entries of the input and output multivectors. | |
| typedef LocalOrdinal | local_ordinal_type |
| The local index type. | |
| typedef GlobalOrdinal | global_ordinal_type |
| The global index type. | |
| typedef Node | node_type |
| The Kokkos Node type. | |
Public Member Functions | |
Constructor and destructor | |
| MixedScalarMultiplyOp (const Teuchos::RCP< const op_type > &A) | |
| Constructor. | |
| ~MixedScalarMultiplyOp () override=default | |
| Destructor (virtual for memory safety of derived classes). | |
Related Symbols | |
(Note that these are not member symbols.) | |
| template<class Scalar , class OpScalar , class LocalOrdinal , class GlobalOrdinal , class Node > | |
| Teuchos::RCP< MixedScalarMultiplyOp< Scalar, OpScalar, LocalOrdinal, GlobalOrdinal, Node > > | createMixedScalarMultiplyOp (const Teuchos::RCP< const Operator< OpScalar, LocalOrdinal, GlobalOrdinal, Node > > &A) |
| Non-member function to create a MixedScalarMultiplyOp. | |
Methods implementing Operator | |
| const Teuchos::RCP< const op_type > | op_ |
| The underlying CrsMatrix object. | |
| 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 override |
Compute Y = beta*Y + alpha*Op(A)*X, where Op(A) is either A,   | |
| bool | hasTransposeApply () const override |
| Whether this Operator's apply() method can apply the transpose or conjugate transpose. | |
| Teuchos::RCP< const map_type > | getDomainMap () const override |
| The domain Map of this Operator. | |
| Teuchos::RCP< const map_type > | getRangeMap () const override |
| The range Map of this Operator. | |
Detailed Description
class Tpetra::MixedScalarMultiplyOp< Scalar, OpScalar, LocalOrdinal, GlobalOrdinal, Node >
A class for wrapping an Operator of one Scalar type into an Operator of another Scalar type.
- Template Parameters
-
Scalar The type of the entries of the input and output MultiVector (see apply()). Same as the first template parameter of Operator. OpScalar The type of the entries of the wrapped Operator. LocalOrdinal The second template parameter of Operator. GlobalOrdinal The third template parameter of Operator. Node The fourth template parameter of Operator.
Definition at line 76 of file Tpetra_MixedScalarMultiplyOp.hpp.
Member Typedef Documentation
◆ op_type
| using Tpetra::MixedScalarMultiplyOp< Scalar, OpScalar, LocalOrdinal, GlobalOrdinal, Node >::op_type = Operator<OpScalar, LocalOrdinal, GlobalOrdinal, Node> |
The specialization of CrsMatrix which this class wraps.
Definition at line 81 of file Tpetra_MixedScalarMultiplyOp.hpp.
◆ map_type
| using Tpetra::MixedScalarMultiplyOp< Scalar, OpScalar, LocalOrdinal, GlobalOrdinal, Node >::map_type = Map<LocalOrdinal, GlobalOrdinal, Node> |
The specialization of Map which this class uses.
Definition at line 84 of file Tpetra_MixedScalarMultiplyOp.hpp.
◆ scalar_type
|
inherited |
The type of the entries of the input and output multivectors.
Definition at line 92 of file Tpetra_Operator.hpp.
◆ local_ordinal_type
|
inherited |
The local index type.
Definition at line 95 of file Tpetra_Operator.hpp.
◆ global_ordinal_type
|
inherited |
The global index type.
Definition at line 98 of file Tpetra_Operator.hpp.
◆ node_type
|
inherited |
The Kokkos Node type.
Definition at line 101 of file Tpetra_Operator.hpp.
Constructor & Destructor Documentation
◆ MixedScalarMultiplyOp()
|
inline |
Constructor.
- Parameters
-
A [in] The Operator to wrap as an Operator<Scalar, ...>.
Definition at line 94 of file Tpetra_MixedScalarMultiplyOp.hpp.
◆ ~MixedScalarMultiplyOp()
|
overridedefault |
Destructor (virtual for memory safety of derived classes).
Member Function Documentation
◆ apply()
|
inlineoverridevirtual |
Compute Y = beta*Y + alpha*Op(A)*X, where Op(A) is either A,
Implements Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 110 of file Tpetra_MixedScalarMultiplyOp.hpp.
◆ hasTransposeApply()
|
inlineoverridevirtual |
Whether this Operator's apply() method can apply the transpose or conjugate transpose.
This is always true, since it is true for the CrsMatrix that this object wraps.
Reimplemented from Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 134 of file Tpetra_MixedScalarMultiplyOp.hpp.
◆ getDomainMap()
|
inlineoverridevirtual |
The domain Map of this Operator.
Implements Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 139 of file Tpetra_MixedScalarMultiplyOp.hpp.
◆ getRangeMap()
|
inlineoverridevirtual |
The range Map of this Operator.
Implements Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 144 of file Tpetra_MixedScalarMultiplyOp.hpp.
Friends And Related Symbol Documentation
◆ createMixedScalarMultiplyOp()
|
related |
Non-member function to create a MixedScalarMultiplyOp.
The function has the same template parameters of MixedScalarMultiplyOp.
- Parameters
-
A [in] The Operator instance to wrap in an MixedScalarMultiplyOp.
- Returns
- The MixedScalarMultiplyOp wrapper for the given Operator.
Definition at line 179 of file Tpetra_MixedScalarMultiplyOp.hpp.
Member Data Documentation
◆ op_
|
protected |
The underlying CrsMatrix object.
Definition at line 154 of file Tpetra_MixedScalarMultiplyOp.hpp.
The documentation for this class was generated from the following file:
