Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
Stokhos_DiagEpetraOp.hpp
Go to the documentation of this file.
1 // $Id$
2 // $Source$
3 // @HEADER
4 // ***********************************************************************
5 //
6 // Stokhos Package
7 // Copyright (2009) Sandia Corporation
8 //
9 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
10 // license for use of this work by or on behalf of the U.S. Government.
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are
14 // met:
15 //
16 // 1. Redistributions of source code must retain the above copyright
17 // notice, this list of conditions and the following disclaimer.
18 //
19 // 2. Redistributions in binary form must reproduce the above copyright
20 // notice, this list of conditions and the following disclaimer in the
21 // documentation and/or other materials provided with the distribution.
22 //
23 // 3. Neither the name of the Corporation nor the names of the
24 // contributors may be used to endorse or promote products derived from
25 // this software without specific prior written permission.
26 //
27 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 //
39 // Questions? Contact Eric T. Phipps (etphipp@sandia.gov).
40 //
41 // ***********************************************************************
42 // @HEADER
43 
44 #ifndef STOKHOS_DIAG_EPETRA_OP_HPP
45 #define STOKHOS_DIAG_EPETRA_OP_HPP
46 
47 #include "Teuchos_RCP.hpp"
48 #include "Teuchos_Array.hpp"
49 #include "Teuchos_Time.hpp"
50 
51 #include "Epetra_Operator.h"
52 #include "Epetra_Map.h"
53 #include "Epetra_Comm.h"
54 #include "Epetra_MultiVector.h"
59 
60 namespace Stokhos {
61 
66  class DiagEpetraOp : public Epetra_Operator {
67 
68  public:
69 
72  const Teuchos::RCP<const Epetra_Map>& domain_base_map_,
73  const Teuchos::RCP<const Epetra_Map>& range_base_map_,
74  const Teuchos::RCP<const Epetra_Map>& domain_sg_map_,
75  const Teuchos::RCP<const Epetra_Map>& range_sg_map_,
79 
81  virtual ~DiagEpetraOp();
82 
84  virtual void
86 
89  getOperatorBlocks() const;
90 
94 
96  virtual int SetUseTranspose(bool UseTranspose);
97 
102  virtual int Apply(std::vector< Teuchos::RCP< const Epetra_CrsMatrix> >& sg_J_all, std::vector< Teuchos::RCP< Epetra_CrsMatrix> >& sg_Kkk_all) const;
103 
108  virtual int ApplyInverse(const Epetra_MultiVector& X,
109  Epetra_MultiVector& Y) const;
110 
112  virtual double NormInf() const;
113 
115  virtual const char* Label () const;
116 
118  virtual bool UseTranspose() const;
119 
124  virtual bool HasNormInf() const;
125 
130  virtual const Epetra_Comm & Comm() const;
131 
136  virtual const Epetra_Map& OperatorDomainMap () const;
137 
142  virtual const Epetra_Map& OperatorRangeMap () const;
143 
147  virtual const double ApplyTime() const{
148  return this->ApplyTimer->totalElapsedTime(false);};
149 
150  private:
151 
153  DiagEpetraOp(const DiagEpetraOp&);
154 
157 
158  protected:
159 
161  std::string label;
162 
165 
168 
171 
174 
177 
180 
183 
186 
189 
192 
195 
198 
201 
204 
207 
208  }; // class DiagEpetraOp
209 
210 } // namespace Stokhos
211 
212 #endif // STOKHOS_DIAG_EPETRA_OP_HPP
Stokhos::DiagEpetraOp::~DiagEpetraOp
virtual ~DiagEpetraOp()
Destructor.
Definition: Stokhos_DiagEpetraOp.cpp:75
Stokhos::DiagEpetraOp::useTranspose
bool useTranspose
Flag indicating whether transpose was selected.
Definition: Stokhos_DiagEpetraOp.hpp:185
Stokhos::DiagEpetraOp::OperatorDomainMap
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator.
Definition: Stokhos_DiagEpetraOp.cpp:239
Teuchos_RCP.hpp
Stokhos::DiagEpetraOp::result_block
Teuchos::Array< Teuchos::RCP< Epetra_MultiVector > > result_block
MultiVectors for each block for Apply() result.
Definition: Stokhos_DiagEpetraOp.hpp:197
Stokhos::DiagEpetraOp::range_sg_map
Teuchos::RCP< const Epetra_Map > range_sg_map
Stores range SG map.
Definition: Stokhos_DiagEpetraOp.hpp:173
Stokhos::DiagEpetraOp::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_DiagEpetraOp.cpp:201
Stokhos_VectorOrthogPolyTraitsEpetra.hpp
Stokhos::DiagEpetraOp::sg_basis
Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > sg_basis
Stochastic Galerking basis.
Definition: Stokhos_DiagEpetraOp.hpp:176
Stokhos::DiagEpetraOp
An Epetra operator representing the block stochastic Galerkin operator.
Definition: Stokhos_DiagEpetraOp.hpp:66
Stokhos::DiagEpetraOp::Cijk
Teuchos::RCP< const Stokhos::Sparse3Tensor< int, double > > Cijk
Stores triple product tensor.
Definition: Stokhos_DiagEpetraOp.hpp:179
Epetra_Comm
Teuchos_Array.hpp
Stokhos::Sparse3Tensor< int, double >
Stokhos_VectorOrthogPoly.hpp
Stokhos::DiagEpetraOp::tmp
Teuchos::RCP< Epetra_MultiVector > tmp
Temporary multivector used in Apply()
Definition: Stokhos_DiagEpetraOp.hpp:200
Stokhos::DiagEpetraOp::SetUseTranspose
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
Definition: Stokhos_DiagEpetraOp.cpp:99
Teuchos::RCP< const Epetra_Map >
Stokhos::DiagEpetraOp::OperatorRangeMap
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
Definition: Stokhos_DiagEpetraOp.cpp:245
Stokhos::DiagEpetraOp::operator=
DiagEpetraOp & operator=(const DiagEpetraOp &)
Private to prohibit copying.
Teuchos::Array
Stokhos::DiagEpetraOp::num_blocks
int num_blocks
Number of Jacobian blocks (not necessarily equal to expansion_size)
Definition: Stokhos_DiagEpetraOp.hpp:191
Stokhos_Sparse3Tensor.hpp
Stokhos::DiagEpetraOp::block_ops
Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > block_ops
Stores operators.
Definition: Stokhos_DiagEpetraOp.hpp:182
Stokhos::DiagEpetraOp::ApplyTime
virtual const double ApplyTime() const
Returns the time spent applying this operator.
Definition: Stokhos_DiagEpetraOp.hpp:147
Stokhos::DiagEpetraOp::Label
virtual const char * Label() const
Returns a character string describing the operator.
Definition: Stokhos_DiagEpetraOp.cpp:216
Stokhos::DiagEpetraOp::Apply
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.
Definition: Stokhos_DiagEpetraOp.cpp:109
Stokhos::DiagEpetraOp::tmp_trans
Teuchos::RCP< Epetra_MultiVector > tmp_trans
Temporary multivector used in Apply() for transpose.
Definition: Stokhos_DiagEpetraOp.hpp:203
Stokhos::DiagEpetraOp::expansion_size
int expansion_size
Number of terms in expansion.
Definition: Stokhos_DiagEpetraOp.hpp:188
Stokhos
Top-level namespace for Stokhos classes and functions.
Definition: Stokhos_AbstractPreconditionerFactory.hpp:48
Stokhos::DiagEpetraOp::input_block
Teuchos::Array< Teuchos::RCP< const Epetra_MultiVector > > input_block
MultiVectors for each block for Apply() input.
Definition: Stokhos_DiagEpetraOp.hpp:194
Stokhos::DiagEpetraOp::getOperatorBlocks
virtual Teuchos::RCP< const Stokhos::EpetraOperatorOrthogPoly > getOperatorBlocks() const
Get operator blocks.
Definition: Stokhos_DiagEpetraOp.cpp:87
Stokhos::DiagEpetraOp::label
std::string label
Label for operator.
Definition: Stokhos_DiagEpetraOp.hpp:161
Stokhos::DiagEpetraOp::domain_sg_map
Teuchos::RCP< const Epetra_Map > domain_sg_map
Stores domain SG map.
Definition: Stokhos_DiagEpetraOp.hpp:170
Stokhos::DiagEpetraOp::NormInf
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
Definition: Stokhos_DiagEpetraOp.cpp:209
Stokhos::DiagEpetraOp::ApplyTimer
Teuchos::RCP< Teuchos::Time > ApplyTimer
Operation Timer.
Definition: Stokhos_DiagEpetraOp.hpp:206
Teuchos_Time.hpp
Epetra_Comm.h
Stokhos::DiagEpetraOp::HasNormInf
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Definition: Stokhos_DiagEpetraOp.cpp:228
Stokhos::DiagEpetraOp::reset
virtual void reset(const Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > &ops)
Reset operator blocks.
Definition: Stokhos_DiagEpetraOp.cpp:80
Teuchos::Time::totalElapsedTime
double totalElapsedTime(bool readCurrentTime=false) const
Epetra_MultiVector
Stokhos::DiagEpetraOp::range_base_map
Teuchos::RCP< const Epetra_Map > range_base_map
Stores range base map.
Definition: Stokhos_DiagEpetraOp.hpp:167
Stokhos::DiagEpetraOp::Comm
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
Definition: Stokhos_DiagEpetraOp.cpp:234
Stokhos_OrthogPolyBasis.hpp
Stokhos::DiagEpetraOp::UseTranspose
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
Definition: Stokhos_DiagEpetraOp.cpp:222
Epetra_Map.h
Stokhos::DiagEpetraOp::domain_base_map
Teuchos::RCP< const Epetra_Map > domain_base_map
Stores domain base map.
Definition: Stokhos_DiagEpetraOp.hpp:164
Epetra_Operator
Epetra_Map
Epetra_MultiVector.h
Stokhos::DiagEpetraOp::DiagEpetraOp
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.
Definition: Stokhos_DiagEpetraOp.cpp:49
Epetra_Operator.h
Stokhos::OrthogPolyBasis< int, double >