Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_ApproxJacobiPreconditioner.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_JACOBI_PRECONDITIONER_HPP
43#define STOKHOS_APPROX_JACOBI_PRECONDITIONER_HPP
44
45#include "Teuchos_RCP.hpp"
46
48#include "EpetraExt_MultiComm.h"
51#include "Epetra_Map.h"
53#include "Teuchos_ParameterList.hpp"
55#include "EpetraExt_BlockMultiVector.h"
56
57namespace Stokhos {
58
64
65 public:
66
69 const Teuchos::RCP<const EpetraExt::MultiComm>& sg_comm,
70 const Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> >& sg_basis,
71 const Teuchos::RCP<const Stokhos::EpetraSparse3Tensor>& epetraCijk,
72 const Teuchos::RCP<const Epetra_Map>& base_map,
73 const Teuchos::RCP<const Epetra_Map>& sg_map,
74 const Teuchos::RCP<Stokhos::AbstractPreconditionerFactory>& prec_factory,
75 const Teuchos::RCP<Teuchos::ParameterList>& params);
76
79
82
84 virtual void
85 setupPreconditioner(const Teuchos::RCP<Stokhos::SGOperator>& sg_op,
86 const Epetra_Vector& x);
87
89
92
94 virtual int SetUseTranspose(bool UseTranspose);
95
100 virtual int Apply(const Epetra_MultiVector& Input,
101 Epetra_MultiVector& Result) const;
102
107 virtual int ApplyInverse(const Epetra_MultiVector& X,
108 Epetra_MultiVector& Y) const;
109
111 virtual double NormInf() const;
112
114 virtual const char* Label () const;
115
117 virtual bool UseTranspose() const;
118
123 virtual bool HasNormInf() const;
124
129 virtual const Epetra_Comm & Comm() const;
130
135 virtual const Epetra_Map& OperatorDomainMap () const;
136
141 virtual const Epetra_Map& OperatorRangeMap () const;
142
144
145 private:
146
149
152
153 protected:
154
156 std::string label;
157
159 Teuchos::RCP<const EpetraExt::MultiComm> sg_comm;
160
162 Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> > sg_basis;
163
165 Teuchos::RCP<const Stokhos::EpetraSparse3Tensor> epetraCijk;
166
168 Teuchos::RCP<const Epetra_Map> base_map;
169
171 Teuchos::RCP<const Epetra_Map> sg_map;
172
174 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory;
175
177 Teuchos::RCP<Epetra_Operator> mean_prec;
178
181
184
186 Teuchos::RCP<Stokhos::SGOperator> sg_op;
187
189 Teuchos::RCP<Stokhos::EpetraOperatorOrthogPoly > sg_poly;
190
192 Teuchos::RCP<Stokhos::SGOperator> mat_free_op;
193
195 mutable Teuchos::RCP<EpetraExt::BlockMultiVector> rhs_block;
196
197 }; // class ApproxJacobiPreconditioner
198
199} // namespace Stokhos
200
201#endif // STOKHOS_APPROX_JACOBI_PRECONDITIONER_HPP
A stochastic preconditioner based on applying two iterations of approximate Jacobi.
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 const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator.
Teuchos::RCP< const EpetraExt::MultiComm > sg_comm
Stores SG parallel communicator.
Teuchos::RCP< Stokhos::SGOperator > mat_free_op
SG operator to implement SG mat-vec.
virtual void setupPreconditioner(const Teuchos::RCP< Stokhos::SGOperator > &sg_op, const Epetra_Vector &x)
Setup preconditioner.
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 ...
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
virtual const char * Label() const
Returns a character string describing the operator.
Teuchos::RCP< Stokhos::SGOperator > sg_op
Pointer to the SG operator.
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > sg_basis
Stochastic Galerking basis.
Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > prec_factory
Stores factory for building mean preconditioner.
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > sg_poly
Pointer to the PCE expansion of Jacobian.
ApproxJacobiPreconditioner(const ApproxJacobiPreconditioner &)
Private to prohibit copying.
Teuchos::RCP< const Epetra_Map > base_map
Stores base map.
bool useTranspose
Flag indicating whether transpose was selected.
Teuchos::RCP< Epetra_Operator > mean_prec
Stores mean preconditioner.
Teuchos::RCP< const Stokhos::EpetraSparse3Tensor > epetraCijk
Stores Epetra Cijk tensor.
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
ApproxJacobiPreconditioner & operator=(const ApproxJacobiPreconditioner &)
Private to prohibit copying.
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
ApproxJacobiPreconditioner(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< const Epetra_Map > sg_map
Stores SG map.
Teuchos::RCP< EpetraExt::BlockMultiVector > rhs_block
Temporary vector for storing rhs in Gauss-Seidel loop.
Abstract base class for multivariate orthogonal polynomials.
An abstract class to represent a generic stochastic Galerkin preconditioner as an Epetra_Operator.
Top-level namespace for Stokhos classes and functions.