Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_FullyAssembledPreconditioner.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_FULLY_ASSEMBLED_PRECONDITIONER_HPP
43#define STOKHOS_FULLY_ASSEMBLED_PRECONDITIONER_HPP
44
45#include "Teuchos_RCP.hpp"
46
49#include "Teuchos_ParameterList.hpp"
50
51namespace Stokhos {
52
58
59 public:
60
63 const Teuchos::RCP<Stokhos::AbstractPreconditionerFactory>& prec_factory,
64 const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
65
68
71
73 virtual void
74 setupPreconditioner(const Teuchos::RCP<Stokhos::SGOperator>& sg_op,
75 const Epetra_Vector& x);
76
78
81
83 virtual int SetUseTranspose(bool UseTranspose);
84
89 virtual int Apply(const Epetra_MultiVector& Input,
90 Epetra_MultiVector& Result) const;
91
96 virtual int ApplyInverse(const Epetra_MultiVector& X,
97 Epetra_MultiVector& Y) const;
98
100 virtual double NormInf() const;
101
103 virtual const char* Label () const;
104
106 virtual bool UseTranspose() const;
107
112 virtual bool HasNormInf() const;
113
118 virtual const Epetra_Comm & Comm() const;
119
124 virtual const Epetra_Map& OperatorDomainMap () const;
125
130 virtual const Epetra_Map& OperatorRangeMap () const;
131
133
134 private:
135
138
141
142 protected:
143
145 std::string label;
146
148 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory;
149
151 Teuchos::RCP<Epetra_Operator> prec;
152
153 }; // class FullyAssembledPreconditioner
154
155} // namespace Stokhos
156
157#endif // STOKHOS_FULLY_ASSEMBLED_PRECONDITIONER_HPP
A stochastic preconditioner based on applying a preconditioner to the fully assembled operator.
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Teuchos::RCP< Epetra_Operator > prec
Stores preconditioner.
FullyAssembledPreconditioner & operator=(const FullyAssembledPreconditioner &)
Private to prohibit copying.
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 void setupPreconditioner(const Teuchos::RCP< Stokhos::SGOperator > &sg_op, const Epetra_Vector &x)
Setup preconditioner.
Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > prec_factory
Stores factory for building preconditioner.
FullyAssembledPreconditioner(const FullyAssembledPreconditioner &)
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 char * Label() const
Returns a character string describing the operator.
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix 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 ...
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
An abstract class to represent a generic stochastic Galerkin preconditioner as an Epetra_Operator.
Top-level namespace for Stokhos classes and functions.