Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_PreconditionerFactory.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_PRECONDITIONER_FACTORY_HPP
43#define STOKHOS_PRECONDITIONER_FACTORY_HPP
44
45#include "Teuchos_RCP.hpp"
46#include "Teuchos_ParameterList.hpp"
47#include "Epetra_Operator.h"
49
50namespace Stokhos {
51
54 public:
55
58 const std::string& prec_name,
59 const Teuchos::RCP<Teuchos::ParameterList>& params);
60
63
65 virtual Teuchos::RCP<Epetra_Operator>
66 compute(const Teuchos::RCP<Epetra_Operator>& mat,
67 bool compute_prec = true);
68
70 virtual void
71 recompute(const Teuchos::RCP<Epetra_Operator>& mat,
72 const Teuchos::RCP<Epetra_Operator>& prec);
73
74 protected:
75
77 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> factory;
78
79 }; // class PreconditionerFactory
80
81} // namespace Stokhos
82
83#endif // STOKHOS_PRECONDITIONER_FACTORY_HPP
An abstract class to represent a generic preconditioner factory.
An class for building preconditioners.
virtual void recompute(const Teuchos::RCP< Epetra_Operator > &mat, const Teuchos::RCP< Epetra_Operator > &prec)
Recompute preconditioner operator for a new matrix.
Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > factory
Preconditioner factory.
virtual Teuchos::RCP< Epetra_Operator > compute(const Teuchos::RCP< Epetra_Operator > &mat, bool compute_prec=true)
Compute preconditioner operator.
Top-level namespace for Stokhos classes and functions.