Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
Stokhos_MeanBasedPreconditioner.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_MEAN_BASED_PRECONDITIONER_HPP
43 #define STOKHOS_MEAN_BASED_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 
55 namespace Stokhos {
56 
62 
63  public:
64 
67  const Teuchos::RCP<const EpetraExt::MultiComm>& sg_comm,
68  const Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> >& sg_basis,
69  const Teuchos::RCP<const Stokhos::EpetraSparse3Tensor>& epetraCijk,
70  const Teuchos::RCP<const Epetra_Map>& base_map,
71  const Teuchos::RCP<const Epetra_Map>& sg_map,
72  const Teuchos::RCP<Stokhos::AbstractPreconditionerFactory>& prec_factory,
73  const Teuchos::RCP<Teuchos::ParameterList>& params);
74 
76  virtual ~MeanBasedPreconditioner();
77 
80 
82  virtual void
83  setupPreconditioner(const Teuchos::RCP<Stokhos::SGOperator>& sg_op,
84  const Epetra_Vector& x);
85 
87 
90 
92  virtual int SetUseTranspose(bool UseTranspose);
93 
98  virtual int Apply(const Epetra_MultiVector& Input,
99  Epetra_MultiVector& Result) const;
100 
105  virtual int ApplyInverse(const Epetra_MultiVector& X,
106  Epetra_MultiVector& Y) const;
107 
109  virtual double NormInf() const;
110 
112  virtual const char* Label () const;
113 
115  virtual bool UseTranspose() const;
116 
121  virtual bool HasNormInf() const;
122 
127  virtual const Epetra_Comm & Comm() const;
128 
133  virtual const Epetra_Map& OperatorDomainMap () const;
134 
139  virtual const Epetra_Map& OperatorRangeMap () const;
140 
142 
143  private:
144 
147 
150 
151  protected:
152 
154  std::string label;
155 
157  Teuchos::RCP<const EpetraExt::MultiComm> sg_comm;
158 
160  Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> > sg_basis;
161 
163  Teuchos::RCP<const Stokhos::EpetraSparse3Tensor> epetraCijk;
164 
166  Teuchos::RCP<const Epetra_Map> base_map;
167 
169  Teuchos::RCP<const Epetra_Map> sg_map;
170 
173 
175  Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory;
176 
178  Teuchos::RCP<Epetra_Operator> mean_prec;
179 
182 
185 
186  }; // class MeanBasedPreconditioner
187 
188 } // namespace Stokhos
189 
190 #endif // STOKHOS_MEAN_BASED_PRECONDITIONER_HPP
bool useTranspose
Flag indicating whether transpose was selected.
MeanBasedPreconditioner(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.
A stochastic preconditioner based on applying the inverse of the mean.
virtual const char * Label() const
Returns a character string describing the operator.
Teuchos::RCP< const Epetra_Map > base_map
Stores base map.
virtual void setupPreconditioner(const Teuchos::RCP< Stokhos::SGOperator > &sg_op, const Epetra_Vector &x)
Setup preconditioner.
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
MeanBasedPreconditioner & operator=(const MeanBasedPreconditioner &)
Private to prohibit copying.
Teuchos::RCP< const Stokhos::EpetraSparse3Tensor > epetraCijk
Stores Epetra Cijk tensor.
Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > sg_basis
Stochastic Galerking basis.
const IndexType const IndexType const IndexType const IndexType const ValueType const ValueType * x
Definition: csr_vector.h:260
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
bool use_block_apply
Flag indicating whether to use apply all vectors simultaneously.
Top-level namespace for Stokhos classes and functions.
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< const EpetraExt::MultiComm > sg_comm
Stores SG parallel communicator.
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.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this 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 ...
An abstract class to represent a generic stochastic Galerkin preconditioner as an Epetra_Operator...
Teuchos::RCP< Epetra_Operator > mean_prec
Stores mean preconditioner.
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator. ...
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.