Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
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
60namespace Stokhos {
61
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_,
76 const Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> >& sg_basis,
77 const Teuchos::RCP<const Stokhos::Sparse3Tensor<int,double> >& Cijk,
78 const Teuchos::RCP<Stokhos::EpetraOperatorOrthogPoly >& ops);
79
81 virtual ~DiagEpetraOp();
82
84 virtual void
85 reset(const Teuchos::RCP<Stokhos::EpetraOperatorOrthogPoly >& ops);
86
88 virtual Teuchos::RCP<const Stokhos::EpetraOperatorOrthogPoly >
89 getOperatorBlocks() const;
90
92 virtual Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly >
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
154
157
158 protected:
159
161 std::string label;
162
164 Teuchos::RCP<const Epetra_Map> domain_base_map;
165
167 Teuchos::RCP<const Epetra_Map> range_base_map;
168
170 Teuchos::RCP<const Epetra_Map> domain_sg_map;
171
173 Teuchos::RCP<const Epetra_Map> range_sg_map;
174
176 Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> > sg_basis;
177
179 Teuchos::RCP<const Stokhos::Sparse3Tensor<int,double> > Cijk;
180
182 Teuchos::RCP<Stokhos::EpetraOperatorOrthogPoly > block_ops;
183
186
189
192
194 mutable Teuchos::Array< Teuchos::RCP<const Epetra_MultiVector> > input_block;
195
197 mutable Teuchos::Array< Teuchos::RCP<Epetra_MultiVector> > result_block;
198
200 mutable Teuchos::RCP<Epetra_MultiVector> tmp;
201
203 mutable Teuchos::RCP<Epetra_MultiVector> tmp_trans;
204
206 Teuchos::RCP<Teuchos::Time> ApplyTimer;
207
208 }; // class DiagEpetraOp
209
210} // namespace Stokhos
211
212#endif // STOKHOS_DIAG_EPETRA_OP_HPP
An Epetra operator representing the block stochastic Galerkin operator.
Teuchos::RCP< Epetra_MultiVector > tmp
Temporary multivector used in Apply()
virtual void reset(const Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > &ops)
Reset operator blocks.
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
Teuchos::RCP< Epetra_MultiVector > tmp_trans
Temporary multivector used in Apply() for transpose.
virtual Teuchos::RCP< const Stokhos::EpetraOperatorOrthogPoly > getOperatorBlocks() const
Get operator blocks.
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.
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::RCP< Stokhos::EpetraOperatorOrthogPoly > block_ops
Stores operators.
int expansion_size
Number of terms in expansion.
std::string label
Label for operator.
Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > sg_basis
Stochastic Galerking basis.
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
virtual const char * Label() const
Returns a character string describing the operator.
Teuchos::RCP< Teuchos::Time > ApplyTimer
Operation Timer.
int num_blocks
Number of Jacobian blocks (not necessarily equal to expansion_size)
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 ~DiagEpetraOp()
Destructor.
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
Teuchos::RCP< const Epetra_Map > domain_base_map
Stores domain base map.
DiagEpetraOp & operator=(const DiagEpetraOp &)
Private to prohibit copying.
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.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
Teuchos::RCP< const Epetra_Map > domain_sg_map
Stores domain SG map.
virtual const double ApplyTime() const
Returns the time spent applying this operator.
Teuchos::Array< Teuchos::RCP< const Epetra_MultiVector > > input_block
MultiVectors for each block for Apply() input.
DiagEpetraOp(const DiagEpetraOp &)
Private to prohibit copying.
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_Map > range_sg_map
Stores range SG map.
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator.
Teuchos::RCP< const Stokhos::Sparse3Tensor< int, double > > Cijk
Stores triple product tensor.
Abstract base class for multivariate orthogonal polynomials.
Data structure storing a sparse 3-tensor C(i,j,k) in a a compressed format.
Top-level namespace for Stokhos classes and functions.