Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
Stokhos_PCECovarianceOp.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Stokhos Package
5 // Copyright (2009) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
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 Eric T. Phipps (etphipp@sandia.gov).
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef STOKHOS_PCE_COVARIANCE_OP_HPP
43 #define STOKHOS_PCE_COVARIANCE_OP_HPP
44 
45 #include "Teuchos_RCP.hpp"
46 #include "Teuchos_Array.hpp"
47 #include "Epetra_Operator.h"
48 #include "EpetraExt_BlockVector.h"
51 
52 namespace Stokhos {
53 
65  public:
66 
69 
73 
77 
79  virtual ~PCECovarianceOp();
80 
82  virtual int SetUseTranspose(bool UseTranspose);
83 
88  virtual int Apply(const Epetra_MultiVector& Input,
89  Epetra_MultiVector& Result) const;
90 
95  virtual int ApplyInverse(const Epetra_MultiVector& X,
96  Epetra_MultiVector& Y) const;
97 
99  virtual double NormInf() const;
100 
102  virtual const char* Label () const;
103 
105  virtual bool UseTranspose() const;
106 
111  virtual bool HasNormInf() const;
112 
117  virtual const Epetra_Comm & Comm() const;
118 
123  virtual const Epetra_Map& OperatorDomainMap () const;
124 
129  virtual const Epetra_Map& OperatorRangeMap () const;
130 
132  const Epetra_BlockMap& CoeffMap() const;
133 
134  private:
135 
138 
141 
142  protected:
143 
145  std::string label;
146 
149 
152 
155 
158 
161 
162  }; // class PCECovarianceOp
163 
164 } // namespace Stokhos
165 
166 #endif // STOKHOS_PCE_COVARIANCE_OP_HPP
Stokhos::PCECovarianceOp
An Epetra operator representing the covariance operator of a polynomial chaos expansion.
Definition: Stokhos_PCECovarianceOp.hpp:64
Teuchos_RCP.hpp
Stokhos::PCECovarianceOp::UseTranspose
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
Definition: Stokhos_PCECovarianceOp.cpp:157
Stokhos::PCECovarianceOp::s
Teuchos::Array< double > s
Scaling vector in A = X*S*X^T.
Definition: Stokhos_PCECovarianceOp.hpp:151
Stokhos_VectorOrthogPolyTraitsEpetra.hpp
Stokhos::PCECovarianceOp::CoeffMap
const Epetra_BlockMap & CoeffMap() const
Returns PCE coefficient map.
Definition: Stokhos_PCECovarianceOp.cpp:186
Stokhos::PCECovarianceOp::OperatorDomainMap
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator.
Definition: Stokhos_PCECovarianceOp.cpp:174
Stokhos::PCECovarianceOp::tmp
Teuchos::RCP< Epetra_MultiVector > tmp
Temporary vector needed for apply.
Definition: Stokhos_PCECovarianceOp.hpp:160
Epetra_Comm
Teuchos_Array.hpp
Stokhos_VectorOrthogPoly.hpp
Teuchos::RCP
Stokhos::PCECovarianceOp::~PCECovarianceOp
virtual ~PCECovarianceOp()
Destructor.
Definition: Stokhos_PCECovarianceOp.cpp:101
Teuchos::Array< double >
Stokhos::PCECovarianceOp::OperatorRangeMap
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
Definition: Stokhos_PCECovarianceOp.cpp:180
Stokhos
Top-level namespace for Stokhos classes and functions.
Definition: Stokhos_AbstractPreconditionerFactory.hpp:48
Stokhos::PCECovarianceOp::HasNormInf
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Definition: Stokhos_PCECovarianceOp.cpp:163
Stokhos::PCECovarianceOp::operator=
PCECovarianceOp & operator=(const PCECovarianceOp &)
Private to prohibit copying.
Stokhos::PCECovarianceOp::NormInf
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
Definition: Stokhos_PCECovarianceOp.cpp:144
Epetra_BlockMap
Stokhos::PCECovarianceOp::PCECovarianceOp
PCECovarianceOp(const Stokhos::VectorOrthogPoly< Epetra_Vector > &X_poly)
Constructor with polynomial X.
Definition: Stokhos_PCECovarianceOp.cpp:49
Stokhos::PCECovarianceOp::X
Teuchos::RCP< const Epetra_MultiVector > X
Multivector X defining A = X*S*X^T.
Definition: Stokhos_PCECovarianceOp.hpp:148
Epetra_MultiVector
Stokhos::PCECovarianceOp::useTranspose
bool useTranspose
Flag indicating whether transpose was selected.
Definition: Stokhos_PCECovarianceOp.hpp:154
Stokhos::VectorOrthogPoly< Epetra_Vector >
Stokhos::PCECovarianceOp::SetUseTranspose
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
Definition: Stokhos_PCECovarianceOp.cpp:106
Stokhos::PCECovarianceOp::Label
virtual const char * Label() const
Returns a character std::string describing the operator.
Definition: Stokhos_PCECovarianceOp.cpp:151
Stokhos::PCECovarianceOp::label
std::string label
Label for operator.
Definition: Stokhos_PCECovarianceOp.hpp:145
Stokhos::PCECovarianceOp::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_PCECovarianceOp.cpp:113
Epetra_Operator
Epetra_Map
Stokhos::PCECovarianceOp::tmp_map
Teuchos::RCP< Epetra_Map > tmp_map
Map needed for temporary vector.
Definition: Stokhos_PCECovarianceOp.hpp:157
Stokhos::PCECovarianceOp::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_PCECovarianceOp.cpp:136
Epetra_Operator.h
Stokhos::OrthogPolyBasis< int, double >
Stokhos::PCECovarianceOp::Comm
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
Definition: Stokhos_PCECovarianceOp.cpp:169