Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Stokhos_KLReducedMatrixFreeOperator.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_KL_REDUCED_MATRIX_FREE_OPERATOR_HPP
11 #define STOKHOS_KL_REDUCED_MATRIX_FREE_OPERATOR_HPP
12 
13 #include "Stokhos_SGOperator.hpp"
14 #include "EpetraExt_MultiComm.h"
17 #include "Epetra_Map.h"
19 #include "Teuchos_Array.hpp"
20 
21 #include "Epetra_MultiVector.h"
26 
27 namespace Stokhos {
28 
34 
35  public:
36 
47 
50 
53 
55  virtual void setupOperator(
57 
61 
64  getSGPolynomial() const;
65 
67 
70 
72  virtual int SetUseTranspose(bool UseTranspose);
73 
78  virtual int Apply(const Epetra_MultiVector& Input,
79  Epetra_MultiVector& Result) const;
80 
85  virtual int ApplyInverse(const Epetra_MultiVector& X,
86  Epetra_MultiVector& Y) const;
87 
89  virtual double NormInf() const;
90 
92  virtual const char* Label () const;
93 
95  virtual bool UseTranspose() const;
96 
101  virtual bool HasNormInf() const;
102 
107  virtual const Epetra_Comm & Comm() const;
108 
113  virtual const Epetra_Map& OperatorDomainMap () const;
114 
119  virtual const Epetra_Map& OperatorRangeMap () const;
120 
122 
123  protected:
124 
126  void setup();
127 
128  private:
129 
132 
135 
136  protected:
137 
139  std::string label;
140 
143 
146 
149 
152 
155 
158 
161 
164 
167 
170 
173 
176 
179 
182 
184  int num_KL;
185 
188 
191 
194 
197 
200 
203 
206 
209 
212 
215 
218 
219  }; // class KLReducedMatrixFreeOperator
220 
221 } // namespace Stokhos
222 
223 #endif // STOKHOS_KL_REDUCED_MATRIX_FREE_OPERATOR_HPP
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator. ...
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 ...
KLReducedMatrixFreeOperator & operator=(const KLReducedMatrixFreeOperator &)
Private to prohibit copying.
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
virtual const char * Label() const
Returns a character string describing the operator.
Teuchos::RCP< Stokhos::MatrixFreeOperator > kl_mat_free_op
Matrix-Free operator using KL operators.
bool useTranspose
Flag indicating whether transpose was selected.
Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > kl_ops
KL blocks as operators.
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 double NormInf() const
Returns an approximate infinity norm of the operator matrix.
Teuchos::RCP< const EpetraExt::MultiComm > sg_comm
Stores SG parallel communicator.
Teuchos::RCP< const Cijk_type > Cijk
Stores triple product tensor.
virtual Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > getSGPolynomial()
Get SG polynomial.
bool do_error_tests
Whether to do KL error tests (can be expensive)
KLReducedMatrixFreeOperator(const Teuchos::RCP< const EpetraExt::MultiComm > &sg_comm, const Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > &sg_basis, const Teuchos::RCP< const Stokhos::EpetraSparse3Tensor > &epetraCijk, const Teuchos::RCP< const Epetra_Map > &domain_base_map, const Teuchos::RCP< const Epetra_Map > &range_base_map, const Teuchos::RCP< const Epetra_Map > &domain_sg_map, const Teuchos::RCP< const Epetra_Map > &range_sg_map, const Teuchos::RCP< Teuchos::ParameterList > &params)
Constructor.
Teuchos::RCP< Stokhos::Sparse3Tensor< int, double > > sparse_kl_coeffs
Sparse KL coefficients.
virtual void setupOperator(const Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > &poly)
Setup operator.
An abstract class to represent a generic stochastic Galerkin operator as an Epetra_Operator.
Teuchos::RCP< Epetra_CrsMatrix > mean
Mean block.
Teuchos::RCP< const Stokhos::EpetraSparse3Tensor > epetraCijk
Stores Epetra Cijk tensor.
double drop_tolerance
Tolerance for dropping entries in sparse 3 tensor.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
Teuchos::RCP< const Epetra_Map > range_sg_map
Stores range SG map.
Teuchos::RCP< Epetra_Map > block_vec_map
Block map for vectorized-matrices.
Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > sg_basis
Stochastic Galerking basis.
Teuchos::RCP< Stokhos::EpetraVectorOrthogPoly > block_vec_poly
Polynomial sorting vectorized matrix coefficients.
Stokhos::Sparse3Tensor< int, double > Cijk_type
Short-hand for Cijk.
Teuchos::RCP< const Epetra_Map > domain_base_map
Stores domain base map.
Teuchos::RCP< Teuchos::ParameterList > params
Algorithmic parameters.
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
An Epetra operator representing the block stochastic Galerkin operator.
Teuchos::Array< Teuchos::Array< double > > dot_products
Dot products of KL eigenvectors and Jacobian blocks.
Teuchos::Array< Teuchos::RCP< Epetra_CrsMatrix > > kl_blocks
KL blocks.
Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > block_ops
Stores operators.
Teuchos::RCP< const Epetra_Map > domain_sg_map
Stores domain SG map.
Teuchos::RCP< const Epetra_Map > range_base_map
Stores range base map.
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.