Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_ApproxGaussSeidelPreconditioner.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Stokhos Package
5// Copyright (2009) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Eric T. Phipps (etphipp@sandia.gov).
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef STOKHOS_APPROX_GAUSS_SEIDEL_PRECONDITIONER_HPP
43#define STOKHOS_APPROX_GAUSS_SEIDEL_PRECONDITIONER_HPP
44
45#include "Teuchos_RCP.hpp"
46
48#include "EpetraExt_MultiComm.h"
51#include "Epetra_Map.h"
53#include "Teuchos_ParameterList.hpp"
54#include "EpetraExt_BlockMultiVector.h"
55
56namespace Stokhos {
57
63
64 public:
65
68 const Teuchos::RCP<const EpetraExt::MultiComm>& sg_comm,
69 const Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> >& sg_basis,
70 const Teuchos::RCP<const Stokhos::EpetraSparse3Tensor>& epetraCijk,
71 const Teuchos::RCP<const Epetra_Map>& base_map,
72 const Teuchos::RCP<const Epetra_Map>& sg_map,
73 const Teuchos::RCP<Stokhos::AbstractPreconditionerFactory>& prec_factory,
74 const Teuchos::RCP<Teuchos::ParameterList>& params);
75
78
81
83 virtual void
84 setupPreconditioner(const Teuchos::RCP<Stokhos::SGOperator>& sg_op,
85 const Epetra_Vector& x);
86
88
91
93 virtual int SetUseTranspose(bool UseTranspose);
94
99 virtual int Apply(const Epetra_MultiVector& Input,
100 Epetra_MultiVector& Result) const;
101
106 virtual int ApplyInverse(const Epetra_MultiVector& X,
107 Epetra_MultiVector& Y) const;
108
110 virtual double NormInf() const;
111
113 virtual const char* Label () const;
114
116 virtual bool UseTranspose() const;
117
122 virtual bool HasNormInf() const;
123
128 virtual const Epetra_Comm & Comm() const;
129
134 virtual const Epetra_Map& OperatorDomainMap () const;
135
140 virtual const Epetra_Map& OperatorRangeMap () const;
141
143
144 private:
145
148
151
152 protected:
153
155 std::string label;
156
158 Teuchos::RCP<const EpetraExt::MultiComm> sg_comm;
159
161 Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> > sg_basis;
162
164 Teuchos::RCP<const Stokhos::EpetraSparse3Tensor> epetraCijk;
165
167 Teuchos::RCP<const Epetra_Map> base_map;
168
170 Teuchos::RCP<const Epetra_Map> sg_map;
171
173 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory;
174
176 Teuchos::RCP<Epetra_Operator> mean_prec;
177
180
182 Teuchos::RCP<Stokhos::SGOperator> sg_op;
183
185 Teuchos::RCP<Stokhos::EpetraOperatorOrthogPoly > sg_poly;
186
189
191 Teuchos::RCP<const Cijk_type > Cijk;
192
195
198
201
203 mutable Teuchos::RCP<Epetra_MultiVector> mat_vec_tmp;
204
206 mutable Teuchos::RCP<EpetraExt::BlockMultiVector> rhs_block;
207
208 }; // class ApproxGaussSeidelPreconditioner
209
210} // namespace Stokhos
211
212#endif // STOKHOS_APPROX_GAUSS_SEIDEL_PRECONDITIONER_HPP
A stochastic preconditioner based on applying one iteration of approximate Gauss-Seidel.
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
Teuchos::RCP< Epetra_Operator > mean_prec
Stores mean preconditioner.
Teuchos::RCP< const Cijk_type > Cijk
Pointer to triple product.
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Teuchos::RCP< const Stokhos::EpetraSparse3Tensor > epetraCijk
Stores Epetra Cijk tensor.
Teuchos::RCP< Epetra_MultiVector > mat_vec_tmp
Temporary vector for storing matrix-vector products.
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator.
bool only_use_linear
Limit Gauss-Seidel loop to linear terms.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
bool useTranspose
Flag indicating whether transpose was selected.
virtual void setupPreconditioner(const Teuchos::RCP< Stokhos::SGOperator > &sg_op, const Epetra_Vector &x)
Setup preconditioner.
Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > sg_basis
Stochastic Galerking basis.
Teuchos::RCP< Stokhos::SGOperator > sg_op
Pointer to the SG 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 ...
ApproxGaussSeidelPreconditioner & operator=(const ApproxGaussSeidelPreconditioner &)
Private to prohibit copying.
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
ApproxGaussSeidelPreconditioner(const ApproxGaussSeidelPreconditioner &)
Private to prohibit copying.
ApproxGaussSeidelPreconditioner(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 > &base_map, const Teuchos::RCP< const Epetra_Map > &sg_map, const Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > &prec_factory, const Teuchos::RCP< Teuchos::ParameterList > &params)
Constructor.
Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > prec_factory
Stores factory for building mean preconditioner.
Teuchos::RCP< const Epetra_Map > sg_map
Stores SG map.
Teuchos::RCP< const EpetraExt::MultiComm > sg_comm
Stores SG parallel communicator.
Teuchos::RCP< EpetraExt::BlockMultiVector > rhs_block
Temporary vector for storing rhs in Gauss-Seidel loop.
Stokhos::Sparse3Tensor< int, double > Cijk_type
Short-hand for Cijk.
virtual const char * Label() const
Returns a character string describing the operator.
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 ...
bool scale_op
Flag indicating whether operator be scaled with <\psi_i^2>
Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > sg_poly
Pointer to the PCE expansion of Jacobian.
Teuchos::RCP< const Epetra_Map > base_map
Stores base map.
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
Abstract base class for multivariate orthogonal polynomials.
An abstract class to represent a generic stochastic Galerkin preconditioner as an Epetra_Operator.
Data structure storing a sparse 3-tensor C(i,j,k) in a a compressed format.
Top-level namespace for Stokhos classes and functions.