Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
Stokhos_EpetraMultiVectorOperator.hpp
Go to the documentation of this file.
1 // $Id$
2 // $Source$
3 // @HEADER
4 // ***********************************************************************
5 //
6 // Stokhos Package
7 // Copyright (2009) Sandia Corporation
8 //
9 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
10 // license for use of this work by or on behalf of the U.S. Government.
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are
14 // met:
15 //
16 // 1. Redistributions of source code must retain the above copyright
17 // notice, this list of conditions and the following disclaimer.
18 //
19 // 2. Redistributions in binary form must reproduce the above copyright
20 // notice, this list of conditions and the following disclaimer in the
21 // documentation and/or other materials provided with the distribution.
22 //
23 // 3. Neither the name of the Corporation nor the names of the
24 // contributors may be used to endorse or promote products derived from
25 // this software without specific prior written permission.
26 //
27 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 //
39 // Questions? Contact Eric T. Phipps (etphipp@sandia.gov).
40 //
41 // ***********************************************************************
42 // @HEADER
43 
44 #ifndef STOKHOS_EPETRA_MULTIVECTOR_OPERATOR_HPP
45 #define STOKHOS_EPETRA_MULTIVECTOR_OPERATOR_HPP
46 
47 #include "Teuchos_RCP.hpp"
48 #include "Epetra_Operator.h"
49 #include "Epetra_MultiVector.h"
50 
51 namespace Stokhos {
52 
69 
70  public:
71 
76 
81 
84 
86  getMultiVector() const { return multi_vec; }
87 
90 
92  virtual int SetUseTranspose(bool UseTranspose);
93 
98  virtual int Apply(const Epetra_MultiVector& Input,
99  Epetra_MultiVector& Result) const;
100 
105  virtual int ApplyInverse(const Epetra_MultiVector& X,
106  Epetra_MultiVector& Y) const;
107 
109  virtual double NormInf() const;
110 
112  virtual const char* Label () const;
113 
115  virtual bool UseTranspose() const;
116 
121  virtual bool HasNormInf() const;
122 
127  virtual const Epetra_Comm & Comm() const;
128 
133  virtual const Epetra_Map& OperatorDomainMap () const;
134 
139  virtual const Epetra_Map& OperatorRangeMap () const;
140 
141  private:
142 
145 
148 
149  protected:
150 
152  std::string label;
153 
156 
159 
162 
165 
168 
169  }; // class EpetraMultiVectorOperator
170 
171 } // namespace Stokhos
172 
173 #endif // STOKHOS_EPETRA_MULTIVECTOR_OPERATOR_HPP
Stokhos::EpetraMultiVectorOperator::is_multi_vec_transposed
bool is_multi_vec_transposed
Whether the multivector is already transposed.
Definition: Stokhos_EpetraMultiVectorOperator.hpp:161
Teuchos_RCP.hpp
Stokhos::EpetraMultiVectorOperator::HasNormInf
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Definition: Stokhos_EpetraMultiVectorOperator.cpp:157
Stokhos::EpetraMultiVectorOperator::SetUseTranspose
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
Definition: Stokhos_EpetraMultiVectorOperator.cpp:85
Stokhos::EpetraMultiVectorOperator::Comm
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
Definition: Stokhos_EpetraMultiVectorOperator.cpp:164
Stokhos::EpetraMultiVectorOperator::ApplyInverse
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 ...
Definition: Stokhos_EpetraMultiVectorOperator.cpp:113
Stokhos::EpetraMultiVectorOperator::EpetraMultiVectorOperator
EpetraMultiVectorOperator(const Teuchos::RCP< const Epetra_MultiVector > &multi_vec, bool is_multi_vec_transposed)
Constructor.
Definition: Stokhos_EpetraMultiVectorOperator.cpp:49
Stokhos::EpetraMultiVectorOperator::domain_map
Teuchos::RCP< Epetra_Map > domain_map
Domain map ( = number of columns of multi_vec)
Definition: Stokhos_EpetraMultiVectorOperator.hpp:167
Epetra_Comm
Teuchos::RCP< const Epetra_MultiVector >
Stokhos::EpetraMultiVectorOperator::getMultiVector
Teuchos::RCP< Epetra_MultiVector > getMultiVector()
Definition: Stokhos_EpetraMultiVectorOperator.hpp:89
Stokhos::EpetraMultiVectorOperator::getMultiVector
Teuchos::RCP< const Epetra_MultiVector > getMultiVector() const
Definition: Stokhos_EpetraMultiVectorOperator.hpp:86
Stokhos::EpetraMultiVectorOperator::operator=
EpetraMultiVectorOperator & operator=(const EpetraMultiVectorOperator &)
Private to prohibit copying.
Stokhos
Top-level namespace for Stokhos classes and functions.
Definition: Stokhos_AbstractPreconditionerFactory.hpp:48
Stokhos::EpetraMultiVectorOperator::useTranspose
bool useTranspose
Flag indicating whether transpose was selected.
Definition: Stokhos_EpetraMultiVectorOperator.hpp:164
Stokhos::EpetraMultiVectorOperator::UseTranspose
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
Definition: Stokhos_EpetraMultiVectorOperator.cpp:148
Stokhos::EpetraMultiVectorOperator
An adaptor that supplies the operator interface to a multi-vector.
Definition: Stokhos_EpetraMultiVectorOperator.hpp:68
Epetra_MultiVector
Stokhos::EpetraMultiVectorOperator::label
std::string label
Label for operator.
Definition: Stokhos_EpetraMultiVectorOperator.hpp:152
Stokhos::EpetraMultiVectorOperator::~EpetraMultiVectorOperator
virtual ~EpetraMultiVectorOperator()
Destructor.
Definition: Stokhos_EpetraMultiVectorOperator.cpp:79
Stokhos::EpetraMultiVectorOperator::OperatorRangeMap
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
Definition: Stokhos_EpetraMultiVectorOperator.cpp:179
Stokhos::EpetraMultiVectorOperator::multi_vec
Teuchos::RCP< const Epetra_MultiVector > multi_vec
Multi-vector.
Definition: Stokhos_EpetraMultiVectorOperator.hpp:155
Epetra_Operator
Epetra_Map
Stokhos::EpetraMultiVectorOperator::OperatorDomainMap
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator.
Definition: Stokhos_EpetraMultiVectorOperator.cpp:170
Epetra_MultiVector.h
Stokhos::EpetraMultiVectorOperator::nonconst_multi_vec
Teuchos::RCP< Epetra_MultiVector > nonconst_multi_vec
Non-const multi-vector.
Definition: Stokhos_EpetraMultiVectorOperator.hpp:158
Stokhos::EpetraMultiVectorOperator::NormInf
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
Definition: Stokhos_EpetraMultiVectorOperator.cpp:122
Epetra_Operator.h
Stokhos::EpetraMultiVectorOperator::Apply
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 ...
Definition: Stokhos_EpetraMultiVectorOperator.cpp:97
Stokhos::EpetraMultiVectorOperator::Label
virtual const char * Label() const
Returns a character string describing the operator.
Definition: Stokhos_EpetraMultiVectorOperator.cpp:141