Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_MPBlockDiagonalPreconditioner.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_MP_BLOCK_DIAGONAL_PRECONDITIONER_HPP
43#define STOKHOS_MP_BLOCK_DIAGONAL_PRECONDITIONER_HPP
44
45#include "Teuchos_RCP.hpp"
46
48#include "EpetraExt_MultiComm.h"
49#include "Epetra_Map.h"
51#include "Teuchos_ParameterList.hpp"
52#include "Teuchos_Array.hpp"
53
54namespace Stokhos {
55
61
62 public:
63
66 const Teuchos::RCP<const EpetraExt::MultiComm>& mp_comm,
67 int num_mp_blocks,
68 const Teuchos::RCP<const Epetra_Map>& base_map,
69 const Teuchos::RCP<const Epetra_Map>& mp_map,
70 const Teuchos::RCP<Stokhos::AbstractPreconditionerFactory>& prec_factory,
71 const Teuchos::RCP<Teuchos::ParameterList>& params);
72
75
78
80 virtual void
82 const Teuchos::RCP<Stokhos::BlockDiagonalOperator>& mp_op,
83 const Epetra_Vector& x);
84
86
89
91 virtual int SetUseTranspose(bool UseTranspose);
92
97 virtual int Apply(const Epetra_MultiVector& Input,
98 Epetra_MultiVector& Result) const;
99
104 virtual int ApplyInverse(const Epetra_MultiVector& X,
105 Epetra_MultiVector& Y) const;
106
108 virtual double NormInf() const;
109
111 virtual const char* Label () const;
112
114 virtual bool UseTranspose() const;
115
120 virtual bool HasNormInf() const;
121
126 virtual const Epetra_Comm & Comm() const;
127
132 virtual const Epetra_Map& OperatorDomainMap () const;
133
138 virtual const Epetra_Map& OperatorRangeMap () const;
139
141
142 private:
143
146
149
150 protected:
151
153 std::string label;
154
156 Teuchos::RCP<const EpetraExt::MultiComm> mp_comm;
157
160
162 Teuchos::RCP<const Epetra_Map> base_map;
163
165 Teuchos::RCP<const Epetra_Map> mp_map;
166
168 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory;
169
171 Teuchos::Array< Teuchos::RCP<Epetra_Operator> > block_precs;
172
175
176 }; // class MPBlockDiagonalPreconditioner
177
178} // namespace Stokhos
179
180#endif // STOKHOS_MP_BLOCK_DIAGONAL_PRECONDITIONER_HPP
A multi-point preconditioner based on applying the inverse of the diagonal.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
Teuchos::RCP< const Epetra_Map > mp_map
Stores MP map.
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
virtual const char * Label() const
Returns a character string describing the operator.
MPBlockDiagonalPreconditioner(const MPBlockDiagonalPreconditioner &)
Private to prohibit copying.
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 bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > prec_factory
Stores factory for building mean preconditioner.
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator.
virtual void setupPreconditioner(const Teuchos::RCP< Stokhos::BlockDiagonalOperator > &mp_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 ...
MPBlockDiagonalPreconditioner & operator=(const MPBlockDiagonalPreconditioner &)
Private to prohibit copying.
Teuchos::RCP< const Epetra_Map > base_map
Stores base map.
Teuchos::RCP< const EpetraExt::MultiComm > mp_comm
Stores MP parallel communicator.
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix 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 bool UseTranspose() const
Returns the current UseTranspose setting.
Teuchos::Array< Teuchos::RCP< Epetra_Operator > > block_precs
Stores preconditioner for each block.
An abstract class to represent a generic stochastic Galerkin preconditioner as an Epetra_Operator.
Top-level namespace for Stokhos classes and functions.