Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Stokhos_FullyAssembledPreconditioner.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Stokhos Package
4 //
5 // Copyright 2009 NTESS and the Stokhos contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 #ifndef STOKHOS_FULLY_ASSEMBLED_PRECONDITIONER_HPP
11 #define STOKHOS_FULLY_ASSEMBLED_PRECONDITIONER_HPP
12 
13 #include "Teuchos_RCP.hpp"
14 
18 
19 namespace Stokhos {
20 
26 
27  public:
28 
33 
36 
39 
41  virtual void
43  const Epetra_Vector& x);
44 
46 
49 
51  virtual int SetUseTranspose(bool UseTranspose);
52 
57  virtual int Apply(const Epetra_MultiVector& Input,
58  Epetra_MultiVector& Result) const;
59 
64  virtual int ApplyInverse(const Epetra_MultiVector& X,
65  Epetra_MultiVector& Y) const;
66 
68  virtual double NormInf() const;
69 
71  virtual const char* Label () const;
72 
74  virtual bool UseTranspose() const;
75 
80  virtual bool HasNormInf() const;
81 
86  virtual const Epetra_Comm & Comm() const;
87 
92  virtual const Epetra_Map& OperatorDomainMap () const;
93 
98  virtual const Epetra_Map& OperatorRangeMap () const;
99 
101 
102  private:
103 
106 
109 
110  protected:
111 
113  std::string label;
114 
117 
120 
121  }; // class FullyAssembledPreconditioner
122 
123 } // namespace Stokhos
124 
125 #endif // STOKHOS_FULLY_ASSEMBLED_PRECONDITIONER_HPP
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
FullyAssembledPreconditioner(const Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > &prec_factory, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
Constructor.
virtual const char * Label() const
Returns a character string describing the operator.
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > prec_factory
Stores factory for building 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 int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
A stochastic preconditioner based on applying a preconditioner to the fully assembled operator...
FullyAssembledPreconditioner & operator=(const FullyAssembledPreconditioner &)
Private to prohibit copying.
virtual void setupPreconditioner(const Teuchos::RCP< Stokhos::SGOperator > &sg_op, const Epetra_Vector &x)
Setup preconditioner.
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
Teuchos::RCP< Epetra_Operator > prec
Stores preconditioner.
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.
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. ...
An abstract class to represent a generic stochastic Galerkin preconditioner as an Epetra_Operator...