Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Stokhos_DiagEpetraOp.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_DIAG_EPETRA_OP_HPP
11 #define STOKHOS_DIAG_EPETRA_OP_HPP
12 
13 #include "Teuchos_RCP.hpp"
14 #include "Teuchos_Array.hpp"
15 #include "Teuchos_Time.hpp"
16 
17 #include "Epetra_Operator.h"
18 #include "Epetra_Map.h"
19 #include "Epetra_Comm.h"
20 #include "Epetra_MultiVector.h"
25 
26 namespace Stokhos {
27 
32  class DiagEpetraOp : public Epetra_Operator {
33 
34  public:
35 
38  const Teuchos::RCP<const Epetra_Map>& domain_base_map_,
39  const Teuchos::RCP<const Epetra_Map>& range_base_map_,
40  const Teuchos::RCP<const Epetra_Map>& domain_sg_map_,
41  const Teuchos::RCP<const Epetra_Map>& range_sg_map_,
45 
47  virtual ~DiagEpetraOp();
48 
50  virtual void
52 
55  getOperatorBlocks() const;
56 
60 
62  virtual int SetUseTranspose(bool UseTranspose);
63 
68  virtual int Apply(std::vector< Teuchos::RCP< const Epetra_CrsMatrix> >& sg_J_all, std::vector< Teuchos::RCP< Epetra_CrsMatrix> >& sg_Kkk_all) const;
69 
74  virtual int ApplyInverse(const Epetra_MultiVector& X,
75  Epetra_MultiVector& Y) const;
76 
78  virtual double NormInf() const;
79 
81  virtual const char* Label () const;
82 
84  virtual bool UseTranspose() const;
85 
90  virtual bool HasNormInf() const;
91 
96  virtual const Epetra_Comm & Comm() const;
97 
102  virtual const Epetra_Map& OperatorDomainMap () const;
103 
108  virtual const Epetra_Map& OperatorRangeMap () const;
109 
113  virtual const double ApplyTime() const{
114  return this->ApplyTimer->totalElapsedTime(false);};
115 
116  private:
117 
119  DiagEpetraOp(const DiagEpetraOp&);
120 
123 
124  protected:
125 
127  std::string label;
128 
131 
134 
137 
140 
143 
146 
149 
152 
155 
158 
161 
164 
167 
170 
173 
174  }; // class DiagEpetraOp
175 
176 } // namespace Stokhos
177 
178 #endif // STOKHOS_DIAG_EPETRA_OP_HPP
Teuchos::RCP< const Stokhos::Sparse3Tensor< int, double > > Cijk
Stores triple product tensor.
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator. ...
virtual const double ApplyTime() const
Returns the time spent applying this operator.
Teuchos::RCP< const Epetra_Map > range_sg_map
Stores range SG map.
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
Teuchos::RCP< Epetra_MultiVector > tmp
Temporary multivector used in Apply()
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > sg_basis
Stochastic Galerking basis.
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
Teuchos::Array< Teuchos::RCP< const Epetra_MultiVector > > input_block
MultiVectors for each block for Apply() input.
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
Teuchos::RCP< const Epetra_Map > domain_sg_map
Stores domain SG map.
DiagEpetraOp & operator=(const DiagEpetraOp &)
Private to prohibit copying.
Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > block_ops
Stores operators.
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::RCP< Epetra_MultiVector > tmp_trans
Temporary multivector used in Apply() for transpose.
int num_blocks
Number of Jacobian blocks (not necessarily equal to expansion_size)
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
int expansion_size
Number of terms in expansion.
std::string label
Label for operator.
virtual void reset(const Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > &ops)
Reset operator blocks.
virtual const char * Label() const
Returns a character string describing the operator.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
An Epetra operator representing the block stochastic Galerkin operator.
Teuchos::RCP< const Epetra_Map > domain_base_map
Stores domain base map.
virtual Teuchos::RCP< const Stokhos::EpetraOperatorOrthogPoly > getOperatorBlocks() const
Get operator blocks.
Teuchos::RCP< Teuchos::Time > ApplyTimer
Operation Timer.
bool useTranspose
Flag indicating whether transpose was selected.
virtual int Apply(std::vector< Teuchos::RCP< const Epetra_CrsMatrix > > &sg_J_all, std::vector< Teuchos::RCP< Epetra_CrsMatrix > > &sg_Kkk_all) const
Returns Diagonal blocks of SG matrix when PC coefficients of the SG matrix are given.
DiagEpetraOp(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< const Stokhos::OrthogPolyBasis< int, double > > &sg_basis, const Teuchos::RCP< const Stokhos::Sparse3Tensor< int, double > > &Cijk, const Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > &ops)
Constructor.
Teuchos::Array< Teuchos::RCP< Epetra_MultiVector > > result_block
MultiVectors for each block for Apply() result.
Teuchos::RCP< const Epetra_Map > range_base_map
Stores range base map.
virtual ~DiagEpetraOp()
Destructor.