Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Stokhos_PCECovarianceOp.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_PCE_COVARIANCE_OP_HPP
11 #define STOKHOS_PCE_COVARIANCE_OP_HPP
12 
13 #include "Teuchos_RCP.hpp"
14 #include "Teuchos_Array.hpp"
15 #include "Epetra_Operator.h"
16 #include "EpetraExt_BlockVector.h"
19 
20 namespace Stokhos {
21 
33  public:
34 
37 
41 
45 
47  virtual ~PCECovarianceOp();
48 
50  virtual int SetUseTranspose(bool UseTranspose);
51 
56  virtual int Apply(const Epetra_MultiVector& Input,
57  Epetra_MultiVector& Result) const;
58 
63  virtual int ApplyInverse(const Epetra_MultiVector& X,
64  Epetra_MultiVector& Y) const;
65 
67  virtual double NormInf() const;
68 
70  virtual const char* Label () const;
71 
73  virtual bool UseTranspose() const;
74 
79  virtual bool HasNormInf() const;
80 
85  virtual const Epetra_Comm & Comm() const;
86 
91  virtual const Epetra_Map& OperatorDomainMap () const;
92 
97  virtual const Epetra_Map& OperatorRangeMap () const;
98 
100  const Epetra_BlockMap& CoeffMap() const;
101 
102  private:
103 
106 
109 
110  protected:
111 
113  std::string label;
114 
117 
120 
123 
126 
129 
130  }; // class PCECovarianceOp
131 
132 } // namespace Stokhos
133 
134 #endif // STOKHOS_PCE_COVARIANCE_OP_HPP
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_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
Teuchos::RCP< Epetra_MultiVector > tmp
Temporary vector needed for apply.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
PCECovarianceOp(const Stokhos::VectorOrthogPoly< Epetra_Vector > &X_poly)
Constructor with polynomial X.
std::string label
Label for operator.
An Epetra operator representing the covariance operator of a polynomial chaos expansion.
PCECovarianceOp & operator=(const PCECovarianceOp &)
Private to prohibit copying.
virtual ~PCECovarianceOp()
Destructor.
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
bool useTranspose
Flag indicating whether transpose was selected.
Teuchos::RCP< const Epetra_MultiVector > X
Multivector X defining A = X*S*X^T.
const Epetra_BlockMap & CoeffMap() const
Returns PCE coefficient map.
Teuchos::RCP< Epetra_Map > tmp_map
Map needed for temporary vector.
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator. ...
Teuchos::Array< double > s
Scaling vector in A = X*S*X^T.
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 ...
virtual const char * Label() const
Returns a character std::string describing the operator.
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.