Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Stokhos_KLMatrixFreeOperator.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_KLMATRIX_FREE_OPERATOR_HPP
11 #define STOKHOS_KLMATRIX_FREE_OPERATOR_HPP
12 
13 #include "Stokhos_SGOperator.hpp"
14 #include "EpetraExt_MultiComm.h"
17 #include "Epetra_Map.h"
18 #include "Epetra_Import.h"
20 #include "Teuchos_Array.hpp"
21 
22 namespace Stokhos {
23 
29 
30  public:
31 
42 
44  virtual ~KLMatrixFreeOperator();
45 
48 
50  virtual void setupOperator(
52 
56 
59  getSGPolynomial() const;
60 
62 
65 
67  virtual int SetUseTranspose(bool UseTranspose);
68 
73  virtual int Apply(const Epetra_MultiVector& Input,
74  Epetra_MultiVector& Result) const;
75 
80  virtual int ApplyInverse(const Epetra_MultiVector& X,
81  Epetra_MultiVector& Y) const;
82 
84  virtual double NormInf() const;
85 
87  virtual const char* Label () const;
88 
90  virtual bool UseTranspose() const;
91 
96  virtual bool HasNormInf() const;
97 
102  virtual const Epetra_Comm & Comm() const;
103 
108  virtual const Epetra_Map& OperatorDomainMap () const;
109 
114  virtual const Epetra_Map& OperatorRangeMap () const;
115 
117 
118  private:
119 
122 
125 
126  protected:
127 
129  std::string label;
130 
133 
136 
139 
142 
145 
148 
151 
154 
157 
160 
163 
166 
169 
172 
175 
178 
180  bool scale_op;
181 
184 
187 
190 
193 
196 
199 
202 
205 
208 
211 
214 
217 
220 
221  }; // class KLMatrixFreeOperator
222 
223 } // namespace Stokhos
224 
225 #endif // STOKHOS_KLMATRIX_FREE_OPERATOR_HPP
Teuchos::RCP< const Epetra_Map > range_sg_map
Stores range SG map.
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 ...
Cijk_type::k_iterator k_end
Ending k iterator.
Teuchos::RCP< Epetra_Map > global_col_map_trans
Stores operator column SG map for transpose.
bool scale_op
Flag indicating whether operator be scaled with &lt;^2&gt;
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
Teuchos::RCP< const Stokhos::EpetraSparse3Tensor > epetraCijk
Stores Epetra Cijk tensor.
bool is_stoch_parallel
Whether we have parallelism over stochastic blocks.
Teuchos::RCP< const EpetraExt::MultiComm > sg_comm
Stores SG parallel communicator.
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.
virtual Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > getSGPolynomial()
Get SG polynomial.
int num_blocks
Number of Jacobian blocks (not necessarily equal to expansion_size)
KLMatrixFreeOperator(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.
Stokhos::Sparse3Tensor< int, double > Cijk_type
Short-hand for Cijk.
virtual const char * Label() const
Returns a character std::string describing the operator.
int expansion_size
Number of terms in expansion.
Teuchos::RCP< const Epetra_Map > range_base_map
Stores range base map.
Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > sg_basis
Stochastic Galerking basis.
Bi-directional iterator for traversing a sparse array.
bool useTranspose
Flag indicating whether transpose was selected.
Teuchos::Array< Teuchos::RCP< const Epetra_MultiVector > > input_block
MultiVectors for each block for Apply() input.
Teuchos::RCP< Epetra_MultiVector > tmp_trans
Temporary multivector used in Apply() for transpose.
An abstract class to represent a generic stochastic Galerkin operator as an Epetra_Operator.
Teuchos::RCP< const Epetra_Map > domain_sg_map
Stores domain SG map.
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
Cijk_type::k_iterator k_begin
Starting k iterator.
int max_num_mat_vec
Maximum number of matvecs in Apply.
Teuchos::RCP< const Cijk_type > Cijk
Stores triple product tensor.
Teuchos::RCP< const Epetra_BlockMap > stoch_col_map
Stores stochastic part of column map.
Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > block_ops
Stores operators.
Teuchos::RCP< Epetra_Import > col_importer
Importer from domain map to column map.
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator. ...
std::string label
Label for operator.
Teuchos::RCP< Epetra_MultiVector > input_col_trans
Temporary to store result of importing input into column map (transpose)
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
bool include_mean
Flag indicating whether to include mean term.
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
Teuchos::RCP< Epetra_Import > col_importer_trans
Importer from range map to column map.
KLMatrixFreeOperator & operator=(const KLMatrixFreeOperator &)
Private to prohibit copying.
Teuchos::RCP< Epetra_Map > global_col_map
Stores operator column SG map.
Teuchos::RCP< const Epetra_Map > domain_base_map
Stores domain base map.
virtual void setupOperator(const Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > &poly)
Setup 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 ...
Teuchos::Array< Teuchos::RCP< Epetra_MultiVector > > result_block
MultiVectors for each block for Apply() result.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
Teuchos::RCP< Epetra_MultiVector > input_col
Temporary to store result of importing input into column map.
Teuchos::RCP< Epetra_MultiVector > tmp
Temporary multivector used in Apply()