Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_PreconditionerFactory.cpp
Go to the documentation of this file.
1// $Id$
2// $Source$
3// @HEADER
4// ***********************************************************************
5//
6// Stokhos Package
7// Copyright (2009) Sandia Corporation
8//
9// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
10// license for use of this work by or on behalf of the U.S. Government.
11//
12// Redistribution and use in source and binary forms, with or without
13// modification, are permitted provided that the following conditions are
14// met:
15//
16// 1. Redistributions of source code must retain the above copyright
17// notice, this list of conditions and the following disclaimer.
18//
19// 2. Redistributions in binary form must reproduce the above copyright
20// notice, this list of conditions and the following disclaimer in the
21// documentation and/or other materials provided with the distribution.
22//
23// 3. Neither the name of the Corporation nor the names of the
24// contributors may be used to endorse or promote products derived from
25// this software without specific prior written permission.
26//
27// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38//
39// Questions? Contact Eric T. Phipps (etphipp@sandia.gov).
40//
41// ***********************************************************************
42// @HEADER
43
47#include "Teuchos_Assert.hpp"
48
50PreconditionerFactory(const std::string& prec_name,
51 const Teuchos::RCP<Teuchos::ParameterList>& params)
52{
53 if (prec_name == "Ifpack")
54 factory =
55 Teuchos::rcp(new Stokhos::IfpackPreconditionerFactory(params));
56 else if (prec_name == "ML")
57 factory =
58 Teuchos::rcp(new Stokhos::MLPreconditionerFactory(params));
59 else
60 TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
61 "Error! Unknown preconditioner type " << prec_name
62 << ". Valid choices are \"Ifpack\" and \"ML\".");
63}
64
65Teuchos::RCP<Epetra_Operator>
67compute(const Teuchos::RCP<Epetra_Operator>& mat, bool compute_prec)
68{
69 return factory->compute(mat, compute_prec);
70}
71
72void
74recompute(const Teuchos::RCP<Epetra_Operator>& mat,
75 const Teuchos::RCP<Epetra_Operator>& prec)
76{
77 factory->recompute(mat, prec);
78}
A factory for building Ifpack preconditioners.
A factory for building ML preconditioners.
PreconditionerFactory(const std::string &prec_name, const Teuchos::RCP< Teuchos::ParameterList > &params)
Constructor.
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.