Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_MPPreconditionerFactory.cpp
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
46#include "Teuchos_Assert.hpp"
47
49MPPreconditionerFactory(const Teuchos::RCP<Teuchos::ParameterList>& params_) :
50 params(params_)
51{
52}
53
54Teuchos::RCP<Stokhos::MPPreconditioner>
56build(const Teuchos::RCP<const EpetraExt::MultiComm>& mp_comm,
57 int num_mp_blocks,
58 const Teuchos::RCP<const Epetra_Map>& base_map,
59 const Teuchos::RCP<const Epetra_Map>& mp_map)
60{
61 Teuchos::RCP<Stokhos::MPPreconditioner> mp_prec;
62 std::string prec_method = params->get("Preconditioner Method",
63 "Block Diagonal");
64 if (prec_method == "Block Diagonal") {
65 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory =
66 buildPointPreconditionerFactory();
67 mp_prec = Teuchos::rcp(new Stokhos::MPBlockDiagonalPreconditioner(
68 mp_comm, num_mp_blocks,
69 base_map, mp_map, prec_factory,
70 params));
71 }
72 else if (prec_method == "Mean-based") {
73 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory =
74 buildPointPreconditionerFactory();
75 mp_prec = Teuchos::rcp(new Stokhos::MPMeanBasedPreconditioner(
76 mp_comm, num_mp_blocks,
77 base_map, mp_map, prec_factory,
78 params));
79 }
80 else if (prec_method == "None")
81 mp_prec = Teuchos::null;
82 else
83 TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
84 "Error! Unknown preconditioner method " << prec_method
85 << "." << std::endl);
86
87 return mp_prec;
88}
89
90Teuchos::RCP<Stokhos::AbstractPreconditionerFactory>
93{
94 std::string prec_name =
95 params->get("MP Preconditioner Type", "Ifpack");
96 Teuchos::RCP<Teuchos::ParameterList> precParams =
97 Teuchos::rcp(&params->sublist("MP Preconditioner Parameters"),false);
98 return Teuchos::rcp(new Stokhos::PreconditionerFactory(prec_name,
99 precParams));
100}
A multi-point preconditioner based on applying the inverse of the diagonal.
A multi-point preconditioner based on applying the inverse of the mean.
MPPreconditionerFactory(const Teuchos::RCP< Teuchos::ParameterList > &params)
Constructor.
virtual Teuchos::RCP< Stokhos::MPPreconditioner > build(const Teuchos::RCP< const EpetraExt::MultiComm > &mp_comm, int num_mp_blocks, const Teuchos::RCP< const Epetra_Map > &base_map, const Teuchos::RCP< const Epetra_Map > &mp_map)
Build preconditioner operator.
Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > buildPointPreconditionerFactory()
Build preconditioner factory for each point.
An class for building preconditioners.