Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Stokhos_EpetraMultiVectorOperator.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Stokhos Package
4 //
5 // Copyright 2009 NTESS and the Stokhos contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 #ifndef STOKHOS_EPETRA_MULTIVECTOR_OPERATOR_HPP
11 #define STOKHOS_EPETRA_MULTIVECTOR_OPERATOR_HPP
12 
13 #include "Teuchos_RCP.hpp"
14 #include "Epetra_Operator.h"
15 #include "Epetra_MultiVector.h"
16 
17 namespace Stokhos {
18 
35 
36  public:
37 
42 
45  const Teuchos::RCP<Epetra_MultiVector>& multi_vec,
46  bool is_multi_vec_transposed);
47 
50 
52  getMultiVector() const { return multi_vec; }
53 
56 
58  virtual int SetUseTranspose(bool UseTranspose);
59 
64  virtual int Apply(const Epetra_MultiVector& Input,
65  Epetra_MultiVector& Result) const;
66 
71  virtual int ApplyInverse(const Epetra_MultiVector& X,
72  Epetra_MultiVector& Y) const;
73 
75  virtual double NormInf() const;
76 
78  virtual const char* Label () const;
79 
81  virtual bool UseTranspose() const;
82 
87  virtual bool HasNormInf() const;
88 
93  virtual const Epetra_Comm & Comm() const;
94 
99  virtual const Epetra_Map& OperatorDomainMap () const;
100 
105  virtual const Epetra_Map& OperatorRangeMap () const;
106 
107  private:
108 
111 
114 
115  protected:
116 
118  std::string label;
119 
122 
125 
128 
131 
134 
135  }; // class EpetraMultiVectorOperator
136 
137 } // namespace Stokhos
138 
139 #endif // STOKHOS_EPETRA_MULTIVECTOR_OPERATOR_HPP
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
Teuchos::RCP< Epetra_Map > domain_map
Domain map ( = number of columns of multi_vec)
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
bool is_multi_vec_transposed
Whether the multivector is already transposed.
EpetraMultiVectorOperator & operator=(const EpetraMultiVectorOperator &)
Private to prohibit copying.
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
EpetraMultiVectorOperator(const Teuchos::RCP< const Epetra_MultiVector > &multi_vec, bool is_multi_vec_transposed)
Constructor.
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
Teuchos::RCP< const Epetra_MultiVector > getMultiVector() const
An adaptor that supplies the operator interface to a multi-vector.
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator. ...
bool useTranspose
Flag indicating whether transpose was selected.
Teuchos::RCP< Epetra_MultiVector > getMultiVector()
virtual const char * Label() const
Returns a character string describing the operator.
Teuchos::RCP< Epetra_MultiVector > nonconst_multi_vec
Non-const multi-vector.
virtual int ApplyInverse(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of the inverse of the operator applied to a Epetra_MultiVector Input in Result as ...
Teuchos::RCP< const Epetra_MultiVector > multi_vec
Multi-vector.
virtual int Apply(const Epetra_MultiVector &Input, Epetra_MultiVector &Result) const
Returns the result of a Epetra_Operator applied to a Epetra_MultiVector Input in Result as described ...
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.